zigtools/zls
Zls
ZLS is a language server for the Zig language that implements the Language Server Protocol to provide IDE-like intelligence. It functions as a code intelligence provider, static code analysis tool, and automated refactoring engine for Zig projects.
The server integrates directly with the Zig compiler toolchain to derive precise type information and perform semantic analysis. It uses this integration to surface real-time compilation errors as editor diagnostics and to provide semantic syntax highlighting based on resolved types rather than regex patterns.
The project covers a wide range of development capabilities, including symbol navigation, code completion, and inlay hints. It provides refactoring utilities for symbol renaming, source code formatting, and import organization. Additionally, it manages build automation, including automatic builds on save and dependency fetching.
The server supports configuration validation via JSON Schema and integrates with editors such as Sublime Text and JetBrains IDEs.
Features
- Language Server Protocol Integrations - Implements the Language Server Protocol to provide IDE-like intelligence and automation for the Zig language.
- Code Intelligence Providers - Functions as a backend providing autocomplete, symbol navigation, and semantic intelligence for the Zig language.
- LSP Server Implementations - Implements the Language Server Protocol via JSON-RPC to provide intelligence to various text editors.
- Code Completion - Provides real-time suggestions for symbols and expressions as the user types to accelerate development.
- Automated Code Refactoring - Performs bulk symbol renaming and applies automatic fixes to maintain a clean Zig codebase.
- Definition Navigation - Enables jumping directly from a symbol usage to its definition within the source code.
- Language Server Protocols - Communicates with text editors through the standardized Language Server Protocol to deliver tooling.
- Language Servers - Implements the Language Server Protocol to deliver IDE-like intelligence and automation for Zig.
- Static Code Analysis - Identifies compilation errors and analyzes symbol references across projects to ensure code correctness.
- Symbol Indexing - Implements symbol indexing to enable efficient navigation between definitions and call sites across the project.
- In-Process Integrations - Interfaces directly with the Zig compiler within the server process for low-latency type information retrieval.
- In-Process Runtimes - Executes compiler logic within the same process as the server to minimize metadata retrieval latency.
- Language Development Environments - Provides a development environment for Zig with autocomplete, symbol navigation, and real-time error checking.
- Compiler-Integrated Analysis - Integrates directly with the Zig compiler to resolve symbols and derive precise type information for analysis.
- Semantic Syntax Highlighting - Provides syntax highlighting based on the resolved semantic meaning and types of identifiers.
- Automated Refactoring Engines - Implements a programmatic engine for codebase-wide symbol renaming and automatic code fixes.
- Codebase Symbol References - Locates all instances where a specific symbol is used across a project to assess the impact of changes.
- Symbol Renamers - Provides project-wide symbol renaming to ensure consistent naming and referential integrity.
- Static Code Analysis Tools - Integrates with the Zig compiler to derive type information and surface compilation errors as diagnostics.
- Automated Code Fixes - Programmatically applies edits to resolve common code issues and bypass editor limitations.
- Automated Code Fix Suggestions - Proposes quick fixes and refactorings at specific code locations to resolve errors or improve quality.
- Inlay Hints - Displays inline text hints in the editor to reveal inferred types and parameter names.
- Source Code Formatters - Implements a standard formatter to adjust code indentation and style for project consistency.
- Hover Information Displays - Displays type information and documentation for symbols via inline popups on mouse hover.
- Syntax Highlighting & Indentation - Provides semantic syntax highlighting and automatic indentation to improve source code readability.
- Build Automation - Triggers project compilation on save and manages target architectures and dependency fetching.
- Zig Language Environments - Provides utilities for managing Zig project builds, dependency fetching, and environment installation.
- Build-Triggered Diagnostics - Triggers project compilation upon saving files to surface compiler errors as real-time editor diagnostics.
