chore: scope the docs name-exactness rule to sqlguard's own API - #86
Merged
Merged
Conversation
CodeAnt flagged `interpolateParams` in website/docs/middleware.md against the website-docs-version-markers rule, which says every option, function and rule name in the docs must match an exported identifier or a registered rule name. Read literally that is what the rule demands, so the reviewer was right and the rule was wrong: the docs legitimately name identifiers this project does not own — sql.Open, stdlib.GetConnector, gorm.Plugin, pgxpool.Pool, standard_conforming_strings, sql_mode — and every one of them would be a violation. The intent was always that a name presented as sqlguard's own must exist, because a wrong one sends readers looking for an API that isn't there. A correctly spelled upstream name does the opposite. The rule now says so, in the four places it lives: .codeant/review.json, .greptile/config.json, .coderabbit.yaml and AGENTS.md.
🤖 CodeAnt AI — Review Status
|
Thanks for using CodeAnt! 🎉We're free for open-source projects. if you're enjoying it, help us grow by sharing. Share on X · |
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Repository: KARTIKrocks/sqlguard/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🏁 CodeAnt Quality Gate ResultsCommit: ✅ Overall Status: PASSEDQuality Gate Details
|
CodeAnt Nitpicks2 code suggestions1. The new requirement treats each fenced block as compilable, but
|
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.
User description
Follow-up to the CodeAnt nitpick on #85.
What it flagged
interpolateParamsinwebsite/docs/middleware.md:102, against thewebsite-docs-version-markersrule that #84 added:It was right, and the rule was wrong
Read literally, that is exactly what the rule demands — and the docs are full
of names this project does not own:
sql.Open,sql.OpenDB,stdlib.GetConnector,gorm.Plugin,bun.QueryHook,pgxpool.Pool,standard_conforming_strings,sql_mode. Every one of them is a violationunder that wording.
interpolateParamswas simply the one that appeared in adiff.
The intent was always narrower: a name presented as sqlguard's own must
exist, because a wrong one sends a reader looking for an API that isn't there.
A correctly spelled upstream name does the opposite — it tells them exactly
what to look up. The rule now says so.
Changed in the four places the rule lives
.codeant/review.json,.greptile/config.json,.coderabbit.yamlandAGENTS.md— the sync disciplineAGENTS.mddescribes, on its first outing:The
interpolateParamsline inwebsite/docs/middleware.mdis unchanged andstays in #85; it is accurate (
go-sql-driver/mysqlinterpolates client-sideonly when that DSN parameter is on, which is what makes
ErrSkipthe commonpath on MySQL).
CodeAnt-AI Description
Limit documentation name checks to sqlguard’s own API
What Changed
Impact
✅ Fewer false-positive documentation review warnings✅ Valid upstream API names remain usable in docs✅ Clearer checks for sqlguard API references💡 Usage Guide
Checking Your Pull Request
Every time you make a pull request, our system automatically looks through it. We check for security issues, mistakes in how you're setting up your infrastructure, and common code problems. We do this to make sure your changes are solid and won't cause any trouble later.
Talking to CodeAnt AI
Got a question or need a hand with something in your pull request? You can easily get in touch with CodeAnt AI right here. Just type the following in a comment on your pull request, and replace "Your question here" with whatever you want to ask:
This lets you have a chat with CodeAnt AI about your pull request, making it easier to understand and improve your code.
Example
Preserve Org Learnings with CodeAnt
You can record team preferences so CodeAnt AI applies them in future reviews. Reply directly to the specific CodeAnt AI suggestion (in the same thread) and replace "Your feedback here" with your input:
This helps CodeAnt AI learn and adapt to your team's coding style and standards.
Example
Retrigger review
Ask CodeAnt AI to review the PR again, by typing:
Check Your Repository Health
To analyze the health of your code repository, visit our dashboard at https://app.codeant.ai. This tool helps you identify potential issues and areas for improvement in your codebase, ensuring your repository maintains high standards of code health.