Skip to content

Commit 9dd9ca7

Browse files
NetailNetail
authored
feat(graphql_analyze): implement useUniqueArgumentNames (#8591)
1 parent 5e85d43 commit 9dd9ca7

16 files changed

Lines changed: 389 additions & 37 deletions

File tree

‎.changeset/nine-nights-know.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 [`useUniqueArgumentNames`](https://biomejs.dev/linter/rules/use-unique-argument-names/). Enforce unique arguments for GraphQL fields & directives.
6+
7+
**Invalid:**
8+
9+
```graphql
10+
query {
11+
field(arg1: "value", arg1: "value")
12+
}
13+
```

‎.changeset/proud-ways-listen.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
"@biomejs/biome": patch
33
---
44

5-
Reduced the system calls when running the CLI. The performances might be noticable in big projects that have multiple libraries and enable project rules.
5+
Reduced the system calls when running the CLI. The performances might be noticeable in big projects that have multiple libraries and enable project rules.

‎.changeset/public-walls-buy.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,11 @@
33
---
44

55
Added the nursery rule [`useUniqueVariableNames`](https://biomejs.dev/linter/rules/use-unique-variable-names/). Enforce unique variable names for GraphQL operations.
6+
7+
**Invalid:**
8+
9+
```graphql
10+
query ($x: Int, $x: Int) {
11+
field
12+
}
13+
```

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

Lines changed: 52 additions & 31 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
@@ -229,6 +229,7 @@ define_categories! {
229229
"lint/nursery/useRequiredScripts": "https://biomejs.dev/linter/rules/use-required-scripts",
230230
"lint/nursery/useSortedClasses": "https://biomejs.dev/linter/rules/use-sorted-classes",
231231
"lint/nursery/useSpread": "https://biomejs.dev/linter/rules/no-spread",
232+
"lint/nursery/useUniqueArgumentNames": "https://biomejs.dev/linter/rules/use-unique-argument-names",
232233
"lint/nursery/useUniqueFieldDefinitionNames": "https://biomejs.dev/linter/rules/use-unique-field-definition-names",
233234
"lint/nursery/useUniqueGraphqlOperationName": "https://biomejs.dev/linter/rules/use-unique-graphql-operation-name",
234235
"lint/nursery/useUniqueInputFieldNames": "https://biomejs.dev/linter/rules/use-unique-input-field-names",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ use biome_analyze::declare_lint_group;
66
pub mod no_empty_source;
77
pub mod use_consistent_graphql_descriptions;
88
pub mod use_deprecated_date;
9+
pub mod use_unique_argument_names;
910
pub mod use_unique_field_definition_names;
1011
pub mod use_unique_graphql_operation_name;
1112
pub mod use_unique_input_field_names;
1213
pub mod use_unique_variable_names;
13-
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_field_definition_names :: UseUniqueFieldDefinitionNames , self :: use_unique_graphql_operation_name :: UseUniqueGraphqlOperationName , self :: use_unique_input_field_names :: UseUniqueInputFieldNames , self :: use_unique_variable_names :: UseUniqueVariableNames ,] } }
14+
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 ,] } }

‎crates/biome_graphql_analyze/src/lint/nursery/use_unique_argument_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::GraphqlArguments;
8+
use biome_rowan::{AstNode, TokenText};
9+
use biome_rule_options::use_unique_argument_names::UseUniqueArgumentNamesOptions;
10+
11+
declare_lint_rule! {
12+
/// Require all argument names for fields & directives to be unique.
13+
///
14+
/// A GraphQL field or directive is only valid if all supplied arguments are uniquely named.
15+
///
16+
/// ## Examples
17+
///
18+
/// ### Invalid
19+
///
20+
/// ```graphql,expect_diagnostic
21+
/// query {
22+
/// field(arg1: "value", arg1: "value")
23+
/// }
24+
/// ```
25+
///
26+
/// ### Valid
27+
///
28+
/// ```graphql
29+
/// query {
30+
/// field(arg1: "value", arg2: "value")
31+
/// }
32+
/// ```
33+
///
34+
pub UseUniqueArgumentNames {
35+
version: "next",
36+
name: "useUniqueArgumentNames",
37+
language: "graphql",
38+
recommended: false,
39+
sources: &[RuleSource::EslintGraphql("unique-argument-names").same()],
40+
}
41+
}
42+
43+
impl Rule for UseUniqueArgumentNames {
44+
type Query = Ast<GraphqlArguments>;
45+
type State = ();
46+
type Signals = Option<Self::State>;
47+
type Options = UseUniqueArgumentNamesOptions;
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.arguments() {
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 argument name."
77+
},
78+
)
79+
.note(markup! {
80+
"A GraphQL field or directive is only valid if all supplied arguments are uniquely named. Make sure to name every argument differently."
81+
}),
82+
)
83+
}
84+
}

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ declare_lint_rule! {
1818
/// ### Invalid
1919
///
2020
/// ```graphql,expect_diagnostic
21-
/// query C($x: Int, $x: Int) {
22-
/// __typename
21+
/// query ($x: Int, $x: Int) {
22+
/// field
2323
/// }
2424
/// ```
2525
///
2626
/// ### Valid
2727
///
2828
/// ```graphql
29-
/// query C($x: Int, $y: Int) {
30-
/// __typename
29+
/// query ($x: Int, $y: Int) {
30+
/// field
3131
/// }
3232
/// ```
3333
///

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

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

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

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
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(arg1: "value", arg1: "value")
10+
}
11+
query B {
12+
field(arg1: "value", arg1: "value", arg1: "value")
13+
}
14+
query C {
15+
field @directive(arg1: "value", arg1: "value")
16+
}
17+
query D {
18+
field @directive(arg1: "value", arg1: "value", arg1: "value")
19+
}
20+
21+
```
22+
23+
# Diagnostics
24+
```
25+
invalid.graphql:3:7 lint/nursery/useUniqueArgumentNames ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
26+
27+
i Duplicate argument name.
28+
29+
1 │ # should generate diagnostics
30+
2 │ query A {
31+
> 3 │ field(arg1: "value", arg1: "value")
32+
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
4 │ }
34+
5 │ query B {
35+
36+
i A GraphQL field or directive is only valid if all supplied arguments are uniquely named. Make sure to name every argument differently.
37+
38+
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.
39+
40+
41+
```
42+
43+
```
44+
invalid.graphql:6:7 lint/nursery/useUniqueArgumentNames ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
45+
46+
i Duplicate argument name.
47+
48+
4 │ }
49+
5 │ query B {
50+
> 6 │ field(arg1: "value", arg1: "value", arg1: "value")
51+
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52+
7 │ }
53+
8 │ query C {
54+
55+
i A GraphQL field or directive is only valid if all supplied arguments are uniquely named. Make sure to name every argument differently.
56+
57+
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.
58+
59+
60+
```
61+
62+
```
63+
invalid.graphql:9:18 lint/nursery/useUniqueArgumentNames ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
64+
65+
i Duplicate argument name.
66+
67+
7 │ }
68+
8 │ query C {
69+
> 9 │ field @directive(arg1: "value", arg1: "value")
70+
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
71+
10 │ }
72+
11 │ query D {
73+
74+
i A GraphQL field or directive is only valid if all supplied arguments are uniquely named. Make sure to name every argument differently.
75+
76+
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.
77+
78+
79+
```
80+
81+
```
82+
invalid.graphql:12:18 lint/nursery/useUniqueArgumentNames ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
83+
84+
i Duplicate argument name.
85+
86+
10 │ }
87+
11 │ query D {
88+
> 12 │ field @directive(arg1: "value", arg1: "value", arg1: "value")
89+
│ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
90+
13 │ }
91+
14 │
92+
93+
i A GraphQL field or directive is only valid if all supplied arguments are uniquely named. Make sure to name every argument differently.
94+
95+
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.
96+
97+
98+
```

0 commit comments

Comments
 (0)