Add lint command for StructKit YAML definitions#141
Draft
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.
Motivation
Description
lintimplemented instructkit/commands/lint.pywith support for multipletargets,--all,-s/--structures-path, and--jsonoutput.ValidateCommandhelpers, missing top-leveldescription, duplicate file/folder entries, undeclared and unused template variables, suspicious/unsafe hook patterns, unpinned GitHub/raw URLs, and invalid entry names.lintsubcommand inget_parser()instructkit/main.pyand document the command, rules, usage and examples indocs/cli-reference.md.tests/test_lint_command.pythat cover command registration, variable/template checks, duplicates, hook and remote URL detection, JSON output and error exit behavior, and--alldiscovery.Testing
pytest tests/test_lint_command.pyand the tests passed (7 passed).pytestand all tests passed (161 passed).python -m structkit.main lint --all --jsonwhich produced a JSON report of warnings/errors and returned non-zero exit when errors were present as expected.Codex Task