Skip to content

docs: update Guardrails built-in scanner lists - #2748

Merged
claudiacodacy merged 4 commits into
masterfrom
guardrails-builtin-scanners-list
Sep 10, 2026
Merged

docs: update Guardrails built-in scanner lists#2748
claudiacodacy merged 4 commits into
masterfrom
guardrails-builtin-scanners-list

Conversation

@claudiacodacy

Copy link
Copy Markdown
Contributor

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 mirrors builtinAdapterEntries in analysis-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). The dummy-1 test 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 is domain.SupportedToolsMetadata in domain/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.
  • Both #built-in-scanners / #built-in-scanners_1 anchors still resolve in the built HTML; no headings were reworded.
  • Lockstep siblings (grep -rln '^<!--NOTE' docs/): the Guardrails page carries no NOTE comment and is not listed in any. client-side-tools.md is in that group but covers tools you run and upload yourself, not Guardrails' bundled scanners.
  • No shared includes on the page.
  • No inbound #built-in-scanners links inside the repo; the Slack link points at it, and the anchor is unchanged.
  • Not version-gated — Guardrails is Cloud-only.
  • vale on the changed page: added Agentlinter to the Codacy vocabulary. The three remaining hits (NPM, repeated you, an Oxford comma) are pre-existing and outside this diff.

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.
@claudiacodacy
claudiacodacy requested a review from a team as a code owner September 10, 2026 13:07
@github-actions

github-actions Bot commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 53.95 (🟢 +0)

File Readability
codacy-guardrails-getting-started.md 58.64 (🟢 +0.62)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
codacy-guardrails-getting-started.md 58.64 48.84 11.32 13.4 11.09 6.72
  🟢 +0.62 🟢 +0.2 🟢 +0.1 🟢 +0.2 🟢 +0 🟢 +0.04

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.95 42.93 10.93 12.37 12.3 8.02
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@github-actions
github-actions Bot temporarily deployed to Netlify September 10, 2026 13:09 Inactive

@codacy-production codacy-production Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 --strict and 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

…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.
@claudiacodacy
claudiacodacy enabled auto-merge (squash) September 10, 2026 13:10
@github-actions
github-actions Bot temporarily deployed to Netlify September 10, 2026 13:12 Inactive
@claudiacodacy
claudiacodacy merged commit cef15c3 into master Sep 10, 2026
5 checks passed
@claudiacodacy
claudiacodacy deleted the guardrails-builtin-scanners-list branch September 10, 2026 13:12
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants