zls Documentation

Technical Documentation: zigtools/zls

ℹ️ Provenance: Multi-Tier Ingestion · CodeWiki Reference

Overview (`README.md`) Copy Section

ZLS is a non-official implementation of the Language Server Protocol for Zig in Zig. It provides developers with IDE features in their editor.

Installation Copy Chapter

The complete installation guide is available on the Zigtools website. It covers editor setup, prebuilt binaries and additional documentation.

Build From Source Copy Section

The default branch of ZLS targets Zig master.

git clone https://github.com/zigtools/zls
cd zls
zig build -Doptimize=ReleaseSafe

When upgrading Zig, make sure to update ZLS too keep them in sync.

Features Copy Chapter

ZLS supports most language features, including simple type function support, payload capture type resolution, custom packages, and others. Support for comptime and semantic analysis is Work-in-Progress.

The majority of LSP features are supported:

• Completions
• Hover
• Diagnostics and opt-in build-on-save
• Go to definition/declaration
• Workspace symbols and document symbols
• Find references and rename symbol
• Formatting based on zig fmt
• Semantic tokens highlighting
• Inlay hints
• Code actions

Quick Thanks :) Copy Chapter

We'd like to take a second to thank all our awesome contributors and donators/backers/sponsors; if you have time or money to spare, consider partaking in either of these options - they help keep ZLS awesome for everyone!

Overview (`src/analyser/README.md`) Copy Section

This directory contains mostly future work on an improved analysis backend. Only a fractions of this code is being used. For the current analysis backend implementation, See src/analysis.zig.

--- METRICS ---

• Files Extracted: 2
• Estimated Token Budget: ~552 tokens
• Canonical Reference: https://codewiki.google/github.com/zigtools/zls