New option prefix for match-document-filename rule (#1141)

* prefix

add spec

valid

invalid

invalid

changeset

minor changeset

fix changeset

* fix

Co-authored-by: Dimitri POSTOLOV <[email protected]>

Author: TuvalSimha

.changeset/light-lizards-know.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+add new option `prefix` for `match-document-filename` rule

docs/rules/match-document-filename.md

@@ -85,6 +85,28 @@ query UserById {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { style: 'kebab-case', prefix: 'mutation.' } }]
+
+# mutation.add-alert.graphql
+mutation addAlert {
+  foo
+}
+```
+
+### Correct
+
+```graphql
+# eslint @graphql-eslint/match-document-filename: ['error', { fragment: { prefix: 'query.' } }]
+
+# query.me.graphql
+query me {
+  foo
+}
+```
+
 ## Config Schema
 
 The schema defines the following properties:
@@ -151,6 +173,8 @@ This element must be one of the following enum values:
 
 ### `suffix` (string)
 
+### `prefix` (string)
+
 ## Resources
 
 - [Rule source](../../packages/plugin/src/rules/match-document-filename.ts)

packages/plugin/src/rules/match-document-filename.ts

@@ -37,6 +37,7 @@ const schema = {
       properties: {
         style: { enum: CASE_STYLES },
         suffix: { type: 'string' },
+        prefix: { type: 'string' },
       },
     },
   },
@@ -137,6 +138,26 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
             }
           `,
         },
+        {
+          title: 'Correct',
+          usage: [{ fragment: { style: 'kebab-case', prefix: 'mutation.' } }],
+          code: /* GraphQL */ `
+            # mutation.add-alert.graphql
+            mutation addAlert {
+              foo
+            }
+          `,
+        },
+        {
+          title: 'Correct',
+          usage: [{ fragment: { prefix: 'query.' } }],
+          code: /* GraphQL */ `
+            # query.me.graphql
+            query me {
+              foo
+            }
+          `,
+        },
       ],
       configOptions: [
         {
@@ -211,12 +232,13 @@ export const rule: GraphQLESLintRule<RuleOptions> = {
           option = { style: option };
         }
         const expectedExtension = options.fileExtension || fileExtension;
-        let expectedFilename: string;
+        let expectedFilename = option.prefix || '';
+
         if (option.style) {
-          expectedFilename =
+          expectedFilename +=
             option.style === 'matchDocumentStyle' ? docName : convertCase(option.style, docName);
         } else {
-          expectedFilename = filename;
+          expectedFilename += filename;
         }
         expectedFilename += (option.suffix || '') + expectedExtension;
         const filenameWithExtension = filename + expectedExtension;

packages/plugin/tests/__snapshots__/match-document-filename.spec.md

@@ -75,6 +75,28 @@ exports[`Invalid #4 1`] = `
         | ^ Unexpected filename "user-fields.gql". Rename it to "UserFields.gql"
 `;
 
+exports[`Invalid #7 1`] = `
+#### ⌨️ Code
+
+      1 |         mutation addAlertChannel {
+      2 |           foo
+      3 |         }
+
+#### ⚙️ Options
+
+    {
+      "mutation": {
+        "prefix": "mutation."
+      }
+    }
+
+#### ❌ Error
+
+    > 1 |         mutation addAlertChannel {
+        | ^ Unexpected filename "add-alert-channel.graphql". Rename it to "mutation.add-alert-channel.graphql"
+      2 |           foo
+`;
+
 exports[`compare only first operation name 1`] = `
 #### ⌨️ Code
 

packages/plugin/tests/match-document-filename.spec.ts

@@ -105,5 +105,20 @@ ruleTester.runGraphQLTests<RuleOptions>('match-document-filename', rule, {
         { message: 'Unexpected filename "getUsersQuery.gql". Rename it to "GetUsers.query.gql"' },
       ],
     },
+    {
+      filename: 'add-alert-channel.graphql',
+      code: /* GraphQL */ `
+        mutation addAlertChannel {
+          foo
+        }
+      `,
+      options: [{ mutation: { prefix: 'mutation.' } }],
+      errors: [
+        {
+          message:
+            'Unexpected filename "add-alert-channel.graphql". Rename it to "mutation.add-alert-channel.graphql"',
+        },
+      ],
+    },
   ],
 });