docs(checks): add tools-overloaded to README rule table; extend sarif tests#16
Merged
Merged
Conversation
… tests The tools-overloaded rule has been implemented and tested in checks.test.ts but was missing from the README What-it-checks table and from the sarif test suite. This commit closes both gaps: - Adds the tools-overloaded row to the What it checks table in README.md so the docs match the implementation. - Extends test/sarif.test.ts: asserts tools-overloaded appears in the full SARIF rule catalog (empty-diagnostics path), and adds a round-trip test that verifies a tools-overloaded diagnostic emits at warning level with a correct ruleIndex. - Updates the test count badge from 70 to 77 (reflects tests added in earlier bot runs plus the two new ones here).
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.
Why
The
tools-overloadedrule was shipped in a previous commit but was neveradded to the "What it checks" table in README.md. Anyone reading the docs
to understand what skillcheck catches would not know this rule exists. The
SARIF test suite also had a gap: it checked for three rules in the catalog
but not for
tools-overloaded, so a regression that dropped the rule fromsarif.tsRULES would go undetected.What
tools-overloadedrow to the "What it checks" table in README.mdso the documentation matches the implementation.
test/sarif.test.tswith two new cases:tools-overloadedappears in the full SARIF rule catalog on theempty-diagnostics path (where all rules must be present).
tools-overloadeddiagnostic produces awarninglevel result whose
ruleIndexpoints to the correct catalog entry.earlier bot runs plus the two new ones here).
Tests
npm run lint(tsc --noEmit): cleannpm run build: cleannpm test: 77 passing (9 test files, +2 new cases in sarif.test.ts)Self-merge gate
Generated by Claude Code