@graphql-eslint/eslint-plugin 3.8.0-alpha-998ffa8.0 → 3.8.0-alpha-fb12b01.0

package/docs/rules/match-document-filename.md

@@ -131,7 +131,7 @@ The schema defines the following additional types:
 
 ## `asString` (enum)
 
-One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`, `kebab-case`, `documentStyle`
+One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`, `kebab-case`, `matchDocumentStyle`
 
 ## `asObject` (object)
 
@@ -146,7 +146,7 @@ This element must be one of the following enum values:
 - `snake_case`
 - `UPPER_CASE`
 - `kebab-case`
-- `documentStyle`
+- `matchDocumentStyle`
 
 ### `suffix` (string)
 

package/index.js

@@ -1098,7 +1098,7 @@ const rule$2 = {
 const MATCH_EXTENSION = 'MATCH_EXTENSION';
 const MATCH_STYLE = 'MATCH_STYLE';
 const ACCEPTED_EXTENSIONS = ['.gql', '.graphql'];
-const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case', 'documentStyle'];
+const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case', 'matchDocumentStyle'];
 const schemaOption = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
@@ -1274,7 +1274,7 @@ const rule$3 = {
                 const expectedExtension = options.fileExtension || fileExtension;
                 let expectedFilename;
                 if (option.style) {
-                    expectedFilename = option.style === 'documentStyle' ? docName : convertCase(option.style, docName);
+                    expectedFilename = option.style === 'matchDocumentStyle' ? docName : convertCase(option.style, docName);
                 }
                 else {
                     expectedFilename = filename;
@@ -2635,12 +2635,40 @@ const rule$g = {
 const RULE_ID$2 = 'require-description';
 const ALLOWED_KINDS$1 = [
     ...TYPES_KINDS,
+    graphql.Kind.DIRECTIVE_DEFINITION,
     graphql.Kind.FIELD_DEFINITION,
     graphql.Kind.INPUT_VALUE_DEFINITION,
     graphql.Kind.ENUM_VALUE_DEFINITION,
-    graphql.Kind.DIRECTIVE_DEFINITION,
     graphql.Kind.OPERATION_DEFINITION,
 ];
+function getNodeName(node) {
+    const DisplayNodeNameMap = {
+        [graphql.Kind.OBJECT_TYPE_DEFINITION]: 'type',
+        [graphql.Kind.INTERFACE_TYPE_DEFINITION]: 'interface',
+        [graphql.Kind.ENUM_TYPE_DEFINITION]: 'enum',
+        [graphql.Kind.SCALAR_TYPE_DEFINITION]: 'scalar',
+        [graphql.Kind.INPUT_OBJECT_TYPE_DEFINITION]: 'input',
+        [graphql.Kind.UNION_TYPE_DEFINITION]: 'union',
+        [graphql.Kind.DIRECTIVE_DEFINITION]: 'directive',
+    };
+    switch (node.kind) {
+        case graphql.Kind.OBJECT_TYPE_DEFINITION:
+        case graphql.Kind.INTERFACE_TYPE_DEFINITION:
+        case graphql.Kind.ENUM_TYPE_DEFINITION:
+        case graphql.Kind.SCALAR_TYPE_DEFINITION:
+        case graphql.Kind.INPUT_OBJECT_TYPE_DEFINITION:
+        case graphql.Kind.UNION_TYPE_DEFINITION:
+            return `${DisplayNodeNameMap[node.kind]} ${node.name.value}`;
+        case graphql.Kind.DIRECTIVE_DEFINITION:
+            return `${DisplayNodeNameMap[node.kind]} @${node.name.value}`;
+        case graphql.Kind.FIELD_DEFINITION:
+        case graphql.Kind.INPUT_VALUE_DEFINITION:
+        case graphql.Kind.ENUM_VALUE_DEFINITION:
+            return `${node.parent.name.value}.${node.name.value}`;
+        case graphql.Kind.OPERATION_DEFINITION:
+            return node.name ? `${node.operation} ${node.name.value}` : node.operation;
+    }
+}
 const rule$h = {
     meta: {
         docs: {
@@ -2693,7 +2721,7 @@ const rule$h = {
         },
         type: 'suggestion',
         messages: {
-            [RULE_ID$2]: 'Description is required for nodes of type "{{ nodeType }}"',
+            [RULE_ID$2]: 'Description is required for `{{ nodeName }}`.',
         },
         schema: {
             type: 'array',
@@ -2755,7 +2783,7 @@ const rule$h = {
                         loc: isOperation ? getLocation(node.loc, node.operation) : getLocation(node.name.loc, node.name.value),
                         messageId: RULE_ID$2,
                         data: {
-                            nodeType: node.kind,
+                            nodeName: getNodeName(node),
                         },
                     });
                 }

package/index.mjs

@@ -1092,7 +1092,7 @@ const rule$2 = {
 const MATCH_EXTENSION = 'MATCH_EXTENSION';
 const MATCH_STYLE = 'MATCH_STYLE';
 const ACCEPTED_EXTENSIONS = ['.gql', '.graphql'];
-const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case', 'documentStyle'];
+const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case', 'matchDocumentStyle'];
 const schemaOption = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
@@ -1268,7 +1268,7 @@ const rule$3 = {
                 const expectedExtension = options.fileExtension || fileExtension;
                 let expectedFilename;
                 if (option.style) {
-                    expectedFilename = option.style === 'documentStyle' ? docName : convertCase(option.style, docName);
+                    expectedFilename = option.style === 'matchDocumentStyle' ? docName : convertCase(option.style, docName);
                 }
                 else {
                     expectedFilename = filename;
@@ -2629,12 +2629,40 @@ const rule$g = {
 const RULE_ID$2 = 'require-description';
 const ALLOWED_KINDS$1 = [
     ...TYPES_KINDS,
+    Kind.DIRECTIVE_DEFINITION,
     Kind.FIELD_DEFINITION,
     Kind.INPUT_VALUE_DEFINITION,
     Kind.ENUM_VALUE_DEFINITION,
-    Kind.DIRECTIVE_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 rule$h = {
     meta: {
         docs: {
@@ -2687,7 +2715,7 @@ const rule$h = {
         },
         type: 'suggestion',
         messages: {
-            [RULE_ID$2]: 'Description is required for nodes of type "{{ nodeType }}"',
+            [RULE_ID$2]: 'Description is required for `{{ nodeName }}`.',
         },
         schema: {
             type: 'array',
@@ -2749,7 +2777,7 @@ const rule$h = {
                         loc: isOperation ? getLocation(node.loc, node.operation) : getLocation(node.name.loc, node.name.value),
                         messageId: RULE_ID$2,
                         data: {
-                            nodeType: node.kind,
+                            nodeName: getNodeName(node),
                         },
                     });
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.8.0-alpha-998ffa8.0",
+  "version": "3.8.0-alpha-fb12b01.0",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {

package/rules/match-document-filename.d.ts

@@ -1,6 +1,6 @@
 import { CaseStyle as _CaseStyle } from '../utils';
 import { GraphQLESLintRule } from '../types';
-declare type CaseStyle = _CaseStyle | 'documentStyle';
+declare type CaseStyle = _CaseStyle | 'matchDocumentStyle';
 declare const ACCEPTED_EXTENSIONS: ['.gql', '.graphql'];
 declare type PropertySchema = {
     style?: CaseStyle;

package/rules/require-description.d.ts

@@ -1,6 +1,6 @@
 import { Kind } from 'graphql';
 import { GraphQLESLintRule } from '../types';
-declare const ALLOWED_KINDS: readonly [Kind.OBJECT_TYPE_DEFINITION, Kind.INTERFACE_TYPE_DEFINITION, Kind.ENUM_TYPE_DEFINITION, Kind.SCALAR_TYPE_DEFINITION, Kind.INPUT_OBJECT_TYPE_DEFINITION, Kind.UNION_TYPE_DEFINITION, Kind.FIELD_DEFINITION, Kind.INPUT_VALUE_DEFINITION, Kind.ENUM_VALUE_DEFINITION, Kind.DIRECTIVE_DEFINITION, Kind.OPERATION_DEFINITION];
+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];
 declare type AllowedKind = typeof ALLOWED_KINDS[number];
 export declare type RequireDescriptionRuleConfig = {
     types?: boolean;