feat(graphql_analyze): implement useInputName

Author: Netail

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

@@ -6,9 +6,10 @@ use biome_analyze::declare_lint_group;
 pub mod no_empty_source;
 pub mod use_consistent_graphql_descriptions;
 pub mod use_deprecated_date;
+pub mod use_input_name;
 pub mod use_unique_argument_names;
 pub mod use_unique_field_definition_names;
 pub mod use_unique_graphql_operation_name;
 pub mod use_unique_input_field_names;
 pub mod use_unique_variable_names;
-declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: no_empty_source :: NoEmptySource , self :: use_consistent_graphql_descriptions :: UseConsistentGraphqlDescriptions , self :: use_deprecated_date :: UseDeprecatedDate , self :: use_unique_argument_names :: UseUniqueArgumentNames , self :: use_unique_field_definition_names :: UseUniqueFieldDefinitionNames , self :: use_unique_graphql_operation_name :: UseUniqueGraphqlOperationName , self :: use_unique_input_field_names :: UseUniqueInputFieldNames , self :: use_unique_variable_names :: UseUniqueVariableNames ,] } }
+declare_lint_group! { pub Nursery { name : "nursery" , rules : [self :: no_empty_source :: NoEmptySource , self :: use_consistent_graphql_descriptions :: UseConsistentGraphqlDescriptions , self :: use_deprecated_date :: UseDeprecatedDate , self :: use_input_name :: UseInputName , self :: use_unique_argument_names :: UseUniqueArgumentNames , self :: use_unique_field_definition_names :: UseUniqueFieldDefinitionNames , self :: use_unique_graphql_operation_name :: UseUniqueGraphqlOperationName , self :: use_unique_input_field_names :: UseUniqueInputFieldNames , self :: use_unique_variable_names :: UseUniqueVariableNames ,] } }

crates/biome_diagnostics_categories/src/categories.rs

@@ -0,0 +1,87 @@
+use biome_analyze::{
+    Ast, Rule, RuleDiagnostic, RuleSource, context::RuleContext, declare_lint_rule,
+};
+use biome_console::markup;
+use biome_graphql_syntax::{
+    GraphqlFieldDefinition, GraphqlFieldDefinitionList, GraphqlFieldsDefinition,
+    GraphqlObjectTypeDefinition, GraphqlObjectTypeExtension,
+};
+use biome_rowan::{AstNode, declare_node_union};
+use biome_rule_options::use_input_name::UseInputNameOptions;
+
+declare_lint_rule! {
+    /// Require mutation argument to be always called “input” and input type to be called Mutation name + “Input”.
+    ///
+    /// Require mutation argument to be always called “input” and input type to be called Mutation name + “Input”.
+    /// Using the same name for all input parameters will make your schemas easier to consume and more predictable.
+    /// Using the same name as mutation for InputType will make it easier to find mutations that InputType belongs to.
+    ///
+    /// ## Examples
+    ///
+    /// ### Invalid
+    ///
+    /// ```graphql,expect_diagnostic
+    /// type Mutation {
+    ///   SetMessage(message: InputMessage): String
+    /// }
+    /// ```
+    ///
+    /// ### Valid
+    ///
+    /// ```graphql
+    /// type Mutation {
+    ///   SetMessage(input: SetMessageInput): String
+    /// }
+    /// ```
+    ///
+    pub UseInputName {
+        version: "next",
+        name: "useInputName",
+        language: "graphql",
+        recommended: false,
+        sources: &[RuleSource::EslintGraphql("input-name").inspired()],
+    }
+}
+
+impl Rule for UseInputName {
+    type Query = Ast<GraphqlFieldDefinition>;
+    type State = ();
+    type Signals = Option<Self::State>;
+    type Options = UseInputNameOptions;
+
+    fn run(ctx: &RuleContext<Self>) -> Self::Signals {
+        let node = ctx.query();
+
+        let def_list = node
+            .syntax()
+            .parent()
+            .and_then(GraphqlFieldDefinitionList::cast)?;
+        let fields_def = def_list
+            .syntax()
+            .parent()
+            .and_then(GraphqlFieldsDefinition::cast)?;
+        let is_query = fields_def.syntax().parent().is_some(|parent| {})?;
+
+        if !is_query {
+            return None;
+        }
+
+        None
+    }
+
+    fn diagnostic(ctx: &RuleContext<Self>, _state: &Self::State) -> Option<RuleDiagnostic> {
+        let span = ctx.query().range();
+        Some(
+            RuleDiagnostic::new(
+                rule_category!(),
+                span,
+                markup! {
+                    "Unexpected empty block is not allowed"
+                },
+            )
+            .note(markup! {
+                "This note will give you more information."
+            }),
+        )
+    }
+}

crates/biome_graphql_analyze/src/lint/nursery.rs

@@ -0,0 +1,18 @@
+# should generate diagnostics
+type Mutation { SetMessage(message: String): String }
+
+type Mutation { SetMessage(input: String): String }
+
+type Mutation { SetMessage(hello: SetMessageInput): String }
+
+type Mutation { userCreate(record: CreateOneUserInput!): CreateOneUserPayload }
+
+type Mutation { userCreate(record: [CreateOneUserInput]!): CreateOneUserPayload }
+
+type Mutation { userCreate(record: [CreateOneUserInput!]!): CreateOneUserPayload }
+
+type Mutation { userCreate(record: [CreateOneUserInput!]): CreateOneUserPayload }
+
+type Mutation { userCreate(record: String, test: String): String }
+
+type Mutation { userCreate(input: UserCreateInput): String }

crates/biome_graphql_analyze/src/lint/nursery/use_input_name.rs

@@ -0,0 +1,15 @@
+# should not generate diagnostics
+type Mutation { SetMessage(input: SetMessageInput): String }
+
+type Mutation { CreateMessage(input: CreateMessageInput): String DeleteMessage(input: DeleteMessageInput): Boolean }
+
+type Mutation { CreateMessage(input: CreateMessageInput!): String }
+
+type Mutation { CreateMessage(input: [CreateMessageInput]): String }
+
+type Mutation { userCreate(input: userCreateInput): String }
+
+type Mutation { CreateMessage(input: String): String }
+extend type Mutation { CreateMessage(input: String): String }
+type Query { message(id: ID): Message }
+extend type Query { message(id: ID): Message }

crates/biome_graphql_analyze/tests/specs/nursery/useInputName/invalid.graphql

@@ -7,6 +7,7 @@
 #[macro_use]
 mod generated;
 mod file_source;
+mod object_ext;
 pub mod string_value_ext;
 mod syntax_node;
 

crates/biome_graphql_analyze/tests/specs/nursery/useInputName/valid.graphql

@@ -0,0 +1,49 @@
+use crate::{GraphqlObjectTypeDefinition, GraphqlObjectTypeExtension};
+
+impl GraphqlObjectTypeDefinition {
+    pub fn is_mutation(&self) -> bool {
+        if let Some(name) = self.name().ok()
+            && let Some(value_token) = name.value_token().ok()
+            && value_token.to_string() == "Mutation"
+        {
+            return true;
+        }
+
+        false
+    }
+
+    pub fn is_query(&self) -> bool {
+        if let Some(name) = self.name().ok()
+            && let Some(value_token) = name.value_token().ok()
+            && value_token.to_string() == "Query"
+        {
+            return true;
+        }
+
+        false
+    }
+}
+
+impl GraphqlObjectTypeExtension {
+    pub fn is_mutation(&self) -> bool {
+        if let Some(name) = self.name().ok()
+            && let Some(value_token) = name.value_token().ok()
+            && value_token.to_string() == "Mutation"
+        {
+            return true;
+        }
+
+        false
+    }
+
+    pub fn is_query(&self) -> bool {
+        if let Some(name) = self.name().ok()
+            && let Some(value_token) = name.value_token().ok()
+            && value_token.to_string() == "Query"
+        {
+            return true;
+        }
+
+        false
+    }
+}

crates/biome_graphql_syntax/src/lib.rs

@@ -330,6 +330,7 @@ pub mod use_image_size;
 pub mod use_import_extensions;
 pub mod use_import_type;
 pub mod use_index_of;
+pub mod use_input_name;
 pub mod use_is_array;
 pub mod use_is_nan;
 pub mod use_iterable_callback_return;

crates/biome_graphql_syntax/src/object_ext.rs

@@ -0,0 +1,6 @@
+use biome_deserialize_macros::{Deserializable, Merge};
+use serde::{Deserialize, Serialize};
+#[derive(Default, Clone, Debug, Deserialize, Deserializable, Merge, Eq, PartialEq, Serialize)]
+#[cfg_attr(feature = "schema", derive(schemars::JsonSchema))]
+#[serde(rename_all = "camelCase", deny_unknown_fields, default)]
+pub struct UseInputNameOptions {}