@graphql-eslint/eslint-plugin 3.0.0-alpha-069461d.0 → 3.0.0-alpha-698204a.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.0.0-alpha-069461d.0",
+  "version": "3.0.0-alpha-698204a.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 || ^16.0.0"

package/rules/alphabetize.d.ts

@@ -4,14 +4,12 @@ declare const valuesEnum: ['EnumTypeDefinition'];
 declare const selectionsEnum: ('OperationDefinition' | 'FragmentDefinition')[];
 declare const variablesEnum: ['OperationDefinition'];
 declare const argumentsEnum: ('FieldDefinition' | 'Field' | 'DirectiveDefinition' | 'Directive')[];
-declare type AlphabetizeConfig = [
-    {
-        fields?: typeof fieldsEnum;
-        values?: typeof valuesEnum;
-        selections?: typeof selectionsEnum;
-        variables?: typeof variablesEnum;
-        arguments?: typeof argumentsEnum;
-    }
-];
-declare const rule: GraphQLESLintRule<AlphabetizeConfig>;
+declare type AlphabetizeConfig = {
+    fields?: typeof fieldsEnum;
+    values?: typeof valuesEnum;
+    selections?: typeof selectionsEnum;
+    variables?: typeof variablesEnum;
+    arguments?: typeof argumentsEnum;
+};
+declare const rule: GraphQLESLintRule<[AlphabetizeConfig]>;
 export default rule;

package/rules/description-style.d.ts

@@ -1,8 +1,6 @@
 import { GraphQLESLintRule } from '../types';
-declare type DescriptionStyleRuleConfig = [
-    {
-        style: 'inline' | 'block';
-    }
-];
-declare const rule: GraphQLESLintRule<DescriptionStyleRuleConfig>;
+declare type DescriptionStyleRuleConfig = {
+    style: 'inline' | 'block';
+};
+declare const rule: GraphQLESLintRule<[DescriptionStyleRuleConfig]>;
 export default rule;

package/rules/index.d.ts

@@ -6,19 +6,15 @@ export declare const rules: {
         variables?: ["OperationDefinition"];
         arguments?: ("Field" | "Directive" | "FieldDefinition" | "DirectiveDefinition")[];
     }], false>;
-    'avoid-duplicate-fields': import("..").GraphQLESLintRule<any[], false>;
-    'avoid-operation-name-prefix': import("..").GraphQLESLintRule<import("./avoid-operation-name-prefix").AvoidOperationNamePrefixConfig, false>;
-    'avoid-scalar-result-type-on-mutation': import("..").GraphQLESLintRule<any[], false>;
-    'avoid-typename-prefix': import("..").GraphQLESLintRule<any[], false>;
     'description-style': import("..").GraphQLESLintRule<[{
         style: "block" | "inline";
     }], false>;
-    'input-name': import("..").GraphQLESLintRule<{
+    'input-name': import("..").GraphQLESLintRule<[{
         checkInputType?: boolean;
         caseSensitiveInputType?: boolean;
         checkQueries?: boolean;
         checkMutations?: boolean;
-    }[], false>;
+    }], false>;
     'match-document-filename': import("..").GraphQLESLintRule<[{
         fileExtension?: ".gql" | ".graphql";
         query?: import("../utils").CaseStyle | {
@@ -159,11 +155,13 @@ export declare const rules: {
     'no-anonymous-operations': import("..").GraphQLESLintRule<any[], false>;
     'no-case-insensitive-enum-values-duplicates': import("..").GraphQLESLintRule<any[], false>;
     'no-deprecated': import("..").GraphQLESLintRule<[], true>;
+    'no-duplicate-fields': import("..").GraphQLESLintRule<any[], false>;
     'no-hashtag-description': import("..").GraphQLESLintRule<any[], false>;
-    'no-operation-name-suffix': import("..").GraphQLESLintRule<any[], false>;
     'no-root-type': import("..").GraphQLESLintRule<[{
         disallow: ("query" | "mutation" | "subscription")[];
     }], false>;
+    'no-scalar-result-type-on-mutation': import("..").GraphQLESLintRule<any[], false>;
+    'no-typename-prefix': import("..").GraphQLESLintRule<any[], false>;
     'no-unreachable-types': import("..").GraphQLESLintRule<any[], false>;
     'no-unused-fields': import("..").GraphQLESLintRule<any[], false>;
     'require-deprecation-date': import("..").GraphQLESLintRule<[{
@@ -171,7 +169,19 @@ export declare const rules: {
     }], false>;
     'require-deprecation-reason': import("..").GraphQLESLintRule<any[], false>;
     'require-description': import("..").GraphQLESLintRule<[{
-        on: import("graphql").Kind[];
+        types?: boolean;
+        overrides?: {
+            ScalarTypeDefinition?: boolean;
+            ObjectTypeDefinition?: boolean;
+            FieldDefinition?: boolean;
+            InputValueDefinition?: boolean;
+            InterfaceTypeDefinition?: boolean;
+            UnionTypeDefinition?: boolean;
+            EnumTypeDefinition?: boolean;
+            EnumValueDefinition?: boolean;
+            InputObjectTypeDefinition?: boolean;
+            DirectiveDefinition?: boolean;
+        };
     }], false>;
     'require-field-of-type-query-in-mutation-result': import("..").GraphQLESLintRule<any[], false>;
     'require-id-when-available': import("..").GraphQLESLintRule<[{

package/rules/input-name.d.ts

@@ -5,5 +5,5 @@ declare type InputNameRuleConfig = {
     checkQueries?: boolean;
     checkMutations?: boolean;
 };
-declare const rule: GraphQLESLintRule<InputNameRuleConfig[]>;
+declare const rule: GraphQLESLintRule<[InputNameRuleConfig]>;
 export default rule;

package/rules/match-document-filename.d.ts

@@ -5,14 +5,12 @@ declare type PropertySchema = {
     style: CaseStyle;
     suffix: string;
 };
-declare type MatchDocumentFilenameRuleConfig = [
-    {
-        fileExtension?: typeof ACCEPTED_EXTENSIONS[number];
-        query?: CaseStyle | PropertySchema;
-        mutation?: CaseStyle | PropertySchema;
-        subscription?: CaseStyle | PropertySchema;
-        fragment?: CaseStyle | PropertySchema;
-    }
-];
-declare const rule: GraphQLESLintRule<MatchDocumentFilenameRuleConfig>;
+declare type MatchDocumentFilenameRuleConfig = {
+    fileExtension?: typeof ACCEPTED_EXTENSIONS[number];
+    query?: CaseStyle | PropertySchema;
+    mutation?: CaseStyle | PropertySchema;
+    subscription?: CaseStyle | PropertySchema;
+    fragment?: CaseStyle | PropertySchema;
+};
+declare const rule: GraphQLESLintRule<[MatchDocumentFilenameRuleConfig]>;
 export default rule;

package/rules/naming-convention.d.ts

@@ -8,12 +8,12 @@ declare const KindToDisplayName: {
     UnionTypeDefinition: string;
     FieldDefinition: string;
     InputValueDefinition: string;
-    VariableDefinition: string;
     Argument: string;
     DirectiveDefinition: string;
     EnumValueDefinition: string;
     OperationDefinition: string;
     FragmentDefinition: string;
+    VariableDefinition: string;
 };
 declare type AllowedKind = keyof typeof KindToDisplayName;
 declare type AllowedStyle = 'camelCase' | 'PascalCase' | 'snake_case' | 'UPPER_CASE';

package/rules/require-description.d.ts

@@ -1,8 +1,12 @@
-import { GraphQLESLintRule } from '../types';
 import { Kind } from 'graphql';
-declare const DESCRIBABLE_NODES: Kind[];
-declare type RequireDescriptionRuleConfig = [{
-    on: typeof DESCRIBABLE_NODES;
-}];
-declare const rule: GraphQLESLintRule<RequireDescriptionRuleConfig>;
+import { GraphQLESLintRule } from '../types';
+declare const ALLOWED_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, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.DIRECTIVE_DEFINITION];
+declare type AllowedKind = typeof ALLOWED_KINDS[number];
+declare type RequireDescriptionRuleConfig = {
+    types?: boolean;
+    overrides?: {
+        [key in AllowedKind]?: boolean;
+    };
+};
+declare const rule: GraphQLESLintRule<[RequireDescriptionRuleConfig]>;
 export default rule;

package/rules/require-id-when-available.d.ts

@@ -1,6 +1,6 @@
 import { GraphQLESLintRule } from '../types';
-declare type RequireIdWhenAvailableRuleConfig = [{
+declare type RequireIdWhenAvailableRuleConfig = {
     fieldName: string;
-}];
-declare const rule: GraphQLESLintRule<RequireIdWhenAvailableRuleConfig, true>;
+};
+declare const rule: GraphQLESLintRule<[RequireIdWhenAvailableRuleConfig], true>;
 export default rule;

package/rules/selection-set-depth.d.ts

@@ -1,7 +1,7 @@
 import { GraphQLESLintRule } from '../types';
-declare type SelectionSetDepthRuleConfig = [{
+declare type SelectionSetDepthRuleConfig = {
     maxDepth: number;
     ignore?: string[];
-}];
-declare const rule: GraphQLESLintRule<SelectionSetDepthRuleConfig>;
+};
+declare const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]>;
 export default rule;

package/rules/strict-id-in-types.d.ts

@@ -3,12 +3,10 @@ export interface ExceptionRule {
     types?: string[];
     suffixes?: string[];
 }
-declare type StrictIdInTypesRuleConfig = [
-    {
-        acceptedIdNames?: string[];
-        acceptedIdTypes?: string[];
-        exceptions?: ExceptionRule;
-    }
-];
-declare const rule: GraphQLESLintRule<StrictIdInTypesRuleConfig>;
+declare type StrictIdInTypesRuleConfig = {
+    acceptedIdNames?: string[];
+    acceptedIdTypes?: string[];
+    exceptions?: ExceptionRule;
+};
+declare const rule: GraphQLESLintRule<[StrictIdInTypesRuleConfig]>;
 export default rule;

package/types.d.ts

@@ -45,9 +45,10 @@ export declare type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleCo
     })): void;
     parserServices?: ParserServices;
 };
-export declare type RuleDocsInfo<T> = Rule.RuleMetaData & {
-    docs: {
-        category: 'Best Practices' | 'Stylistic Issues' | 'Validation';
+export declare type CategoryType = 'Schema' | 'Operations';
+export declare type RuleDocsInfo<T> = {
+    docs: Omit<Rule.RuleMetaData['docs'], 'category'> & {
+        category: CategoryType | CategoryType[];
         requiresSchema?: boolean;
         requiresSiblings?: boolean;
         examples?: {
@@ -55,12 +56,15 @@ export declare type RuleDocsInfo<T> = Rule.RuleMetaData & {
             code: string;
             usage?: T;
         }[];
-        optionsForConfig?: T;
+        configOptions?: T | {
+            schema?: T;
+            operations?: T;
+        };
         graphQLJSRuleName?: string;
     };
 };
 export declare type GraphQLESLintRule<Options = any[], WithTypeInfo extends boolean = false> = {
     create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
-    meta: Rule.RuleMetaData & RuleDocsInfo<Options>;
+    meta: Omit<Rule.RuleMetaData, 'docs'> & RuleDocsInfo<Options>;
 };
 export declare type ValueOf<T> = T[keyof T];

package/utils.d.ts

@@ -19,7 +19,7 @@ export declare const normalizePath: (path: string) => string;
 export declare const getOnDiskFilepath: (filepath: string) => string;
 export declare const getTypeName: (node: any) => any;
 export declare const loaderCache: Record<string, LoaderSource[]>;
-export declare const TYPES_KINDS: Kind[];
+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 declare enum CaseStyle {
     camelCase = "camelCase",
     pascalCase = "PascalCase",

package/configs/all.d.ts

@@ -1,99 +0,0 @@
-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;
-        '@graphql-eslint/description-style': string;
-        '@graphql-eslint/input-name': string;
-        '@graphql-eslint/match-document-filename': string;
-        '@graphql-eslint/no-deprecated': string;
-        '@graphql-eslint/no-hashtag-description': string;
-        '@graphql-eslint/no-root-type': (string | {
-            disallow: string[];
-        })[];
-        '@graphql-eslint/no-unreachable-types': string;
-        '@graphql-eslint/no-unused-fields': string;
-        '@graphql-eslint/require-deprecation-date': string;
-        '@graphql-eslint/require-description': string;
-        '@graphql-eslint/require-field-of-type-query-in-mutation-result': string;
-        '@graphql-eslint/require-id-when-available': string;
-        '@graphql-eslint/selection-set-depth': string;
-        '@graphql-eslint/unique-fragment-name': string;
-        '@graphql-eslint/unique-operation-name': string;
-        '@graphql-eslint/avoid-typename-prefix': string;
-        '@graphql-eslint/executable-definitions': string;
-        '@graphql-eslint/fields-on-correct-type': string;
-        '@graphql-eslint/fragments-on-composite-type': string;
-        '@graphql-eslint/known-argument-names': string;
-        '@graphql-eslint/known-directives': string;
-        '@graphql-eslint/known-fragment-names': string;
-        '@graphql-eslint/known-type-names': string;
-        '@graphql-eslint/lone-anonymous-operation': string;
-        '@graphql-eslint/lone-schema-definition': string;
-        '@graphql-eslint/naming-convention': (string | {
-            types: string;
-            fields: string;
-            overrides: {
-                EnumValueDefinition: string;
-                OperationDefinition: {
-                    style: string;
-                    forbiddenPrefixes: string[];
-                    forbiddenSuffixes: string[];
-                };
-                FragmentDefinition: {
-                    style: string;
-                    forbiddenPrefixes: string[];
-                    forbiddenSuffixes: string[];
-                };
-                'FieldDefinition[parent.name.value=Query]': {
-                    forbiddenPrefixes: string[];
-                    forbiddenSuffixes: string[];
-                };
-                'FieldDefinition[parent.name.value=Mutation]': {
-                    forbiddenPrefixes: string[];
-                    forbiddenSuffixes: string[];
-                };
-                'FieldDefinition[parent.name.value=Subscription]': {
-                    forbiddenPrefixes: string[];
-                    forbiddenSuffixes: string[];
-                };
-            };
-        })[];
-        '@graphql-eslint/no-anonymous-operations': string;
-        '@graphql-eslint/no-case-insensitive-enum-values-duplicates': string;
-        '@graphql-eslint/no-fragment-cycles': string;
-        '@graphql-eslint/no-operation-name-suffix': string;
-        '@graphql-eslint/no-undefined-variables': string;
-        '@graphql-eslint/no-unused-fragments': string;
-        '@graphql-eslint/no-unused-variables': string;
-        '@graphql-eslint/one-field-subscriptions': string;
-        '@graphql-eslint/overlapping-fields-can-be-merged': string;
-        '@graphql-eslint/possible-fragment-spread': string;
-        '@graphql-eslint/possible-type-extension': string;
-        '@graphql-eslint/provided-required-arguments': string;
-        '@graphql-eslint/require-deprecation-reason': string;
-        '@graphql-eslint/scalar-leafs': string;
-        '@graphql-eslint/strict-id-in-types': string;
-        '@graphql-eslint/unique-argument-names': string;
-        '@graphql-eslint/unique-directive-names': string;
-        '@graphql-eslint/unique-directive-names-per-location': string;
-        '@graphql-eslint/unique-enum-value-names': string;
-        '@graphql-eslint/unique-field-definition-names': string;
-        '@graphql-eslint/unique-input-field-names': string;
-        '@graphql-eslint/unique-operation-types': string;
-        '@graphql-eslint/unique-type-names': string;
-        '@graphql-eslint/unique-variable-names': string;
-        '@graphql-eslint/value-literals-of-correct-type': string;
-        '@graphql-eslint/variables-are-input-types': string;
-        '@graphql-eslint/variables-in-allowed-position': string;
-    };
-    parser: string;
-    plugins: string[];
-};

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

@@ -1,50 +0,0 @@
-# `avoid-operation-name-prefix`
-
-- Category: `Stylistic Issues`
-- Rule name: `@graphql-eslint/avoid-operation-name-prefix`
-- 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/avoid operation name prefix, useful if you wish to avoid prefix in your root fields, or avoid using REST terminology in your schema.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/avoid-operation-name-prefix: ['error', { keywords: ['get'] }]
-
-query getUserDetails {
-  # ...
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/avoid-operation-name-prefix: ['error', { keywords: ['get'] }]
-
-query userDetails {
-  # ...
-}
-```
-
-## Config Schema
-
-The schema defines the following properties:
-
-### `caseSensitive` (boolean)
-
-Default: `false`
-
-### `keywords` (array, required)
-
-The object is an array with all elements of the type `string`.
-
-Additional restrictions:
-
-* Minimum items: `1`
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/avoid-operation-name-prefix.ts)

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

@@ -1,37 +0,0 @@
-# `avoid-typename-prefix`
-
-✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
-
-- Category: `Best Practices`
-- Rule name: `@graphql-eslint/avoid-typename-prefix`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Enforces users to avoid using the type name in a field name while defining your schema.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/avoid-typename-prefix: 'error'
-
-type User {
-  userId: ID!
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/avoid-typename-prefix: 'error'
-
-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/no-operation-name-suffix.md

@@ -1,38 +0,0 @@
-# `no-operation-name-suffix`
-
-✅ The `"extends": "plugin:@graphql-eslint/recommended"` property in a configuration file enables this rule.
-
-🔧 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: `Stylistic Issues`
-- Rule name: `@graphql-eslint/no-operation-name-suffix`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
-- Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
-
-Makes sure you are not adding the operation type to the name of the operation.
-
-## Usage Examples
-
-### Incorrect
-
-```graphql
-# eslint @graphql-eslint/no-operation-name-suffix: 'error'
-
-query userQuery {
-  # ...
-}
-```
-
-### Correct
-
-```graphql
-# eslint @graphql-eslint/no-operation-name-suffix: 'error'
-
-query user {
-  # ...
-}
-```
-
-## Resources
-
-- [Rule source](../../packages/plugin/src/rules/no-operation-name-suffix.ts)

package/rules/avoid-operation-name-prefix.d.ts

@@ -1,9 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-export declare type AvoidOperationNamePrefixConfig = [
-    {
-        keywords: string[];
-        caseSensitive?: boolean;
-    }
-];
-declare const rule: GraphQLESLintRule<AvoidOperationNamePrefixConfig>;
-export default rule;

package/rules/no-operation-name-suffix.d.ts

@@ -1,3 +0,0 @@
-import { GraphQLESLintRule } from '../types';
-declare const rule: GraphQLESLintRule;
-export default rule;