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-0.3.1.tar.gz (191.8 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-0.3.1-py3-none-any.whl (194.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ignition_lsp-0.3.1.tar.gz
Algorithm Hash digest
SHA256 c899b56c188ccaf0463b97c3197cc3d91fc032434048e6554e9c6ef066c5b90e
MD5 5e72bba1cfdda195af5660d95b05e1d4
BLAKE2b-256 952842b1ab272a6ba4a71d1bca1b5217dd3ebfd8731d95f977d1cb0db246290b

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ignition_lsp-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 194.4 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-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 20941c12d64ba9dc24f4cd74bfadecee9b294b90d2f6e9812f929ab95d43d355
MD5 c50dfdd47e74c4ffb2be120e07d9e5a5
BLAKE2b-256 b41c38da3af1ae245d91ee325e016bd4fb84215d3753029736a3fbee2fb42abb

See more details on using hashes here.

Provenance

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