feat: add new style matchDocumentStyle for match-document-filename rule (#929)

* feat: add new style `documentStyle` for `match-document-filename` rule

* rename `documentStyle` to `matchDocumentStyle`

Author: dimaMachina

.changeset/strong-fireants-greet.md

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

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

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

@@ -1,15 +1,17 @@
 import { basename, extname } from 'path';
 import { existsSync } from 'fs';
 import { FragmentDefinitionNode, Kind, OperationDefinitionNode } from 'graphql';
-import { CaseStyle, convertCase } from '../utils';
+import { CaseStyle as _CaseStyle, convertCase } from '../utils';
 import { GraphQLESLintRule } from '../types';
 import { GraphQLESTreeNode } from '../estree-parser';
 
+type CaseStyle = _CaseStyle | 'matchDocumentStyle';
+
 const MATCH_EXTENSION = 'MATCH_EXTENSION';
 const MATCH_STYLE = 'MATCH_STYLE';
 
 const ACCEPTED_EXTENSIONS: ['.gql', '.graphql'] = ['.gql', '.graphql'];
-const CASE_STYLES: CaseStyle[] = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case'];
+const CASE_STYLES: CaseStyle[] = ['camelCase', 'PascalCase', 'snake_case', 'UPPER_CASE', 'kebab-case', 'matchDocumentStyle'];
 
 type PropertySchema = {
   style?: CaseStyle;
@@ -210,8 +212,13 @@ const rule: GraphQLESLintRule<[MatchDocumentFilenameRuleConfig]> = {
           option = { style: option } as PropertySchema;
         }
         const expectedExtension = options.fileExtension || fileExtension;
-        const expectedFilename =
-          (option.style ? convertCase(option.style, docName) : filename) + (option.suffix || '') + expectedExtension;
+        let expectedFilename: string;
+        if (option.style) {
+          expectedFilename = option.style === 'matchDocumentStyle' ? docName : convertCase(option.style, docName);
+        } else {
+          expectedFilename = filename;
+        }
+        expectedFilename += (option.suffix || '') + expectedExtension;
         const filenameWithExtension = filename + expectedExtension;
 
         if (expectedFilename !== filenameWithExtension) {

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

@@ -12,17 +12,17 @@ ruleTester.runGraphQLTests<[MatchDocumentFilenameRuleConfig]>('match-document-fi
     },
     {
       filename: 'src/user-by-id.query.gql',
-      code: `query USER_BY_ID { user { id } }`,
+      code: 'query USER_BY_ID { user { id } }',
       options: [{ query: { style: 'kebab-case', suffix: '.query' } }],
     },
     {
       filename: 'src/createUserQuery.gql',
-      code: `mutation CREATE_USER { user { id } }`,
+      code: 'mutation CREATE_USER { user { id } }',
       options: [{ mutation: { style: 'camelCase', suffix: 'Query' } }],
     },
     {
       filename: 'src/NEW_USER.gql',
-      code: `subscription new_user { user { id } }`,
+      code: 'subscription new_user { user { id } }',
       options: [{ subscription: { style: 'UPPER_CASE' } }],
     },
     {
@@ -32,9 +32,14 @@ ruleTester.runGraphQLTests<[MatchDocumentFilenameRuleConfig]>('match-document-fi
     },
     {
       filename: 'src/UserById.gql',
-      code: `query USER_BY_ID { user { id } }`,
+      code: 'query USER_BY_ID { user { id } }',
       options: [{ query: { style: 'PascalCase' } }],
     },
+    {
+      filename: 'src/SAMEAsOperation.gql',
+      code: 'query SAMEAsOperation { foo }',
+      options: [{ query: 'matchDocumentStyle' }],
+    },
   ],
   invalid: [
     {
@@ -45,26 +50,26 @@ ruleTester.runGraphQLTests<[MatchDocumentFilenameRuleConfig]>('match-document-fi
     },
     {
       filename: 'src/user-by-id.gql',
-      code: `query UserById { user { id } }`,
+      code: 'query UserById { user { id } }',
       options: [{ query: { style: 'PascalCase' } }],
       errors: [{ message: `Unexpected filename "user-by-id.gql". Rename it to "UserById.gql"` }],
     },
     {
       filename: 'src/userById.gql',
-      code: `query UserById { user { id } }`,
+      code: 'query UserById { user { id } }',
       options: [{ query: { style: 'PascalCase', suffix: '.query' } }],
       errors: [{ message: `Unexpected filename "userById.gql". Rename it to "UserById.query.gql"` }],
     },
     {
       filename: 'src/user-fields.gql',
-      code: `fragment UserFields on User { id }`,
+      code: 'fragment UserFields on User { id }',
       options: [{ fragment: { style: 'PascalCase' } }],
       errors: [{ message: 'Unexpected filename "user-fields.gql". Rename it to "UserFields.gql"' }],
     },
     {
-      // Compare only first operation name
+      name: 'compare only first operation name',
       filename: 'src/getUsersQuery.gql',
-      code: `query getUsers { users } mutation createPost { createPost }`,
+      code: 'query getUsers { users } mutation createPost { createPost }',
       options: [
         {
           query: { style: 'PascalCase', suffix: '.query' },
@@ -74,7 +79,7 @@ ruleTester.runGraphQLTests<[MatchDocumentFilenameRuleConfig]>('match-document-fi
       errors: [{ message: 'Unexpected filename "getUsersQuery.gql". Rename it to "GetUsers.query.gql"' }],
     },
     {
-      // Compare only first operation name if fragment is present
+      name: 'compare only first operation name if fragment is present',
       filename: 'src/getUsersQuery.gql',
       code: /* GraphQL */ `
         fragment UserFields on User {