ignition-lint

A comprehensive linting toolkit for Ignition SCADA projects that combines naming convention validation, empirical schema checks, script analysis, and CI/CD automation.

What It Does

ignition-lint validates your Ignition project files across five dimensions:

• Perspective Linting — Schema-aware checks against view.json files, bindings, event handlers, and onChange scripts using production-validated rules from 12,000+ real industrial components
• Expression Validation — Detects now() polling issues, unknown expression functions, malformed property references, and fragile component-tree traversal in Ignition expressions
• Naming Validation — Enforces component, parameter, and custom property naming styles (PascalCase, camelCase, snake_case, or custom regex)
• Script Analysis — Lints Jython inline scripts (from view.json bindings, event handlers, onChange, and transforms) and standalone Python files in script-python directories
• Unused Property Detection — Flags unreferenced custom and params properties on a per-view basis

Why Use It

Ignition projects grow fast in industrial environments. Without consistent validation, teams end up with:

• Generic component names like Label or Button that make views hard to navigate
• Mixed naming conventions across parameters and properties
• Jython syntax issues that only surface at runtime
• Deprecated API usage (print statements, .iteritems(), xrange())
• Hardcoded gateway URLs and overridden system variables
• now() expressions polling at 1 000 ms by default, causing unnecessary load
• Dead custom properties that accumulate over time
• Fragile getSibling() / getChild() calls that break when views are refactored

ignition-lint catches these issues early — in your editor, in pre-commit hooks, or in CI.

Relationship to ia-eknorr/ignition-lint

This project extends the foundational work by Eric Knorr in ia-eknorr/ignition-lint, which pioneered naming convention validation for Ignition view.json files.

Capability	ia-eknorr/ignition-lint	TheThoughtagen/ignition-lint
View.json naming validation	Yes	Yes (enhanced)
GitHub Actions integration	Yes	Yes (enhanced)
CLI tool	No	Yes (--target any dir, --project Ignition layout)
Project-wide linting	No	Yes
Script validation	No	Yes (inline Jython + standalone .py)
Empirical schema validation	No	Yes
Expression validation	No	Yes (polling, functions, property refs)
Unused property detection	No	Yes (per-view custom/params analysis)
MCP/AI integration	No	Yes (FastMCP server + JSON output)
Lint suppression	No	Yes

Use ia-eknorr/ignition-lint if you only need the original naming checks and a lightweight GitHub Action. Use TheThoughtagen/ignition-lint for local CLI tooling, schema validation, script linting, MCP integration, or suppression support.

Tooling Overview

Command	Purpose
ignition-lint	CLI entry point for project and file linting
ignition-lint-server	FastMCP server for AI agent integrations
ignition-lint-action	Wrapper used by the GitHub Action

Next Steps

• Installation — Get up and running
• Basic Usage — Lint your first project
• CLI Reference — Full command-line options