ZLS 0.16.0

Feature improvements

Workspace Symbols (#2339)

The workspace/symbol request has been implemented. It provides an editor with a project-wide list of all symbols that match a query string.

Show Example

The query search is case-insensitive and ignores underscore characters to avoid missing results from spelling differences between snake_case and camelCase. To implement workspace symbols and improve cross-file symbol references (explained further below), all files within workspace folders are loaded during startup. The .zig-cache and zig-pkg subdirectories are excluded from this.

The impact on memory usage has been tested with Zig and ZLS codebases to ensure that ZLS doesn’t use unreasonable amounts of memory.

The extra resource cost for workspace symbols will only apply once they have been requested.

Reliable symbol references across files (#2608)

This is about the feature that implements editor functionally like “Find All References” or “Rename Symbol”.

The implementation of symbol references was fundamentally broken with regards to how it dealt with references across files. It has been reworked completely to more reliably find all references within files of the same build system module. In the future, this can handle additional cases like references across modules or within the standard library.

Accurate module @import resolution (#2510)

To resolve module @imports and other build system dependant features, a custom build runner extracts the releveant information out of a build.zig. This data would however previously merge the entire build graph into one single module and compilation unit. This can easily lead to incorrect results in any non trivial project that contains multiple modules so it has been reworked to keep track of each individual module so that analysis can differentiate between them just like how the compiler does it.

Some examples of what has been improved:

• auto complete for @import will only show the modules that have been directly added to the module that the current file belongs to
• @import("some_name") will resolve the correct module if there are multiple modules that have imported different modules with “some_name” as their name.
• @import("root") now actually figures out in which compilation units a given file is in.

Folding Ranges for @import()s (#2514)

A sequence of three or more @import() declarations will get a folding range to be collapsed. Depending on the editor, folding ranges for imports can be collapsed by default.

Completions

• completions on branching types will be merged instead of showing duplicate items (#2638)
• switch on errors will complete based on the actual error set (#2619)
• Declarations that are marked as “Deprecated” are sorted towards the end (#2623)
• Fields with default are sorted towards the end (#2636)

Go to definition on container type jump to @This() alias (#2582)

const Foo = struct {
    //^^^ Go to Definition here
    const Me = @This();
    //    ^^ will jump there
}

This is related to an open proposal about using @This() aliases for documentation.

Compile log output in build on save diagnostics (#2493)

The output of @compileLog statements that were collected during build on save will now be provided through diagnostics.

Show Example

Expand branching types in hover popup (#2349)

Types that resolve differently based on comptime control flow will show all possibilities in the hover popup.

Show Example

Contributors

Here is a list of everyone who has made at least one contribution to this release of ZLS:

• Techatrix
• FnControlOption
• Johan Persson
• xdBronch
• llogick
• Carmen
• Leon Lombar
• Nikita Belov
• andrewkraevskii
• Ataias Pereira Reis
• Iisakki Rotko
• Luna Schwalbe
• Nico Elbers
• Sachin Beniwal
• Sungbae Jeong
• SuperAuguste
• Vivek Singh
• eshom
• psznm

Sponsors

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!

Full Changelog: 0.15.0…0.16.0

Release Artifacts

All files are signed with minisign using this public key:

RWR+9B91GBZ0zOjh6Lr17+zKf5BoSuFvrx2xSeDE57uIYvnKBGmMjOex