@graphql-eslint/eslint-plugin 2.3.0-alpha-6ba4002.0 → 2.3.2-alpha-99be3d2.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.|🚀||
@@ -72,4 +73,4 @@ Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbs
 
 - [Writing Custom Rules](custom-rules.md)
 - [How the parser works?](parser.md)
-- [`parserOptions`](parser-options.md)
+- [`parserOptions`](parser-options.md)

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.
 
@@ -58,7 +58,7 @@ This is useful if you wish to use other GraphQL tools that works with the origin
 Here's an example for using original `graphql-js` validate method to validate `OperationDefinition`:
 
 ```ts
-import { validate } from 'graphql-js';
+import { validate } from 'graphql';
 import { requireGraphQLSchemaFromContext } from '@graphql-eslint/eslint-plugin';
 
 export const rule = {

package/docs/rules/alphabetize.md

@@ -0,0 +1,145 @@
+# `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`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/alphabetize.ts)
+- [Test source](../../packages/plugin/tests/alphabetize.spec.ts)

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

@@ -51,4 +51,9 @@ query getUsers($first: Int!, $first: Int!) {
     id
   }
 }
-```
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/avoid-duplicate-fields.ts)
+- [Test source](../../packages/plugin/tests/avoid-duplicate-fields.spec.ts)

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

@@ -31,20 +31,20 @@ 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`.
 
 Additional restrictions:
 
-* Minimum items: `1`
+* Minimum items: `1`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/avoid-operation-name-prefix.ts)

package/docs/rules/avoid-scalar-result-type-on-mutation.md

@@ -27,4 +27,9 @@ type Mutation {
 type Mutation {
   createUser: User!
 }
-```
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/avoid-scalar-result-type-on-mutation.ts)
+- [Test source](../../packages/plugin/tests/avoid-scalar-result-type-on-mutation.spec.ts)

package/docs/rules/avoid-typename-prefix.md

@@ -29,4 +29,9 @@ type User {
 type User {
   id: ID!
 }
-```
+```
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/avoid-typename-prefix.ts)
+- [Test source](../../packages/plugin/tests/avoid-typename-prefix.spec.ts)

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,23 +27,24 @@ 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:
 
 * `block`
 * `inline`
 
-Default: `"inline"`
+Default: `"inline"`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/description-style.ts)
+- [Test source](../../packages/plugin/tests/description-style.spec.ts)

package/docs/rules/executable-definitions.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ExecutableDefinitionsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ExecutableDefinitionsRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ExecutableDefinitionsRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/ExecutableDefinitionsRule-test.ts)

package/docs/rules/fields-on-correct-type.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if all fields selected are defined by the parent type, or are an allowed meta field such as `__typename`.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FieldsOnCorrectTypeRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FieldsOnCorrectTypeRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FieldsOnCorrectTypeRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/FieldsOnCorrectTypeRule-test.ts)

package/docs/rules/fragments-on-composite-type.md

@@ -9,4 +9,9 @@
 
 Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FragmentsOnCompositeTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FragmentsOnCompositeTypesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FragmentsOnCompositeTypesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/FragmentsOnCompositeTypesRule-test.ts)

package/docs/rules/input-name.md

@@ -42,32 +42,33 @@ 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
 
-Default: `true`
+Default: `true`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/input-name.ts)
+- [Test source](../../packages/plugin/tests/input-name.spec.ts)

package/docs/rules/known-argument-names.md

@@ -9,4 +9,9 @@
 
 A GraphQL field is only valid if all supplied arguments are defined by that field.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownArgumentNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownArgumentNamesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownArgumentNamesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownArgumentNamesRule-test.ts)

package/docs/rules/known-directives.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if all `@directives` are known by the schema and legally positioned.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownDirectivesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownDirectivesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownDirectivesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownDirectivesRule-test.ts)

package/docs/rules/known-fragment-names.md

@@ -82,4 +82,9 @@ const GET_USER = /* GraphQL */ `
   # Will give false positive error 'Unknown fragment "UserFields"'
   ${USER_FIELDS}
 `
-```
+```
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownFragmentNamesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownFragmentNamesRule-test.ts)

package/docs/rules/known-type-names.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownTypeNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownTypeNamesRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownTypeNamesRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/KnownTypeNamesRule-test.ts)

package/docs/rules/lone-anonymous-operation.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if when it contains an anonymous operation (the query short-hand) that it contains only that one operation definition.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneAnonymousOperationRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneAnonymousOperationRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneAnonymousOperationRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/LoneAnonymousOperationRule-test.ts)

package/docs/rules/lone-schema-definition.md

@@ -9,4 +9,9 @@
 
 A GraphQL document is only valid if it contains only one schema definition.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneSchemaDefinitionRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneSchemaDefinitionRule.ts).
+
+## Resources
+
+- [Rule source](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneSchemaDefinitionRule.ts)
+- [Test source](https://github.com/graphql/graphql-js/tree/main/src/validation/__tests__/LoneSchemaDefinitionRule-test.ts)

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:
 
@@ -149,4 +145,9 @@ This element must be one of the following enum values:
 * `PascalCase`
 * `snake_case`
 * `UPPER_CASE`
-* `kebab-case`
+* `kebab-case`
+
+## Resources
+
+- [Rule source](../../packages/plugin/src/rules/match-document-filename.ts)
+- [Test source](../../packages/plugin/tests/match-document-filename.spec.ts)