fix: avoid treating modules named build.zig as build scripts - #3250
Open
vkurilyak wants to merge 2 commits into
Open
fix: avoid treating modules named build.zig as build scripts#3250vkurilyak wants to merge 2 commits into
vkurilyak wants to merge 2 commits into
Conversation
vkurilyak
force-pushed
the
fix/3249-build-script-detection
branch
from
August 24, 2026 15:56
10e5982 to
267f187
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3249.
I am a fan of Zig and VS Code, and I decided to contribute to ZLS tooling after looking into this issue.
ZLS currently treats any file named
build.zigas a build script. This can make ordinary modules run through the build runner and produce misleading diagnostics.This change checks for the public
buildentry point before loading build configuration or starting build-on-save. It also adds regression coverage for both a valid build script and an ordinary module namedbuild.zig.I typically follow a defensive programming style and use assertions to make important invariants explicit. I added a few here to help catch issues like this earlier. If the project prefers those assertions to be removed, please let me know.
Tests:
zig build check test -j1 --summary all