fix: feedback

Author: Netail

.changeset/chubby-bottles-lick.md

@@ -2,9 +2,9 @@
 "@biomejs/biome": patch
 ---
 
-Added the rule [`useDescriptionStyle`](https://biomejs.dev/linter/rules/use-description-style/), requiring all descriptions to follow the same style (either block or inline).
+Added the nursery rule [`useConsistentGraphqlDescriptions`](https://biomejs.dev/linter/rules/use-consistent-graphql-descriptions/), requiring all descriptions to follow the same style (either block or inline) inside GraphQL files.
 
-##### Invalid
+**Invalid example:**
 
 ```graphql
 enum EnumValue {
@@ -13,7 +13,7 @@ enum EnumValue {
 }
 ```
 
-##### Valid
+**Valid example:**
 
 ```graphql
 enum EnumValue {

crates/biome_configuration/src/analyzer/linter/rules.rs

@@ -192,7 +192,7 @@ define_categories! {
     "lint/nursery/useConsistentArrowReturn": "https://biomejs.dev/linter/rules/use-consistent-arrow-return",
     "lint/nursery/useConsistentObjectDefinition": "https://biomejs.dev/linter/rules/use-consistent-object-definition",
     "lint/nursery/useConsistentTypeDefinitions": "https://biomejs.dev/linter/rules/use-consistent-type-definitions",
-    "lint/nursery/useDescriptionStyle": "https://biomejs.dev/linter/rules/use-description-style",
+    "lint/nursery/useConsistentGraphqlDescriptions": "https://biomejs.dev/linter/rules/use-consistent-graphql-descriptions",
     "lint/nursery/useExhaustiveSwitchCases": "https://biomejs.dev/linter/rules/use-exhaustive-switch-cases",
     "lint/nursery/useExplicitFunctionReturnType": "https://biomejs.dev/linter/rules/use-explicit-type",
     "lint/nursery/useExplicitType": "https://biomejs.dev/linter/rules/use-explicit-type",

crates/biome_diagnostics_categories/src/categories.rs

@@ -3,5 +3,5 @@
 //! Generated file, do not edit by hand, see `xtask/codegen`
 
 use biome_analyze::declare_lint_group;
-pub mod use_description_style;
-declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: use_description_style :: UseDescriptionStyle ,] } }
+pub mod use_consistent_graphql_descriptions;
+declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: use_consistent_graphql_descriptions :: UseConsistentGraphqlDescriptions ,] } }

crates/biome_graphql_analyze/src/lint/nursery.rs

@@ -4,14 +4,18 @@ use biome_analyze::{
 use biome_console::markup;
 use biome_graphql_syntax::GraphqlDescription;
 use biome_rowan::AstNode;
-use biome_rule_options::use_description_style::{Style, UseDescriptionStyleOptions};
+use biome_rule_options::use_consistent_graphql_descriptions::{
+    Style, UseConsistentGraphqlDescriptionsOptions,
+};
 
 declare_lint_rule! {
     /// Require all descriptions to follow the same style (either block or inline)
     ///
     /// ## Examples
     ///
-    /// ### Invalid
+    /// ### style: `block`
+    ///
+    /// #### Invalid
     ///
     /// ```graphql,expect_diagnostic
     /// enum EnumValue {
@@ -20,7 +24,7 @@ declare_lint_rule! {
     /// }
     /// ```
     ///
-    /// ### Valid
+    /// #### Valid
     ///
     /// ```graphql
     /// enum EnumValue {
@@ -31,20 +35,50 @@ declare_lint_rule! {
     /// }
     /// ```
     ///
-    pub UseDescriptionStyle {
+    /// ### style: `inline`
+    ///
+    /// #### Invalid
+    ///
+    /// ```graphql,expect_diagnostic
+    /// enum EnumValue {
+    ///   """
+    ///   this is a description
+    ///   """
+    ///   DEFAULT
+    /// }
+    /// ```
+    ///
+    /// #### Valid
+    ///
+    /// ```graphql
+    /// enum EnumValue {
+    ///   "this is a description"
+    ///   DEFAULT
+    /// }
+    /// ```
+    ///
+    /// ## Options
+    ///
+    /// ### style
+    ///
+    /// Use the `style` option to specify the required description style:
+    /// - `"block"` (default): Requires triple-quoted block descriptions (`"""..."""`)
+    /// - `"inline"`: Requires single-quoted inline descriptions (`"..."`)
+    ///
+    pub UseConsistentGraphqlDescriptions {
         version: "next",
-        name: "useDescriptionStyle",
+        name: "useConsistentGraphqlDescriptions",
         language: "graphql",
         sources: &[RuleSource::EslintGraphql("description-style").same()],
         recommended: false,
     }
 }
 
-impl Rule for UseDescriptionStyle {
+impl Rule for UseConsistentGraphqlDescriptions {
     type Query = Ast<GraphqlDescription>;
     type State = ();
     type Signals = Option<Self::State>;
-    type Options = UseDescriptionStyleOptions;
+    type Options = UseConsistentGraphqlDescriptionsOptions;
 
     fn run(ctx: &RuleContext<Self>) -> Option<Self::State> {
         let node = ctx.query();

…rc/lint/nursery/use_description_style.rs …y/use_consistent_graphql_descriptions.rscrates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs renamed to crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs crates/biome_graphql_analyze/src/lint/nursery/use_description_style.rs renamed to crates/biome_graphql_analyze/src/lint/nursery/use_consistent_graphql_descriptions.rs

@@ -265,6 +265,7 @@ pub mod use_consistent_array_type;
 pub mod use_consistent_arrow_return;
 pub mod use_consistent_builtin_instantiation;
 pub mod use_consistent_curly_braces;
+pub mod use_consistent_graphql_descriptions;
 pub mod use_consistent_member_accessibility;
 pub mod use_consistent_object_definitions;
 pub mod use_consistent_type_definitions;
@@ -274,7 +275,6 @@ pub mod use_default_parameter_last;
 pub mod use_default_switch_clause;
 pub mod use_default_switch_clause_last;
 pub mod use_deprecated_reason;
-pub mod use_description_style;
 pub mod use_enum_initializers;
 pub mod use_error_message;
 pub mod use_exhaustive_dependencies;

crates/biome_rule_options/src/lib.rs

@@ -6,16 +6,19 @@ use std::str::FromStr;
 #[derive(Default, Clone, Debug, Deserialize, Deserializable, Eq, PartialEq, Serialize)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[serde(rename_all = "camelCase", deny_unknown_fields, default)]
-pub struct UseDescriptionStyleOptions {
+pub struct UseConsistentGraphqlDescriptionsOptions {
+    /// The description style to enforce. Default to "block"
     pub style: Style,
 }
 
 #[derive(Clone, Copy, Debug, Default, Deserialize, Deserializable, Eq, PartialEq, Serialize)]
 #[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
 #[serde(rename_all = "camelCase")]
 pub enum Style {
+    /// Requires triple-quoted block descriptions (`"""..."""`)
     #[default]
     Block,
+    /// Requires single-quoted inline descriptions (`"..."`)
     Inline,
 }