docs: update Guardrails built-in scanner lists - #2748
Merged
Conversation
The VSCode list predates the new analysis CLI. The extension now registers the full built-in adapter set from @codacy/analysis-adapters (codacy-vscode-extension src/cli/CodacyCli.ts), so replace the list with the 30 tool families that preset registers. dartanalyzer drops off: it is now a cloud-only descriptor in the CLI's unsupported-tools package. The JetBrains extension still runs codacy-cli-v2, whose tool set is unchanged apart from Semgrep having been replaced by Opengrep. Reported by Mark Raihlin.
Contributor
|
Overall readability score: 53.95 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Contributor
Up to standards ✅🟢 Issues
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
No merge-blocking code, security, or quality issues were identified. Codacy reports the PR is up to standards. The acceptance criteria lack automated validation in the diff, including strict documentation build and anchor checks.
About this PR
- Add automated validation for the scanner lists and a strict MkDocs build, including anchor resolution, so future documentation drift is detected.
Test suggestions
- Verify the VSCode scanner list contains all expected tool families, including Agentlinter, and excludes dartanalyzer.
- Verify the JetBrains scanner list contains Opengrep instead of Semgrep while retaining the other documented scanners.
- Build the documentation with
mkdocs build --strictand verify both built-in-scanners anchors resolve.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify the VSCode scanner list contains all expected tool families, including Agentlinter, and excludes dartanalyzer.
2. Verify the JetBrains scanner list contains Opengrep instead of Semgrep while retaining the other documented scanners.
3. Build the documentation with `mkdocs build --strict` and verify both built-in-scanners anchors resolve.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
DMarinhoCodacy
approved these changes
Sep 10, 2026
…tead Lizard was the only linked entry, and it pointed at a 2025-02 release note rather than reference material. Unlink it and add one link under each list to Supported languages and tools, which covers every scanner.
…' into guardrails-builtin-scanners-list
claudiacodacy
enabled auto-merge (squash)
September 10, 2026 13:10
claudiacodacy
added a commit
that referenced
this pull request
Sep 10, 2026
Brings in #2747 (link each Codacy skill to its SKILL.md) and #2748 (update the Guardrails built-in scanner lists). One conflict, in docs/codacy-skills/index.md. #2747 removed the "Needs" column from the Available skills table and moved the per-skill CLI requirement into a sentence under Requirements, which is the column this branch had added the two CLI page links to. Resolved by taking that commit's table as-is and moving the links to the sentence the information moved to, so both changes survive: the skill names link to their SKILL.md, and the two CLI names link to their documentation. docs/codacy-guardrails/codacy-guardrails-getting-started.md merged without conflict — #2748 rewrote the scanner lists above the two lines this branch changed. Verified the merged file is that commit's version plus only those two link edits, with all 30 scanner entries intact. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Reported by Mark Raihlin in #product-docs: the Guardrails getting-started page still shows the old scanner list, which is much larger now that the new analysis CLI shipped.
VSCode-based IDEs
The extension no longer downloads a CLI — it registers the full built-in adapter set in-process via
registerBuiltinAdapters()from@codacy/analysis-adapters(codacy-vscode-extension,src/cli/CodacyCli.ts:62). The list now mirrorsbuiltinAdapterEntriesinanalysis-cli(packages/adapters/src/index.ts): 32 registered adapters, listed as 30 tool families (ESLint 8/9 and PMD 6/7 each collapse to one entry). Thedummy-1test analyzer is excluded.dartanalyzer drops off this list. It is no longer a locally-runnable adapter — it is now a cloud-only descriptor in
packages/tools/unsupported-tools/src/descriptors.json, so the extension lists it but never executes it.JetBrains IDEs
The JetBrains extension still downloads and runs
codacy-cli-v2(Config.kt:35), whose tool set isdomain.SupportedToolsMetadataindomain/tool.go— the same eight tools already documented, except Semgrep is now Opengrep. That is the only change to this list.Checks
mkdocs build --strict— passes.#built-in-scanners/#built-in-scanners_1anchors still resolve in the built HTML; no headings were reworded.grep -rln '^<!--NOTE' docs/): the Guardrails page carries no NOTE comment and is not listed in any.client-side-tools.mdis in that group but covers tools you run and upload yourself, not Guardrails' bundled scanners.#built-in-scannerslinks inside the repo; the Slack link points at it, and the anchor is unchanged.valeon the changed page: addedAgentlinterto the Codacy vocabulary. The three remaining hits (NPM, repeatedyou, an Oxford comma) are pre-existing and outside this diff.