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

package/index.mjs

@@ -65,16 +65,6 @@ const allConfig = {
     ...recommendedConfig,
     rules: {
         ...recommendedConfig.rules,
-        '@graphql-eslint/alphabetize': [
-            'error',
-            {
-                fields: ['ObjectTypeDefinition', 'InterfaceTypeDefinition', 'InputObjectTypeDefinition'],
-                values: ['EnumTypeDefinition'],
-                selections: ['OperationDefinition', 'FragmentDefinition'],
-                variables: ['OperationDefinition'],
-                arguments: ['FieldDefinition', 'Field', 'DirectiveDefinition', 'Directive'],
-            },
-        ],
         '@graphql-eslint/avoid-duplicate-fields': 'error',
         '@graphql-eslint/avoid-operation-name-prefix': 'error',
         '@graphql-eslint/avoid-scalar-result-type-on-mutation': 'error',
@@ -314,6 +304,14 @@ const validationToRule = (name, ruleName, docs, getDocumentNode) => {
         },
     };
 };
+const importFiles = (context) => {
+    const code = context.getSourceCode().text;
+    if (!isGraphQLImportFile(code)) {
+        return null;
+    }
+    // Import documents because file contains '#import' comments
+    return processImport(context.getFilename());
+};
 const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-definitions', 'ExecutableDefinitions', {
     description: `A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.`,
 }), validationToRule('fields-on-correct-type', 'FieldsOnCorrectType', {
@@ -390,14 +388,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
             \``,
         },
     ],
-}, context => {
-    const code = context.getSourceCode().text;
-    if (!isGraphQLImportFile(code)) {
-        return null;
-    }
-    // Import documents because file contains '#import' comments
-    return processImport(context.getFilename());
-}), validationToRule('known-type-names', 'KnownTypeNames', {
+}, importFiles), validationToRule('known-type-names', 'KnownTypeNames', {
     description: `A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.`,
 }), validationToRule('lone-anonymous-operation', 'LoneAnonymousOperation', {
     description: `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.`,
@@ -439,7 +430,7 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     return getParentNode(context.getFilename());
 }), validationToRule('no-unused-variables', 'NoUnusedVariables', {
     description: `A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.`,
-}), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
+}, importFiles), validationToRule('overlapping-fields-can-be-merged', 'OverlappingFieldsCanBeMerged', {
     description: `A selection set is only valid if all fields (including spreading any fragments) either correspond to distinct response names or can be merged without ambiguity.`,
 }), validationToRule('possible-fragment-spread', 'PossibleFragmentSpreads', {
     description: `A fragment spread is only valid if the type condition could ever possibly be true: if there is a non-empty intersection of the possible parent types, and possible types which pass the type condition.`,
@@ -484,240 +475,6 @@ const GRAPHQL_JS_VALIDATIONS = Object.assign({}, validationToRule('executable-de
     description: `Variables passed to field arguments conform to type.`,
 }));
 
-const ALPHABETIZE = 'ALPHABETIZE';
-const fieldsEnum = [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION];
-const valuesEnum = [Kind.ENUM_TYPE_DEFINITION];
-const selectionsEnum = [Kind.OPERATION_DEFINITION, Kind.FRAGMENT_DEFINITION];
-const variablesEnum = [Kind.OPERATION_DEFINITION];
-const argumentsEnum = [Kind.FIELD_DEFINITION, Kind.FIELD, Kind.DIRECTIVE_DEFINITION, Kind.DIRECTIVE];
-const rule = {
-    meta: {
-        type: 'suggestion',
-        docs: {
-            category: 'Best Practices',
-            description: 'Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.',
-            url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/alphabetize.md',
-            examples: [
-                {
-                    title: 'Incorrect',
-                    usage: [{ fields: [Kind.OBJECT_TYPE_DEFINITION] }],
-                    code: /* GraphQL */ `
-            type User {
-              password: String
-              firstName: String! # should be before "password"
-              age: Int # should be before "firstName"
-              lastName: String!
-            }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ fields: [Kind.OBJECT_TYPE_DEFINITION] }],
-                    code: /* GraphQL */ `
-            type User {
-              age: Int
-              firstName: String!
-              lastName: String!
-              password: String
-            }
-          `,
-                },
-                {
-                    title: 'Incorrect',
-                    usage: [{ values: [Kind.ENUM_TYPE_DEFINITION] }],
-                    code: /* GraphQL */ `
-            enum Role {
-              SUPER_ADMIN
-              ADMIN # should be before "SUPER_ADMIN"
-              USER
-              GOD # should be before "USER"
-            }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ values: [Kind.ENUM_TYPE_DEFINITION] }],
-                    code: /* GraphQL */ `
-            enum Role {
-              ADMIN
-              GOD
-              SUPER_ADMIN
-              USER
-            }
-          `,
-                },
-                {
-                    title: 'Incorrect',
-                    usage: [{ selections: [Kind.OPERATION_DEFINITION] }],
-                    code: /* GraphQL */ `
-            query {
-              me {
-                firstName
-                lastName
-                email # should be before "lastName"
-              }
-            }
-          `,
-                },
-                {
-                    title: 'Correct',
-                    usage: [{ selections: [Kind.OPERATION_DEFINITION] }],
-                    code: /* GraphQL */ `
-            query {
-              me {
-                email
-                firstName
-                lastName
-              }
-            }
-          `,
-                },
-            ],
-            optionsForConfig: [
-                {
-                    fields: fieldsEnum,
-                    values: valuesEnum,
-                    selections: selectionsEnum,
-                    variables: variablesEnum,
-                    arguments: argumentsEnum,
-                },
-            ],
-        },
-        messages: {
-            [ALPHABETIZE]: '"{{ currName }}" should be before "{{ prevName }}".',
-        },
-        schema: {
-            type: 'array',
-            minItems: 1,
-            maxItems: 1,
-            items: {
-                type: 'object',
-                additionalProperties: false,
-                minProperties: 1,
-                properties: {
-                    fields: {
-                        type: 'array',
-                        contains: {
-                            enum: fieldsEnum,
-                        },
-                        description: 'Fields of `type`, `interface`, and `input`.',
-                    },
-                    values: {
-                        type: 'array',
-                        contains: {
-                            enum: valuesEnum,
-                        },
-                        description: 'Values of `enum`.',
-                    },
-                    selections: {
-                        type: 'array',
-                        contains: {
-                            enum: selectionsEnum,
-                        },
-                        description: 'Selections of operations (`query`, `mutation` and `subscription`) and `fragment`.',
-                    },
-                    variables: {
-                        type: 'array',
-                        contains: {
-                            enum: variablesEnum,
-                        },
-                        description: 'Variables of operations (`query`, `mutation` and `subscription`).',
-                    },
-                    arguments: {
-                        type: 'array',
-                        contains: {
-                            enum: argumentsEnum,
-                        },
-                        description: 'Arguments of fields and directives.',
-                    },
-                },
-            },
-        },
-    },
-    create(context) {
-        var _a, _b, _c, _d, _e;
-        function checkNodes(nodes) {
-            let prevName = null;
-            for (const node of nodes) {
-                const currName = node.name.value;
-                if (prevName && prevName > currName) {
-                    const { start, end } = node.name.loc;
-                    const isVariableNode = node.kind === Kind.VARIABLE;
-                    context.report({
-                        loc: {
-                            start: {
-                                line: start.line,
-                                column: start.column - (isVariableNode ? 2 : 1),
-                            },
-                            end: {
-                                line: end.line,
-                                column: end.column,
-                            },
-                        },
-                        messageId: ALPHABETIZE,
-                        data: isVariableNode
-                            ? {
-                                currName: `$${currName}`,
-                                prevName: `$${prevName}`,
-                            }
-                            : { currName, prevName },
-                    });
-                }
-                prevName = currName;
-            }
-        }
-        const opts = context.options[0];
-        const fields = new Set((_a = opts.fields) !== null && _a !== void 0 ? _a : []);
-        const listeners = {};
-        const fieldsSelector = [
-            fields.has(Kind.OBJECT_TYPE_DEFINITION) && [Kind.OBJECT_TYPE_DEFINITION, Kind.OBJECT_TYPE_EXTENSION],
-            fields.has(Kind.INTERFACE_TYPE_DEFINITION) && [Kind.INTERFACE_TYPE_DEFINITION, Kind.INTERFACE_TYPE_EXTENSION],
-            fields.has(Kind.INPUT_OBJECT_TYPE_DEFINITION) && [
-                Kind.INPUT_OBJECT_TYPE_DEFINITION,
-                Kind.INPUT_OBJECT_TYPE_EXTENSION,
-            ],
-        ]
-            .flat()
-            .join(',');
-        const hasEnumValues = ((_b = opts.values) === null || _b === void 0 ? void 0 : _b[0]) === Kind.ENUM_TYPE_DEFINITION;
-        const selectionsSelector = (_c = opts.selections) === null || _c === void 0 ? void 0 : _c.join(',');
-        const hasVariables = ((_d = opts.variables) === null || _d === void 0 ? void 0 : _d[0]) === Kind.OPERATION_DEFINITION;
-        const argumentsSelector = (_e = opts.arguments) === null || _e === void 0 ? void 0 : _e.join(',');
-        if (fieldsSelector) {
-            listeners[fieldsSelector] = (node) => {
-                checkNodes(node.fields);
-            };
-        }
-        if (hasEnumValues) {
-            const enumValuesSelector = [Kind.ENUM_TYPE_DEFINITION, Kind.ENUM_TYPE_EXTENSION].join(',');
-            listeners[enumValuesSelector] = (node) => {
-                checkNodes(node.values);
-            };
-        }
-        if (selectionsSelector) {
-            listeners[`:matches(${selectionsSelector}) SelectionSet`] = (node) => {
-                checkNodes(node.selections
-                    // inline fragment don't have name, so we skip them
-                    .filter(selection => selection.kind !== Kind.INLINE_FRAGMENT)
-                    .map(selection => 
-                // sort by alias is field is renamed
-                'alias' in selection && selection.alias ? { name: selection.alias } : selection));
-            };
-        }
-        if (hasVariables) {
-            listeners.OperationDefinition = (node) => {
-                checkNodes(node.variableDefinitions.map(varDef => varDef.variable));
-            };
-        }
-        if (argumentsSelector) {
-            listeners[argumentsSelector] = (node) => {
-                checkNodes(node.arguments);
-            };
-        }
-        return listeners;
-    },
-};
-
 const AVOID_DUPLICATE_FIELDS = 'AVOID_DUPLICATE_FIELDS';
 const ensureUnique = () => {
     const set = new Set();
@@ -732,7 +489,7 @@ const ensureUnique = () => {
         },
     };
 };
-const rule$1 = {
+const rule = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -840,7 +597,7 @@ const rule$1 = {
 };
 
 const AVOID_OPERATION_NAME_PREFIX = 'AVOID_OPERATION_NAME_PREFIX';
-const rule$2 = {
+const rule$1 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -926,7 +683,7 @@ const rule$2 = {
     },
 };
 
-const rule$3 = {
+const rule$2 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -978,7 +735,7 @@ const rule$3 = {
 };
 
 const AVOID_TYPENAME_PREFIX = 'AVOID_TYPENAME_PREFIX';
-const rule$4 = {
+const rule$3 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1032,7 +789,7 @@ const rule$4 = {
     },
 };
 
-const rule$5 = {
+const rule$4 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1043,9 +800,9 @@ const rule$5 = {
                     code: /* GraphQL */ `
             """ Description """
             type someTypeName {
-              # ...
+                ...
             }
-          `,
+            `,
                 },
                 {
                     title: 'Correct',
@@ -1053,9 +810,9 @@ const rule$5 = {
                     code: /* GraphQL */ `
             " Description "
             type someTypeName {
-              # ...
+                ...
             }
-          `,
+            `,
                 },
             ],
             description: 'Require all comments to follow the same style (either block or inline).',
@@ -1092,7 +849,7 @@ const rule$5 = {
     },
 };
 
-const rule$6 = {
+const rule$5 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1217,7 +974,7 @@ const CASE_STYLES = [
 const schemaOption = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
-const rule$7 = {
+const rule$6 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1462,7 +1219,7 @@ function checkNameFormat(params) {
 const schemaOption$1 = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
-const rule$8 = {
+const rule$7 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1574,18 +1331,18 @@ const rule$8 = {
                 style,
                 leadingUnderscore: options.leadingUnderscore,
                 trailingUnderscore: options.trailingUnderscore,
-                prefix,
-                suffix,
-                forbiddenPrefixes,
-                forbiddenSuffixes,
+                prefix: prefix,
+                suffix: suffix,
+                forbiddenPrefixes: forbiddenPrefixes,
+                forbiddenSuffixes: forbiddenSuffixes,
             });
             if (result.ok === false) {
                 context.report({
                     node,
                     message: result.errorMessage,
                     data: {
-                        prefix,
-                        suffix,
+                        prefix: prefix,
+                        suffix: suffix,
                         format: style,
                         forbiddenPrefixes: forbiddenPrefixes.join(', '),
                         forbiddenSuffixes: forbiddenSuffixes.join(', '),
@@ -1691,7 +1448,7 @@ const rule$8 = {
 };
 
 const NO_ANONYMOUS_OPERATIONS = 'NO_ANONYMOUS_OPERATIONS';
-const rule$9 = {
+const rule$8 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1749,7 +1506,7 @@ const rule$9 = {
 };
 
 const ERROR_MESSAGE_ID = 'NO_CASE_INSENSITIVE_ENUM_VALUES_DUPLICATES';
-const rule$a = {
+const rule$9 = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1804,7 +1561,7 @@ const rule$a = {
 };
 
 const NO_DEPRECATED = 'NO_DEPRECATED';
-const rule$b = {
+const rule$a = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -1918,7 +1675,7 @@ const rule$b = {
 };
 
 const HASHTAG_COMMENT = 'HASHTAG_COMMENT';
-const rule$c = {
+const rule$b = {
     meta: {
         messages: {
             [HASHTAG_COMMENT]: 'Using hashtag (#) for adding GraphQL descriptions is not allowed. Prefer using """ for multiline, or " for a single line description.',
@@ -1993,7 +1750,7 @@ const rule$c = {
 };
 
 const NO_OPERATION_NAME_SUFFIX = 'NO_OPERATION_NAME_SUFFIX';
-const rule$d = {
+const rule$c = {
     meta: {
         fixable: 'code',
         type: 'suggestion',
@@ -2048,7 +1805,7 @@ const rule$d = {
 
 const UNREACHABLE_TYPE = 'UNREACHABLE_TYPE';
 const RULE_NAME = 'no-unreachable-types';
-const rule$e = {
+const rule$d = {
     meta: {
         messages: {
             [UNREACHABLE_TYPE]: `Type "{{ typeName }}" is unreachable`,
@@ -2123,7 +1880,7 @@ const rule$e = {
 
 const UNUSED_FIELD = 'UNUSED_FIELD';
 const RULE_NAME$1 = 'no-unused-fields';
-const rule$f = {
+const rule$e = {
     meta: {
         messages: {
             [UNUSED_FIELD]: `Field "{{fieldName}}" is unused`,
@@ -2310,7 +2067,7 @@ const MESSAGE_REQUIRE_DATE = 'MESSAGE_REQUIRE_DATE';
 const MESSAGE_INVALID_FORMAT = 'MESSAGE_INVALID_FORMAT';
 const MESSAGE_INVALID_DATE = 'MESSAGE_INVALID_DATE';
 const MESSAGE_CAN_BE_REMOVED = 'MESSAGE_CAN_BE_REMOVED';
-const rule$g = {
+const rule$f = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2410,7 +2167,7 @@ const rule$g = {
     },
 };
 
-const rule$h = {
+const rule$g = {
     meta: {
         docs: {
             description: `Require all deprecation directives to specify a reason.`,
@@ -2500,7 +2257,7 @@ function verifyRule(context, node) {
         }
     }
 }
-const rule$i = {
+const rule$h = {
     meta: {
         docs: {
             category: 'Best Practices',
@@ -2565,7 +2322,7 @@ const rule$i = {
 };
 
 const RULE_NAME$2 = 'require-field-of-type-query-in-mutation-result';
-const rule$j = {
+const rule$i = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2728,7 +2485,7 @@ const convertNode = (typeInfo) => (node, key, parent) => {
 
 const REQUIRE_ID_WHEN_AVAILABLE = 'REQUIRE_ID_WHEN_AVAILABLE';
 const DEFAULT_ID_FIELD_NAME = 'id';
-const rule$k = {
+const rule$j = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -2864,7 +2621,7 @@ const rule$k = {
     },
 };
 
-const rule$l = {
+const rule$k = {
     meta: {
         docs: {
             category: 'Best Practices',
@@ -2986,7 +2743,7 @@ const shouldIgnoreNode = ({ node, exceptions }) => {
     }
     return false;
 };
-const rule$m = {
+const rule$l = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3176,7 +2933,7 @@ const checkNode = (context, node, ruleName, messageId) => {
         });
     }
 };
-const rule$n = {
+const rule$m = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3234,7 +2991,7 @@ const rule$n = {
 
 const RULE_NAME$4 = 'unique-operation-name';
 const UNIQUE_OPERATION_NAME = 'UNIQUE_OPERATION_NAME';
-const rule$o = {
+const rule$n = {
     meta: {
         type: 'suggestion',
         docs: {
@@ -3299,31 +3056,30 @@ const rule$o = {
  */
 const rules = {
     ...GRAPHQL_JS_VALIDATIONS,
-    alphabetize: rule,
-    'avoid-duplicate-fields': rule$1,
-    'avoid-operation-name-prefix': rule$2,
-    'avoid-scalar-result-type-on-mutation': rule$3,
-    'avoid-typename-prefix': rule$4,
-    'description-style': rule$5,
-    'input-name': rule$6,
-    'match-document-filename': rule$7,
-    'naming-convention': rule$8,
-    'no-anonymous-operations': rule$9,
-    'no-case-insensitive-enum-values-duplicates': rule$a,
-    'no-deprecated': rule$b,
-    'no-hashtag-description': rule$c,
-    'no-operation-name-suffix': rule$d,
-    'no-unreachable-types': rule$e,
-    'no-unused-fields': rule$f,
-    'require-deprecation-date': rule$g,
-    'require-deprecation-reason': rule$h,
-    'require-description': rule$i,
-    'require-field-of-type-query-in-mutation-result': rule$j,
-    'require-id-when-available': rule$k,
-    'selection-set-depth': rule$l,
-    'strict-id-in-types': rule$m,
-    'unique-fragment-name': rule$n,
-    'unique-operation-name': rule$o,
+    'avoid-duplicate-fields': rule,
+    'avoid-operation-name-prefix': rule$1,
+    'avoid-scalar-result-type-on-mutation': rule$2,
+    'avoid-typename-prefix': rule$3,
+    'description-style': rule$4,
+    'input-name': rule$5,
+    'match-document-filename': rule$6,
+    'naming-convention': rule$7,
+    'no-anonymous-operations': rule$8,
+    'no-case-insensitive-enum-values-duplicates': rule$9,
+    'no-deprecated': rule$a,
+    'no-hashtag-description': rule$b,
+    'no-operation-name-suffix': rule$c,
+    'no-unreachable-types': rule$d,
+    'no-unused-fields': rule$e,
+    'require-deprecation-date': rule$f,
+    'require-deprecation-reason': rule$g,
+    'require-description': rule$h,
+    'require-field-of-type-query-in-mutation-result': rule$i,
+    'require-id-when-available': rule$j,
+    'selection-set-depth': rule$k,
+    'strict-id-in-types': rule$l,
+    'unique-fragment-name': rule$m,
+    'unique-operation-name': rule$n,
 };
 
 const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "2.3.0-alpha-4c161e5.0",
+  "version": "2.3.0-alpha-6ba4002.0",
   "sideEffects": false,
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0"

package/rules/index.d.ts

@@ -1,11 +1,4 @@
 export declare const rules: {
-    alphabetize: import("..").GraphQLESLintRule<[{
-        fields?: ("ObjectTypeDefinition" | "InterfaceTypeDefinition" | "InputObjectTypeDefinition")[];
-        values?: "EnumTypeDefinition"[];
-        selections?: ("OperationDefinition" | "FragmentDefinition")[];
-        variables?: "OperationDefinition"[];
-        arguments?: ("Field" | "Directive" | "FieldDefinition" | "DirectiveDefinition")[];
-    }], false>;
     'avoid-duplicate-fields': import("..").GraphQLESLintRule<[], false>;
     'avoid-operation-name-prefix': import("..").GraphQLESLintRule<import("./avoid-operation-name-prefix").AvoidOperationNamePrefixConfig, false>;
     'avoid-scalar-result-type-on-mutation': import("..").GraphQLESLintRule<any[], false>;

package/testkit.d.ts

@@ -2,7 +2,7 @@ import { RuleTester } from 'eslint';
 import { ASTKindToNode } from 'graphql';
 import { GraphQLESTreeNode } from './estree-parser';
 import { GraphQLESLintRule, ParserOptions } from './types';
-export declare type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = {
+export declare type GraphQLESLintRuleListener<WithTypeInfo extends boolean> = {
     [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
 } & Record<string, any>;
 export declare type GraphQLValidTestCase<Options> = Omit<RuleTester.ValidTestCase, 'options' | 'parserOptions'> & {

package/types.d.ts

@@ -55,7 +55,6 @@ export declare type RuleDocsInfo<T> = Rule.RuleMetaData & {
             code: string;
             usage?: T;
         }[];
-        optionsForConfig?: T;
     };
 };
 export declare type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = false> = {