@graphql-eslint/eslint-plugin 3.16.2-alpha-20230318045109-091842b → 3.16.2-alpha-20230322112454-cb28ba7

package/cjs/rules/require-deprecation-reason.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rule = void 0;
 const index_js_1 = require("../estree-converter/index.js");
+const utils_js_1 = require("../utils.js");
 exports.rule = {
     meta: {
         docs: {
@@ -48,10 +49,7 @@ exports.rule = {
                 if (!value) {
                     context.report({
                         node: node.name,
-                        data: {
-                            test: 'test',
-                        },
-                        message: 'Directive "@deprecated" must have a reason!',
+                        message: `Deprecation reason is required for ${(0, utils_js_1.getNodeName)(node.parent)}.`,
                     });
                 }
             },

package/cjs/rules/require-description.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rule = void 0;
+exports.rule = exports.RULE_ID = void 0;
 const utils_1 = require("@graphql-tools/utils");
 const graphql_1 = require("graphql");
 const utils_js_1 = require("../utils.js");
-const RULE_ID = 'require-description';
+exports.RULE_ID = 'require-description';
 const ALLOWED_KINDS = [
     ...utils_js_1.TYPES_KINDS,
     graphql_1.Kind.DIRECTIVE_DEFINITION,
@@ -13,34 +13,6 @@ const ALLOWED_KINDS = [
     graphql_1.Kind.ENUM_VALUE_DEFINITION,
     graphql_1.Kind.OPERATION_DEFINITION,
 ];
-function getNodeName(node) {
-    const DisplayNodeNameMap = {
-        [graphql_1.Kind.OBJECT_TYPE_DEFINITION]: 'type',
-        [graphql_1.Kind.INTERFACE_TYPE_DEFINITION]: 'interface',
-        [graphql_1.Kind.ENUM_TYPE_DEFINITION]: 'enum',
-        [graphql_1.Kind.SCALAR_TYPE_DEFINITION]: 'scalar',
-        [graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION]: 'input',
-        [graphql_1.Kind.UNION_TYPE_DEFINITION]: 'union',
-        [graphql_1.Kind.DIRECTIVE_DEFINITION]: 'directive',
-    };
-    switch (node.kind) {
-        case graphql_1.Kind.OBJECT_TYPE_DEFINITION:
-        case graphql_1.Kind.INTERFACE_TYPE_DEFINITION:
-        case graphql_1.Kind.ENUM_TYPE_DEFINITION:
-        case graphql_1.Kind.SCALAR_TYPE_DEFINITION:
-        case graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION:
-        case graphql_1.Kind.UNION_TYPE_DEFINITION:
-            return `${DisplayNodeNameMap[node.kind]} ${node.name.value}`;
-        case graphql_1.Kind.DIRECTIVE_DEFINITION:
-            return `${DisplayNodeNameMap[node.kind]} @${node.name.value}`;
-        case graphql_1.Kind.FIELD_DEFINITION:
-        case graphql_1.Kind.INPUT_VALUE_DEFINITION:
-        case graphql_1.Kind.ENUM_VALUE_DEFINITION:
-            return `${node.parent.name.value}.${node.name.value}`;
-        case graphql_1.Kind.OPERATION_DEFINITION:
-            return node.name ? `${node.operation} ${node.name.value}` : node.operation;
-    }
-}
 const schema = {
     type: 'array',
     minItems: 1,
@@ -74,7 +46,7 @@ exports.rule = {
         docs: {
             category: 'Schema',
             description: 'Enforce descriptions in type definitions and operations.',
-            url: `https://the-guild.dev/graphql/eslint/rules/${RULE_ID}`,
+            url: `https://the-guild.dev/graphql/eslint/rules/${exports.RULE_ID}`,
             examples: [
                 {
                     title: 'Incorrect',
@@ -136,7 +108,7 @@ exports.rule = {
         },
         type: 'suggestion',
         messages: {
-            [RULE_ID]: 'Description is required for `{{ nodeName }}`.',
+            [exports.RULE_ID]: 'Description is required for {{ nodeName }}',
         },
         schema,
     },
@@ -152,7 +124,7 @@ exports.rule = {
             }
         }
         if (rootField) {
-            const schema = (0, utils_js_1.requireGraphQLSchemaFromContext)(RULE_ID, context);
+            const schema = (0, utils_js_1.requireGraphQLSchemaFromContext)(exports.RULE_ID, context);
             const rootTypeNames = (0, utils_1.getRootTypeNames)(schema);
             kinds.add(`:matches(ObjectTypeDefinition, ObjectTypeExtension)[name.value=/^(${[
                 ...rootTypeNames,
@@ -182,9 +154,9 @@ exports.rule = {
                 if (description.length === 0) {
                     context.report({
                         loc: isOperation ? (0, utils_js_1.getLocation)(node.loc.start, node.operation) : node.name.loc,
-                        messageId: RULE_ID,
+                        messageId: exports.RULE_ID,
                         data: {
-                            nodeName: getNodeName(node),
+                            nodeName: (0, utils_js_1.getNodeName)(node),
                         },
                     });
                 }

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.IS_BROWSER = exports.CWD = exports.VIRTUAL_DOCUMENT_REGEX = exports.normalizePath = exports.logger = exports.requireGraphQLSchemaFromContext = exports.requireSiblingsOperations = void 0;
+exports.getNodeName = 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");
@@ -98,3 +98,34 @@ function truthy(value) {
     return !!value;
 }
 exports.truthy = truthy;
+function getNodeName(node) {
+    const DisplayNodeNameMap = {
+        [graphql_1.Kind.OBJECT_TYPE_DEFINITION]: 'type',
+        [graphql_1.Kind.INTERFACE_TYPE_DEFINITION]: 'interface',
+        [graphql_1.Kind.ENUM_TYPE_DEFINITION]: 'enum',
+        [graphql_1.Kind.SCALAR_TYPE_DEFINITION]: 'scalar',
+        [graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION]: 'input',
+        [graphql_1.Kind.UNION_TYPE_DEFINITION]: 'union',
+        [graphql_1.Kind.DIRECTIVE_DEFINITION]: 'directive',
+        [graphql_1.Kind.FIELD_DEFINITION]: 'field',
+        [graphql_1.Kind.ENUM_VALUE_DEFINITION]: 'value',
+        [graphql_1.Kind.INPUT_VALUE_DEFINITION]: 'value',
+    };
+    switch (node.kind) {
+        case graphql_1.Kind.OBJECT_TYPE_DEFINITION:
+        case graphql_1.Kind.INTERFACE_TYPE_DEFINITION:
+        case graphql_1.Kind.ENUM_TYPE_DEFINITION:
+        case graphql_1.Kind.SCALAR_TYPE_DEFINITION:
+        case graphql_1.Kind.INPUT_OBJECT_TYPE_DEFINITION:
+        case graphql_1.Kind.UNION_TYPE_DEFINITION:
+        case graphql_1.Kind.DIRECTIVE_DEFINITION:
+            return `${DisplayNodeNameMap[node.kind]} "${node.name.value}"`;
+        case graphql_1.Kind.FIELD_DEFINITION:
+        case graphql_1.Kind.INPUT_VALUE_DEFINITION:
+        case graphql_1.Kind.ENUM_VALUE_DEFINITION:
+            return `${DisplayNodeNameMap[node.kind]} "${node.name.value}" in ${DisplayNodeNameMap[node.parent.kind]} "${node.parent.name.value}"`;
+        case graphql_1.Kind.OPERATION_DEFINITION:
+            return node.name ? `${node.operation} "${node.name.value}"` : node.operation;
+    }
+}
+exports.getNodeName = getNodeName;

package/esm/rules/require-deprecation-reason.js

@@ -1,4 +1,5 @@
 import { valueFromNode } from '../estree-converter/index.js';
+import { getNodeName } from '../utils.js';
 export const rule = {
     meta: {
         docs: {
@@ -45,10 +46,7 @@ export const rule = {
                 if (!value) {
                     context.report({
                         node: node.name,
-                        data: {
-                            test: 'test',
-                        },
-                        message: 'Directive "@deprecated" must have a reason!',
+                        message: `Deprecation reason is required for ${getNodeName(node.parent)}.`,
                     });
                 }
             },

package/esm/rules/require-description.js

@@ -1,7 +1,7 @@
 import { getRootTypeNames } from '@graphql-tools/utils';
 import { Kind, TokenKind } from 'graphql';
-import { getLocation, requireGraphQLSchemaFromContext, TYPES_KINDS } from '../utils.js';
-const RULE_ID = 'require-description';
+import { getLocation, getNodeName, requireGraphQLSchemaFromContext, TYPES_KINDS, } from '../utils.js';
+export const RULE_ID = 'require-description';
 const ALLOWED_KINDS = [
     ...TYPES_KINDS,
     Kind.DIRECTIVE_DEFINITION,
@@ -10,34 +10,6 @@ const ALLOWED_KINDS = [
     Kind.ENUM_VALUE_DEFINITION,
     Kind.OPERATION_DEFINITION,
 ];
-function getNodeName(node) {
-    const DisplayNodeNameMap = {
-        [Kind.OBJECT_TYPE_DEFINITION]: 'type',
-        [Kind.INTERFACE_TYPE_DEFINITION]: 'interface',
-        [Kind.ENUM_TYPE_DEFINITION]: 'enum',
-        [Kind.SCALAR_TYPE_DEFINITION]: 'scalar',
-        [Kind.INPUT_OBJECT_TYPE_DEFINITION]: 'input',
-        [Kind.UNION_TYPE_DEFINITION]: 'union',
-        [Kind.DIRECTIVE_DEFINITION]: 'directive',
-    };
-    switch (node.kind) {
-        case Kind.OBJECT_TYPE_DEFINITION:
-        case Kind.INTERFACE_TYPE_DEFINITION:
-        case Kind.ENUM_TYPE_DEFINITION:
-        case Kind.SCALAR_TYPE_DEFINITION:
-        case Kind.INPUT_OBJECT_TYPE_DEFINITION:
-        case Kind.UNION_TYPE_DEFINITION:
-            return `${DisplayNodeNameMap[node.kind]} ${node.name.value}`;
-        case Kind.DIRECTIVE_DEFINITION:
-            return `${DisplayNodeNameMap[node.kind]} @${node.name.value}`;
-        case Kind.FIELD_DEFINITION:
-        case Kind.INPUT_VALUE_DEFINITION:
-        case Kind.ENUM_VALUE_DEFINITION:
-            return `${node.parent.name.value}.${node.name.value}`;
-        case Kind.OPERATION_DEFINITION:
-            return node.name ? `${node.operation} ${node.name.value}` : node.operation;
-    }
-}
 const schema = {
     type: 'array',
     minItems: 1,
@@ -133,7 +105,7 @@ export const rule = {
         },
         type: 'suggestion',
         messages: {
-            [RULE_ID]: 'Description is required for `{{ nodeName }}`.',
+            [RULE_ID]: 'Description is required for {{ nodeName }}',
         },
         schema,
     },

package/esm/utils.js

@@ -84,3 +84,33 @@ export const englishJoinWords = (words) => new Intl.ListFormat('en-US', { type:
 export function truthy(value) {
     return !!value;
 }
+export function getNodeName(node) {
+    const DisplayNodeNameMap = {
+        [Kind.OBJECT_TYPE_DEFINITION]: 'type',
+        [Kind.INTERFACE_TYPE_DEFINITION]: 'interface',
+        [Kind.ENUM_TYPE_DEFINITION]: 'enum',
+        [Kind.SCALAR_TYPE_DEFINITION]: 'scalar',
+        [Kind.INPUT_OBJECT_TYPE_DEFINITION]: 'input',
+        [Kind.UNION_TYPE_DEFINITION]: 'union',
+        [Kind.DIRECTIVE_DEFINITION]: 'directive',
+        [Kind.FIELD_DEFINITION]: 'field',
+        [Kind.ENUM_VALUE_DEFINITION]: 'value',
+        [Kind.INPUT_VALUE_DEFINITION]: 'value',
+    };
+    switch (node.kind) {
+        case Kind.OBJECT_TYPE_DEFINITION:
+        case Kind.INTERFACE_TYPE_DEFINITION:
+        case Kind.ENUM_TYPE_DEFINITION:
+        case Kind.SCALAR_TYPE_DEFINITION:
+        case Kind.INPUT_OBJECT_TYPE_DEFINITION:
+        case Kind.UNION_TYPE_DEFINITION:
+        case Kind.DIRECTIVE_DEFINITION:
+            return `${DisplayNodeNameMap[node.kind]} "${node.name.value}"`;
+        case Kind.FIELD_DEFINITION:
+        case Kind.INPUT_VALUE_DEFINITION:
+        case Kind.ENUM_VALUE_DEFINITION:
+            return `${DisplayNodeNameMap[node.kind]} "${node.name.value}" in ${DisplayNodeNameMap[node.parent.kind]} "${node.parent.name.value}"`;
+        case Kind.OPERATION_DEFINITION:
+            return node.name ? `${node.operation} "${node.name.value}"` : node.operation;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.16.2-alpha-20230318045109-091842b",
+  "version": "3.16.2-alpha-20230322112454-cb28ba7",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/typings/rules/require-description.d.cts

@@ -1,5 +1,6 @@
 import { Kind } from 'graphql';
 import { GraphQLESLintRule } from '../types.cjs';
+export declare const RULE_ID = "require-description";
 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.DIRECTIVE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.OPERATION_DEFINITION];
 type AllowedKind = (typeof ALLOWED_KINDS)[number];
 export type RuleOptions = [

package/typings/rules/require-description.d.ts

@@ -1,5 +1,6 @@
 import { Kind } from 'graphql';
 import { GraphQLESLintRule } from '../types.js';
+export declare const RULE_ID = "require-description";
 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.DIRECTIVE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.OPERATION_DEFINITION];
 type AllowedKind = (typeof ALLOWED_KINDS)[number];
 export type RuleOptions = [

package/typings/utils.d.cts

@@ -35,4 +35,5 @@ export declare const ARRAY_DEFAULT_OPTIONS: {
 export declare const englishJoinWords: (words: string[]) => string;
 type Truthy<T> = T extends '' | 0 | false | null | undefined ? never : T;
 export declare function truthy<T>(value: T): value is Truthy<T>;
+export declare function getNodeName(node: any): any;
 export {};

package/typings/utils.d.ts

@@ -35,4 +35,5 @@ export declare const ARRAY_DEFAULT_OPTIONS: {
 export declare const englishJoinWords: (words: string[]) => string;
 type Truthy<T> = T extends '' | 0 | false | null | undefined ? never : T;
 export declare function truthy<T>(value: T): value is Truthy<T>;
+export declare function getNodeName(node: any): any;
 export {};