@graphql-eslint/eslint-plugin 3.7.0 → 3.7.1-alpha-d9a3c78.0

package/docs/README.md

@@ -44,7 +44,7 @@ Name            &nbs
 [provided-required-arguments](rules/provided-required-arguments.md)|A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.|![recommended][]|🔮
 [require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|![all][]|🚀
 [require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|![recommended][]|🚀
-[require-description](rules/require-description.md)|Enforce descriptions in your type definitions.|![recommended][]|🚀
+[require-description](rules/require-description.md)|Enforce descriptions in type definitions and operations.|![recommended][]|🚀
 [require-field-of-type-query-in-mutation-result](rules/require-field-of-type-query-in-mutation-result.md)|Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.|![all][]|🚀
 [require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|![recommended][]|🚀
 [scalar-leafs](rules/scalar-leafs.md)|A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.|![recommended][]|🔮

package/docs/parser.md

@@ -36,7 +36,7 @@ Here's a list of changes that the parser performs, in order to make the GraphQL
 
 **Problem**: GraphQL uses `location` field to store the AST locations, while ESTree also uses it in a different structure.
 
-**Solution**: The parser creates a new `location` field that is compatible with ESTree, and renames the GraphQL `location` to `gqlLocation`.
+**Solution**: The parser creates a new `location` field that is compatible with ESTree.
 
 ### Loading GraphQL Schema
 

package/docs/rules/alphabetize.md

@@ -1,5 +1,7 @@
 # `alphabetize`
 
+🔧 The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#--fix) can automatically fix some of the problems reported by this rule.
+
 - Category: `Schema & Operations`
 - Rule name: `@graphql-eslint/alphabetize`
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)

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

@@ -131,7 +131,7 @@ The schema defines the following additional types:
 
 ## `asString` (enum)
 
-One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`, `kebab-case`
+One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`, `kebab-case`, `matchDocumentStyle`
 
 ## `asObject` (object)
 
@@ -146,6 +146,7 @@ This element must be one of the following enum values:
 - `snake_case`
 - `UPPER_CASE`
 - `kebab-case`
+- `matchDocumentStyle`
 
 ### `suffix` (string)
 

package/docs/rules/require-description.md

@@ -7,7 +7,7 @@
 - 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 descriptions in your type definitions.
+Enforce descriptions in type definitions and operations.
 
 ## Usage Examples
 
@@ -37,6 +37,17 @@ type someTypeName {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/require-description: ['error', { OperationDefinition: true }]
+
+# Create a new user
+mutation createUser {
+  # ...
+}
+```
+
 ## Config Schema
 
 The schema defines the following properties:
@@ -84,6 +95,12 @@ Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ObjectTypeDefinition).
 
+### `OperationDefinition` (boolean)
+
+Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
+
+> You must use only comment syntax `#` and not description syntax `"""` or `"`.
+
 ### `ScalarTypeDefinition` (boolean)
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ScalarTypeDefinition).

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

@@ -1,4 +1,4 @@
-import { ASTNode, Location, TypeInfo, TypeNode, ValueNode } from 'graphql';
+import { ASTNode, TypeInfo, TypeNode, ValueNode } from 'graphql';
 import { BaseNode } from 'estree';
 export declare type SafeGraphQLType<T extends ASTNode | ValueNode> = Omit<T extends {
     readonly type: TypeNode;
@@ -7,7 +7,6 @@ export declare type SafeGraphQLType<T extends ASTNode | ValueNode> = Omit<T exte
 } : T, 'loc'>;
 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 ? {
     typeInfo?: () => {
         argument?: ReturnType<TypeInfo['getArgument']>;

package/estree-parser/utils.d.ts

@@ -1,13 +1,18 @@
-import { Location, ValueNode, StringValueNode, ASTNode, GraphQLOutputType, GraphQLNamedType } from 'graphql';
-import { SourceLocation, Comment } from 'estree';
-import { GraphQLESTreeNode } from './estree-ast';
+import { Location, ValueNode, StringValueNode, ASTNode, GraphQLOutputType, GraphQLNamedType, Token, Source } from 'graphql';
+import type { Comment } from 'estree';
+import type { AST } from 'eslint';
+import type { GraphQLESTreeNode } from './estree-ast';
 export default function keyValMap<T, V>(list: ReadonlyArray<T>, keyFn: (item: T) => string, valFn: (item: T) => V): Record<string, V>;
 export declare function valueFromNode(valueNode: GraphQLESTreeNode<ValueNode>, variables?: Record<string, any>): any;
 export declare function getBaseType(type: GraphQLOutputType): GraphQLNamedType;
-export declare function convertRange(gqlLocation: Location): [number, number];
+declare type TokenKindValue = '<SOF>' | '!' | '$' | '&' | '(' | ')' | '...' | ':' | '=' | '@' | '[' | ']' | '{' | '|' | '}' | 'Name' | 'Int' | 'Float' | 'String' | 'BlockString' | 'Comment';
+export declare function convertToken<T extends 'Line' | 'Block' | TokenKindValue>(token: Token, type: T): Omit<AST.Token, 'type'> & {
+    type: T;
+};
+export declare function extractTokens(source: Source): AST.Token[];
 export declare function extractCommentsFromAst(loc: Location): Comment[];
-export declare function convertLocation(gqlLocation: Location): SourceLocation;
 export declare function isNodeWithDescription<T extends ASTNode>(obj: T): obj is T & {
     readonly description?: StringValueNode;
 };
 export declare function convertDescription<T extends ASTNode>(node: T): Comment[];
+export {};