@graphql-eslint/eslint-plugin 3.13.1-alpha-20221105010933-2b1e7ee → 3.13.1

package/docs/rules/match-document-filename.md

@@ -0,0 +1,156 @@
+# `match-document-filename`
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/match-document-filename`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+This rule allows you to enforce that the file name should match the operation name.
+
+## Usage Examples
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.gql' }]
+
+# user.gql
+type User {
+  id: ID!
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { query: 'snake_case' }]
+
+# user_by_id.gql
+query UserById {
+  userById(id: 5) {
+    id
+    name
+    fullName
+  }
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { style: 'kebab-case', suffix: '.fragment' } }]
+
+# user-fields.fragment.gql
+fragment user_fields on User {
+  id
+  email
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { mutation: { style: 'PascalCase', suffix: 'Mutation' } }]
+
+# DeleteUserMutation.gql
+mutation DELETE_USER {
+  deleteUser(id: 5)
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fileExtension: '.graphql' }]
+
+# post.gql
+type Post {
+  id: ID!
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { query: 'PascalCase' }]
+
+# user-by-id.gql
+query UserById {
+  userById(id: 5) {
+    id
+    name
+    fullName
+  }
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `fileExtension` (enum)
+
+This element must be one of the following enum values:
+
+- `.gql`
+- `.graphql`
+
+### `query`
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `mutation`
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `subscription`
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `fragment`
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `asString` (enum)
+
+One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`, `kebab-case`, `matchDocumentStyle`
+
+## `asObject` (object)
+
+Properties of the `asObject` object:
+
+### `style` (enum)
+
+This element must be one of the following enum values:
+
+- `camelCase`
+- `PascalCase`
+- `snake_case`
+- `UPPER_CASE`
+- `kebab-case`
+- `matchDocumentStyle`
+
+### `suffix` (string)
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/match-document-filename.ts)
+- [Test source](../../packages/plugin/tests/match-document-filename.spec.ts)

package/docs/rules/naming-convention.md

@@ -0,0 +1,300 @@
+# `naming-convention`
+
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` and `"plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema & Operations`
+- Rule name: `@graphql-eslint/naming-convention`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Require names to follow specified conventions.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { types: 'PascalCase', FieldDefinition: 'camelCase' }]
+
+type user {
+  first_name: String!
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }]
+
+fragment UserFragment on User {
+  # ...
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }]
+
+type Query {
+  getUsers: [User!]!
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { types: 'PascalCase', FieldDefinition: 'camelCase' }]
+
+type User {
+  firstName: String
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { FragmentDefinition: { style: 'PascalCase', forbiddenSuffixes: ['Fragment'] } }]
+
+fragment UserFields on User {
+  # ...
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { 'FieldDefinition[parent.name.value=Query]': { forbiddenPrefixes: ['get'] } }]
+
+type Query {
+  users: [User!]!
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { FieldDefinition: { style: 'camelCase', ignorePattern: '^(EAN13|UPC|UK)' } }]
+
+type Product {
+  EAN13: String
+  UPC: String
+  UKFlag: String
+}
+```
+
+## Config Schema
+
+> It's possible to use a [`selector`](https://eslint.org/docs/developer-guide/selectors) that starts with allowed `ASTNode` names which are described below.
+>
+> Paste or drop code into the editor in [ASTExplorer](https://astexplorer.net) and inspect the generated AST to compose your selector.
+>
+> Example: pattern property `FieldDefinition[parent.name.value=Query]` will match only fields for type `Query`.
+
+The schema defines the following properties:
+
+### `types`
+
+Includes:
+
+- `ObjectTypeDefinition`
+- `InterfaceTypeDefinition`
+- `EnumTypeDefinition`
+- `ScalarTypeDefinition`
+- `InputObjectTypeDefinition`
+- `UnionTypeDefinition`
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `Argument`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#Argument).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `DirectiveDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#DirectiveDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `EnumTypeDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#EnumTypeDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `EnumValueDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#EnumValueDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `FieldDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#FieldDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `FragmentDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#FragmentDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `InputObjectTypeDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#InputObjectTypeDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `InputValueDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#InputValueDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `InterfaceTypeDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#InterfaceTypeDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `ObjectTypeDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ObjectTypeDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `OperationDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `ScalarTypeDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ScalarTypeDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `UnionTypeDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#UnionTypeDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `VariableDefinition`
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#VariableDefinition).
+
+The object must be one of the following types:
+
+* `asString`
+* `asObject`
+
+### `allowLeadingUnderscore` (boolean)
+
+Default: `false`
+
+### `allowTrailingUnderscore` (boolean)
+
+Default: `false`
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `asString` (enum)
+
+One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`
+
+## `asObject` (object)
+
+Properties of the `asObject` object:
+
+### `style` (enum)
+
+This element must be one of the following enum values:
+
+- `camelCase`
+- `PascalCase`
+- `snake_case`
+- `UPPER_CASE`
+
+### `prefix` (string)
+
+### `suffix` (string)
+
+### `forbiddenPrefixes` (array)
+
+The object is an array with all elements of the type `string`.
+
+Additional restrictions:
+
+* Minimum items: `1`
+* Unique items: `true`
+
+### `forbiddenSuffixes` (array)
+
+The object is an array with all elements of the type `string`.
+
+Additional restrictions:
+
+* Minimum items: `1`
+* Unique items: `true`
+
+### `ignorePattern` (string)
+
+Option to skip validation of some words, e.g. acronyms
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/naming-convention.ts)
+- [Test source](../../packages/plugin/tests/naming-convention.spec.ts)

package/docs/rules/no-anonymous-operations.md

@@ -0,0 +1,39 @@
+# `no-anonymous-operations`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-anonymous-operations`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Require name for your GraphQL operations. This is useful since most GraphQL client libraries are using the operation name for caching purposes.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-anonymous-operations: 'error'
+
+query {
+  # ...
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-anonymous-operations: 'error'
+
+query user {
+  # ...
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-anonymous-operations.ts)
+- [Test source](../../packages/plugin/tests/no-anonymous-operations.spec.ts)

package/docs/rules/no-case-insensitive-enum-values-duplicates.md

@@ -0,0 +1,43 @@
+# `no-case-insensitive-enum-values-duplicates`
+
+✅ The `"extends": "plugin:@graphql-eslint/schema-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Schema`
+- Rule name: `@graphql-eslint/no-case-insensitive-enum-values-duplicates`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Disallow case-insensitive enum values duplicates.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-case-insensitive-enum-values-duplicates: 'error'
+
+enum MyEnum {
+  Value
+  VALUE
+  ValuE
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-case-insensitive-enum-values-duplicates: 'error'
+
+enum MyEnum {
+  Value1
+  Value2
+  Value3
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-case-insensitive-enum-values-duplicates.ts)
+- [Test source](../../packages/plugin/tests/no-case-insensitive-enum-values-duplicates.spec.ts)

package/docs/rules/no-deprecated.md

@@ -0,0 +1,85 @@
+# `no-deprecated`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-deprecated`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Enforce that deprecated fields or enum values are not in use by operations.
+
+## Usage Examples
+
+### Incorrect (field)
+
+```graphql
+# eslint @graphql-eslint/no-deprecated: 'error'
+
+# In your schema
+type User {
+  id: ID!
+  name: String! @deprecated(reason: "old field, please use fullName instead")
+  fullName: String!
+}
+
+# Query
+query user {
+  user {
+    name # This is deprecated, so you'll get an error
+  }
+}
+```
+
+### Incorrect (enum value)
+
+```graphql
+# eslint @graphql-eslint/no-deprecated: 'error'
+
+# In your schema
+type Mutation {
+  changeSomething(type: SomeType): Boolean!
+}
+
+enum SomeType {
+  NEW
+  OLD @deprecated(reason: "old field, please use NEW instead")
+}
+
+# Mutation
+mutation {
+  changeSomething(
+    type: OLD # This is deprecated, so you'll get an error
+  ) {
+    ...
+  }
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/no-deprecated: 'error'
+
+# In your schema
+type User {
+  id: ID!
+  name: String! @deprecated(reason: "old field, please use fullName instead")
+  fullName: String!
+}
+
+# Query
+query user {
+  user {
+    id
+    fullName
+  }
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-deprecated.ts)
+- [Test source](../../packages/plugin/tests/no-deprecated.spec.ts)

package/docs/rules/no-duplicate-fields.md

@@ -0,0 +1,65 @@
+# `no-duplicate-fields`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+💡 This rule provides [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-duplicate-fields`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-duplicate-fields: 'error'
+
+query {
+  user {
+    name
+    email
+    name # duplicate field
+  }
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-duplicate-fields: 'error'
+
+query {
+  users(
+    first: 100
+    skip: 50
+    after: "cji629tngfgou0b73kt7vi5jo"
+    first: 100 # duplicate argument
+  ) {
+    id
+  }
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/no-duplicate-fields: 'error'
+
+query (
+  $first: Int!
+  $first: Int! # duplicate variable
+) {
+  users(first: $first, skip: 50) {
+    id
+  }
+}
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/no-duplicate-fields.ts)
+- [Test source](../../packages/plugin/tests/no-duplicate-fields.spec.ts)

package/docs/rules/no-fragment-cycles.md

@@ -0,0 +1,17 @@
+# `no-fragment-cycles`
+
+✅ The `"extends": "plugin:@graphql-eslint/operations-recommended"` property in a configuration file enables this rule.
+
+- Category: `Operations`
+- Rule name: `@graphql-eslint/no-fragment-cycles`
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+A GraphQL fragment is only valid when it does not have cycles in fragments usage.
+
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoFragmentCyclesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/NoFragmentCyclesRule-test.ts)