Skip to content

Commit a5f59cd

Browse files
Netailautofix-ci[bot]
Netail
and
autofix-ci[bot]
authored
feat(graphql_analyze): implement useUniqueInputFieldNames (#8592)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 958e24b commit a5f59cd

13 files changed

Lines changed: 329 additions & 26 deletions

File tree

‎.changeset/cold-ravens-show.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
"@biomejs/biome": patch
3+
---
4+
5+
Added the nursery rule [`useUniqueInputFieldNames`](https://biomejs.dev/linter/rules/use-unique-input-field-names/). Require fields within an input object to be unique.
6+
7+
**Invalid:**
8+
9+
```graphql
10+
query A($x: Int, $x: Int) {
11+
field
12+
}
13+
```

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

Lines changed: 46 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎crates/biome_diagnostics_categories/src/categories.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,7 @@ define_categories! {
230230
"lint/nursery/useSortedClasses": "https://biomejs.dev/linter/rules/use-sorted-classes",
231231
"lint/nursery/useSpread": "https://biomejs.dev/linter/rules/no-spread",
232232
"lint/nursery/useUniqueGraphqlOperationName": "https://biomejs.dev/linter/rules/use-unique-graphql-operation-name",
233+
"lint/nursery/useUniqueInputFieldNames": "https://biomejs.dev/linter/rules/use-unique-input-field-names",
233234
"lint/nursery/useUniqueVariableNames": "https://biomejs.dev/linter/rules/use-unique-variable-names",
234235
"lint/nursery/useVueConsistentDefinePropsDeclaration": "https://biomejs.dev/linter/rules/use-vue-consistent-define-props-declaration",
235236
"lint/nursery/useVueDefineMacrosOrder": "https://biomejs.dev/linter/rules/use-vue-define-macros-order",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ pub mod no_empty_source;
77
pub mod use_consistent_graphql_descriptions;
88
pub mod use_deprecated_date;
99
pub mod use_unique_graphql_operation_name;
10+
pub mod use_unique_input_field_names;
1011
pub mod use_unique_variable_names;
11-
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_graphql_operation_name :: UseUniqueGraphqlOperationName , self :: use_unique_variable_names :: UseUniqueVariableNames ,] } }
12+
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_graphql_operation_name :: UseUniqueGraphqlOperationName , self :: use_unique_input_field_names :: UseUniqueInputFieldNames , self :: use_unique_variable_names :: UseUniqueVariableNames ,] } }

‎crates/biome_graphql_analyze/src/lint/nursery/use_unique_input_field_names.rs‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
use std::collections::HashSet;
2+
3+
use biome_analyze::{
4+
Ast, Rule, RuleDiagnostic, RuleSource, context::RuleContext, declare_lint_rule,
5+
};
6+
use biome_console::markup;
7+
use biome_graphql_syntax::GraphqlObjectValue;
8+
use biome_rowan::{AstNode, TokenText};
9+
use biome_rule_options::use_unique_input_field_names::UseUniqueInputFieldNamesOptions;
10+
11+
declare_lint_rule! {
12+
/// Require fields within an input object to be unique.
13+
///
14+
/// A GraphQL input object value is only valid if all supplied fields are uniquely named.
15+
///
16+
/// ## Examples
17+
///
18+
/// ### Invalid
19+
///
20+
/// ```graphql,expect_diagnostic
21+
/// query {
22+
/// field(arg: { f1: "value", f1: "value" })
23+
/// }
24+
/// ```
25+
///
26+
/// ### Valid
27+
///
28+
/// ```graphql
29+
/// query {
30+
/// field(arg: { f1: "value", f2: "value" })
31+
/// }
32+
/// ```
33+
///
34+
pub UseUniqueInputFieldNames {
35+
version: "next",
36+
name: "useUniqueInputFieldNames",
37+
language: "graphql",
38+
recommended: false,
39+
sources: &[RuleSource::EslintGraphql("unique-input-field-names").same()],
40+
}
41+
}
42+
43+
impl Rule for UseUniqueInputFieldNames {
44+
type Query = Ast<GraphqlObjectValue>;
45+
type State = ();
46+
type Signals = Option<Self::State>;
47+
type Options = UseUniqueInputFieldNamesOptions;
48+
49+
fn run(ctx: &RuleContext<Self>) -> Self::Signals {
50+
let node = ctx.query();
51+
let mut found: HashSet<TokenText> = HashSet::new();
52+
53+
for element in node.members() {
54+
if let Some(name) = element.name().ok()
55+
&& let Some(value_token) = name.value_token().ok()
56+
{
57+
let string = value_token.token_text();
58+
if found.contains(&string) {
59+
return Some(());
60+
} else {
61+
found.insert(string);
62+
}
63+
}
64+
}
65+
66+
None
67+
}
68+
69+
fn diagnostic(ctx: &RuleContext<Self>, _state: &Self::State) -> Option<RuleDiagnostic> {
70+
let span = ctx.query().range();
71+
Some(
72+
RuleDiagnostic::new(
73+
rule_category!(),
74+
span,
75+
markup! {
76+
"Duplicate input field name."
77+
},
78+
)
79+
.note(markup! {
80+
"A GraphQL input object value is only valid if all supplied fields are uniquely named. Make sure to name every input field differently."
81+
}),
82+
)
83+
}
84+
}

‎crates/biome_graphql_analyze/tests/specs/nursery/useUniqueInputFieldNames/invalid.graphql‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# should generate diagnostics
2+
query A {
3+
field(arg: { f1: "value", f1: "value" })
4+
}
5+
query B {
6+
field(arg: { f1: "value", f1: "value", f1: "value" })
7+
}
8+
query C {
9+
field(arg: { f1: {f2: "value", f2: "value" }})
10+
}

‎crates/biome_graphql_analyze/tests/specs/nursery/useUniqueInputFieldNames/invalid.graphql.snap‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
source: crates/biome_graphql_analyze/tests/spec_tests.rs
3+
expression: invalid.graphql
4+
---
5+
# Input
6+
```graphql
7+
# should generate diagnostics
8+
query A {
9+
field(arg: { f1: "value", f1: "value" })
10+
}
11+
query B {
12+
field(arg: { f1: "value", f1: "value", f1: "value" })
13+
}
14+
query C {
15+
field(arg: { f1: {f2: "value", f2: "value" }})
16+
}
17+
18+
```
19+
20+
# Diagnostics
21+
```
22+
invalid.graphql:3:13 lint/nursery/useUniqueInputFieldNames ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
23+
24+
i Duplicate input field name.
25+
26+
1 │ # should generate diagnostics
27+
2 │ query A {
28+
> 3 │ field(arg: { f1: "value", f1: "value" })
29+
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
30+
4 │ }
31+
5 │ query B {
32+
33+
i A GraphQL input object value is only valid if all supplied fields are uniquely named. Make sure to name every input field differently.
34+
35+
i This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
36+
37+
38+
```
39+
40+
```
41+
invalid.graphql:6:13 lint/nursery/useUniqueInputFieldNames ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
42+
43+
i Duplicate input field name.
44+
45+
4 │ }
46+
5 │ query B {
47+
> 6 │ field(arg: { f1: "value", f1: "value", f1: "value" })
48+
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
49+
7 │ }
50+
8 │ query C {
51+
52+
i A GraphQL input object value is only valid if all supplied fields are uniquely named. Make sure to name every input field differently.
53+
54+
i This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
55+
56+
57+
```
58+
59+
```
60+
invalid.graphql:9:19 lint/nursery/useUniqueInputFieldNames ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
61+
62+
i Duplicate input field name.
63+
64+
7 │ }
65+
8 │ query C {
66+
> 9 │ field(arg: { f1: {f2: "value", f2: "value" }})
67+
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
68+
10 │ }
69+
11 │
70+
71+
i A GraphQL input object value is only valid if all supplied fields are uniquely named. Make sure to name every input field differently.
72+
73+
i This rule belongs to the nursery group, which means it is not yet stable and may change in the future. Visit https://biomejs.dev/linter/#nursery for more information.
74+
75+
76+
```

‎crates/biome_graphql_analyze/tests/specs/nursery/useUniqueInputFieldNames/valid.graphql‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# should not generate diagnostics
2+
query A {
3+
field(arg: { f: true })
4+
}
5+
query B {
6+
field(arg1: { f: true }, arg2: { f: true })
7+
}
8+
query C {
9+
field(arg: { f1: "value", f2: "value", f3: "value" })
10+
}
11+
query D {
12+
field(arg: {
13+
deep: {
14+
deep: {
15+
id: 1
16+
}
17+
id: 1
18+
}
19+
id: 1
20+
})
21+
}

‎crates/biome_graphql_analyze/tests/specs/nursery/useUniqueInputFieldNames/valid.graphql.snap‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
source: crates/biome_graphql_analyze/tests/spec_tests.rs
3+
expression: valid.graphql
4+
---
5+
# Input
6+
```graphql
7+
# should not generate diagnostics
8+
query A {
9+
field(arg: { f: true })
10+
}
11+
query B {
12+
field(arg1: { f: true }, arg2: { f: true })
13+
}
14+
query C {
15+
field(arg: { f1: "value", f2: "value", f3: "value" })
16+
}
17+
query D {
18+
field(arg: {
19+
deep: {
20+
deep: {
21+
id: 1
22+
}
23+
id: 1
24+
}
25+
id: 1
26+
})
27+
}
28+
29+
```

‎crates/biome_rule_options/src/lib.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,7 @@ pub mod use_trim_start_end;
384384
pub mod use_unified_type_signatures;
385385
pub mod use_unique_element_ids;
386386
pub mod use_unique_graphql_operation_name;
387+
pub mod use_unique_input_field_names;
387388
pub mod use_unique_variable_names;
388389
pub mod use_valid_anchor;
389390
pub mod use_valid_aria_props;

0 commit comments

Comments
 (0)