Ignition Lint

Static analysis for Ignition Perspective view.json files. Catches naming inconsistencies, performance problems, broken component references, dead custom properties, and Python errors in embedded scripts — before they hit the gateway.

Why

Perspective views are JSON-encoded UI definitions with embedded Python scripts. There's no compiler, no IDE checker, no type system. A typo in an event handler, a now() polling interval that hammers the gateway, or a custom property nobody references will survive happily in source control until somebody hits the bad path in production.

Ignition Lint runs at design time. It builds an object model of every component, binding, and script in your views, then checks it against a configurable set of rules. Plug it into pre-commit to gate developers, into CI to gate pull requests, or run it standalone to audit an existing project.

Quick start

pip install ign-lint
ign-lint path/to/view.json

To lint many views with a project-wide config:

ign-lint --config rule_config.json --files "views/**/view.json"

Built-in rules

Rule What it catches
NamePatternRule Component, property, and script names that don't match a configured convention
BadComponentReferenceRule Brittle traversal patterns (.getSibling(), .getParent(), relative paths)
ComponentReferenceValidationRule Relative references that don't resolve to a real component
PollingIntervalRule now() polling intervals below a configurable minimum
UnusedCustomPropertiesRule Custom properties and view parameters defined but never referenced
ExcessiveContextDataRule Large datasets stored in custom properties (arrays, breadth, depth, total volume)
PylintScriptRule Pylint findings across every script in the view

Every rule is configurable. Severity is per-rule (error or warning). Several rules support auto-fix.

Documentation

The full documentation covers configuration, every rule (user guide plus full technical reference), pre-commit and GitHub Actions integration, debug output, and the framework internals for writing custom rules.

Read the docs: bw-design-group.github.io/ignition-lint

Highlights:

  • Tutorial — first-run walkthrough on a real view, reading the output, and configuring a rule
  • Per-rule pages — common configurations, examples drawn from real fixtures, and what each rule's auto-fix does
  • Developer guide — the visitor pattern, base classes, registry API, and a step-by-step for writing your own rule

Project status

The package publishes to PyPI as ign-lint. Release history lives in CHANGELOG.md (and is mirrored in the docs site). Release process is documented in RELEASING.md.

License

MIT — see LICENSE.

Project links

Data verified by PyPI on Aug 31, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: Alex Spyksma

GitHub Statistics

Data verified by PyPI on Aug 31, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

MIT License (MIT)

Requires

Python <3.14, >=3.10

Tags

ignition perspective linting json scada quality-assurance static-analysis

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ign_lint-0.6.4.tar.gz (100.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ign_lint-0.6.4-py3-none-any.whl (120.2 kB view details)

Uploaded Python 3

File details

Details for the file ign_lint-0.6.4.tar.gz.

File metadata

  • Download URL: ign_lint-0.6.4.tar.gz
  • Upload date:
  • Size: 100.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ign_lint-0.6.4.tar.gz
Algorithm Hash digest
SHA256 386f4c1f79f1fd699cac54ef90766c4cc50dc29739b6b6c92e2bde340ebccf42
MD5 df0d24de5f8ed89811cf37f9749d69b5
BLAKE2b-256 d2f031e2bd937a481b29ef547747c03bd0ba3208debf774ae7fdba5e440fdca9

See more details on using hashes here.

Provenance

The following attestation bundles were made for ign_lint-0.6.4.tar.gz:

Publisher: publish.yml on bw-design-group/ignition-lint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ign_lint-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: ign_lint-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 120.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ign_lint-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9502d0813c581dbcb19f68b6f8886aae6fcd38b28ac0b2ec7fa204d0855eea13
MD5 64f3e69d40f46d08cc7f73af8c6e1549
BLAKE2b-256 87b3965518d8a485d8643c53e4de4e1a24f8015b533b1a97a1c157bc3f74c560

See more details on using hashes here.

Provenance

The following attestation bundles were made for ign_lint-0.6.4-py3-none-any.whl:

Publisher: publish.yml on bw-design-group/ignition-lint

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.6.4 This release

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page