@graphql-eslint/eslint-plugin 2.3.0-alpha-6ba4002.0 → 2.4.0-alpha-be7d9d8.0

package/README.md

@@ -46,7 +46,7 @@ npm install --save-dev @graphql-eslint/eslint-plugin
 
 ### Configuration
 
-To get started, create an override configuration for your ESLint, while applying it to to `.graphql` files (do that even if you are declaring your operations in code files):
+To get started, create an override configuration for your ESLint, while applying it to `.graphql` files (do that even if you are declaring your operations in code files):
 
 ```json
 {

package/configs/all.d.ts

@@ -1,5 +1,12 @@
 export declare const allConfig: {
     rules: {
+        '@graphql-eslint/alphabetize': (string | {
+            fields: string[];
+            values: string[];
+            selections: string[];
+            variables: string[];
+            arguments: string[];
+        })[];
         '@graphql-eslint/avoid-duplicate-fields': string;
         '@graphql-eslint/avoid-operation-name-prefix': string;
         '@graphql-eslint/avoid-scalar-result-type-on-mutation': string;

package/configs/index.d.ts

@@ -1,6 +1,13 @@
 export declare const configs: {
     all: {
         rules: {
+            '@graphql-eslint/alphabetize': (string | {
+                fields: string[];
+                values: string[];
+                selections: string[];
+                variables: string[];
+                arguments: string[];
+            })[];
             '@graphql-eslint/avoid-duplicate-fields': string;
             '@graphql-eslint/avoid-operation-name-prefix': string;
             '@graphql-eslint/avoid-scalar-result-type-on-mutation': string;

package/docs/README.md

@@ -11,6 +11,7 @@ Each rule has emojis denoting:
 <!-- prettier-ignore-start -->
 Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|Description|🚀&nbsp;/&nbsp;🔮|🔧|✅
 -|-|:-:|-|-
+[alphabetize](rules/alphabetize.md)|Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.|🚀||
 [avoid-duplicate-fields](rules/avoid-duplicate-fields.md)|Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.|🚀||
 [avoid-operation-name-prefix](rules/avoid-operation-name-prefix.md)|Enforce/avoid operation name prefix, useful if you wish to avoid prefix in your root fields, or avoid using REST terminology in your schema.|🚀||
 [avoid-scalar-result-type-on-mutation](rules/avoid-scalar-result-type-on-mutation.md)|Avoid scalar result type on mutation type to make sure to return a valid state.|🚀||

package/docs/custom-rules.md

@@ -38,7 +38,7 @@ const rule: GraphQLESLintRule = {
 So what happens here?
 
 1. `@graphql-eslint/eslint-plugin` handles the parsing process for your GraphQL content. It will load the GraphQL files (either from code files or from `.graphql` files with SDL), parse it using GraphQL parser, converts it to ESTree structure and let ESLint do the rest.
-1. You rule is being loaded by ESLint, and executes just like any other ESLint rule.
+1. Your rule is being loaded by ESLint, and executes just like any other ESLint rule.
 1. Our custom rule asks ESLint to run our function for every `OperationDefinition` found.
 1. If the `OperationDefinition` node doesn't have a valid `name` - we report an error to ESLint.
 
@@ -49,7 +49,7 @@ You can scan the `packages/plugin/src/rules` directory in this repo for referenc
 ## Accessing original GraphQL AST nodes
 
 Since our parser converts GraphQL AST to ESTree structure, there are some minor differences in the structure of the objects.
-If you are using TypeScript, and you typed your rule with `GraphQLESLintRule` - you'll see that each `node` is a bit different from from the AST nodes of GraphQL (you can read more about that in [graphql-eslint parser documentation](./parser.md)).
+If you are using TypeScript, and you typed your rule with `GraphQLESLintRule` - you'll see that each `node` is a bit different from the AST nodes of GraphQL (you can read more about that in [graphql-eslint parser documentation](./parser.md)).
 
 If you need access to the original GraphQL AST `node`, you can use `.rawNode()` method on each node you get from the AST structure of ESLint.
 

package/docs/rules/alphabetize.md

@@ -0,0 +1,140 @@
+# `alphabetize`
+
+- Category: `Best Practices`
+- Rule name: `@graphql-eslint/alphabetize`
+- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
+
+Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.
+
+## Usage Examples
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/alphabetize: ['error', { fields: ['ObjectTypeDefinition'] }]
+
+type User {
+  password: String
+  firstName: String! # should be before "password"
+  age: Int # should be before "firstName"
+  lastName: String!
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/alphabetize: ['error', { fields: ['ObjectTypeDefinition'] }]
+
+type User {
+  age: Int
+  firstName: String!
+  lastName: String!
+  password: String
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/alphabetize: ['error', { values: ['EnumTypeDefinition'] }]
+
+enum Role {
+  SUPER_ADMIN
+  ADMIN # should be before "SUPER_ADMIN"
+  USER
+  GOD # should be before "USER"
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/alphabetize: ['error', { values: ['EnumTypeDefinition'] }]
+
+enum Role {
+  ADMIN
+  GOD
+  SUPER_ADMIN
+  USER
+}
+```
+
+### Incorrect
+
+```graphql
+# eslint @graphql-eslint/alphabetize: ['error', { selections: ['OperationDefinition'] }]
+
+query {
+  me {
+    firstName
+    lastName
+    email # should be before "lastName"
+  }
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/alphabetize: ['error', { selections: ['OperationDefinition'] }]
+
+query {
+  me {
+    email
+    firstName
+    lastName
+  }
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `fields` (array)
+
+Fields of `type`, `interface`, and `input`.
+
+The elements of the array must contain the following properties:
+
+- `ObjectTypeDefinition`
+- `InterfaceTypeDefinition`
+- `InputObjectTypeDefinition`
+
+### `values` (array)
+
+Values of `enum`.
+
+The elements of the array must contain the following properties:
+
+- `EnumTypeDefinition`
+
+### `selections` (array)
+
+Selections of operations (`query`, `mutation` and `subscription`) and `fragment`.
+
+The elements of the array must contain the following properties:
+
+- `OperationDefinition`
+- `FragmentDefinition`
+
+### `variables` (array)
+
+Variables of operations (`query`, `mutation` and `subscription`).
+
+The elements of the array must contain the following properties:
+
+- `OperationDefinition`
+
+### `arguments` (array)
+
+Arguments of fields and directives.
+
+The elements of the array must contain the following properties:
+
+- `FieldDefinition`
+- `Field`
+- `DirectiveDefinition`
+- `Directive`

package/docs/rules/avoid-operation-name-prefix.md

@@ -31,17 +31,13 @@ query userDetails {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `caseSensitive` (boolean)
+### `caseSensitive` (boolean)
 
 Default: `false`
 
-#### `keywords` (array, required)
+### `keywords` (array, required)
 
 The object is an array with all elements of the type `string`.
 

package/docs/rules/description-style.md

@@ -16,7 +16,7 @@ Require all comments to follow the same style (either block or inline).
 
 """ Description """
 type someTypeName {
-    ...
+  # ...
 }
 ```
 
@@ -27,19 +27,15 @@ type someTypeName {
 
 " Description "
 type someTypeName {
-    ...
+  # ...
 }
 ```
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `style` (string, enum)
+### `style` (string, enum)
 
 This element must be one of the following enum values:
 

package/docs/rules/input-name.md

@@ -42,31 +42,27 @@ type Mutation {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `checkInputType` (boolean)
+### `checkInputType` (boolean)
 
 Check that the input type name follows the convention <mutationName>Input
 
 Default: `false`
 
-#### `caseSensitiveInputType` (boolean)
+### `caseSensitiveInputType` (boolean)
 
 Allow for case discrepancies in the input type name
 
 Default: `true`
 
-#### `checkQueries` (boolean)
+### `checkQueries` (boolean)
 
 Apply the rule to Queries
 
 Default: `false`
 
-#### `checkMutations` (boolean)
+### `checkMutations` (boolean)
 
 Apply the rule to Mutations
 

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

@@ -86,41 +86,37 @@ query UserById {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `fileExtension` (string, enum)
+### `fileExtension` (string, enum)
 
 This element must be one of the following enum values:
 
 * `.gql`
 * `.graphql`
 
-#### `query`
+### `query`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `mutation`
+### `mutation`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `subscription`
+### `subscription`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `fragment`
+### `fragment`
 
 The object must be one of the following types:
 

package/docs/rules/naming-convention.md

@@ -33,97 +33,93 @@ type SomeTypeName {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `FieldDefinition`
+### `FieldDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `InputObjectTypeDefinition`
+### `InputObjectTypeDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `EnumValueDefinition`
+### `EnumValueDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `InputValueDefinition`
+### `InputValueDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `ObjectTypeDefinition`
+### `ObjectTypeDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `InterfaceTypeDefinition`
+### `InterfaceTypeDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `EnumTypeDefinition`
+### `EnumTypeDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `UnionTypeDefinition`
+### `UnionTypeDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `ScalarTypeDefinition`
+### `ScalarTypeDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `OperationDefinition`
+### `OperationDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `FragmentDefinition`
+### `FragmentDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `QueryDefinition`
+### `QueryDefinition`
 
 The object must be one of the following types:
 
 * `asString`
 * `asObject`
 
-#### `leadingUnderscore` (string, enum)
+### `leadingUnderscore` (string, enum)
 
 This element must be one of the following enum values:
 
@@ -132,7 +128,7 @@ This element must be one of the following enum values:
 
 Default: `"forbid"`
 
-#### `trailingUnderscore` (string, enum)
+### `trailingUnderscore` (string, enum)
 
 This element must be one of the following enum values:
 

package/docs/rules/require-deprecation-date.md

@@ -44,10 +44,6 @@ type User {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `argumentName` (string)
+### `argumentName` (string)

package/docs/rules/require-description.md

@@ -37,20 +37,12 @@ type someTypeName {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `on` (array)
+### `on` (array)
 
 The object is an array with all elements of the type `string`.
 
 Additional restrictions:
 
-* Minimum items: `1`
-
-Additional restrictions:
-
 * Minimum items: `1`

package/docs/rules/require-id-when-available.md

@@ -50,12 +50,8 @@ query user {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `fieldName` (string)
+### `fieldName` (string)
 
 Default: `"id"`

package/docs/rules/selection-set-depth.md

@@ -53,18 +53,10 @@ query deep2 {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
+### `maxDepth` (number)
 
-The array object has the following properties:
+### `ignore` (array)
 
-#### `maxDepth` (number)
-
-#### `ignore` (array)
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-* Minimum items: `1`
+The object is an array with all elements of the type `string`.

package/docs/rules/strict-id-in-types.md

@@ -62,13 +62,9 @@ type Error {
 
 ## Config Schema
 
-### (array)
+The schema defines the following properties:
 
-The schema defines an array with all elements of the type `object`.
-
-The array object has the following properties:
-
-#### `acceptedIdNames` (array)
+### `acceptedIdNames` (array)
 
 The object is an array with all elements of the type `string`.
 
@@ -80,7 +76,7 @@ Default:
 ]
 ```
 
-#### `acceptedIdTypes` (array)
+### `acceptedIdTypes` (array)
 
 The object is an array with all elements of the type `string`.
 
@@ -92,11 +88,11 @@ Default:
 ]
 ```
 
-#### `exceptions` (object)
+### `exceptions` (object)
 
 Properties of the `exceptions` object:
 
-##### `types` (array)
+#### `types` (array)
 
 This is used to exclude types with names that match one of the specified values.
 
@@ -108,7 +104,7 @@ Default:
 []
 ```
 
-##### `suffixes` (array)
+#### `suffixes` (array)
 
 This is used to exclude types with names with suffixes that match one of the specified values.
 

package/estree-parser/converter.d.ts

@@ -1,7 +1,6 @@
 import { GraphQLESTreeNode } from './estree-ast';
 import { ASTNode, TypeInfo } from 'graphql';
-import { Comment } from 'estree';
 export declare function convertToESTree<T extends ASTNode>(node: T, typeInfo?: TypeInfo): {
-    rootTree: GraphQLESTreeNode<T>;
-    comments: Comment[];
+    rootTree: GraphQLESTreeNode<T, false>;
+    comments: import("estree").Comment[];
 };

package/estree-parser/estree-ast.d.ts

@@ -5,7 +5,7 @@ export declare type SafeGraphQLType<T extends ASTNode | ValueNode> = Omit<T exte
 } ? Omit<T, 'type'> & {
     readonly gqlType: TypeNode;
 } : T, 'loc'>;
-export declare type SingleESTreeNode<T extends any, WithTypeInfo extends boolean> = T extends ASTNode | ValueNode ? SafeGraphQLType<T> & Pick<BaseNode, 'leadingComments' | 'loc' | 'range'> & {
+export declare type SingleESTreeNode<T, WithTypeInfo extends boolean> = T extends ASTNode | ValueNode ? SafeGraphQLType<T> & Pick<BaseNode, 'leadingComments' | 'loc' | 'range'> & {
     type: T['kind'];
     gqlLocation: Location;
 } & (WithTypeInfo extends true ? {
@@ -21,7 +21,7 @@ export declare type SingleESTreeNode<T extends any, WithTypeInfo extends boolean
         gqlType?: ReturnType<TypeInfo['getType']>;
     };
 } : {}) : T;
-export declare type GraphQLESTreeNode<T extends any, WithTypeInfo extends boolean = false> = T extends ASTNode | ValueNode ? {
+export declare type GraphQLESTreeNode<T, WithTypeInfo extends boolean = false> = T extends ASTNode | ValueNode ? {
     rawNode: () => T;
 } & {
     [K in keyof SingleESTreeNode<T, WithTypeInfo>]: SingleESTreeNode<T, WithTypeInfo>[K] extends ReadonlyArray<infer Nested> ? GraphQLESTreeNode<Nested, WithTypeInfo>[] : SingleESTreeNode<T, WithTypeInfo>[K] extends ASTNode ? GraphQLESTreeNode<SingleESTreeNode<T, WithTypeInfo>[K], WithTypeInfo> : SingleESTreeNode<T, WithTypeInfo>[K];