feat(biome_graphql_analyze): implement useConsistentGraphqlDescriptions
#7672
Conversation
🦋 Changeset detectedLatest commit: c14d38f The changes in this PR will be included in the next version bump. This PR includes changesets to release 13 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
CodSpeed Performance ReportMerging #7672 will not alter performanceComparing Summary
Footnotes
|
WalkthroughAdds a new GraphQL linter rule Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
crates/biome_configuration/src/analyzer/linter/rules.rsis excluded by!**/rules.rsand included by**crates/biome_diagnostics_categories/src/categories.rsis excluded by!**/categories.rsand included by**crates/biome_graphql_analyze/src/lint/nursery.rsis excluded by!**/nursery.rsand included by**crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/invalid.graphql.snapis excluded by!**/*.snapand included by**crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/valid.graphql.snapis excluded by!**/*.snapand included by**packages/@biomejs/backend-jsonrpc/src/workspace.tsis excluded by!**/backend-jsonrpc/src/workspace.tsand included by**packages/@biomejs/biome/configuration_schema.jsonis excluded by!**/configuration_schema.jsonand included by**
📒 Files selected for processing (7)
.changeset/chubby-bottles-lick.md(1 hunks)crates/biome_graphql_analyze/src/lint.rs(1 hunks)crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs(1 hunks)crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/invalid.graphql(1 hunks)crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/valid.graphql(1 hunks)crates/biome_rule_options/src/lib.rs(1 hunks)crates/biome_rule_options/src/use_description_style.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
crates/biome_*/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place core crates under /crates/biome_*/
Files:
crates/biome_rule_options/src/lib.rscrates/biome_graphql_analyze/src/lint.rscrates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/valid.graphqlcrates/biome_rule_options/src/use_description_style.rscrates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/invalid.graphqlcrates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
**/*.{rs,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Before committing, format Rust and TOML files (e.g., via
just f/just format)
Files:
crates/biome_rule_options/src/lib.rscrates/biome_graphql_analyze/src/lint.rscrates/biome_rule_options/src/use_description_style.rscrates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
**/*.rs
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Document rules, assists, and options via inline rustdoc in Rust source
Files:
crates/biome_rule_options/src/lib.rscrates/biome_graphql_analyze/src/lint.rscrates/biome_rule_options/src/use_description_style.rscrates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
crates/biome_*_{syntax,parser,formatter,analyze,factory,semantic}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Maintain the per-language crate structure: biome_{lang}_{syntax,parser,formatter,analyze,factory,semantic}
Files:
crates/biome_graphql_analyze/src/lint.rscrates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/valid.graphqlcrates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/invalid.graphqlcrates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
**/tests/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place test files under a tests/ directory in each crate
Files:
crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/valid.graphqlcrates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/invalid.graphql
.changeset/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
.changeset/**/*.md: Create changesets using thejust new-changesetcommand; do not author them manually
In changeset markdown, only use headers #### or #####
Changeset descriptions must end every sentence with a full stop (.)
For bug fixes, start the changeset description with a linked issue reference like “Fixed #1234”
Prefer past tense for what was done and present tense for current behavior in changesets
Files:
.changeset/chubby-bottles-lick.md
🧠 Learnings (4)
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/biome_js_analyze/lib/src/lint/nursery/*.rs : Place all new JavaScript lint rules in the nursery group under biome_js_analyze/lib/src/lint/nursery/<rule_name>.rs
Applied to files:
crates/biome_graphql_analyze/src/lint.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/biome_rule_options/lib/*.rs : Define per-rule options in biome_rule_options/lib/<rule>.rs with a dedicated options struct/enum (camelCase serde names, deny_unknown_fields, default) and derive Serialize/Deserialize/Deserializable (and schemars JsonSchema when schema feature is on)
Applied to files:
crates/biome_rule_options/src/use_description_style.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : Document rules in the declare_lint_rule! doc comment with a one-line first paragraph, followed by sections including ## Examples, ### Invalid (first) and ### Valid, and optional ## Options
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In documentation code blocks: specify a language; mark invalid examples with expect_diagnostic (exactly one diagnostic per snippet); valid examples must parse with no diagnostics; order modifiers consistently; use options/full_options/use_options where applicable
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
🧬 Code graph analysis (3)
crates/biome_graphql_analyze/src/lint.rs (1)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Nursery(1627-1764)Style(1850-2139)
crates/biome_rule_options/src/use_description_style.rs (1)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
UseDescriptionStyleOptions(8216-8216)Style(1850-2139)
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs (2)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Style(1850-2139)UseDescriptionStyleOptions(8216-8216)crates/biome_analyze/src/rule.rs (3)
sources(576-579)same(244-249)recommended(561-564)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: Test (depot-windows-2022-16)
- GitHub Check: Test (depot-ubuntu-24.04-arm-16)
- GitHub Check: Documentation
- GitHub Check: Check Dependencies
- GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
- GitHub Check: autofix
- GitHub Check: Lint project (depot-windows-2022)
- GitHub Check: Test Node.js API
- GitHub Check: Bench (biome_configuration)
- GitHub Check: Check JS Files
- GitHub Check: Bench (biome_graphql_formatter)
- GitHub Check: Bench (biome_graphql_parser)
🔇 Additional comments (6)
crates/biome_rule_options/src/use_description_style.rs (1)
1-41: LGTM!The options struct and enum follow the project conventions: camelCase serde naming,
deny_unknown_fields, proper derives (includingJsonSchemaunder feature gate), and sensible defaults.crates/biome_rule_options/src/lib.rs (1)
277-277: LGTM!Module export is correctly placed in alphabetical order.
crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/valid.graphql (1)
1-15: LGTM!Valid test spec correctly demonstrates block-style descriptions (the default), and the comment accurately states no diagnostics should be generated.
crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/invalid.graphql (1)
1-8: LGTM!Invalid test spec correctly demonstrates inline-style descriptions, which should trigger diagnostics when the default block style is enforced.
crates/biome_graphql_analyze/src/lint.rs (1)
6-9: LGTM!The nursery module is correctly exposed, and the Lint category declaration properly includes the new Nursery group. This follows the established pattern for adding lint groups.
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs (1)
62-78: LGTM!The diagnostic message correctly identifies the violation and provides clear guidance on the expected style, assuming the
runmethod is fixed to signal both Block and Inline violations.
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
Outdated
Show resolved
Hide resolved
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Show resolved
Hide resolved
02192ad to
9107c7b
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs (1)
10-33: Consider documenting thestyleoption.The doc comment follows the required structure (one-line summary, ## Examples, ### Invalid first, ### Valid). However, since the rule accepts
UseDescriptionStyleOptionswith a configurablestylefield, consider adding an optional## Optionssection to document the available choices (blockorinline) and the default.Example addition after line 32:
+ /// + /// ## Options + /// + /// Use the `style` option to specify the required description style: + /// - `"block"` (default): Requires triple-quoted block descriptions (`"""..."""`) + /// - `"inline"`: Requires single-quoted inline descriptions (`"..."`)Based on learnings.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
crates/biome_graphql_analyze/tests/specs/nursery/useDescriptionStyle/invalid.graphql.snapis excluded by!**/*.snapand included by**
📒 Files selected for processing (2)
.changeset/chubby-bottles-lick.md(1 hunks)crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
crates/biome_*_{syntax,parser,formatter,analyze,factory,semantic}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Maintain the per-language crate structure: biome_{lang}_{syntax,parser,formatter,analyze,factory,semantic}
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
crates/biome_*/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place core crates under /crates/biome_*/
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
**/*.{rs,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Before committing, format Rust and TOML files (e.g., via
just f/just format)
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
**/*.rs
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Document rules, assists, and options via inline rustdoc in Rust source
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
.changeset/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
.changeset/**/*.md: Create changesets using thejust new-changesetcommand; do not author them manually
In changeset markdown, only use headers #### or #####
Changeset descriptions must end every sentence with a full stop (.)
For bug fixes, start the changeset description with a linked issue reference like “Fixed #1234”
Prefer past tense for what was done and present tense for current behavior in changesets
Files:
.changeset/chubby-bottles-lick.md
🧠 Learnings (4)
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : Document rules in the declare_lint_rule! doc comment with a one-line first paragraph, followed by sections including ## Examples, ### Invalid (first) and ### Valid, and optional ## Options
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : When deprecating a rule, add deprecated: "<reason>" in declare_lint_rule! with an explanatory message
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In documentation code blocks: specify a language; mark invalid examples with expect_diagnostic (exactly one diagnostic per snippet); valid examples must parse with no diagnostics; order modifiers consistently; use options/full_options/use_options where applicable
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
📚 Learning: 2025-10-02T12:55:57.541Z
Learnt from: CR
PR: biomejs/biome#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:55:57.541Z
Learning: Applies to .changeset/**/*.md : Changeset descriptions must end every sentence with a full stop (.)
Applied to files:
.changeset/chubby-bottles-lick.md
🧬 Code graph analysis (1)
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs (2)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Style(8582-8582)UseDescriptionStyleOptions(8216-8218)crates/biome_analyze/src/rule.rs (3)
sources(576-579)same(244-249)recommended(561-564)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: Test (depot-ubuntu-24.04-arm-16)
- GitHub Check: Documentation
- GitHub Check: Lint project (depot-windows-2022)
- GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
- GitHub Check: Test (depot-windows-2022-16)
- GitHub Check: Check Dependencies
- GitHub Check: Test Node.js API
- GitHub Check: Check JS Files
- GitHub Check: Bench (biome_graphql_formatter)
- GitHub Check: Bench (biome_graphql_parser)
- GitHub Check: autofix
- GitHub Check: Bench (biome_configuration)
🔇 Additional comments (5)
.changeset/chubby-bottles-lick.md (1)
1-25: LGTM!The changeset follows all coding guidelines:
- Uses correct header level (#####)
- Description ends with a full stop
- Uses "descriptions" terminology (not "comments")
- Past tense for what was added
- Valid/invalid examples are clear
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs (4)
1-7: Imports look good.All necessary dependencies are imported cleanly.
34-40: Rule metadata is correct.The metadata properly declares this as a nursery rule aligned with ESLint GraphQL's
description-stylerule.
49-64: Run method logic is sound.Both
BlockandInlinestyle enforcement are correctly implemented. The method properly returns a signal when the description style doesn't match the configured option.
66-82: Diagnostic message is clear and helpful.The diagnostic correctly highlights the unexpected style and provides a note indicating the expected style.
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
| /// ``` | ||
| /// |
There was a problem hiding this comment.
The docs must describe the options, explain the defaults and show a failing example with the options that isn't the default
crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs
Outdated
Show resolved
Hide resolved
useDescriptionStyleuseConsistentGraphqlDescriptions
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
crates/biome_configuration/src/analyzer/linter/rules.rsis excluded by!**/rules.rsand included by**crates/biome_diagnostics_categories/src/categories.rsis excluded by!**/categories.rsand included by**crates/biome_graphql_analyze/src/lint/nursery.rsis excluded by!**/nursery.rsand included by**packages/@biomejs/backend-jsonrpc/src/workspace.tsis excluded by!**/backend-jsonrpc/src/workspace.tsand included by**packages/@biomejs/biome/configuration_schema.jsonis excluded by!**/configuration_schema.jsonand included by**
📒 Files selected for processing (4)
.changeset/chubby-bottles-lick.md(1 hunks)crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs(1 hunks)crates/biome_rule_options/src/lib.rs(1 hunks)crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- crates/biome_rule_options/src/lib.rs
🧰 Additional context used
📓 Path-based instructions (5)
crates/biome_*_{syntax,parser,formatter,analyze,factory,semantic}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Maintain the per-language crate structure: biome_{lang}_{syntax,parser,formatter,analyze,factory,semantic}
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
crates/biome_*/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place core crates under /crates/biome_*/
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rscrates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
**/*.{rs,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Before committing, format Rust and TOML files (e.g., via
just f/just format)
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rscrates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
**/*.rs
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Document rules, assists, and options via inline rustdoc in Rust source
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rscrates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
.changeset/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
.changeset/**/*.md: Create changesets using thejust new-changesetcommand; do not author them manually
In changeset markdown, only use headers #### or #####
Changeset descriptions must end every sentence with a full stop (.)
For bug fixes, start the changeset description with a linked issue reference like “Fixed #1234”
Prefer past tense for what was done and present tense for current behavior in changesets
Files:
.changeset/chubby-bottles-lick.md
🧠 Learnings (2)
📚 Learning: 2025-10-02T12:55:57.541Z
Learnt from: CR
PR: biomejs/biome#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:55:57.541Z
Learning: Applies to .changeset/**/*.md : Changeset descriptions must end every sentence with a full stop (.)
Applied to files:
.changeset/chubby-bottles-lick.md
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/biome_rule_options/lib/*.rs : Define per-rule options in biome_rule_options/lib/<rule>.rs with a dedicated options struct/enum (camelCase serde names, deny_unknown_fields, default) and derive Serialize/Deserialize/Deserializable (and schemars JsonSchema when schema feature is on)
Applied to files:
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
🧬 Code graph analysis (2)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Style(8584-8584)UseConsistentGraphqlDescriptionsOptions(8213-8218)crates/biome_analyze/src/rule.rs (2)
sources(576-579)same(244-249)
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs (2)
crates/biome_configuration/src/analyzer/linter/rules.rs (2)
from_str(56-68)from_str(1186-1555)packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
UseConsistentGraphqlDescriptionsOptions(8213-8218)Style(8584-8584)
🔇 Additional comments (6)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
83-98: LGTM!Both Block and Inline style violations are correctly detected.
100-116: LGTM!Diagnostic message construction is clear and correct.
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs (4)
6-12: LGTM!Struct derives, serde attributes, and docstrings align with project conventions.
14-23: LGTM!Enum derives, serde attributes, and docstrings are correct.
25-35: LGTM!FromStr implementation is correct.
37-44: LGTM!Display implementation mirrors FromStr correctly.
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
afe9897 to
adffd9d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs (2)
10-10: Minor grammar fix.Change "Default to" to "Defaults to" for correct verb tense.
Apply this diff:
- /// The description style to enforce. Default to "block" + /// The description style to enforce. Defaults to "block"
25-35: Consider a more helpful error message.The current error message is generic. Users would benefit from knowing the valid options.
Apply this diff:
- _ => Err("Value not supported for description style"), + _ => Err("Value not supported for description style, expected 'block' or 'inline'"),
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
crates/biome_configuration/src/analyzer/linter/rules.rsis excluded by!**/rules.rsand included by**crates/biome_diagnostics_categories/src/categories.rsis excluded by!**/categories.rsand included by**crates/biome_graphql_analyze/src/lint/nursery.rsis excluded by!**/nursery.rsand included by**packages/@biomejs/backend-jsonrpc/src/workspace.tsis excluded by!**/backend-jsonrpc/src/workspace.tsand included by**packages/@biomejs/biome/configuration_schema.jsonis excluded by!**/configuration_schema.jsonand included by**
📒 Files selected for processing (4)
.changeset/chubby-bottles-lick.md(1 hunks)crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs(1 hunks)crates/biome_rule_options/src/lib.rs(1 hunks)crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- crates/biome_rule_options/src/lib.rs
🧰 Additional context used
📓 Path-based instructions (5)
crates/biome_*_{syntax,parser,formatter,analyze,factory,semantic}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Maintain the per-language crate structure: biome_{lang}_{syntax,parser,formatter,analyze,factory,semantic}
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
crates/biome_*/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place core crates under /crates/biome_*/
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rscrates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
**/*.{rs,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Before committing, format Rust and TOML files (e.g., via
just f/just format)
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rscrates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
**/*.rs
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Document rules, assists, and options via inline rustdoc in Rust source
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rscrates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
.changeset/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
.changeset/**/*.md: Create changesets using thejust new-changesetcommand; do not author them manually
In changeset markdown, only use headers #### or #####
Changeset descriptions must end every sentence with a full stop (.)
For bug fixes, start the changeset description with a linked issue reference like “Fixed #1234”
Prefer past tense for what was done and present tense for current behavior in changesets
Files:
.changeset/chubby-bottles-lick.md
🧠 Learnings (7)
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In declare_lint_rule! blocks, set version: "next" for all rules
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : Document rules in the declare_lint_rule! doc comment with a one-line first paragraph, followed by sections including ## Examples, ### Invalid (first) and ### Valid, and optional ## Options
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : When deprecating a rule, add deprecated: "<reason>" in declare_lint_rule! with an explanatory message
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/biome_js_analyze/lib/src/lint/nursery/*.rs : Place all new JavaScript lint rules in the nursery group under biome_js_analyze/lib/src/lint/nursery/<rule_name>.rs
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In documentation code blocks: specify a language; mark invalid examples with expect_diagnostic (exactly one diagnostic per snippet); valid examples must parse with no diagnostics; order modifiers consistently; use options/full_options/use_options where applicable
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/biome_rule_options/lib/*.rs : Define per-rule options in biome_rule_options/lib/<rule>.rs with a dedicated options struct/enum (camelCase serde names, deny_unknown_fields, default) and derive Serialize/Deserialize/Deserializable (and schemars JsonSchema when schema feature is on)
Applied to files:
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:55:57.541Z
Learnt from: CR
PR: biomejs/biome#0
File: CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:55:57.541Z
Learning: Applies to .changeset/**/*.md : Changeset descriptions must end every sentence with a full stop (.)
Applied to files:
.changeset/chubby-bottles-lick.md
🧬 Code graph analysis (2)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Style(8584-8584)UseConsistentGraphqlDescriptionsOptions(8213-8218)crates/biome_analyze/src/rule.rs (3)
sources(576-579)same(244-249)recommended(561-564)
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs (1)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
UseConsistentGraphqlDescriptionsOptions(8213-8218)Style(8584-8584)
🔇 Additional comments (7)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (4)
1-10: LGTM!Imports are clean and appropriate for the rule implementation.
11-75: LGTM!The rule documentation is thorough and well-structured:
- One-line summary followed by clear Examples and Options sections.
- Both
style: "block"andstyle: "inline"configurations are demonstrated with Invalid and Valid examples.- Annotations (
expect_diagnostic) are correctly placed on Invalid examples only.- Metadata is complete with
version: "next"andsourcesreferencing ESLint GraphQL'sdescription-style.
83-98: LGTM!The
runmethod correctly enforces both style configurations:
- Flags inline descriptions when
style: "block"is set.- Flags block descriptions when
style: "inline"is set.
100-116: LGTM!The diagnostic message clearly indicates the unexpected style and the expected style, making it easy for users to understand and fix the violation.
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs (3)
1-4: LGTM!Imports are minimal and appropriate.
14-23: LGTM!The
Styleenum is well-documented with clear docstrings for each variant, correctly setsBlockas the default, and uses appropriate derives for configuration usage.
37-44: LGTM!The
Displayimplementation is clean and correctly integrates withbiome_console::fmt::Formatter.
adffd9d to
c19a003
Compare
ematipico
left a comment
There was a problem hiding this comment.
Documentation must be updated to follow the advised format. Same for diagnostics, it misses a pillar
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Show resolved
Hide resolved
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (1)
12-12: Enhance the rule description to explain the rationale.Whilst the description states what the rule does, it doesn't explain why (consistency, readability). Per Biome's rule pillars, clarify the benefit to users.
Consider revising to something like:
- /// Require all descriptions to follow the same style (either block or inline) + /// Require all descriptions to follow the same style (either block or inline). + /// + /// Consistent description formatting improves readability and makes GraphQL schemas easier to maintain.Based on maintainer feedback.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
crates/biome_*_{syntax,parser,formatter,analyze,factory,semantic}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Maintain the per-language crate structure: biome_{lang}_{syntax,parser,formatter,analyze,factory,semantic}
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
crates/biome_*/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place core crates under /crates/biome_*/
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
**/*.{rs,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Before committing, format Rust and TOML files (e.g., via
just f/just format)
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
**/*.rs
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Document rules, assists, and options via inline rustdoc in Rust source
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
🧠 Learnings (5)
📓 Common learnings
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/biome_rule_options/lib/*.rs : Define per-rule options in biome_rule_options/lib/<rule>.rs with a dedicated options struct/enum (camelCase serde names, deny_unknown_fields, default) and derive Serialize/Deserialize/Deserializable (and schemars JsonSchema when schema feature is on)
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : When deprecating a rule, add deprecated: "<reason>" in declare_lint_rule! with an explanatory message
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : Document rules in the declare_lint_rule! doc comment with a one-line first paragraph, followed by sections including ## Examples, ### Invalid (first) and ### Valid, and optional ## Options
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In declare_lint_rule! blocks, set version: "next" for all rules
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.209Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.209Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In documentation code blocks: specify a language; mark invalid examples with expect_diagnostic (exactly one diagnostic per snippet); valid examples must parse with no diagnostics; order modifiers consistently; use options/full_options/use_options where applicable
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
🧬 Code graph analysis (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Style(8640-8640)UseConsistentGraphqlDescriptionsOptions(8264-8269)crates/biome_analyze/src/rule.rs (1)
same(244-249)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: Test (depot-ubuntu-24.04-arm-16)
- GitHub Check: Documentation
- GitHub Check: Test (depot-windows-2022-16)
- GitHub Check: Lint project (depot-windows-2022)
- GitHub Check: Check Dependencies
- GitHub Check: Bench (biome_graphql_formatter)
- GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
- GitHub Check: Bench (biome_graphql_parser)
- GitHub Check: Bench (biome_configuration)
- GitHub Check: autofix
- GitHub Check: Test Node.js API
- GitHub Check: Check JS Files
🔇 Additional comments (2)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
78-93: LGTM! Both style configurations are now enforced correctly.The logic properly handles both
BlockandInlinestyles, signalling violations when descriptions don't match the configured style.
95-112: LGTM! Diagnostic message clearly indicates the violation.The message correctly shows the unexpected style (opposite of configured) and the note guides users to the expected style.
| /// ## Options | ||
| /// | ||
| /// ### `style` | ||
| /// | ||
| /// This option will specify the description style. | ||
| /// - `"block"`: Requires triple-quoted block descriptions (`"""..."""`) | ||
| /// - `"inline"`: Requires single-quoted inline descriptions (`"..."`) | ||
| /// | ||
| /// Default `"block"` | ||
| /// | ||
| /// ```json,options | ||
| /// { | ||
| /// "options": { | ||
| /// "style": "block" | ||
| /// } | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// ```graphql,expect_diagnostic,use_options | ||
| /// enum EnumValue { | ||
| /// "this is a description" | ||
| /// DEFAULT | ||
| /// } | ||
| /// ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Add examples demonstrating the non-default option value.
The maintainer requested "a failing example with the options that isn't the default." Whilst lines 48-61 show the default "block" configuration, there are no examples demonstrating style: "inline". Adding a subsection for ### style: inline with corresponding Invalid/Valid examples would make the documentation more complete.
Consider adding after line 61:
+ ///
+ /// ### style: `inline`
+ ///
+ /// #### Invalid
+ ///
+ /// ```json,options
+ /// {
+ /// "options": {
+ /// "style": "inline"
+ /// }
+ /// }
+ /// ```
+ ///
+ /// ```graphql,expect_diagnostic,use_options
+ /// enum EnumValue {
+ /// """
+ /// this is a description
+ /// """
+ /// DEFAULT
+ /// }
+ /// ```
+ ///
+ /// #### Valid
+ ///
+ /// ```graphql,use_options
+ /// enum EnumValue {
+ /// "this is a description"
+ /// DEFAULT
+ /// }
+ /// ```Based on maintainer feedback.
🤖 Prompt for AI Agents
In
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
around lines 38 to 61, the docs show only the default "block" style and lack
examples for the non-default "inline" option; add a new subsection after line 61
titled something like "### style: inline" that includes the JSON options block
setting "style": "inline", an Invalid (expect_diagnostic) GraphQL example that
uses block triple-quoted descriptions (to show the failing case), and a Valid
GraphQL example that uses inline quoted descriptions (to show the passing case),
mirroring the structure/formatting used for the "block" examples so the test
harness picks up the options and diagnostics correctly.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (1)
12-12: Enhance the rule description with a rationale.The description states what the rule does but doesn't explain why enforcing consistent description styles benefits the codebase (e.g., improved readability, easier maintenance, team consistency).
Consider expanding to something like:
- /// Require all descriptions to follow the same style (either block or inline) + /// Require all descriptions to follow the same style (either block or inline). + /// + /// Consistent description formatting improves readability and makes GraphQL schemas easier to maintain.Based on maintainer feedback.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
crates/biome_*_{syntax,parser,formatter,analyze,factory,semantic}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Maintain the per-language crate structure: biome_{lang}_{syntax,parser,formatter,analyze,factory,semantic}
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
crates/biome_*/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place core crates under /crates/biome_*/
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
**/*.{rs,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Before committing, format Rust and TOML files (e.g., via
just f/just format)
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
**/*.rs
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Document rules, assists, and options via inline rustdoc in Rust source
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
🧠 Learnings (5)
📓 Common learnings
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : Document rules in the declare_lint_rule! doc comment with a one-line first paragraph, followed by sections including ## Examples, ### Invalid (first) and ### Valid, and optional ## Options
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/biome_rule_options/lib/*.rs : Define per-rule options in biome_rule_options/lib/<rule>.rs with a dedicated options struct/enum (camelCase serde names, deny_unknown_fields, default) and derive Serialize/Deserialize/Deserializable (and schemars JsonSchema when schema feature is on)
📚 Learning: 2025-10-02T12:57:33.228Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : When deprecating a rule, add deprecated: "<reason>" in declare_lint_rule! with an explanatory message
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.228Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In declare_lint_rule! blocks, set version: "next" for all rules
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.228Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : Document rules in the declare_lint_rule! doc comment with a one-line first paragraph, followed by sections including ## Examples, ### Invalid (first) and ### Valid, and optional ## Options
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.228Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In documentation code blocks: specify a language; mark invalid examples with expect_diagnostic (exactly one diagnostic per snippet); valid examples must parse with no diagnostics; order modifiers consistently; use options/full_options/use_options where applicable
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
🧬 Code graph analysis (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Style(8640-8640)UseConsistentGraphqlDescriptionsOptions(8264-8269)crates/biome_analyze/src/rule.rs (1)
same(244-249)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: Check JS Files
- GitHub Check: autofix
- GitHub Check: Bench (biome_graphql_parser)
- GitHub Check: Test Node.js API
- GitHub Check: Bench (biome_graphql_formatter)
- GitHub Check: Test (depot-ubuntu-24.04-arm-16)
- GitHub Check: Test (depot-windows-2022-16)
- GitHub Check: Documentation
- GitHub Check: Lint project (depot-windows-2022)
- GitHub Check: Check Dependencies
- GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
- GitHub Check: Bench (biome_configuration)
🔇 Additional comments (2)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
80-95: Well done on the fix!Both style checks are now correctly implemented. The logic properly handles violations for both Block and Inline configurations.
97-113: LGTM!The diagnostic message clearly identifies the unexpected style and guides users towards the expected one.
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Show resolved
Hide resolved
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
8cd7afe to
42e5a2a
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (1)
12-12: Add rationale explaining why consistency matters.The rule description states what it does but not why. Per maintainer feedback, include the "second pillar" explaining benefits like consistency, readability, and maintainability.
Based on maintainer feedback.
Consider:
- /// Require all descriptions to follow the same style (either block or inline) + /// Require all descriptions to follow the same style (either block or inline). + /// + /// Consistent description formatting improves codebase readability and reduces cognitive load when reviewing GraphQL schemas. Mixing block and inline styles within a project can make the schema harder to scan and maintain.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs(1 hunks)
🧰 Additional context used
📓 Path-based instructions (4)
crates/biome_*_{syntax,parser,formatter,analyze,factory,semantic}/**
📄 CodeRabbit inference engine (CLAUDE.md)
Maintain the per-language crate structure: biome_{lang}_{syntax,parser,formatter,analyze,factory,semantic}
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
crates/biome_*/**
📄 CodeRabbit inference engine (CLAUDE.md)
Place core crates under /crates/biome_*/
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
**/*.{rs,toml}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Before committing, format Rust and TOML files (e.g., via
just f/just format)
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
**/*.rs
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Document rules, assists, and options via inline rustdoc in Rust source
Files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
🧠 Learnings (3)
📚 Learning: 2025-10-02T12:57:33.228Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In declare_lint_rule! blocks, set version: "next" for all rules
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.228Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : In documentation code blocks: specify a language; mark invalid examples with expect_diagnostic (exactly one diagnostic per snippet); valid examples must parse with no diagnostics; order modifiers consistently; use options/full_options/use_options where applicable
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-02T12:57:33.228Z
Learnt from: CR
PR: biomejs/biome#0
File: crates/biome_analyze/CONTRIBUTING.md:0-0
Timestamp: 2025-10-02T12:57:33.228Z
Learning: Applies to crates/biome_analyze/crates/**/src/**/lint/**/*.rs : Document rules in the declare_lint_rule! doc comment with a one-line first paragraph, followed by sections including ## Examples, ### Invalid (first) and ### Valid, and optional ## Options
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)
- GitHub Check: Test Node.js API
- GitHub Check: Documentation
- GitHub Check: End-to-end tests
- GitHub Check: Test (depot-windows-2022-16)
- GitHub Check: Test (depot-ubuntu-24.04-arm-16)
- GitHub Check: Lint project (depot-windows-2022)
- GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
- GitHub Check: Check Dependencies
- GitHub Check: Check JS Files
- GitHub Check: autofix
- GitHub Check: Bench (biome_graphql_parser)
- GitHub Check: Bench (biome_graphql_formatter)
- GitHub Check: Bench (biome_configuration)
🔇 Additional comments (2)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
80-95: LGTM!Both style checks (Block and Inline) are correctly implemented. The logic properly signals violations when descriptions don't match the configured style.
97-113: LGTM!The diagnostic message correctly inverts the style to indicate which style was found (unexpected), and the note clearly states the expected style. Well done.
9970f59 to
adebefe
Compare
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
crates/biome_rule_options/src/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (1)
56-63: Add the missing Valid example for the inline style option.The Options section demonstrates the failing case when
style: "inline"is configured but lacks the corresponding passing example. This was mentioned in previous reviews as fixed, but it's missing from the current code.Add after line 63:
+ /// + /// #### Valid + /// + /// ```graphql,use_options + /// enum EnumValue { + /// "this is a description" + /// DEFAULT + /// } + /// ```Based on maintainer feedback.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs(1 hunks)
🧰 Additional context used
🧠 Learnings (7)
📚 Learning: 2025-10-15T09:21:24.116Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_diagnostics/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:21:24.116Z
Learning: A diagnostic must explain why something went wrong, using log advices and links to documentation when helpful
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:21:24.116Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_diagnostics/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:21:24.116Z
Learning: `#[derive(Diagnostic)]` is supported on enums; each variant must contain a type that is itself a diagnostic
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:21:24.116Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_diagnostics/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:21:24.116Z
Learning: Prefer implementing the Diagnostic trait via `#[derive(Diagnostic)]`
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:22:15.851Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_formatter/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:22:15.851Z
Learning: Applies to crates/biome_formatter/tests/specs/**/options.json : Use options.json files colocated with test inputs to override formatting options for all files in that folder
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-08-05T14:43:29.581Z
Learnt from: dyc3
Repo: biomejs/biome PR: 7081
File: packages/@biomejs/biome/configuration_schema.json:7765-7781
Timestamp: 2025-08-05T14:43:29.581Z
Learning: The file `packages/biomejs/biome/configuration_schema.json` is auto-generated and should not be manually edited or reviewed for schema issues; any changes should be made at the code generation source.
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:22:15.851Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_formatter/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:22:15.851Z
Learning: Applies to crates/biome_formatter/src/**/*.rs : After generation, remove usages of `format_verbatim_node` and implement real formatting with biome_formatter utilities
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:22:46.002Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_js_formatter/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:22:46.002Z
Learning: Applies to crates/biome_js_formatter/**/*.rs : Implement the `Format` trait for your node type and use `JsFormatter` with `write!`/`format_args!` to define formatting
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
🧬 Code graph analysis (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
packages/@biomejs/backend-jsonrpc/src/workspace.ts (2)
Style(8783-8783)UseConsistentGraphqlDescriptionsOptions(8391-8396)crates/biome_analyze/src/rule.rs (1)
same(246-251)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
- GitHub Check: Lint project (depot-windows-2022)
- GitHub Check: Check Dependencies
- GitHub Check: Test (depot-windows-2022-16)
- GitHub Check: Test (depot-ubuntu-24.04-arm-16)
- GitHub Check: Bench (biome_configuration)
- GitHub Check: Check JS Files
- GitHub Check: Test Node.js API
- GitHub Check: Bench (biome_graphql_formatter)
- GitHub Check: Bench (biome_graphql_parser)
- GitHub Check: autofix
🔇 Additional comments (2)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (2)
1-9: LGTM!Imports are appropriate for the rule implementation.
74-114: Implementation logic looks correct.The
runmethod properly checks both Block and Inline style violations, and thediagnosticmethod provides clear messaging about what was found and what is expected.
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
Outdated
Show resolved
Hide resolved
ematipico
left a comment
There was a problem hiding this comment.
Happy to merge it. Please check the coderrabit bot feedback just in case, I think it added something around docs
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
crates/biome_configuration/src/analyzer/linter/rules.rsis excluded by!**/rules.rsand included by**crates/biome_diagnostics_categories/src/categories.rsis excluded by!**/categories.rsand included by**
📒 Files selected for processing (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs(1 hunks)
🧰 Additional context used
🧠 Learnings (7)
📚 Learning: 2025-10-15T09:21:24.116Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_diagnostics/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:21:24.116Z
Learning: A diagnostic must explain why something went wrong, using log advices and links to documentation when helpful
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:21:24.116Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_diagnostics/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:21:24.116Z
Learning: `#[derive(Diagnostic)]` is supported on enums; each variant must contain a type that is itself a diagnostic
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:21:24.116Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_diagnostics/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:21:24.116Z
Learning: Prefer implementing the Diagnostic trait via `#[derive(Diagnostic)]`
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:22:15.851Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_formatter/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:22:15.851Z
Learning: Applies to crates/biome_formatter/tests/specs/**/options.json : Use options.json files colocated with test inputs to override formatting options for all files in that folder
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-08-05T14:43:29.581Z
Learnt from: dyc3
Repo: biomejs/biome PR: 7081
File: packages/@biomejs/biome/configuration_schema.json:7765-7781
Timestamp: 2025-08-05T14:43:29.581Z
Learning: The file `packages/biomejs/biome/configuration_schema.json` is auto-generated and should not be manually edited or reviewed for schema issues; any changes should be made at the code generation source.
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:22:15.851Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_formatter/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:22:15.851Z
Learning: Applies to crates/biome_formatter/src/**/*.rs : After generation, remove usages of `format_verbatim_node` and implement real formatting with biome_formatter utilities
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
📚 Learning: 2025-10-15T09:22:46.002Z
Learnt from: CR
Repo: biomejs/biome PR: 0
File: crates/biome_js_formatter/CONTRIBUTING.md:0-0
Timestamp: 2025-10-15T09:22:46.002Z
Learning: Applies to crates/biome_js_formatter/**/*.rs : Implement the `Format` trait for your node type and use `JsFormatter` with `write!`/`format_args!` to define formatting
Applied to files:
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs
🧬 Code graph analysis (1)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (1)
crates/biome_analyze/src/rule.rs (2)
same(246-251)span(1477-1479)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (14)
- GitHub Check: Test Node.js API
- GitHub Check: Validate rules documentation
- GitHub Check: Documentation
- GitHub Check: End-to-end tests
- GitHub Check: Bench (biome_graphql_formatter)
- GitHub Check: Bench (biome_graphql_parser)
- GitHub Check: Lint project (depot-windows-2022)
- GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
- GitHub Check: Check Dependencies
- GitHub Check: Test (depot-ubuntu-24.04-arm-16)
- GitHub Check: autofix
- GitHub Check: Test (depot-windows-2022-16)
- GitHub Check: Bench (biome_configuration)
- GitHub Check: Check JS Files
🔇 Additional comments (3)
crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs (3)
1-9: LGTM!Imports are clean and appropriate for the rule implementation.
80-95: LGTM!The logic correctly handles both
BlockandInlinestyle configurations. Well done addressing the previous critical issue.
97-113: LGTM!The diagnostic messages are clear and correctly convey both the violation (unexpected style) and the remedy (write in configured style).
Summary
Implement Eslint Graphql's
description-styleRelated # #3303
Test Plan
Docs