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.2.0.tar.gz (215.5 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.2.0-py3-none-any.whl (214.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ignition_lsp-1.2.0.tar.gz
  • Upload date:
  • Size: 215.5 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.2.0.tar.gz
Algorithm Hash digest
SHA256 ae298c5870593d1c7659d2c6afb72820d9b974099b5baf107979922fc826151a
MD5 8dea3648d4ecd12522d66e0e4ad72a25
BLAKE2b-256 e93a85d411c3c5c3bbebf5c905b4e615f6b868286aac2f3634fb92409327fd0f

See more details on using hashes here.

Provenance

The following attestation bundles were made for ignition_lsp-1.2.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.2.0-py3-none-any.whl.

File metadata

  • Download URL: ignition_lsp-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 214.6 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36e21a9ae8cde2aa5aa66d27af69fed1629f0e9aa60eef1f05709b233b8d435e
MD5 53ae5ce2592aefff905f67f90197d302
BLAKE2b-256 96e5ed466dbb8d1085fbf1aaae965c18f714844d42a397a64a2a8d61d60c106d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ignition_lsp-1.2.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