Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

nullable-records rule #2675

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
+1,122 −2
Draft

nullable-records rule #2675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
343 changes: 343 additions & 0 deletions packages/plugin/__tests__/__snapshots__/nullable-records.spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,343 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html

exports[`nullable-records > invalid > should disallow non-nullability on Node interface 1`] = `
#### ⌨️ Code

1 | interface Node {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmap: Node!
6 | }

#### ❌ Error

4 | type Query {
> 5 | roadmap: Node!
| ^^^^^^^^^^^^^ Type \`Node\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
6 | }

#### 🔧 Autofix output

1 | interface Node {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmap: Node
6 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on a union of types where at least one type has ID 1`] = `
#### ⌨️ Code

1 | type Config {
2 | name: String!
3 | }
4 | type Roadmap {
5 | id: ID!
6 | }
7 | union ConfigOrRoadmap = Config | Roadmap
8 | type Query {
9 | config: ConfigOrRoadmap!
10 | }

#### ❌ Error

8 | type Query {
> 9 | config: ConfigOrRoadmap!
| ^^^^^^^^^^^^^^^^^^^^^^^ Union type \`ConfigOrRoadmap\` has to be nullable, because types \`Roadmap\` have \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
10 | }

#### 🔧 Autofix output

1 | type Config {
2 | name: String!
3 | }
4 | type Roadmap {
5 | id: ID!
6 | }
7 | union ConfigOrRoadmap = Config | Roadmap
8 | type Query {
9 | config: ConfigOrRoadmap
10 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on list of unions of types where at least one type has ID 1`] = `
#### ⌨️ Code

1 | type Config {
2 | name: String!
3 | }
4 | type Roadmap {
5 | id: ID!
6 | }
7 | union ConfigOrRoadmap = Config | Roadmap
8 | type Query {
9 | configs: [ConfigOrRoadmap!]!
10 | }

#### ❌ Error

8 | type Query {
> 9 | configs: [ConfigOrRoadmap!]!
| ^^^^^^^^^^^^^^^^^ Union type \`ConfigOrRoadmap\` has to be nullable, because types \`Roadmap\` have \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
10 | }

#### 🔧 Autofix output

1 | type Config {
2 | name: String!
3 | }
4 | type Roadmap {
5 | id: ID!
6 | }
7 | union ConfigOrRoadmap = Config | Roadmap
8 | type Query {
9 | configs: [ConfigOrRoadmap]!
10 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on non-nullable list of Node interfaces 1`] = `
#### ⌨️ Code

1 | interface Node {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [Node!]!
6 | }

#### ❌ Error

4 | type Query {
> 5 | roadmaps: [Node!]!
| ^^^^^^ Type \`Node\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
6 | }

#### 🔧 Autofix output

1 | interface Node {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [Node]!
6 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on type that has ID 1`] = `
#### ⌨️ Code

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmap: Roadmap!
6 | }

#### ❌ Error

4 | type Query {
> 5 | roadmap: Roadmap!
| ^^^^^^^^^^^^^^^^ Type \`Roadmap\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
6 | }

#### 🔧 Autofix output

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmap: Roadmap
6 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on type that references type with ID 1`] = `
#### ⌨️ Code

1 | type Feature {
2 | id: ID!
3 | }
4 | type Roadmap {
5 | id: ID!
6 | feature: Feature!
7 | }
8 | type Query {
9 | roadmap: Roadmap!
10 | }

#### ❌ Error 1/2

5 | id: ID!
> 6 | feature: Feature!
| ^^^^^^^^^^^^^^^^ Type \`Feature\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
7 | }

#### ❌ Error 2/2

8 | type Query {
> 9 | roadmap: Roadmap!
| ^^^^^^^^^^^^^^^^ Type \`Roadmap\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
10 | }

#### 🔧 Autofix output

1 | type Feature {
2 | id: ID!
3 | }
4 | type Roadmap {
5 | id: ID!
6 | feature: Feature
7 | }
8 | type Query {
9 | roadmap: Roadmap
10 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on type with ID 1`] = `
#### ⌨️ Code

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmap: Roadmap!
6 | }

#### ❌ Error

4 | type Query {
> 5 | roadmap: Roadmap!
| ^^^^^^^^^^^^^^^^ Type \`Roadmap\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
6 | }

#### 🔧 Autofix output

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmap: Roadmap
6 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on type with ID in a list and the list itself 1`] = `
#### ⌨️ Code

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [Roadmap!]!
6 | }

#### ❌ Error

4 | type Query {
> 5 | roadmaps: [Roadmap!]!
| ^^^^^^^^^ Type \`Roadmap\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
6 | }

#### 🔧 Autofix output

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [Roadmap]!
6 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on type with ID in a nullable list 1`] = `
#### ⌨️ Code

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [Roadmap!]
6 | }

#### ❌ Error

4 | type Query {
> 5 | roadmaps: [Roadmap!]
| ^^^^^^^^^ Type \`Roadmap\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
6 | }

#### 🔧 Autofix output

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [Roadmap]
6 | }
`;

exports[`nullable-records > invalid > should disallow non-nullability on type with ID in nested non-nullable lists 1`] = `
#### ⌨️ Code

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [[Roadmap!]!]!
6 | }

#### ❌ Error

4 | type Query {
> 5 | roadmaps: [[Roadmap!]!]!
| ^^^^^^^^^ Type \`Roadmap\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
6 | }

#### 🔧 Autofix output

1 | type Roadmap {
2 | id: ID!
3 | }
4 | type Query {
5 | roadmaps: [[Roadmap]!]!
6 | }
`;

exports[`nullable-records > invalid > should disallow nullability on Node interface field 1`] = `
#### ⌨️ Code

1 | interface Node {
2 | id: ID!
3 | }
4 | type Column implements Node {
5 | id: ID!
6 | }
7 | type Roadmap implements Node {
8 | id: ID!
9 | columns: [Column!]!
10 | }
11 | type Query {
12 | node(id: ID!): Node
13 | }

#### ❌ Error

8 | id: ID!
> 9 | columns: [Column!]!
| ^^^^^^^^ Type \`Column\` has to be nullable, because it has \`id\` field and can be deleted in the client runtime. https://the-guild.dev/graphql/eslint/rules/nullable-records
10 | }

#### 🔧 Autofix output

1 | interface Node {
2 | id: ID!
3 | }
4 | type Column implements Node {
5 | id: ID!
6 | }
7 | type Roadmap implements Node {
8 | id: ID!
9 | columns: [Column]!
10 | }
11 | type Query {
12 | node(id: ID!): Node
13 | }
`;
Loading
Loading