@graphql-eslint/eslint-plugin 3.0.0-alpha-3168a9b.0 → 3.0.0-alpha-7462f3d.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.0.0-alpha-3168a9b.0",
+  "version": "3.0.0-alpha-7462f3d.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

@@ -1,10 +1,9 @@
-import { Kind } from 'graphql';
 import { GraphQLESLintRule } from '../types';
-declare const fieldsEnum: Kind[];
-declare const valuesEnum: Kind[];
-declare const selectionsEnum: Kind[];
-declare const variablesEnum: Kind[];
-declare const argumentsEnum: Kind[];
+declare const fieldsEnum: ('ObjectTypeDefinition' | 'InterfaceTypeDefinition' | 'InputObjectTypeDefinition')[];
+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;

package/rules/index.d.ts

@@ -1,15 +1,11 @@
 export declare const rules: {
     alphabetize: import("..").GraphQLESLintRule<[{
-        fields?: import("graphql").Kind[];
-        values?: import("graphql").Kind[];
-        selections?: import("graphql").Kind[];
-        variables?: import("graphql").Kind[];
-        arguments?: import("graphql").Kind[];
+        fields?: ("ObjectTypeDefinition" | "InterfaceTypeDefinition" | "InputObjectTypeDefinition")[];
+        values?: ["EnumTypeDefinition"];
+        selections?: ("OperationDefinition" | "FragmentDefinition")[];
+        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>;
@@ -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/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/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/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/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;