@graphql-eslint/eslint-plugin 2.3.0-alpha-4c161e5.0 → 2.3.0-alpha-6ba4002.0

package/configs/all.d.ts

@@ -1,12 +1,5 @@
 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,13 +1,6 @@
 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,7 +11,6 @@ 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/rules/avoid-operation-name-prefix.md

@@ -31,13 +31,17 @@ query userDetails {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `caseSensitive` (boolean)
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `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,15 +27,19 @@ type someTypeName {
 
 " Description "
 type someTypeName {
-  # ...
+    ...
 }
 ```
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `style` (string, enum)
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `style` (string, enum)
 
 This element must be one of the following enum values:
 

package/docs/rules/input-name.md

@@ -42,27 +42,31 @@ type Mutation {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `checkInputType` (boolean)
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `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,37 +86,41 @@ query UserById {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `fileExtension` (string, enum)
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `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,93 +33,97 @@ type SomeTypeName {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `FieldDefinition`
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `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:
 
@@ -128,7 +132,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,6 +44,10 @@ type User {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `argumentName` (string)
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `argumentName` (string)

package/docs/rules/require-description.md

@@ -37,12 +37,20 @@ type someTypeName {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `on` (array)
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `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,8 +50,12 @@ query user {
 
 ## Config Schema
 
-The schema defines the following properties:
+### (array)
 
-### `fieldName` (string)
+The schema defines an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `fieldName` (string)
 
 Default: `"id"`

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

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

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

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