@graphql-eslint/eslint-plugin 4.0.0-alpha-20230801163310-8bc4340 → 4.0.0-alpha-20230810160036-304c2c0

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "4.0.0-alpha-20230801163310-8bc4340",
+  "version": "4.0.0-alpha-20230810160036-304c2c0",
   "description": "GraphQL plugin for ESLint",
   "repository": "https://github.com/B2o5T/graphql-eslint",
   "author": "Dotan Simha <dotansimha@gmail.com>",
   "license": "MIT",
   "engines": {
-    "node": ">=12"
+    "node": ">=18"
   },
   "main": "cjs/index.js",
-  "module": "esm/index.js",
   "exports": {
     "./package.json": "./package.json",
     ".": {
+      "browser": "./index.browser.mjs",
       "require": {
         "types": "./cjs/index.d.ts",
         "default": "./cjs/index.js"
@@ -27,7 +27,6 @@
       }
     }
   },
-  "typings": "esm/index.d.mts",
   "keywords": [
     "eslint",
     "eslintplugin",
@@ -35,26 +34,22 @@
     "graphql"
   ],
   "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"
+    "eslint": ">=8.44.0",
+    "graphql": "^16"
   },
   "dependencies": {
     "@graphql-tools/code-file-loader": "^7.3.6",
     "@graphql-tools/graphql-tag-pluck": "^7.3.6",
     "@graphql-tools/utils": "^9.0.0",
-    "chalk": "^4.1.2",
     "debug": "^4.3.4",
     "fast-glob": "^3.2.12",
-    "graphql-config": "^4.4.0",
+    "graphql-config": "^4.5.0",
     "graphql-depth-limit": "^1.1.0",
-    "lodash.lowercase": "^4.3.0",
-    "tslib": "^2.4.1"
+    "lodash.lowercase": "^4.3.0"
   },
   "publishConfig": {
     "directory": "dist",
     "access": "public"
   },
-  "sideEffects": false,
-  "typescript": {
-    "definition": "cjs/index.d.ts"
-  }
+  "sideEffects": false
 }

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

@@ -1,241 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var require_id_when_available_exports = {};
-__export(require_id_when_available_exports, {
-  rule: () => rule
-});
-module.exports = __toCommonJS(require_id_when_available_exports);
-var import_utils = require("@graphql-tools/utils");
-var import_graphql = require("graphql");
-var import_estree_converter = require("../estree-converter/index.js");
-var import_utils2 = require("../utils.js");
-const RULE_ID = "require-id-when-available";
-const DEFAULT_ID_FIELD_NAME = "id";
-const schema = {
-  definitions: {
-    asString: {
-      type: "string"
-    },
-    asArray: import_utils2.ARRAY_DEFAULT_OPTIONS
-  },
-  type: "array",
-  maxItems: 1,
-  items: {
-    type: "object",
-    additionalProperties: false,
-    properties: {
-      fieldName: {
-        oneOf: [{ $ref: "#/definitions/asString" }, { $ref: "#/definitions/asArray" }],
-        default: DEFAULT_ID_FIELD_NAME
-      }
-    }
-  }
-};
-const rule = {
-  meta: {
-    type: "suggestion",
-    hasSuggestions: true,
-    docs: {
-      category: "Operations",
-      description: "Enforce selecting specific fields when they are available on the GraphQL type.",
-      url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
-      requiresSchema: true,
-      requiresSiblings: true,
-      examples: [
-        {
-          title: "Incorrect",
-          code: (
-            /* GraphQL */
-            `
-            # In your schema
-            type User {
-              id: ID!
-              name: String!
-            }
-
-            # Query
-            query {
-              user {
-                name
-              }
-            }
-          `
-          )
-        },
-        {
-          title: "Correct",
-          code: (
-            /* GraphQL */
-            `
-            # In your schema
-            type User {
-              id: ID!
-              name: String!
-            }
-
-            # Query
-            query {
-              user {
-                id
-                name
-              }
-            }
-
-            # Selecting \`id\` with an alias is also valid
-            query {
-              user {
-                id: name
-              }
-            }
-          `
-          )
-        }
-      ],
-      recommended: true
-    },
-    messages: {
-      [RULE_ID]: "Field{{ pluralSuffix }} {{ fieldName }} must be selected when it's available on a type.\nInclude it in your selection set{{ addition }}."
-    },
-    schema
-  },
-  create(context) {
-    const schema2 = (0, import_utils2.requireGraphQLSchemaFromContext)(RULE_ID, context);
-    const siblings = (0, import_utils2.requireSiblingsOperations)(RULE_ID, context);
-    const { fieldName = DEFAULT_ID_FIELD_NAME } = context.options[0] || {};
-    const idNames = (0, import_utils.asArray)(fieldName);
-    const selector = "OperationDefinition SelectionSet[parent.kind!=/(^OperationDefinition|InlineFragment)$/]";
-    const typeInfo = new import_graphql.TypeInfo(schema2);
-    function checkFragments(node) {
-      for (const selection of node.selections) {
-        if (selection.kind !== import_graphql.Kind.FRAGMENT_SPREAD) {
-          continue;
-        }
-        const [foundSpread] = siblings.getFragment(selection.name.value);
-        if (!foundSpread) {
-          continue;
-        }
-        const checkedFragmentSpreads = /* @__PURE__ */ new Set();
-        const visitor = (0, import_graphql.visitWithTypeInfo)(typeInfo, {
-          SelectionSet(node2, key, _parent) {
-            const parent = _parent;
-            if (parent.kind === import_graphql.Kind.FRAGMENT_DEFINITION) {
-              checkedFragmentSpreads.add(parent.name.value);
-            } else if (parent.kind !== import_graphql.Kind.INLINE_FRAGMENT) {
-              checkSelections(
-                node2,
-                typeInfo.getType(),
-                selection.loc.start,
-                parent,
-                checkedFragmentSpreads
-              );
-            }
-          }
-        });
-        (0, import_graphql.visit)(foundSpread.document, visitor);
-      }
-    }
-    function checkSelections(node, type, loc, parent, checkedFragmentSpreads = /* @__PURE__ */ new Set()) {
-      const rawType = (0, import_estree_converter.getBaseType)(type);
-      if (rawType instanceof import_graphql.GraphQLObjectType || rawType instanceof import_graphql.GraphQLInterfaceType) {
-        checkFields(rawType);
-      } else if (rawType instanceof import_graphql.GraphQLUnionType) {
-        for (const selection of node.selections) {
-          if (selection.kind === import_graphql.Kind.INLINE_FRAGMENT) {
-            const types = rawType.getTypes();
-            const t = types.find((t2) => t2.name === selection.typeCondition.name.value);
-            if (t) {
-              checkFields(t);
-            }
-          }
-        }
-      }
-      function checkFields(rawType2) {
-        const fields = rawType2.getFields();
-        const hasIdFieldInType = idNames.some((name) => fields[name]);
-        if (!hasIdFieldInType) {
-          return;
-        }
-        function hasIdField({ selections }) {
-          return selections.some((selection) => {
-            if (selection.kind === import_graphql.Kind.FIELD) {
-              if (selection.alias && idNames.includes(selection.alias.value)) {
-                return true;
-              }
-              return idNames.includes(selection.name.value);
-            }
-            if (selection.kind === import_graphql.Kind.INLINE_FRAGMENT) {
-              return hasIdField(selection.selectionSet);
-            }
-            if (selection.kind === import_graphql.Kind.FRAGMENT_SPREAD) {
-              const [foundSpread] = siblings.getFragment(selection.name.value);
-              if (foundSpread) {
-                const fragmentSpread = foundSpread.document;
-                checkedFragmentSpreads.add(fragmentSpread.name.value);
-                return hasIdField(fragmentSpread.selectionSet);
-              }
-            }
-            return false;
-          });
-        }
-        const hasId = hasIdField(node);
-        checkFragments(node);
-        if (hasId) {
-          return;
-        }
-        const pluralSuffix = idNames.length > 1 ? "s" : "";
-        const fieldName2 = (0, import_utils2.englishJoinWords)(
-          idNames.map((name) => `\`${(parent.alias || parent.name).value}.${name}\``)
-        );
-        const addition = checkedFragmentSpreads.size === 0 ? "" : ` or add to used fragment${checkedFragmentSpreads.size > 1 ? "s" : ""} ${(0, import_utils2.englishJoinWords)([...checkedFragmentSpreads].map((name) => `\`${name}\``))}`;
-        const problem = {
-          loc,
-          messageId: RULE_ID,
-          data: {
-            pluralSuffix,
-            fieldName: fieldName2,
-            addition
-          }
-        };
-        if ("type" in node) {
-          problem.suggest = idNames.map((idName) => ({
-            desc: `Add \`${idName}\` selection`,
-            fix: (fixer) => {
-              let insertNode = node.selections[0];
-              insertNode = insertNode.kind === import_graphql.Kind.INLINE_FRAGMENT ? insertNode.selectionSet.selections[0] : insertNode;
-              return fixer.insertTextBefore(insertNode, `${idName} `);
-            }
-          }));
-        }
-        context.report(problem);
-      }
-    }
-    return {
-      [selector](node) {
-        const typeInfo2 = node.typeInfo();
-        if (typeInfo2.gqlType) {
-          checkSelections(node, typeInfo2.gqlType, node.loc.start, node.parent);
-        }
-      }
-    };
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  rule
-});

package/cjs/types-8d5f4ae0.d.ts

@@ -1,107 +0,0 @@
-import { GraphQLParseOptions } from '@graphql-tools/utils';
-import { Linter, Rule, AST } from 'eslint';
-import * as ESTree from 'estree';
-import { FragmentDefinitionNode, OperationDefinitionNode, SelectionSetNode, OperationTypeNode, GraphQLSchema, ASTKindToNode } from 'graphql';
-import { GraphQLProjectConfig, IExtensions, IGraphQLProject } from 'graphql-config';
-import { JSONSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from './estree-converter/types.js';
-
-type FragmentSource = {
-    filePath: string;
-    document: FragmentDefinitionNode;
-};
-type OperationSource = {
-    filePath: string;
-    document: OperationDefinitionNode;
-};
-type SiblingOperations = {
-    available: boolean;
-    getFragment(fragmentName: string): FragmentSource[];
-    getFragments(): FragmentSource[];
-    getFragmentByType(typeName: string): FragmentSource[];
-    getFragmentsInUse(baseOperation: FragmentDefinitionNode | OperationDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
-    getOperation(operationName: string): OperationSource[];
-    getOperations(): OperationSource[];
-    getOperationByType(operationType: OperationTypeNode): OperationSource[];
-};
-declare function getSiblings(project?: GraphQLProjectConfig, documents?: ParserOptions['documents']): SiblingOperations;
-
-type Schema = GraphQLSchema | null;
-type Pointer = string | string[];
-interface ParserOptions {
-    schema?: Pointer | Record<string, {
-        headers: Record<string, string>;
-    }>;
-    documents?: Pointer;
-    extensions?: IExtensions;
-    include?: Pointer;
-    exclude?: Pointer;
-    projects?: Record<string, IGraphQLProject>;
-    schemaOptions?: Omit<GraphQLParseOptions, 'assumeValidSDL'> & {
-        headers: Record<string, string>;
-    };
-    graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
-    skipGraphQLConfig?: boolean;
-    filePath: string;
-    /** @deprecated Use `documents` instead */
-    operations?: Pointer;
-}
-type ParserServices = {
-    schema: Schema;
-    siblingOperations: SiblingOperations;
-};
-type GraphQLESLintParseResult = Linter.ESLintParseResult & {
-    services: ParserServices;
-};
-type Location = AST.SourceLocation | ESTree.Position;
-type ReportDescriptorLocation = {
-    loc: Location;
-} | {
-    node: {
-        loc: Location;
-    };
-};
-type ReportDescriptor = ReportDescriptorLocation & Rule.ReportDescriptorMessage & Rule.ReportDescriptorOptions;
-type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleContext, 'options' | 'parserServices' | 'report'> & {
-    options: Options;
-    parserServices: ParserServices;
-    report(descriptor: ReportDescriptor): void;
-};
-type CategoryType = 'Operations' | 'Schema';
-type RuleMetaDataDocs = Required<Rule.RuleMetaData>['docs'];
-type RuleDocsInfo<T> = Omit<RuleMetaDataDocs, 'category' | 'suggestion'> & {
-    category: CategoryType | CategoryType[];
-    requiresSchema?: true;
-    requiresSiblings?: true;
-    examples?: {
-        title: string;
-        code: string;
-        usage?: T;
-    }[];
-    configOptions?: T | {
-        schema?: T;
-        operations?: T;
-    };
-    graphQLJSRuleName?: string;
-    isDisabledForAllConfig?: true;
-};
-type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = Record<string, any> & {
-    [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
-};
-type GraphQLESLintRule<Options = [], WithTypeInfo extends boolean = false> = {
-    meta: Omit<Rule.RuleMetaData, 'docs' | 'schema'> & {
-        docs?: RuleDocsInfo<Options>;
-        schema: Readonly<JSONSchema> | [];
-    };
-    create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
-};
-type ValueOf<T> = T[keyof T];
-type Id<T> = {
-    [P in keyof T]: T[P];
-} & {};
-type OmitDistributive<T, K extends PropertyKey> = T extends object ? Id<OmitRecursively<T, K>> : T;
-type OmitRecursively<T extends object, K extends PropertyKey> = Omit<{
-    [P in keyof T]: OmitDistributive<T[P], K>;
-}, K>;
-
-export { CategoryType as C, FragmentSource as F, GraphQLESLintParseResult as G, OmitRecursively as O, ParserOptions as P, ReportDescriptor as R, Schema as S, ValueOf as V, Pointer as a, ParserServices as b, GraphQLESLintRuleContext as c, RuleDocsInfo as d, GraphQLESLintRuleListener as e, GraphQLESLintRule as f, SiblingOperations as g, OperationSource as h, getSiblings as i };

package/esm/types-ace77d86.d.ts

@@ -1,107 +0,0 @@
-import { GraphQLParseOptions } from '@graphql-tools/utils';
-import { Linter, Rule, AST } from 'eslint';
-import * as ESTree from 'estree';
-import { FragmentDefinitionNode, OperationDefinitionNode, SelectionSetNode, OperationTypeNode, GraphQLSchema, ASTKindToNode } from 'graphql';
-import { GraphQLProjectConfig, IExtensions, IGraphQLProject } from 'graphql-config';
-import { JSONSchema } from 'json-schema-to-ts';
-import { GraphQLESTreeNode } from './estree-converter/types.mjs';
-
-type FragmentSource = {
-    filePath: string;
-    document: FragmentDefinitionNode;
-};
-type OperationSource = {
-    filePath: string;
-    document: OperationDefinitionNode;
-};
-type SiblingOperations = {
-    available: boolean;
-    getFragment(fragmentName: string): FragmentSource[];
-    getFragments(): FragmentSource[];
-    getFragmentByType(typeName: string): FragmentSource[];
-    getFragmentsInUse(baseOperation: FragmentDefinitionNode | OperationDefinitionNode | SelectionSetNode, recursive?: boolean): FragmentDefinitionNode[];
-    getOperation(operationName: string): OperationSource[];
-    getOperations(): OperationSource[];
-    getOperationByType(operationType: OperationTypeNode): OperationSource[];
-};
-declare function getSiblings(project?: GraphQLProjectConfig, documents?: ParserOptions['documents']): SiblingOperations;
-
-type Schema = GraphQLSchema | null;
-type Pointer = string | string[];
-interface ParserOptions {
-    schema?: Pointer | Record<string, {
-        headers: Record<string, string>;
-    }>;
-    documents?: Pointer;
-    extensions?: IExtensions;
-    include?: Pointer;
-    exclude?: Pointer;
-    projects?: Record<string, IGraphQLProject>;
-    schemaOptions?: Omit<GraphQLParseOptions, 'assumeValidSDL'> & {
-        headers: Record<string, string>;
-    };
-    graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
-    skipGraphQLConfig?: boolean;
-    filePath: string;
-    /** @deprecated Use `documents` instead */
-    operations?: Pointer;
-}
-type ParserServices = {
-    schema: Schema;
-    siblingOperations: SiblingOperations;
-};
-type GraphQLESLintParseResult = Linter.ESLintParseResult & {
-    services: ParserServices;
-};
-type Location = AST.SourceLocation | ESTree.Position;
-type ReportDescriptorLocation = {
-    loc: Location;
-} | {
-    node: {
-        loc: Location;
-    };
-};
-type ReportDescriptor = ReportDescriptorLocation & Rule.ReportDescriptorMessage & Rule.ReportDescriptorOptions;
-type GraphQLESLintRuleContext<Options = any[]> = Omit<Rule.RuleContext, 'options' | 'parserServices' | 'report'> & {
-    options: Options;
-    parserServices: ParserServices;
-    report(descriptor: ReportDescriptor): void;
-};
-type CategoryType = 'Operations' | 'Schema';
-type RuleMetaDataDocs = Required<Rule.RuleMetaData>['docs'];
-type RuleDocsInfo<T> = Omit<RuleMetaDataDocs, 'category' | 'suggestion'> & {
-    category: CategoryType | CategoryType[];
-    requiresSchema?: true;
-    requiresSiblings?: true;
-    examples?: {
-        title: string;
-        code: string;
-        usage?: T;
-    }[];
-    configOptions?: T | {
-        schema?: T;
-        operations?: T;
-    };
-    graphQLJSRuleName?: string;
-    isDisabledForAllConfig?: true;
-};
-type GraphQLESLintRuleListener<WithTypeInfo extends boolean = false> = Record<string, any> & {
-    [K in keyof ASTKindToNode]?: (node: GraphQLESTreeNode<ASTKindToNode[K], WithTypeInfo>) => void;
-};
-type GraphQLESLintRule<Options = [], WithTypeInfo extends boolean = false> = {
-    meta: Omit<Rule.RuleMetaData, 'docs' | 'schema'> & {
-        docs?: RuleDocsInfo<Options>;
-        schema: Readonly<JSONSchema> | [];
-    };
-    create(context: GraphQLESLintRuleContext<Options>): GraphQLESLintRuleListener<WithTypeInfo>;
-};
-type ValueOf<T> = T[keyof T];
-type Id<T> = {
-    [P in keyof T]: T[P];
-} & {};
-type OmitDistributive<T, K extends PropertyKey> = T extends object ? Id<OmitRecursively<T, K>> : T;
-type OmitRecursively<T extends object, K extends PropertyKey> = Omit<{
-    [P in keyof T]: OmitDistributive<T[P], K>;
-}, K>;
-
-export { CategoryType as C, FragmentSource as F, GraphQLESLintParseResult as G, OmitRecursively as O, ParserOptions as P, ReportDescriptor as R, Schema as S, ValueOf as V, Pointer as a, ParserServices as b, GraphQLESLintRuleContext as c, RuleDocsInfo as d, GraphQLESLintRuleListener as e, GraphQLESLintRule as f, SiblingOperations as g, OperationSource as h, getSiblings as i };