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

package/cjs/rules/no-root-type.js

@@ -27,7 +27,7 @@ exports.rule = {
         docs: {
             category: 'Schema',
             description: 'Disallow using root types `mutation` and/or `subscription`.',
-            url: 'https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/no-root-type.md',
+            url: 'https://the-guild.dev/graphql/eslint/rules/no-root-type',
             requiresSchema: true,
             isDisabledForAllConfig: true,
             examples: [

package/cjs/rules/no-scalar-result-type-on-mutation.js

@@ -11,7 +11,7 @@ exports.rule = {
         docs: {
             category: 'Schema',
             description: 'Avoid scalar result type on mutation type to make sure to return a valid state.',
-            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/cjs/rules/no-typename-prefix.js

@@ -10,7 +10,7 @@ exports.rule = {
             category: 'Schema',
             description: 'Enforces users to avoid using the type name in a field name while defining your schema.',
             recommended: true,
-            url: 'https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/no-typename-prefix.md',
+            url: 'https://the-guild.dev/graphql/eslint/rules/no-typename-prefix',
             examples: [
                 {
                     title: 'Incorrect',

package/cjs/rules/no-unreachable-types.js

@@ -93,7 +93,7 @@ exports.rule = {
         docs: {
             description: 'Requires all types to be reachable at some level by root level fields.',
             category: 'Schema',
-            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/cjs/rules/no-unused-fields.js

@@ -42,7 +42,7 @@ exports.rule = {
         docs: {
             description: 'Requires all fields to be used at some level by siblings operations.',
             category: 'Schema',
-            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,
             requiresSchema: true,
             isDisabledForAllConfig: true,

package/cjs/rules/relay-arguments.js

@@ -41,7 +41,7 @@ exports.rule = {
                 '- `last` takes a non-negative integer',
                 '- `before` takes the Cursor type',
             ].join('\n'),
-            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/cjs/rules/relay-connection-types.js

@@ -35,7 +35,7 @@ exports.rule = {
                 '- Connection type must contain a field `edges` that return a list type that wraps an edge type',
                 '- Connection type must contain a field `pageInfo` that return a non-null `PageInfo` Object type',
             ].join('\n'),
-            url: 'https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/relay-connection-types.md',
+            url: 'https://the-guild.dev/graphql/eslint/rules/relay-connection-types',
             isDisabledForAllConfig: true,
             examples: [
                 {

package/cjs/rules/relay-edge-types.js

@@ -82,7 +82,7 @@ exports.rule = {
                 "- Edge type's field `node` must implement `Node` interface _(optional)_",
                 '- A list type should only wrap an edge type _(optional)_',
             ].join('\n'),
-            url: `https://github.com/B2o5T/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
             isDisabledForAllConfig: true,
             requiresSchema: true,
             examples: [

package/cjs/rules/relay-page-info.js

@@ -21,7 +21,7 @@ exports.rule = {
                 '- `PageInfo` must contain fields `hasPreviousPage` and `hasNextPage`, that return non-null Boolean',
                 '- `PageInfo` must contain fields `startCursor` and `endCursor`, that return either String or Scalar, which can be null if there are no results',
             ].join('\n'),
-            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/cjs/rules/require-deprecation-date.js

@@ -28,7 +28,7 @@ exports.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/cjs/rules/require-deprecation-reason.js

@@ -7,7 +7,7 @@ exports.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/cjs/rules/require-description.js

@@ -74,7 +74,7 @@ exports.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/cjs/rules/require-field-of-type-query-in-mutation-result.js

@@ -10,7 +10,7 @@ exports.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/cjs/rules/require-id-when-available.js

@@ -34,7 +34,7 @@ exports.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/cjs/rules/require-nullable-fields-with-oneof.js

@@ -9,7 +9,7 @@ exports.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/cjs/rules/require-type-pattern-with-oneof.js

@@ -8,7 +8,7 @@ exports.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/cjs/rules/selection-set-depth.js

@@ -29,7 +29,7 @@ exports.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/cjs/rules/strict-id-in-types.js

@@ -43,7 +43,7 @@ exports.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/cjs/rules/unique-fragment-name.js

@@ -39,7 +39,7 @@ exports.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/cjs/rules/unique-operation-name.js

@@ -9,7 +9,7 @@ exports.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/cjs/siblings.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSiblings = void 0;
+const utils_1 = require("@graphql-tools/utils");
+const graphql_1 = require("graphql");
+const documents_js_1 = require("./documents.js");
+const utils_js_1 = require("./utils.js");
+const siblingOperationsCache = new Map();
+function getSiblings(project, documents) {
+    const siblings = project
+        ? (0, documents_js_1.getDocuments)(project)
+        : typeof documents === 'string'
+            ? [(0, utils_1.parseGraphQLSDL)('operation.graphql', documents, { noLocation: true })]
+            : [];
+    if (siblings.length === 0) {
+        let printed = false;
+        const noopWarn = () => {
+            if (!printed) {
+                utils_js_1.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 === graphql_1.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 === graphql_1.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()) => {
+        (0, graphql_1.visit)(selectable, {
+            FragmentSpread(spread) {
+                const fragmentName = spread.name.value;
+                const [fragment] = getFragment(fragmentName);
+                if (!fragment) {
+                    utils_js_1.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;
+}
+exports.getSiblings = getSiblings;

package/cjs/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.truthy = exports.englishJoinWords = exports.ARRAY_DEFAULT_OPTIONS = exports.REPORT_ON_FIRST_CHARACTER = exports.getLocation = exports.convertCase = exports.camelCase = exports.pascalCase = exports.TYPES_KINDS = exports.getTypeName = exports.CWD = exports.VIRTUAL_DOCUMENT_REGEX = exports.normalizePath = exports.logger = exports.requireGraphQLSchemaFromContext = exports.requireSiblingsOperations = void 0;
+exports.truthy = exports.englishJoinWords = exports.ARRAY_DEFAULT_OPTIONS = exports.REPORT_ON_FIRST_CHARACTER = exports.getLocation = exports.convertCase = exports.camelCase = exports.pascalCase = exports.TYPES_KINDS = exports.getTypeName = exports.IS_BROWSER = exports.CWD = exports.VIRTUAL_DOCUMENT_REGEX = exports.normalizePath = exports.logger = exports.requireGraphQLSchemaFromContext = exports.requireSiblingsOperations = void 0;
 const tslib_1 = require("tslib");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const graphql_1 = require("graphql");
@@ -36,6 +36,7 @@ const normalizePath = (path) => (path || '').replace(/\\/g, '/');
 exports.normalizePath = normalizePath;
 exports.VIRTUAL_DOCUMENT_REGEX = /\/\d+_document.graphql$/;
 exports.CWD = process.cwd();
+exports.IS_BROWSER = typeof window !== 'undefined';
 const getTypeName = (node) => 'type' in node ? (0, exports.getTypeName)(node.type) : 'name' in node && node.name ? node.name.value : '';
 exports.getTypeName = getTypeName;
 exports.TYPES_KINDS = [

package/docs/README.md

@@ -1,85 +1 @@
-# Available Rules
-
-Each rule has emojis denoting:
-
-- 📄 if the rule applies to schema documents
-- 📦 if the rule applies to operations
-- 🚀 `graphql-eslint` rule
-- 🔮 `graphql-js` rule
-- 🔧 if some problems reported by the rule are automatically fixable by the `--fix`
-  [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option
-- 💡 if some problems reported by the rule are manually fixable by editor
-  [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions)
-
-<!-- 🚨 IMPORTANT! Do not manually modify this table. Run: `yarn generate:docs` -->
-<!-- prettier-ignore-start -->
-Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|Description|&nbsp;&nbsp;&nbsp;&nbsp;Config&nbsp;&nbsp;&nbsp;&nbsp;|📄&nbsp;/&nbsp;📦|🚀&nbsp;/&nbsp;🔮|🔧&nbsp;/&nbsp;💡
--|-|:-:|:-:|:-:|:-:
-[alphabetize](rules/alphabetize.md)|Enforce arrange in alphabetical order for type fields, enum values, input object fields, operation selections and more.|![all][]|📄 📦|🚀|🔧
-[description-style](rules/description-style.md)|Require all comments to follow the same style (either block or inline).|![recommended][]|📄|🚀|💡
-[executable-definitions](rules/executable-definitions.md)|A GraphQL document is only valid for execution if all definitions are either operation or fragment definitions.|![recommended][]|📦|🔮|
-[fields-on-correct-type](rules/fields-on-correct-type.md)|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`.|![recommended][]|📦|🔮|💡
-[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 `@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 that contains an anonymous operation (the `query` short-hand) is only valid if it contains only that one operation definition.|![recommended][]|📦|🔮|
-[lone-executable-definition](rules/lone-executable-definition.md)|Require queries, mutations, subscriptions or fragments to be located in separate files.|![all][]|📦|🚀|
-[lone-schema-definition](rules/lone-schema-definition.md)|A GraphQL document is only valid if it contains only one schema definition.|![recommended][]|📄|🔮|
-[match-document-filename](rules/match-document-filename.md)|This rule allows you to enforce that the file name should match the operation name.|![all][]|📦|🚀|
-[naming-convention](rules/naming-convention.md)|Require names to follow specified conventions.|![recommended][]|📄 📦|🚀|💡
-[no-anonymous-operations](rules/no-anonymous-operations.md)|Require name for your GraphQL operations. This is useful since most GraphQL client libraries are using the operation name for caching purposes.|![recommended][]|📦|🚀|💡
-[no-case-insensitive-enum-values-duplicates](rules/no-case-insensitive-enum-values-duplicates.md)|Disallow case-insensitive enum values duplicates.|![recommended][]|📄|🚀|💡
-[no-deprecated](rules/no-deprecated.md)|Enforce that deprecated fields or enum values are not in use by operations.|![recommended][]|📦|🚀|💡
-[no-duplicate-fields](rules/no-duplicate-fields.md)|Checks for duplicate fields in selection set, variables in operation definition, or in arguments set of a field.|![recommended][]|📦|🚀|💡
-[no-fragment-cycles](rules/no-fragment-cycles.md)|A GraphQL fragment is only valid when it does not have cycles in fragments usage.|![recommended][]|📦|🔮|
-[no-hashtag-description](rules/no-hashtag-description.md)|Requires to use `"""` or `"` for adding a GraphQL description instead of `#`.|![recommended][]|📄|🚀|💡
-[no-one-place-fragments](rules/no-one-place-fragments.md)|Disallow fragments that are used only in one place.|![all][]|📦|🚀|
-[no-root-type](rules/no-root-type.md)|Disallow using root types `mutation` and/or `subscription`.||📄|🚀|💡
-[no-scalar-result-type-on-mutation](rules/no-scalar-result-type-on-mutation.md)|Avoid scalar result type on mutation type to make sure to return a valid state.|![all][]|📄|🚀|💡
-[no-typename-prefix](rules/no-typename-prefix.md)|Enforces users to avoid using the type name in a field name while defining your schema.|![recommended][]|📄|🚀|💡
-[no-undefined-variables](rules/no-undefined-variables.md)|A GraphQL operation is only valid if all variables encountered, both directly and via fragment spreads, are defined by that operation.|![recommended][]|📦|🔮|
-[no-unreachable-types](rules/no-unreachable-types.md)|Requires all types to be reachable at some level by root level fields.|![recommended][]|📄|🚀|💡
-[no-unused-fields](rules/no-unused-fields.md)|Requires all fields to be used at some level by siblings operations.||📄|🚀|💡
-[no-unused-fragments](rules/no-unused-fragments.md)|A GraphQL document is only valid if all fragment definitions are spread within operations, or spread within other fragments spread within operations.|![recommended][]|📦|🔮|
-[no-unused-variables](rules/no-unused-variables.md)|A GraphQL operation is only valid if all variables defined by an operation are used, either directly or within a spread fragment.|![recommended][]|📦|🔮|
-[one-field-subscriptions](rules/one-field-subscriptions.md)|A GraphQL subscription is valid only if it contains a single root field.|![recommended][]|📦|🔮|
-[overlapping-fields-can-be-merged](rules/overlapping-fields-can-be-merged.md)|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.|![recommended][]|📦|🔮|
-[possible-fragment-spread](rules/possible-fragment-spread.md)|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.|![recommended][]|📦|🔮|
-[possible-type-extension](rules/possible-type-extension.md)|A type extension is only valid if the type is defined and has the same kind.||📄|🔮|💡
-[provided-required-arguments](rules/provided-required-arguments.md)|A field or directive is only valid if all required (non-null without a default value) field arguments have been provided.|![recommended][]|📄 📦|🔮|
-[relay-arguments](rules/relay-arguments.md)|Set of rules to follow Relay specification for Arguments.|![relay][]|📄|🚀|
-[relay-connection-types](rules/relay-connection-types.md)|Set of rules to follow Relay specification for Connection types.|![relay][]|📄|🚀|
-[relay-edge-types](rules/relay-edge-types.md)|Set of rules to follow Relay specification for Edge types.|![relay][]|📄|🚀|
-[relay-page-info](rules/relay-page-info.md)|Set of rules to follow Relay specification for `PageInfo` object.|![relay][]|📄|🚀|
-[require-deprecation-date](rules/require-deprecation-date.md)|Require deletion date on `@deprecated` directive. Suggest removing deprecated things after deprecated date.|![all][]|📄|🚀|💡
-[require-deprecation-reason](rules/require-deprecation-reason.md)|Require all deprecation directives to specify a reason.|![recommended][]|📄|🚀|
-[require-description](rules/require-description.md)|Enforce descriptions in type definitions and operations.|![recommended][]|📄|🚀|
-[require-field-of-type-query-in-mutation-result](rules/require-field-of-type-query-in-mutation-result.md)|Allow the client in one round-trip not only to call mutation but also to get a wagon of data to update their application.|![all][]|📄|🚀|
-[require-id-when-available](rules/require-id-when-available.md)|Enforce selecting specific fields when they are available on the GraphQL type.|![recommended][]|📦|🚀|💡
-[require-nullable-fields-with-oneof](rules/require-nullable-fields-with-oneof.md)|Require `input` or `type` fields to be non-nullable with `@oneOf` directive.|![all][]|📄|🚀|
-[require-type-pattern-with-oneof](rules/require-type-pattern-with-oneof.md)|Enforce types with `@oneOf` directive have `error` and `ok` fields.|![all][]|📄|🚀|
-[scalar-leafs](rules/scalar-leafs.md)|A GraphQL document is valid only if all leaf fields (fields without sub selections) are of scalar or enum types.|![recommended][]|📦|🔮|💡
-[selection-set-depth](rules/selection-set-depth.md)|Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://npmjs.com/package/graphql-depth-limit).|![recommended][]|📦|🚀|💡
-[strict-id-in-types](rules/strict-id-in-types.md)|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.|![recommended][]|📄|🚀|
-[unique-argument-names](rules/unique-argument-names.md)|A GraphQL field or directive is only valid if all supplied arguments are uniquely named.|![recommended][]|📦|🔮|
-[unique-directive-names](rules/unique-directive-names.md)|A GraphQL document is only valid if all defined directives have unique names.|![recommended][]|📄|🔮|
-[unique-directive-names-per-location](rules/unique-directive-names-per-location.md)|A GraphQL document is only valid if all non-repeatable directives at a given location are uniquely named.|![recommended][]|📄 📦|🔮|
-[unique-enum-value-names](rules/unique-enum-value-names.md)|A GraphQL enum type is only valid if all its values are uniquely named.||📄|🔮|
-[unique-field-definition-names](rules/unique-field-definition-names.md)|A GraphQL complex type is only valid if all its fields are uniquely named.|![recommended][]|📄|🔮|
-[unique-fragment-name](rules/unique-fragment-name.md)|Enforce unique fragment names across your project.|![all][]|📦|🚀|
-[unique-input-field-names](rules/unique-input-field-names.md)|A GraphQL input object value is only valid if all supplied fields are uniquely named.|![recommended][]|📦|🔮|
-[unique-operation-name](rules/unique-operation-name.md)|Enforce unique operation names across your project.|![all][]|📦|🚀|
-[unique-operation-types](rules/unique-operation-types.md)|A GraphQL document is only valid if it has only one type per operation.|![recommended][]|📄|🔮|
-[unique-type-names](rules/unique-type-names.md)|A GraphQL document is only valid if all defined types have unique names.|![recommended][]|📄|🔮|
-[unique-variable-names](rules/unique-variable-names.md)|A GraphQL operation is only valid if all its variables are uniquely named.|![recommended][]|📦|🔮|
-[value-literals-of-correct-type](rules/value-literals-of-correct-type.md)|A GraphQL document is only valid if all value literals are of the type expected at their position.|![recommended][]|📦|🔮|💡
-[variables-are-input-types](rules/variables-are-input-types.md)|A GraphQL operation is only valid if all the variables it defines are of input types (scalar, enum, or input object).|![recommended][]|📦|🔮|
-[variables-in-allowed-position](rules/variables-in-allowed-position.md)|Variables passed to field arguments conform to type.|![recommended][]|📦|🔮|
-<!-- prettier-ignore-end -->
-
-[recommended]: https://img.shields.io/badge/-recommended-green.svg
-[all]: https://img.shields.io/badge/-all-blue.svg
-[relay]: https://img.shields.io/badge/-relay-orange.svg
+website/src/pages/rules/index.mdx

package/docs/custom-rules.md

@@ -1,184 +1 @@
-# Writing Custom Rules
-
-To get started with your own rules, start by understanding how
-[ESLint custom rules works](https://eslint.org/docs/developer-guide/working-with-rules).
-
-`graphql-eslint` converts the [GraphQL AST](https://graphql.org/graphql-js/language) into
-[ESTree structure](https://github.com/estree/estree), so it allows you to easily travel the GraphQL
-AST tree easily.
-
-You can visit any GraphQL AST node in your custom rules, and report this as error. You don't need to
-have special handlers for code-files, since `graphql-eslint` extracts usages of `gql` and magic
-`/* GraphQL */` comments automatically, and runs it through the parser, and eventually it knows to
-adjust errors location to fit in your code files original location.
-
-You can explore the GraphQL AST for a given input on
-[astexplorer.net](https://astexplorer.net/#/gist/e72aaccc1e57cbba41659d73cabbf75c/f10ee29317a31ff8012a21762a382c4a03c34d40).
-
-## Getting Started
-
-Start by creating a
-[simple ESLint rule file](https://eslint.org/docs/developer-guide/working-with-rules), and choose
-the AST nodes you wish to visit. It can either be a
-[simple AST node `Kind`](https://github.com/graphql/graphql-js/blob/master/src/language/kinds.d.ts)
-or a complex [ESLint selector](https://eslint.org/docs/developer-guide/selectors) that allows you to
-travel and filter AST nodes.
-
-We recommend you to read the [graphql-eslint parser documentation](parser.md) before getting
-started, to understand the differences between the AST structures.
-
-The `graphql-eslint` comes with a TypeScript wrapper for ESLint rules, and provides a testkit to
-simplify testing process with GraphQL schemas, so you can use that by importing `GraphQLESLintRule`
-type. But if you wish to use JavaScript - that's fine :)
-
-Here's an example for a simple rule that reports on anonymous GraphQL operations:
-
-```ts
-import { GraphQLESLintRule } from '@graphql-eslint/eslint-plugin'
-
-const rule: GraphQLESLintRule = {
-  create(context) {
-    return {
-      OperationDefinition(node) {
-        if (!node.name?.value) {
-          context.report({
-            node,
-            message: 'Oops, name is required!'
-          })
-        }
-      }
-    }
-  }
-}
-```
-
-So what happens here?
-
-1. `@graphql-eslint/eslint-plugin` handles the parsing process for your GraphQL content. It will
-   load the GraphQL files (either from code files or from `.graphql` files with SDL), parse it using
-   GraphQL parser, converts it to ESTree structure and let ESLint do the rest.
-1. Your rule is being loaded by ESLint, and executes just like any other ESLint rule.
-1. Our custom rule asks ESLint to run our function for every `OperationDefinition` found.
-1. If the `OperationDefinition` node doesn't have a valid `name` - we report an error to ESLint.
-
-#### More Examples
-
-You can scan the `packages/plugin/src/rules` directory in this repo for references for implementing
-rules. It coverts most of the use-cases and concepts of rules.
-
-## Accessing original GraphQL AST nodes
-
-Since our parser converts GraphQL AST to ESTree structure, there are some minor differences in the
-structure of the objects. If you are using TypeScript, and you typed your rule with
-`GraphQLESLintRule` - you'll see that each `node` is a bit different from the AST nodes of GraphQL
-(you can read more about that in [graphql-eslint parser documentation](parser.md)).
-
-If you need access to the original GraphQL AST `node`, you can use `.rawNode()` method on each node
-you get from the AST structure of ESLint.
-
-This is useful if you wish to use other GraphQL tools that works with the original GraphQL AST
-objects.
-
-Here's an example for using original `graphql-js` validate method to validate `OperationDefinition`:
-
-```ts
-import { requireGraphQLSchemaFromContext } from '@graphql-eslint/eslint-plugin'
-import { validate } from 'graphql'
-
-export const rule = {
-  create(context) {
-    return {
-      OperationDefinition(node) {
-        const schema = requireGraphQLSchemaFromContext(context)
-
-        validate(context, schema, {
-          kind: Kind.DOCUMENT,
-          definitions: [node.rawNode()]
-        })
-      }
-    }
-  }
-}
-```
-
-## `TypeInfo` / `GraphQLSchema`
-
-If you provide GraphQL schema in your ESLint configuration, it will get loaded automatically, and
-become available in your rules in two ways:
-
-1. You'll be able to access the loaded `GraphQLSchema` object.
-2. In every visited node, you'll be able to use `.typeInfo()` method to get an object with complete
-   type information on your visited node (see
-   [TypeInfo documentation](https://graphql.org/graphql-js/utilities/#typeinfo)).
-
-#### Getting `GraphQLSchema`
-
-To mark your ESLint rules as a rule that needs access to GraphQL schema, start by running
-`requireGraphQLSchemaFromContext` from the plugin package, it will make sure to return a schema, or
-throw an error for the user about the missing schema.
-
-```ts
-const schema = requireGraphQLSchemaFromContext(context)
-```
-
-#### Accessing TypeInfo
-
-If schema is provided and loaded successfully, the `typeInfo` will be available to use. Otherwise -
-it will be `undefined`. If your plugin requires `typeInfo` in order to operate and run, make sure to
-call `requireGraphQLSchemaFromContext` - it will validate that the schema is loaded.
-
-`typeInfo` is provided on every node, based on the type of that node, for example, to access the
-`GraphQLOutputType` while you are visiting a `SelectionSet` node, you can do:
-
-```ts
-import { requireGraphQLSchemaFromContext } from '@graphql-eslint/eslint-plugin'
-
-export const rule = {
-  create(context) {
-    requireGraphQLSchemaFromContext('your-rule-name', context)
-
-    return {
-      SelectionSet(node) {
-        const typeInfo = node.typeInfo()
-        if (typeInfo.gqlType) {
-          console.log(`The GraphQLOutputType is: ${typeInfo.gqlType}`)
-        }
-      }
-    }
-  }
-}
-```
-
-The structure of the return value of `.typeInfo()` is
-[defined here](https://github.com/B2o5T/graphql-eslint/blob/master/packages/plugin/src/estree-converter/converter.ts#L32-L40).
-So based on the `node` you are using, you'll get a different values on `.typeInfo()` result.
-
-## Testing your rules
-
-To test your rules, you can either use the wrapped `GraphQLRuleTester` from this library, or use the
-built-it [`RuleTester`](https://eslint.org/docs/developer-guide/working-with-rules#rule-unit-tests)
-of ESLint.
-
-The wrapped `GraphQLRuleTester` provides built-in configured parser, and a schema loader, if you
-need to test your rule with a loaded schema.
-
-```ts
-import { GraphQLRuleTester } from '@graphql-eslint/eslint-plugin'
-import { rule } from './my-rule'
-
-const ruleTester = new GraphQLRuleTester()
-
-ruleTester.runGraphQLTests('my-rule', rule, {
-  valid: [
-    {
-      code: 'query something { foo }'
-    }
-  ],
-  invalid: [
-    {
-      code: 'query invalid { foo }',
-      errors: [{ message: 'Your error message.' }]
-    }
-  ]
-})
-```
+website/src/pages/docs/custom-rules.mdx