@graphql-eslint/eslint-plugin 3.14.4-alpha-20230111223410-a558ee8 → 3.14.4-alpha-20230111225020-02d9c28

package/esm/rules/require-deprecation-date.js

@@ -25,7 +25,7 @@ export const rule = {
         docs: {
             category: 'Schema',
             description: 'Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.',
-            url: 'https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/require-deprecation-date.md',
+            url: 'https://the-guild.dev/graphql/eslint/rules/require-deprecation-date',
             examples: [
                 {
                     title: 'Incorrect',

package/esm/rules/require-deprecation-reason.js

@@ -4,7 +4,7 @@ export const rule = {
         docs: {
             description: 'Require all deprecation directives to specify a reason.',
             category: 'Schema',
-            url: 'https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/require-deprecation-reason.md',
+            url: 'https://the-guild.dev/graphql/eslint/rules/require-deprecation-reason',
             recommended: true,
             examples: [
                 {

package/esm/rules/require-description.js

@@ -71,7 +71,7 @@ export const rule = {
         docs: {
             category: 'Schema',
             description: 'Enforce descriptions in type definitions and operations.',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             examples: [
                 {
                     title: 'Incorrect',

package/esm/rules/require-field-of-type-query-in-mutation-result.js

@@ -7,7 +7,7 @@ export const rule = {
         docs: {
             category: 'Schema',
             description: 'Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.\n> Currently, no errors are reported for result type `union`, `interface` and `scalar`.',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             requiresSchema: true,
             examples: [
                 {

package/esm/rules/require-id-when-available.js

@@ -31,7 +31,7 @@ export const rule = {
         docs: {
             category: 'Operations',
             description: 'Enforce selecting specific fields when they are available on the GraphQL type.',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             requiresSchema: true,
             requiresSiblings: true,
             examples: [

package/esm/rules/require-nullable-fields-with-oneof.js

@@ -6,7 +6,7 @@ export const rule = {
         docs: {
             category: 'Schema',
             description: 'Require `input` or `type` fields to be non-nullable with `@oneOf` directive.',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             examples: [
                 {
                     title: 'Incorrect',

package/esm/rules/require-type-pattern-with-oneof.js

@@ -5,7 +5,7 @@ export const rule = {
         docs: {
             category: 'Schema',
             description: 'Enforce types with `@oneOf` directive have `error` and `ok` fields.',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             examples: [
                 {
                     title: 'Correct',

package/esm/rules/selection-set-depth.js

@@ -25,7 +25,7 @@ export const rule = {
         docs: {
             category: 'Operations',
             description: 'Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             requiresSiblings: true,
             examples: [
                 {

package/esm/rules/strict-id-in-types.js

@@ -40,7 +40,7 @@ export const rule = {
             description: 'Requires output types to have one unique identifier unless they do not have a logical one. Exceptions can be used to ignore output types that do not have unique identifiers.',
             category: 'Schema',
             recommended: true,
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             requiresSchema: true,
             examples: [
                 {

package/esm/rules/unique-fragment-name.js

@@ -35,7 +35,7 @@ export const rule = {
         docs: {
             category: 'Operations',
             description: 'Enforce unique fragment names across your project.',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             requiresSiblings: true,
             examples: [
                 {

package/esm/rules/unique-operation-name.js

@@ -6,7 +6,7 @@ export const rule = {
         docs: {
             category: 'Operations',
             description: 'Enforce unique operation names across your project.',
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             requiresSiblings: true,
             examples: [
                 {

package/esm/siblings.js

@@ -0,0 +1,109 @@
+import { parseGraphQLSDL } from '@graphql-tools/utils';
+import { Kind, visit, } from 'graphql';
+import { getDocuments } from './documents.js';
+import { logger } from './utils.js';
+const siblingOperationsCache = new Map();
+export function getSiblings(project, documents) {
+    const siblings = project
+        ? getDocuments(project)
+        : typeof documents === 'string'
+            ? [parseGraphQLSDL('operation.graphql', documents, { noLocation: true })]
+            : [];
+    if (siblings.length === 0) {
+        let printed = false;
+        const noopWarn = () => {
+            if (!printed) {
+                logger.warn('getSiblingOperations was called without any operations. Make sure to set "parserOptions.operations" to make this feature available!');
+                printed = true;
+            }
+            return [];
+        };
+        return {
+            available: false,
+            getFragment: noopWarn,
+            getFragments: noopWarn,
+            getFragmentByType: noopWarn,
+            getFragmentsInUse: noopWarn,
+            getOperation: noopWarn,
+            getOperations: noopWarn,
+            getOperationByType: noopWarn,
+        };
+    }
+    // Since the siblings array is cached, we can use it as cache key.
+    // We should get the same array reference each time we get
+    // to this point for the same graphql project
+    const value = siblingOperationsCache.get(siblings);
+    if (value) {
+        return value;
+    }
+    let fragmentsCache = null;
+    const getFragments = () => {
+        var _a;
+        if (fragmentsCache === null) {
+            const result = [];
+            for (const source of siblings) {
+                for (const definition of ((_a = source.document) === null || _a === void 0 ? void 0 : _a.definitions) || []) {
+                    if (definition.kind === Kind.FRAGMENT_DEFINITION) {
+                        result.push({
+                            filePath: source.location,
+                            document: definition,
+                        });
+                    }
+                }
+            }
+            fragmentsCache = result;
+        }
+        return fragmentsCache;
+    };
+    let cachedOperations = null;
+    const getOperations = () => {
+        var _a;
+        if (cachedOperations === null) {
+            const result = [];
+            for (const source of siblings) {
+                for (const definition of ((_a = source.document) === null || _a === void 0 ? void 0 : _a.definitions) || []) {
+                    if (definition.kind === Kind.OPERATION_DEFINITION) {
+                        result.push({
+                            filePath: source.location,
+                            document: definition,
+                        });
+                    }
+                }
+            }
+            cachedOperations = result;
+        }
+        return cachedOperations;
+    };
+    const getFragment = (name) => getFragments().filter(f => { var _a; return ((_a = f.document.name) === null || _a === void 0 ? void 0 : _a.value) === name; });
+    const collectFragments = (selectable, recursive, collected = new Map()) => {
+        visit(selectable, {
+            FragmentSpread(spread) {
+                const fragmentName = spread.name.value;
+                const [fragment] = getFragment(fragmentName);
+                if (!fragment) {
+                    logger.warn(`Unable to locate fragment named "${fragmentName}", please make sure it's loaded using "parserOptions.operations"`);
+                    return;
+                }
+                if (!collected.has(fragmentName)) {
+                    collected.set(fragmentName, fragment.document);
+                    if (recursive) {
+                        collectFragments(fragment.document, recursive, collected);
+                    }
+                }
+            },
+        });
+        return collected;
+    };
+    const siblingOperations = {
+        available: true,
+        getFragment,
+        getFragments,
+        getFragmentByType: typeName => getFragments().filter(f => { var _a, _b; return ((_b = (_a = f.document.typeCondition) === null || _a === void 0 ? void 0 : _a.name) === null || _b === void 0 ? void 0 : _b.value) === typeName; }),
+        getFragmentsInUse: (selectable, recursive = true) => Array.from(collectFragments(selectable, recursive).values()),
+        getOperation: name => getOperations().filter(o => { var _a; return ((_a = o.document.name) === null || _a === void 0 ? void 0 : _a.value) === name; }),
+        getOperations,
+        getOperationByType: type => getOperations().filter(o => o.document.operation === type),
+    };
+    siblingOperationsCache.set(siblings, siblingOperations);
+    return siblingOperations;
+}

package/esm/utils.js

@@ -29,6 +29,7 @@ export const logger = {
 export const normalizePath = (path) => (path || '').replace(/\\/g, '/');
 export const VIRTUAL_DOCUMENT_REGEX = /\/\d+_document.graphql$/;
 export const CWD = process.cwd();
+export const IS_BROWSER = typeof window !== 'undefined';
 export const getTypeName = (node) => 'type' in node ? getTypeName(node.type) : 'name' in node && node.name ? node.name.value : '';
 export const TYPES_KINDS = [
     Kind.OBJECT_TYPE_DEFINITION,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.14.4-alpha-20230111223410-a558ee8",
+  "version": "3.14.4-alpha-20230111225020-02d9c28",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/typings/documents.d.cts

@@ -1,21 +1,3 @@
-import { FragmentDefinitionNode, OperationDefinitionNode, OperationTypeNode, SelectionSetNode } from 'graphql';
+import { Source } from '@graphql-tools/utils';
 import { GraphQLProjectConfig } from 'graphql-config';
-export type FragmentSource = {
-    filePath: string;
-    document: FragmentDefinitionNode;
-};
-export type OperationSource = {
-    filePath: string;
-    document: OperationDefinitionNode;
-};
-export type SiblingOperations = {
-    available: boolean;
-    getFragment(fragmentName: string): FragmentSource[];
-    getFragments(): FragmentSource[];
-    getFragmentByType(typeName: string): FragmentSource[];
-    getFragmentsInUse(baseOperation: OperationDefinitionNode | FragmentDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
-    getOperation(operationName: string): OperationSource[];
-    getOperations(): OperationSource[];
-    getOperationByType(operationType: OperationTypeNode): OperationSource[];
-};
-export declare function getDocuments(project: GraphQLProjectConfig): SiblingOperations;
+export declare const getDocuments: (project: GraphQLProjectConfig) => Source[];

package/typings/documents.d.ts

@@ -1,21 +1,3 @@
-import { FragmentDefinitionNode, OperationDefinitionNode, OperationTypeNode, SelectionSetNode } from 'graphql';
+import { Source } from '@graphql-tools/utils';
 import { GraphQLProjectConfig } from 'graphql-config';
-export type FragmentSource = {
-    filePath: string;
-    document: FragmentDefinitionNode;
-};
-export type OperationSource = {
-    filePath: string;
-    document: OperationDefinitionNode;
-};
-export type SiblingOperations = {
-    available: boolean;
-    getFragment(fragmentName: string): FragmentSource[];
-    getFragments(): FragmentSource[];
-    getFragmentByType(typeName: string): FragmentSource[];
-    getFragmentsInUse(baseOperation: OperationDefinitionNode | FragmentDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
-    getOperation(operationName: string): OperationSource[];
-    getOperations(): OperationSource[];
-    getOperationByType(operationType: OperationTypeNode): OperationSource[];
-};
-export declare function getDocuments(project: GraphQLProjectConfig): SiblingOperations;
+export declare const getDocuments: (project: GraphQLProjectConfig) => Source[];

package/typings/rules/input-name.d.cts

@@ -10,7 +10,7 @@ declare const schema: {
             readonly checkInputType: {
                 readonly type: "boolean";
                 readonly default: false;
-                readonly description: "Check that the input type name follows the convention <mutationName>Input";
+                readonly description: "Check that the input type name follows the convention \\<mutationName>Input";
             };
             readonly caseSensitiveInputType: {
                 readonly type: "boolean";

package/typings/rules/input-name.d.ts

@@ -10,7 +10,7 @@ declare const schema: {
             readonly checkInputType: {
                 readonly type: "boolean";
                 readonly default: false;
-                readonly description: "Check that the input type name follows the convention <mutationName>Input";
+                readonly description: "Check that the input type name follows the convention \\<mutationName>Input";
             };
             readonly caseSensitiveInputType: {
                 readonly type: "boolean";

package/typings/siblings.d.cts

@@ -0,0 +1,22 @@
+import { FragmentDefinitionNode, OperationDefinitionNode, OperationTypeNode, SelectionSetNode } from 'graphql';
+import { GraphQLProjectConfig } from 'graphql-config';
+import { ParserOptions } from './types.cjs';
+export type FragmentSource = {
+    filePath: string;
+    document: FragmentDefinitionNode;
+};
+export type OperationSource = {
+    filePath: string;
+    document: OperationDefinitionNode;
+};
+export type SiblingOperations = {
+    available: boolean;
+    getFragment(fragmentName: string): FragmentSource[];
+    getFragments(): FragmentSource[];
+    getFragmentByType(typeName: string): FragmentSource[];
+    getFragmentsInUse(baseOperation: OperationDefinitionNode | FragmentDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
+    getOperation(operationName: string): OperationSource[];
+    getOperations(): OperationSource[];
+    getOperationByType(operationType: OperationTypeNode): OperationSource[];
+};
+export declare function getSiblings(project?: GraphQLProjectConfig, documents?: ParserOptions['documents']): SiblingOperations;

package/typings/siblings.d.ts

@@ -0,0 +1,22 @@
+import { FragmentDefinitionNode, OperationDefinitionNode, OperationTypeNode, SelectionSetNode } from 'graphql';
+import { GraphQLProjectConfig } from 'graphql-config';
+import { ParserOptions } from './types.js';
+export type FragmentSource = {
+    filePath: string;
+    document: FragmentDefinitionNode;
+};
+export type OperationSource = {
+    filePath: string;
+    document: OperationDefinitionNode;
+};
+export type SiblingOperations = {
+    available: boolean;
+    getFragment(fragmentName: string): FragmentSource[];
+    getFragments(): FragmentSource[];
+    getFragmentByType(typeName: string): FragmentSource[];
+    getFragmentsInUse(baseOperation: OperationDefinitionNode | FragmentDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
+    getOperation(operationName: string): OperationSource[];
+    getOperations(): OperationSource[];
+    getOperationByType(operationType: OperationTypeNode): OperationSource[];
+};
+export declare function getSiblings(project?: GraphQLProjectConfig, documents?: ParserOptions['documents']): SiblingOperations;

package/typings/types.d.cts

@@ -4,7 +4,7 @@ import * as ESTree from 'estree';
 import { GraphQLSchema } from 'graphql';
 import { IExtensions, IGraphQLProject } from 'graphql-config';
 import { JSONSchema } from 'json-schema-to-ts';
-import { SiblingOperations } from './documents.cjs';
+import { SiblingOperations } from './siblings.cjs';
 import { GraphQLESLintRuleListener } from './testkit.cjs';
 export type Schema = GraphQLSchema | Error | null;
 export type Pointer = string | string[];
@@ -13,7 +13,6 @@ export interface ParserOptions {
         headers: Record<string, string>;
     }>;
     documents?: Pointer;
-    operations?: Pointer;
     extensions?: IExtensions;
     include?: Pointer;
     exclude?: Pointer;
@@ -24,6 +23,8 @@ export interface ParserOptions {
     graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
     skipGraphQLConfig?: boolean;
     filePath: string;
+    /** @deprecated Use `documents` instead */
+    operations?: Pointer;
 }
 export type ParserServices = {
     schema: Schema;

package/typings/types.d.ts

@@ -4,7 +4,7 @@ import * as ESTree from 'estree';
 import { GraphQLSchema } from 'graphql';
 import { IExtensions, IGraphQLProject } from 'graphql-config';
 import { JSONSchema } from 'json-schema-to-ts';
-import { SiblingOperations } from './documents.js';
+import { SiblingOperations } from './siblings.js';
 import { GraphQLESLintRuleListener } from './testkit.js';
 export type Schema = GraphQLSchema | Error | null;
 export type Pointer = string | string[];
@@ -13,7 +13,6 @@ export interface ParserOptions {
         headers: Record<string, string>;
     }>;
     documents?: Pointer;
-    operations?: Pointer;
     extensions?: IExtensions;
     include?: Pointer;
     exclude?: Pointer;
@@ -24,6 +23,8 @@ export interface ParserOptions {
     graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
     skipGraphQLConfig?: boolean;
     filePath: string;
+    /** @deprecated Use `documents` instead */
+    operations?: Pointer;
 }
 export type ParserServices = {
     schema: Schema;

package/typings/utils.d.cts

@@ -1,7 +1,7 @@
 import { AST } from 'eslint';
 import { Position } from 'estree';
 import { ASTNode, GraphQLSchema, Kind } from 'graphql';
-import { SiblingOperations } from './documents.cjs';
+import { SiblingOperations } from './siblings.cjs';
 import { GraphQLESLintRuleContext } from './types.cjs';
 export declare function requireSiblingsOperations(ruleId: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
 export declare function requireGraphQLSchemaFromContext(ruleId: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
@@ -12,6 +12,7 @@ export declare const logger: {
 export declare const normalizePath: (path: string) => string;
 export declare const VIRTUAL_DOCUMENT_REGEX: RegExp;
 export declare const CWD: string;
+export declare const IS_BROWSER: boolean;
 export declare const getTypeName: (node: ASTNode) => string;
 export declare const TYPES_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION];
 export type CaseStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE' | 'kebab-case';

package/typings/utils.d.ts

@@ -1,7 +1,7 @@
 import { AST } from 'eslint';
 import { Position } from 'estree';
 import { ASTNode, GraphQLSchema, Kind } from 'graphql';
-import { SiblingOperations } from './documents.js';
+import { SiblingOperations } from './siblings.js';
 import { GraphQLESLintRuleContext } from './types.js';
 export declare function requireSiblingsOperations(ruleId: string, context: GraphQLESLintRuleContext): SiblingOperations | never;
 export declare function requireGraphQLSchemaFromContext(ruleId: string, context: GraphQLESLintRuleContext): GraphQLSchema | never;
@@ -12,6 +12,7 @@ export declare const logger: {
 export declare const normalizePath: (path: string) => string;
 export declare const VIRTUAL_DOCUMENT_REGEX: RegExp;
 export declare const CWD: string;
+export declare const IS_BROWSER: boolean;
 export declare const getTypeName: (node: ASTNode) => string;
 export declare const TYPES_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION];
 export type CaseStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE' | 'kebab-case';

package/docs/rules/alphabetize.md

@@ -1,194 +0,0 @@
-# `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)
-- 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 can contain the following enum values:
-
-- `ObjectTypeDefinition`
-- `InterfaceTypeDefinition`
-- `InputObjectTypeDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `values` (array)
-
-Values of `enum`.
-
-The elements of the array can contain the following enum values:
-
-- `EnumTypeDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `selections` (array)
-
-Selections of `fragment` and operations `query`, `mutation` and `subscription`.
-
-The elements of the array can contain the following enum values:
-
-- `OperationDefinition`
-- `FragmentDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `variables` (array)
-
-Variables of operations `query`, `mutation` and `subscription`.
-
-The elements of the array can contain the following enum values:
-
-- `OperationDefinition`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `arguments` (array)
-
-Arguments of fields and directives.
-
-The elements of the array can contain the following enum values:
-
-- `FieldDefinition`
-- `Field`
-- `DirectiveDefinition`
-- `Directive`
-
-Additional restrictions:
-
-- Minimum items: `1`
-- Unique items: `true`
-
-### `definitions` (boolean)
-
-Definitions – `type`, `interface`, `enum`, `scalar`, `input`, `union` and `directive`.
-
-Default: `false`
-
-### `groups` (array)
-
-Custom order group. Example: `['id', '*', 'createdAt', 'updatedAt']` where `*` says for everything
-else.
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-- Minimum items: `2`
-- Unique items: `true`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/alphabetize.ts)
-- [Test source](../../packages/plugin/tests/alphabetize.spec.ts)