ignition-lint-toolkit 0.4.0

Comprehensive Ignition linting tool with naming conventions and empirical validation. Extends ia-eknorr/ignition-lint with enhanced features.

ignition-lint

A comprehensive linting toolkit for Ignition SCADA projects. Validates Perspective views, Jython scripts, naming conventions, expressions, and more.

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

Installation

pip install ignition-lint-toolkit

Or with uv:

uv pip install ignition-lint-toolkit

Verify the install:

ignition-lint --help

Optional: MCP server support

pip install "ignition-lint-toolkit[mcp]"

Quick start

Lint any directory

Point the linter at any directory and it recursively finds view.json and .py files:

ignition-lint --target /path/to/your/project

Lint a full Ignition project

If your directory follows the standard Ignition layout:

ignition-lint --project /path/to/ignition/project --profile full

Pick specific checks

# Only Perspective views
ignition-lint -t /path/to/views --checks perspective

# Only scripts, JSON output for programmatic use
ignition-lint -t /path/to/scripts --checks scripts --report-format json

# Naming conventions only
ignition-lint --project /path/to/project --naming-only

Suppress noisy rules during adoption

ignition-lint -t ./project --ignore-codes NAMING_PARAMETER,MISSING_DOCSTRING,LONG_LINE

What it checks

Category	Examples
Perspective schema	Component structure, binding types, transform validity, missing props
Expressions	now() polling intervals, unknown functions, malformed property refs, fragile component traversal
Naming conventions	Component, parameter, and custom property naming (PascalCase, camelCase, snake_case, or custom regex)
Jython inline scripts	Syntax errors, indentation, print statements, hardcoded URLs, missing error handling
Standalone scripts	Python syntax, docstrings, deprecated APIs, system overrides, line length
Unused properties	Unreferenced custom and params properties per view

Severity levels

Level	Meaning
ERROR	Critical issues that cause runtime failures
WARNING	Compatibility or best practice issues
INFO	Informational insights and suggestions
STYLE	Code style and documentation improvements

Lint suppression

Three mechanisms let you control which rules fire and where:

1. --ignore-codes flag -- suppress rules globally for an entire run
2. .ignition-lintignore file -- gitignore-style patterns with optional rule scoping per path
3. Inline comments -- # ignition-lint: disable=CODE directives in Python scripts

See the suppression guide for the full reference.

Integrations

GitHub Actions

Create .github/workflows/ignition-lint.yml:

name: Ignition Lint
on: [push, pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: whiskeyhouse/ignition-lint@v1
        with:
          files: "**/view.json"
          component_style: "PascalCase"
          parameter_style: "camelCase"

Pre-commit hook

repos:
  - repo: https://github.com/WhiskeyHouse/ignition-lint
    rev: v1
    hooks:
      - id: ignition-perspective-lint

MCP server (AI agents)

ignition-lint-server

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

Documentation

Full documentation at WhiskeyHouse.github.io/ignition-lint:

• Installation
• Basic usage
• CLI reference
• Rule codes
• Suppression guide
• GitHub Actions

Contributing

Contributions are welcome! See CONTRIBUTING.md for development setup, project structure, and guidelines.

License

MIT © Whiskey House Labs