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.1.0.tar.gz (211.4 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.1.0-py3-none-any.whl (211.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ignition_lsp-1.1.0.tar.gz
  • Upload date:
  • Size: 211.4 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.1.0.tar.gz
Algorithm Hash digest
SHA256 f597223de7832246029d4af64f0ca5e3d21f7d50e58333949ceca89252f9510b
MD5 033084ca64d8bcfdba11987805e5f5b5
BLAKE2b-256 471128308d7d9c7c24c2bf6a45c2fccdfc098a7ab868d13e09a0655bdd09a22e

See more details on using hashes here.

Provenance

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

Publisher: release.yml on TheThoughtagen/ignition-nvim

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.1.0-py3-none-any.whl.

File metadata

  • Download URL: ignition_lsp-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 211.7 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e3d49b9813677b517b07b1d5b740283c56d988e529431bbee13d2a68611f41d
MD5 05027483227ea151df6862c1d1c6341a
BLAKE2b-256 b61a400f6b8cf6a169f32c60d302ce496aeef3ebc5c8d427546f61aca2aa20ea

See more details on using hashes here.

Provenance

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

Publisher: release.yml on TheThoughtagen/ignition-nvim

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