docs(linter): document plugin rewrite fix behavior#3988
docs(linter): document plugin rewrite fix behavior#3988chocky335 wants to merge 2 commits intobiomejs:nextfrom
Conversation
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
WalkthroughDocumentation updates in two files to describe fixable diagnostics and rewrites for GritQL and linter plugins. The linter plugin docs add a fourth parameter to the public API: Suggested reviewers
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/content/docs/linter/plugins.mdx (1)
51-53: Optional: consider dropping the explicitlanguage jsdirective for consistency.The first example (the
Object.assignone above) relies on the JavaScript default without declaringlanguage js. Adding it here is harmless, but it's slightly inconsistent. Either align all JS examples to be explicit, or drop it here and rely on the documented default — your call.✂️ Suggested change
```grit -language js - `console.log($msg)` as $call where {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/linter/plugins.mdx` around lines 51 - 53, The code block contains an explicit "language js" directive inside the grit code fence which is inconsistent with the earlier Object.assign example that relies on the default; remove the "language js" line from the code fence (so the block starts with "```grit" and then the example `console.log($msg) as $call where {`) to match the documented default, or alternatively make all JS examples explicit—pick one approach and apply it consistently across the examples (target the code block containing the `console.log($msg) as $call where {` snippet).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@src/content/docs/linter/plugins.mdx`:
- Around line 51-53: The code block contains an explicit "language js" directive
inside the grit code fence which is inconsistent with the earlier Object.assign
example that relies on the default; remove the "language js" line from the code
fence (so the block starts with "```grit" and then the example
`console.log($msg) as $call where {`) to match the documented default, or
alternatively make all JS examples explicit—pick one approach and apply it
consistently across the examples (target the code block containing the
`console.log($msg) as $call where {` snippet).
Summary
Update plugin docs to match current GritQL plugin behavior from biomejs/biome#9073:
=>register_diagnostic(..., fix_kind = "safe" | "unsafe")--writevs--write --unsafebehavior for plugin rewrites