feat: add ignoreClientDirectives option for known-directives rule (#972)

dimaMachina · web-flow · commit b04a8d5ed648 · 2022-02-19T22:38:44.000+01:00
* add ignoreClientDirectives

* add ignoreClientDirectives

* add ARRAY_DEFAULT_OPTIONS

* remove You can find its source code here from `graphql-js-validation`
diff --git a/.changeset/olive-terms-double.md b/.changeset/olive-terms-double.md
@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+feat: add `ignoreClientDirectives` option for `known-directives` rule
diff --git a/docs/README.md b/docs/README.md
@@ -18,7 +18,7 @@ Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbs
 [fragments-on-composite-type](rules/fragments-on-composite-type.md)|Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.|![recommended][]|🔮|
 [input-name](rules/input-name.md)|Require mutation argument to be always called "input" and input type to be called Mutation name + "Input".|![all][]|🚀|💡
 [known-argument-names](rules/known-argument-names.md)|A GraphQL field is only valid if all supplied arguments are defined by that field.|![recommended][]|🔮|
-[known-directives](rules/known-directives.md)|A GraphQL document is only valid if all `@directives` are known by the schema and legally positioned.|![recommended][]|🔮|
+[known-directives](rules/known-directives.md)|A GraphQL document is only valid if all `@directive`s are known by the schema and legally positioned.|![recommended][]|🔮|
 [known-fragment-names](rules/known-fragment-names.md)|A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.|![recommended][]|🔮|
 [known-type-names](rules/known-type-names.md)|A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.|![recommended][]|🔮|
 [lone-anonymous-operation](rules/lone-anonymous-operation.md)|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.|![recommended][]|🔮|
diff --git a/docs/rules/executable-definitions.md b/docs/rules/executable-definitions.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ExecutableDefinitionsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/fields-on-correct-type.md b/docs/rules/fields-on-correct-type.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all fields selected are defined by the parent type, or are an allowed meta field such as `__typename`.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FieldsOnCorrectTypeRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/fragments-on-composite-type.md b/docs/rules/fragments-on-composite-type.md
@@ -9,7 +9,7 @@
 
 Fragments use a type condition to determine if they apply, since fragments can only be spread into a composite type (object, interface, or union), the type condition must also be a composite type.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/FragmentsOnCompositeTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/known-argument-names.md b/docs/rules/known-argument-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL field is only valid if all supplied arguments are defined by that field.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownArgumentNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/known-directives.md b/docs/rules/known-directives.md
@@ -7,9 +7,36 @@
 - Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-A GraphQL document is only valid if all `@directives` are known by the schema and legally positioned.
+A GraphQL document is only valid if all `@directive`s are known by the schema and legally positioned.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownDirectivesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
+
+## Usage Examples
+
+### Valid
+
+```graphql
+# eslint @graphql-eslint/known-directives: ['error', { ignoreClientDirectives: ['client'] }]
+
+{
+  product {
+    someClientField @client
+  }
+}
+```
+
+## Config Schema
+
+The schema defines the following properties:
+
+### `ignoreClientDirectives` (array, required)
+
+The object is an array with all elements of the type `string`.
+
+Additional restrictions:
+
+* Minimum items: `1`
+* Unique items: `true`
 
 ## Resources
 
diff --git a/docs/rules/known-fragment-names.md b/docs/rules/known-fragment-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all `...Fragment` fragment spreads refer to fragments defined in the same document.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownFragmentNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Usage Examples
 
diff --git a/docs/rules/known-type-names.md b/docs/rules/known-type-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if referenced types (specifically variable definitions and fragment conditions) are defined by the type schema.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/KnownTypeNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/lone-anonymous-operation.md b/docs/rules/lone-anonymous-operation.md
@@ -9,7 +9,7 @@
 
 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.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneAnonymousOperationRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/lone-schema-definition.md b/docs/rules/lone-schema-definition.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if it contains only one schema definition.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/LoneSchemaDefinitionRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/no-fragment-cycles.md b/docs/rules/no-fragment-cycles.md
@@ -9,7 +9,7 @@
 
 A GraphQL fragment is only valid when it does not have cycles in fragments usage.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoFragmentCyclesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/no-undefined-variables.md b/docs/rules/no-undefined-variables.md
@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoUndefinedVariablesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/no-unused-fragments.md b/docs/rules/no-unused-fragments.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoUnusedFragmentsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/no-unused-variables.md b/docs/rules/no-unused-variables.md
@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/NoUnusedVariablesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/one-field-subscriptions.md b/docs/rules/one-field-subscriptions.md
@@ -9,7 +9,7 @@
 
 A GraphQL subscription is valid only if it contains a single root field.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/SingleFieldSubscriptionsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/overlapping-fields-can-be-merged.md b/docs/rules/overlapping-fields-can-be-merged.md
@@ -9,7 +9,7 @@
 
 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.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/OverlappingFieldsCanBeMergedRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/possible-fragment-spread.md b/docs/rules/possible-fragment-spread.md
@@ -9,7 +9,7 @@
 
 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.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/PossibleFragmentSpreadsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/possible-type-extension.md b/docs/rules/possible-type-extension.md
@@ -7,7 +7,7 @@
 
 A type extension is only valid if the type is defined and has the same kind.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/PossibleTypeExtensionsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/provided-required-arguments.md b/docs/rules/provided-required-arguments.md
@@ -9,7 +9,7 @@
 
 A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ProvidedRequiredArgumentsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/scalar-leafs.md b/docs/rules/scalar-leafs.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ScalarLeafsRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-argument-names.md b/docs/rules/unique-argument-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL field or directive is only valid if all supplied arguments are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueArgumentNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-directive-names-per-location.md b/docs/rules/unique-directive-names-per-location.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all non-repeatable directives at a given location are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueDirectivesPerLocationRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-directive-names.md b/docs/rules/unique-directive-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all defined directives have unique names.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueDirectiveNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-enum-value-names.md b/docs/rules/unique-enum-value-names.md
@@ -7,7 +7,7 @@
 
 A GraphQL enum type is only valid if all its values are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueEnumValueNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-field-definition-names.md b/docs/rules/unique-field-definition-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL complex type is only valid if all its fields are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueFieldDefinitionNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-input-field-names.md b/docs/rules/unique-input-field-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL input object value is only valid if all supplied fields are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueInputFieldNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-operation-types.md b/docs/rules/unique-operation-types.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if it has only one type per operation.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueOperationTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-type-names.md b/docs/rules/unique-type-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all defined types have unique names.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueTypeNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/unique-variable-names.md b/docs/rules/unique-variable-names.md
@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all its variables are uniquely named.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/UniqueVariableNamesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/value-literals-of-correct-type.md b/docs/rules/value-literals-of-correct-type.md
@@ -9,7 +9,7 @@
 
 A GraphQL document is only valid if all value literals are of the type expected at their position.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/ValuesOfCorrectTypeRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/variables-are-input-types.md b/docs/rules/variables-are-input-types.md
@@ -9,7 +9,7 @@
 
 A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesAreInputTypesRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/docs/rules/variables-in-allowed-position.md b/docs/rules/variables-in-allowed-position.md
@@ -9,7 +9,7 @@
 
 Variables passed to field arguments conform to type.
 
-> This rule is a wrapper around a `graphql-js` validation function. [You can find its source code here](https://github.com/graphql/graphql-js/blob/main/src/validation/rules/VariablesInAllowedPositionRule.ts).
+> This rule is a wrapper around a `graphql-js` validation function.
 
 ## Resources
 
diff --git a/packages/plugin/src/rules/alphabetize.ts b/packages/plugin/src/rules/alphabetize.ts
@@ -22,6 +22,7 @@ import lowerCase from 'lodash.lowercase';
 import { GraphQLESLintRule } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser';
 import { GraphQLESLintRuleListener } from '../testkit';
+import { ARRAY_DEFAULT_OPTIONS } from '../utils';
 
 const RULE_ID = 'alphabetize';
 
@@ -168,45 +169,35 @@ const rule: GraphQLESLintRule<[AlphabetizeConfig]> = {
         minProperties: 1,
         properties: {
           fields: {
-            type: 'array',
-            uniqueItems: true,
-            minItems: 1,
+            ...ARRAY_DEFAULT_OPTIONS,
             items: {
               enum: fieldsEnum,
             },
             description: 'Fields of `type`, `interface`, and `input`.',
           },
           values: {
-            type: 'array',
-            uniqueItems: true,
-            minItems: 1,
+            ...ARRAY_DEFAULT_OPTIONS,
             items: {
               enum: valuesEnum,
             },
             description: 'Values of `enum`.',
           },
           selections: {
-            type: 'array',
-            uniqueItems: true,
-            minItems: 1,
+            ...ARRAY_DEFAULT_OPTIONS,
             items: {
               enum: selectionsEnum,
             },
             description: 'Selections of `fragment` and operations `query`, `mutation` and `subscription`.',
           },
           variables: {
-            type: 'array',
-            uniqueItems: true,
-            minItems: 1,
+            ...ARRAY_DEFAULT_OPTIONS,
             items: {
               enum: variablesEnum,
             },
             description: 'Variables of operations `query`, `mutation` and `subscription`.',
           },
           arguments: {
-            type: 'array',
-            uniqueItems: true,
-            minItems: 1,
+            ...ARRAY_DEFAULT_OPTIONS,
             items: {
               enum: argumentsEnum,
             },
diff --git a/packages/plugin/src/rules/graphql-js-validation.ts b/packages/plugin/src/rules/graphql-js-validation.ts
diff --git a/packages/plugin/src/rules/match-document-filename.ts b/packages/plugin/src/rules/match-document-filename.ts
diff --git a/packages/plugin/src/rules/naming-convention.ts b/packages/plugin/src/rules/naming-convention.ts
diff --git a/packages/plugin/src/rules/no-root-type.ts b/packages/plugin/src/rules/no-root-type.ts
diff --git a/packages/plugin/src/rules/require-id-when-available.ts b/packages/plugin/src/rules/require-id-when-available.ts
diff --git a/packages/plugin/src/rules/selection-set-depth.ts b/packages/plugin/src/rules/selection-set-depth.ts
diff --git a/packages/plugin/src/rules/strict-id-in-types.ts b/packages/plugin/src/rules/strict-id-in-types.ts
diff --git a/packages/plugin/src/utils.ts b/packages/plugin/src/utils.ts
diff --git a/packages/plugin/tests/__snapshots__/known-directives.spec.md b/packages/plugin/tests/__snapshots__/known-directives.spec.md
diff --git a/packages/plugin/tests/known-directives.spec.ts b/packages/plugin/tests/known-directives.spec.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@graphql-eslint/eslint-plugin': minor
 +---
++
 +feat: add `ignoreClientDirectives` option for `known-directives` rule