Repository navigation
Add gdzig-zlint with the 0.6.1 ruleset - #11
Merged
Merged
Conversation
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
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.
Summary
Adds
gdzig-zlint(ZLint 0.10.0 with the gdzigCODE_STYLErules) and wires itinto mise and CI. Follow-up to gdzig/gdzig#290.
github:gdzig/gdzig-zlint0.6.1 throughmise.toml.zlint.jsonfrom the 0.6.1 template without changing any rule levels.The gdzig rules,
gdzig-public-docs, andline-lengthremain atwarn;homeless-tryremains aterror.mise run lintand a Lint workflow for pushes tomain, PRs, and manual runs.alias, an inferred initializer, test and fixture placement, a trailing comma,
and the namespace file name. The public
XmlDocParserexport remains intact.mise.lockwas created.Verification
gdzig-zlint .: 0 errors, 37 warnings (before: 0 errors, 60 warnings).mise run lint: exits successfully with the same diagnostics.zig build test: passes both before and after these edits. Both runsemit the same expected malformed-XML test warning (
Bad: error.MalformedXml).zig fmt --checkon changed Zig files: passes. The initial whole-treecheck reported pre-existing unformatted
src/cache.zig,src/DocDatabase.zig,and
src/XmlDocParser.zig; those were formatted only after being changed.gdzig-public-docsrequire meaningful API documentation,and 14
line-lengthrequire separate signature, example, or line wrapping.Neither class has a safe mechanical fix within this lint-only rollout.
Notes
--deny-warningsis intentionally not enabled yet because the existingdocumentation and line length diagnostics still need cleanup.