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

package/docs/README.md

@@ -44,7 +44,7 @@ Name            &nbs
 [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][]|🔮
 [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 your type definitions.|![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][]|🚀
 [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][]|🔮

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`
+One of: `camelCase`, `PascalCase`, `snake_case`, `UPPER_CASE`, `kebab-case`, `documentStyle`
 
 ## `asObject` (object)
 
@@ -146,6 +146,7 @@ This element must be one of the following enum values:
 - `snake_case`
 - `UPPER_CASE`
 - `kebab-case`
+- `documentStyle`
 
 ### `suffix` (string)
 

package/docs/rules/require-description.md

@@ -7,7 +7,7 @@
 - Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
-Enforce descriptions in your type definitions.
+Enforce descriptions in type definitions and operations.
 
 ## Usage Examples
 
@@ -42,9 +42,9 @@ type someTypeName {
 ```graphql
 # eslint @graphql-eslint/require-description: ['error', { OperationDefinition: true }]
 
-# Enforce description on operations
-query {
-  foo
+# Create a new user
+mutation createUser {
+  # ...
 }
 ```
 
@@ -99,6 +99,8 @@ Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#OperationDefinition).
 
+> You must use only comment syntax `#` and not description syntax `"""` or `"`.
+
 ### `ScalarTypeDefinition` (boolean)
 
 Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#ScalarTypeDefinition).

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'];
+const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case', 'documentStyle'];
 const schemaOption = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
@@ -1272,7 +1272,14 @@ const rule$3 = {
                     option = { style: option };
                 }
                 const expectedExtension = options.fileExtension || fileExtension;
-                const expectedFilename = (option.style ? convertCase(option.style, docName) : filename) + (option.suffix || '') + expectedExtension;
+                let expectedFilename;
+                if (option.style) {
+                    expectedFilename = option.style === 'documentStyle' ? docName : convertCase(option.style, docName);
+                }
+                else {
+                    expectedFilename = filename;
+                }
+                expectedFilename += (option.suffix || '') + expectedExtension;
                 const filenameWithExtension = filename + expectedExtension;
                 if (expectedFilename !== filenameWithExtension) {
                     context.report({
@@ -2638,7 +2645,7 @@ const rule$h = {
     meta: {
         docs: {
             category: 'Schema',
-            description: 'Enforce descriptions in your type definitions.',
+            description: 'Enforce descriptions in type definitions and operations.',
             url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             examples: [
                 {
@@ -2669,9 +2676,9 @@ const rule$h = {
                     title: 'Correct',
                     usage: [{ OperationDefinition: true }],
                     code: /* GraphQL */ `
-            # Enforce description on operations
-            query {
-              foo
+            # Create a new user
+            mutation createUser {
+              # ...
             }
           `,
                 },
@@ -2701,13 +2708,13 @@ const rule$h = {
                         type: 'boolean',
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
-                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => [
-                        kind,
-                        {
-                            type: 'boolean',
-                            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
-                        },
-                    ])),
+                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => {
+                        let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+                        if (kind === graphql.Kind.OPERATION_DEFINITION) {
+                            description += '\n\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.';
+                        }
+                        return [kind, { type: 'boolean', description }];
+                    })),
                 },
             },
         },
@@ -3775,6 +3782,8 @@ function loadGraphQLConfig(options) {
     const onDiskConfig = options.skipGraphQLConfig
         ? null
         : graphqlConfig.loadConfigSync({
+            // load config relative to the file being linted
+            rootDir: options.filePath ? path.dirname(options.filePath) : undefined,
             throwOnEmpty: false,
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],

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'];
+const CASE_STYLES = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case', 'documentStyle'];
 const schemaOption = {
     oneOf: [{ $ref: '#/definitions/asString' }, { $ref: '#/definitions/asObject' }],
 };
@@ -1266,7 +1266,14 @@ const rule$3 = {
                     option = { style: option };
                 }
                 const expectedExtension = options.fileExtension || fileExtension;
-                const expectedFilename = (option.style ? convertCase(option.style, docName) : filename) + (option.suffix || '') + expectedExtension;
+                let expectedFilename;
+                if (option.style) {
+                    expectedFilename = option.style === 'documentStyle' ? docName : convertCase(option.style, docName);
+                }
+                else {
+                    expectedFilename = filename;
+                }
+                expectedFilename += (option.suffix || '') + expectedExtension;
                 const filenameWithExtension = filename + expectedExtension;
                 if (expectedFilename !== filenameWithExtension) {
                     context.report({
@@ -2632,7 +2639,7 @@ const rule$h = {
     meta: {
         docs: {
             category: 'Schema',
-            description: 'Enforce descriptions in your type definitions.',
+            description: 'Enforce descriptions in type definitions and operations.',
             url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID$2}.md`,
             examples: [
                 {
@@ -2663,9 +2670,9 @@ const rule$h = {
                     title: 'Correct',
                     usage: [{ OperationDefinition: true }],
                     code: /* GraphQL */ `
-            # Enforce description on operations
-            query {
-              foo
+            # Create a new user
+            mutation createUser {
+              # ...
             }
           `,
                 },
@@ -2695,13 +2702,13 @@ const rule$h = {
                         type: 'boolean',
                         description: `Includes:\n\n${TYPES_KINDS.map(kind => `- \`${kind}\``).join('\n')}`,
                     },
-                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => [
-                        kind,
-                        {
-                            type: 'boolean',
-                            description: `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`,
-                        },
-                    ])),
+                    ...Object.fromEntries([...ALLOWED_KINDS$1].sort().map(kind => {
+                        let description = `Read more about this kind on [spec.graphql.org](https://spec.graphql.org/October2021/#${kind}).`;
+                        if (kind === Kind.OPERATION_DEFINITION) {
+                            description += '\n\n> You must use only comment syntax `#` and not description syntax `"""` or `"`.';
+                        }
+                        return [kind, { type: 'boolean', description }];
+                    })),
                 },
             },
         },
@@ -3769,6 +3776,8 @@ function loadGraphQLConfig(options) {
     const onDiskConfig = options.skipGraphQLConfig
         ? null
         : loadConfigSync({
+            // load config relative to the file being linted
+            rootDir: options.filePath ? dirname(options.filePath) : undefined,
             throwOnEmpty: false,
             throwOnMissing: false,
             extensions: [addCodeFileLoaderExtension],

package/package.json

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

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

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