docs: correct lint/diff output examples and rule count in README#119
Open
rmyndharis wants to merge 1 commit into
Open
docs: correct lint/diff output examples and rule count in README#119rmyndharis wants to merge 1 commit into
rmyndharis wants to merge 1 commit into
Conversation
- lint `summary` uses the key `infos`, not `info` - the `diff` JSON includes all token categories plus a `findings` block (before/after/delta) and `regression`; the example previously showed only two token categories and omitted `findings` - the linter runs ten rules — add the missing `token-like-ignored` row
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.
Summary
Three README accuracy fixes so the documented output matches what the CLI emits:
summarykey — the README shows"info": 1, butlintemits"infos". An agent parsingsummary.infoper the docs readsundefined. Corrected toinfos.diffoutput shape — the documented example shows onlycolors/typographyundertokensand omits thefindingsblock entirely. The actual output (commands/diff.ts) emits all five token categories (colors,typography,rounded,spacing,components) plusfindings: { before, after, delta }andregression. Updated the example to match.DEFAULT_RULE_DESCRIPTORSregisters ten;token-like-ignored(added in feat: warn on token-like frontmatter keys silently ignored by export #105) was missing. Added the row and updated "nine" → "ten".Testing
Docs-only. Verified the rule list/severity against
packages/cli/src/linter/linter/rules/index.tsandtoken-like-ignored.ts, and the diff/lint shapes againstcommands/diff.ts,commands/lint.ts, andutils.ts.