Skip to main content

Language Server Protocol implementation for Ignition by Inductive Automation

Project description

Ignition LSP Server

Language Server Protocol implementation for Ignition by Inductive Automation.

Features

  • Autocompletion for system.*, project.*, and shared.* namespaces (239+ functions across 14 modules)
  • Hover documentation with function signatures, parameter details, and scope info
  • Go-to-definition for API functions and project scripts
  • Diagnostics for common scripting issues
  • Workspace symbols for project-wide script navigation
  • Project indexing across Ignition resource files

Installation

From PyPI

pip install ignition-lsp

From Source

cd lsp
pip install -e .

Development Installation

cd lsp
pip install -e ".[dev]"

Usage

The LSP server is automatically started by the ignition.nvim plugin when editing Ignition files.

Manual Start

ignition-lsp

The server communicates via stdio and follows the LSP specification.

Development

Running Tests

pytest

Code Formatting

black ignition_lsp tests

Type Checking

mypy ignition_lsp

Linting

ruff check ignition_lsp tests

Architecture

  • server.py - Main LSP server implementation using pygls 2.0
  • api_loader.py - API database loader and indexer
  • completion.py - Completion provider for Ignition APIs and project scripts
  • hover.py - Hover documentation provider
  • diagnostics.py - Diagnostic provider for code analysis
  • definition.py - Go-to-definition for API functions and project scripts
  • project_scanner.py - Ignition project structure indexer
  • workspace_symbols.py - Workspace symbol provider
  • api_db/ - Ignition API function definitions (14 modules, 239+ functions)

Contributing

See the main project README for contribution guidelines.

License

MIT License - see LICENSE file for details.

Project details


Download files

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

Source Distribution

ignition_lsp-1.3.1.tar.gz (242.0 kB view details)

Uploaded Source

Built Distribution

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

ignition_lsp-1.3.1-py3-none-any.whl (240.3 kB view details)

Uploaded Python 3

File details

Details for the file ignition_lsp-1.3.1.tar.gz.

File metadata

  • Download URL: ignition_lsp-1.3.1.tar.gz
  • Upload date:
  • Size: 242.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ignition_lsp-1.3.1.tar.gz
Algorithm Hash digest
SHA256 f50ad8466e0f21464fc0289114c4a67e80a74fae1dde62f4beec4aa59de68d4b
MD5 a19b5d17ac9a49e426e2f606eb10aea9
BLAKE2b-256 b78db4c1350240e6fc8ec01dcc29da5d68043a389e988d29f28d3e8675246e76

See more details on using hashes here.

Provenance

The following attestation bundles were made for ignition_lsp-1.3.1.tar.gz:

Publisher: release.yml on TheThoughtagen/ignition-ide-plugins

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

File details

Details for the file ignition_lsp-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: ignition_lsp-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 240.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ignition_lsp-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b95a69649d626b1a22a832cdf62fb3f5c27dea75258524843706175f25f68e6f
MD5 555895f428d8d3da5db95364ae999493
BLAKE2b-256 36a61e92d73a8179c8bd5b8fa8a618319ab11281cbf69e8a7c5f0af77f8bcf8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ignition_lsp-1.3.1-py3-none-any.whl:

Publisher: release.yml on TheThoughtagen/ignition-ide-plugins

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page