Skip to content

Commit 5e85d43

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

14 files changed

Lines changed: 461 additions & 35 deletions

File tree

‎.changeset/floppy-phones-create.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@biomejs/biome": patch
3+
---
4+
5+
Added the nursery rule [`useUniqueFieldDefinitionNames`](https://biomejs.dev/linter/rules/use-unique-field-definition-names/). Require all fields of a type to be unique.

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

Lines changed: 50 additions & 29 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/useUniqueFieldDefinitionNames": "https://biomejs.dev/linter/rules/use-unique-field-definition-names",
232233
"lint/nursery/useUniqueGraphqlOperationName": "https://biomejs.dev/linter/rules/use-unique-graphql-operation-name",
233234
"lint/nursery/useUniqueInputFieldNames": "https://biomejs.dev/linter/rules/use-unique-input-field-names",
234235
"lint/nursery/useUniqueVariableNames": "https://biomejs.dev/linter/rules/use-unique-variable-names",

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ 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_field_definition_names;
910
pub mod use_unique_graphql_operation_name;
1011
pub mod use_unique_input_field_names;
1112
pub mod use_unique_variable_names;
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 ,] } }
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 ,] } }

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

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
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::{
8+
GraphqlFieldsDefinition, GraphqlInputFieldsDefinition, GraphqlInputObjectTypeDefinition,
9+
GraphqlInterfaceTypeDefinition, GraphqlObjectTypeDefinition,
10+
};
11+
use biome_rowan::{AstNode, TokenText, declare_node_union};
12+
use biome_rule_options::use_unique_field_definition_names::UseUniqueFieldDefinitionNamesOptions;
13+
14+
declare_lint_rule! {
15+
/// Require all fields of a type to be unique.
16+
///
17+
/// A GraphQL complex type is only valid if all its fields are uniquely named.
18+
///
19+
/// ## Examples
20+
///
21+
/// ### Invalid
22+
///
23+
/// ```graphql,expect_diagnostic
24+
/// type SomeObject {
25+
/// foo: String
26+
/// foo: String
27+
/// }
28+
/// ```
29+
///
30+
/// ```graphql,expect_diagnostic
31+
/// interface SomeObject {
32+
/// foo: String
33+
/// foo: String
34+
/// }
35+
/// ```
36+
///
37+
/// ```graphql,expect_diagnostic
38+
/// input SomeObject {
39+
/// foo: String
40+
/// foo: String
41+
/// }
42+
/// ```
43+
///
44+
/// ### Valid
45+
///
46+
/// ```graphql
47+
/// type SomeObject {
48+
/// foo: String
49+
/// bar: String
50+
/// }
51+
/// ```
52+
///
53+
/// ```graphql
54+
/// interface SomeObject {
55+
/// foo: String
56+
/// bar: String
57+
/// }
58+
/// ```
59+
///
60+
/// ```graphql
61+
/// input SomeObject {
62+
/// foo: String
63+
/// bar: String
64+
/// }
65+
/// ```
66+
///
67+
pub UseUniqueFieldDefinitionNames {
68+
version: "next",
69+
name: "useUniqueFieldDefinitionNames",
70+
language: "graphql",
71+
recommended: false,
72+
sources: &[RuleSource::EslintGraphql("unique-field-definition-names").same()],
73+
}
74+
}
75+
76+
impl Rule for UseUniqueFieldDefinitionNames {
77+
type Query = Ast<UseUniqueFieldDefinitionNamesQuery>;
78+
type State = ();
79+
type Signals = Option<Self::State>;
80+
type Options = UseUniqueFieldDefinitionNamesOptions;
81+
82+
fn run(ctx: &RuleContext<Self>) -> Self::Signals {
83+
let node = ctx.query();
84+
85+
match node {
86+
UseUniqueFieldDefinitionNamesQuery::GraphqlObjectTypeDefinition(object_def) => {
87+
let fields = object_def.fields()?;
88+
check_list(fields)
89+
}
90+
UseUniqueFieldDefinitionNamesQuery::GraphqlInterfaceTypeDefinition(interface_def) => {
91+
let fields = interface_def.fields()?;
92+
check_list(fields)
93+
}
94+
UseUniqueFieldDefinitionNamesQuery::GraphqlInputObjectTypeDefinition(input_def) => {
95+
let fields = input_def.input_fields()?;
96+
check_input_list(fields)
97+
}
98+
}
99+
}
100+
101+
fn diagnostic(ctx: &RuleContext<Self>, _state: &Self::State) -> Option<RuleDiagnostic> {
102+
let span = ctx.query().range();
103+
Some(
104+
RuleDiagnostic::new(
105+
rule_category!(),
106+
span,
107+
markup! {
108+
"Duplicate field name."
109+
},
110+
)
111+
.note(markup! {
112+
"A GraphQL complex type is only valid if all its fields are uniquely named. Make sure to name every field differently."
113+
}),
114+
)
115+
}
116+
}
117+
118+
fn check_list(fields: GraphqlFieldsDefinition) -> Option<()> {
119+
let mut found: HashSet<TokenText> = HashSet::new();
120+
121+
for element in fields.fields() {
122+
if let Some(name) = element.name().ok()
123+
&& let Some(value_token) = name.value_token().ok()
124+
{
125+
let string = value_token.token_text();
126+
if found.contains(&string) {
127+
return Some(());
128+
} else {
129+
found.insert(string);
130+
}
131+
}
132+
}
133+
134+
None
135+
}
136+
137+
fn check_input_list(fields: GraphqlInputFieldsDefinition) -> Option<()> {
138+
let mut found: HashSet<TokenText> = HashSet::new();
139+
140+
for element in fields.fields() {
141+
if let Some(name) = element.name().ok()
142+
&& let Some(value_token) = name.value_token().ok()
143+
{
144+
let string = value_token.token_text();
145+
if found.contains(&string) {
146+
return Some(());
147+
} else {
148+
found.insert(string);
149+
}
150+
}
151+
}
152+
153+
None
154+
}
155+
156+
declare_node_union! {
157+
pub UseUniqueFieldDefinitionNamesQuery = GraphqlObjectTypeDefinition | GraphqlInterfaceTypeDefinition | GraphqlInputObjectTypeDefinition
158+
}

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# should generate diagnostics
2+
type SomeObject {
3+
foo: String
4+
bar: String
5+
foo: String
6+
}
7+
8+
interface SomeInterface {
9+
foo: String
10+
bar: String
11+
foo: String
12+
}
13+
14+
input SomeInputObject {
15+
foo: String
16+
bar: String
17+
foo: String
18+
}

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

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

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# should not generate diagnostics
2+
type SomeObjectA
3+
interface SomeInterfaceA
4+
input SomeInputObjectA
5+
6+
# ---
7+
8+
type SomeObjectB {
9+
foo: String
10+
}
11+
12+
interface SomeInterfaceB {
13+
foo: String
14+
}
15+
16+
input SomeInputObjectB {
17+
foo: String
18+
}
19+
20+
# ---
21+
22+
type SomeObjectC {
23+
foo: String
24+
bar: String
25+
}
26+
27+
interface SomeInterfaceC {
28+
foo: String
29+
bar: String
30+
}
31+
32+
input SomeInputObjectC {
33+
foo: String
34+
bar: String
35+
}

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

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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+
type SomeObjectA
9+
interface SomeInterfaceA
10+
input SomeInputObjectA
11+
12+
# ---
13+
14+
type SomeObjectB {
15+
foo: String
16+
}
17+
18+
interface SomeInterfaceB {
19+
foo: String
20+
}
21+
22+
input SomeInputObjectB {
23+
foo: String
24+
}
25+
26+
# ---
27+
28+
type SomeObjectC {
29+
foo: String
30+
bar: String
31+
}
32+
33+
interface SomeInterfaceC {
34+
foo: String
35+
bar: String
36+
}
37+
38+
input SomeInputObjectC {
39+
foo: String
40+
bar: String
41+
}
42+
43+
```

‎crates/biome_rule_options/src/lib.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,7 @@ pub mod use_top_level_regex;
383383
pub mod use_trim_start_end;
384384
pub mod use_unified_type_signatures;
385385
pub mod use_unique_element_ids;
386+
pub mod use_unique_field_definition_names;
386387
pub mod use_unique_graphql_operation_name;
387388
pub mod use_unique_input_field_names;
388389
pub mod use_unique_variable_names;

0 commit comments

Comments
 (0)