ci: add typos config to suppress false positives on Vertica SVG gradient IDs#2181
ci: add typos config to suppress false positives on Vertica SVG gradient IDs#2181
Conversation
…ent IDs Co-Authored-By: Yosef Arbiv <yosef.arbiv@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
👋 @devin-ai-integration[bot] |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdded a Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
_typos.toml (1)
1-6: Consider a pattern-based approach if supported.If future Vertica SVG identifiers follow the same
*_ot_gradientpattern, you might explore whether typos supports wildcard or regex-based rules to reduce maintenance. However, the current explicit approach is safer and works well for the known identifiers.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@_typos.toml` around lines 1 - 6, The current _typos.toml lists explicit identifiers (vertica_page_ot_gradient, vertica_oss_ot_gradient, vertica_cloud_ot_gradient) which works but is verbose; check whether the typos tool supports wildcard or regex rules and, if so, replace these explicit keys with a single pattern-based rule (e.g., a wildcard or regex matching *_ot_gradient) to cover future SVG IDs; if the tool does not support patterns, keep the explicit entries but add a short comment noting to revisit when pattern support is available.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@_typos.toml`:
- Around line 1-6: The current _typos.toml lists explicit identifiers
(vertica_page_ot_gradient, vertica_oss_ot_gradient, vertica_cloud_ot_gradient)
which works but is verbose; check whether the typos tool supports wildcard or
regex rules and, if so, replace these explicit keys with a single pattern-based
rule (e.g., a wildcard or regex matching *_ot_gradient) to cover future SVG IDs;
if the tool does not support patterns, keep the explicit entries but add a short
comment noting to revisit when pattern support is available.
Co-Authored-By: Yosef Arbiv <yosef.arbiv@gmail.com>
Co-Authored-By: Yosef Arbiv <yosef.arbiv@gmail.com>
Summary
Adds a
_typos.tomlconfiguration file to suppress false positives from thetypospre-commit hook. The hook flagsotin Vertica logo SVG gradient IDs (e.g.,vertica_page_ot_gradient) as a misspelling, but these are intentional SVG element identifiers.The three suppressed identifiers appear in:
docs/cloud/integrations/dwh/vertica.mdxdocs/snippets/oss/adapters-cards.mdxdocs/snippets/cloud/integrations/cards-groups/connect-dwh-cards.mdxThis was causing the
code-qualityCI check to fail on every PR that includes these docs files.Review & Testing Checklist for Human
_typos.tomlis picked up by the pre-commit typos hook (it auto-discovers_typos.tomlin the repo root)Notes
extend-identifiers(notextend-words) because typos splits on underscores, treatingotas a separate word within the identifier.Link to Devin session: https://app.devin.ai/sessions/e56abb358db34b84956c5b78d163f348
Requested by: @arbiv
Summary by CodeRabbit