Skip to content

docs: fix correct graphql references#7623

Merged
ematipico merged 1 commit intobiomejs:mainfrom
Netail:docs/correct-graphql-references
Oct 1, 2025
Merged

docs: fix correct graphql references#7623
ematipico merged 1 commit intobiomejs:mainfrom
Netail:docs/correct-graphql-references

Conversation

@Netail
Copy link
Copy Markdown
Member

@Netail Netail commented Sep 30, 2025

Summary

  • graphql-schema-linter is it's own linter, not part of Eslint, so no Eslint prefix
  • Correct GraphQL-ESLint documentation url
  • Correct GraphQL-ESLint rule prefix is @graphql-eslint/ not graphql/

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Sep 30, 2025

⚠️ No Changeset found

Latest commit: 4fb55ab

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the A-Linter Area: linter label Sep 30, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Sep 30, 2025

Walkthrough

  • Renames RuleSource variant EslintGraphqlSchemaLinter to GraphqlSchemaLinter.
  • Updates all internal matches and displays to reference GraphqlSchemaLinter:
    • Display impl maps to "graphql-schema-linter".
    • Equality/ordering and variant matching use GraphqlSchemaLinter.
    • as_rule_name and namespaced rule name generation include GraphqlSchemaLinter; former EslintGraphqlSchemaLinter branches removed.
    • to_rule_url now handles GraphqlSchemaLinter for URL construction.
  • Adjusts graphql lint rule declaration to use RuleSource::GraphqlSchemaLinter("enum-values-all-caps").inspired() in use_graphql_naming_convention.rs.
  • No other control-flow or logic changes indicated.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title refers to correcting GraphQL references in documentation but frames the change as purely documentation work and does not highlight the primary code change of renaming an enum variant and updating API mappings. While it addresses a real part of the changeset, it lacks specificity about the main refactoring and may mislead readers about the scope. Under our criteria, a partially related title still passes, though it could be more precise.
Description Check ✅ Passed The description outlines the removal of the Eslint prefix, adjustment of the GraphQL-ESLint documentation URL, and correction of the rule prefix, which directly corresponds to the documented changes in both source code and documentation. This alignment with the actual modifications means the description is clearly related to the changeset and satisfies the criteria.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Sep 30, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
crates/biome_analyze/src/rule.rs (1)

392-395: Stop classifying GraphQL Schema Linter as an ESLint plugin.

Now that GraphqlSchemaLinter stands on its own, is_eslint_plugin should return false for it; otherwise we still lump a standalone tool in the ESLint bucket.

-        !matches!(self, Self::Clippy(_) | Self::Eslint(_) | Self::Stylelint(_))
+        !matches!(
+            self,
+            Self::Clippy(_) | Self::Eslint(_) | Self::Stylelint(_) | Self::GraphqlSchemaLinter(_)
+        )
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b9b9d8 and 4fb55ab.

📒 Files selected for processing (2)
  • crates/biome_analyze/src/rule.rs (5 hunks)
  • crates/biome_graphql_analyze/src/lint/style/use_graphql_naming_convention.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
crates/biome_*/**

📄 CodeRabbit inference engine (CLAUDE.md)

Place core crates under /crates/biome_*/

Files:

  • crates/biome_analyze/src/rule.rs
  • crates/biome_graphql_analyze/src/lint/style/use_graphql_naming_convention.rs
**/*.rs

📄 CodeRabbit inference engine (CONTRIBUTING.md)

Format all Rust source files before committing (just f)

Files:

  • crates/biome_analyze/src/rule.rs
  • crates/biome_graphql_analyze/src/lint/style/use_graphql_naming_convention.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/style/use_graphql_naming_convention.rs
🧬 Code graph analysis (1)
crates/biome_graphql_analyze/src/lint/style/use_graphql_naming_convention.rs (1)
crates/biome_analyze/src/rule.rs (2)
  • sources (576-579)
  • inspired (252-257)
⏰ 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). (24)
  • GitHub Check: Documentation
  • GitHub Check: Test (depot-windows-2022-16)
  • GitHub Check: Test (depot-ubuntu-24.04-arm-16)
  • GitHub Check: Lint project (depot-ubuntu-24.04-arm-16)
  • GitHub Check: Check Dependencies
  • GitHub Check: Lint project (depot-windows-2022)
  • GitHub Check: Bench (biome_package)
  • GitHub Check: Bench (biome_html_formatter)
  • GitHub Check: Bench (biome_configuration)
  • GitHub Check: Bench (biome_json_formatter)
  • GitHub Check: Bench (biome_graphql_parser)
  • GitHub Check: Bench (biome_module_graph)
  • GitHub Check: Bench (biome_graphql_formatter)
  • GitHub Check: Bench (biome_html_parser)
  • GitHub Check: Bench (biome_json_analyze)
  • GitHub Check: Bench (biome_json_parser)
  • GitHub Check: Bench (biome_css_analyze)
  • GitHub Check: Bench (biome_css_formatter)
  • GitHub Check: Bench (biome_js_analyze)
  • GitHub Check: Bench (biome_js_formatter)
  • GitHub Check: Bench (biome_css_parser)
  • GitHub Check: Bench (biome_js_parser)
  • GitHub Check: Test Node.js API
  • GitHub Check: autofix

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq bot commented Sep 30, 2025

CodSpeed Performance Report

Merging #7623 will not alter performance

Comparing Netail:docs/correct-graphql-references (4fb55ab) with main (2b9b9d8)

Summary

✅ 133 untouched

@ematipico ematipico merged commit fa4fcd3 into biomejs:main Oct 1, 2025
29 checks passed
@Netail Netail deleted the docs/correct-graphql-references branch October 1, 2025 00:27
@coderabbitai coderabbitai bot mentioned this pull request Oct 14, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 8, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@ematipico ematipico ematipico approved these changes

Assignees

No one assigned

Labels

A-Linter Area: linter

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Netail @ematipico