feat: add new option ignorePattern for naming-convention rule (#865)

Author: dimaMachina

.changeset/lazy-walls-chew.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+feat: add new option ignorePattern for `naming-convention` rule

docs/rules/naming-convention.md

@@ -71,6 +71,18 @@ type Query {
 }
 ```
 
+### Correct
+
+```graphql
+# eslint @graphql-eslint/naming-convention: ['error', { FieldDefinition: { style: 'camelCase', ignorePattern: '^(EAN13|UPC|UK)' } }]
+
+type Product {
+  EAN13: String
+  UPC: String
+  UKFlag: String
+}
+```
+
 ## Config Schema
 
 > It's possible to use a [`selector`](https://eslint.org/docs/developer-guide/selectors) that starts with allowed `ASTNode` names which are described below.
@@ -276,6 +288,10 @@ Additional restrictions:
 * Minimum items: `1`
 * Unique items: `true`
 
+### `ignorePattern` (string)
+
+Option to skip validation of some words, e.g. acronyms
+
 ## Resources
 
 - [Rule source](../../packages/plugin/src/rules/naming-convention.ts)

packages/plugin/src/rules/naming-convention.ts

@@ -47,6 +47,7 @@ type PropertySchema = {
   prefix?: string;
   forbiddenPrefixes?: string[];
   forbiddenSuffixes?: string[];
+  ignorePattern?: string;
 };
 
 type Options = AllowedStyle | PropertySchema;
@@ -124,6 +125,17 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
             }
           `,
         },
+        {
+          title: 'Correct',
+          usage: [{ FieldDefinition: { style: 'camelCase', ignorePattern: '^(EAN13|UPC|UK)' } }],
+          code: /* GraphQL */ `
+            type Product {
+              EAN13: String
+              UPC: String
+              UKFlag: String
+            }
+          `,
+        },
       ],
       configOptions: {
         schema: [
@@ -191,6 +203,10 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
               minItems: 1,
               items: { type: 'string' },
             },
+            ignorePattern: {
+              type: 'string',
+              description: 'Option to skip validation of some words, e.g. acronyms',
+            },
           },
         },
       },
@@ -249,15 +265,16 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
       if (!node) {
         return;
       }
-      const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style } = normalisePropertyOption(selector);
+      const { prefix, suffix, forbiddenPrefixes, forbiddenSuffixes, style, ignorePattern } =
+        normalisePropertyOption(selector);
       const nodeType = KindToDisplayName[n.kind] || n.kind;
       const nodeName = node.value;
       const error = getError();
       if (error) {
         const { errorMessage, renameToName } = error;
-        const [leadingUnderscore] = nodeName.match(/^_*/);
-        const [trailingUnderscore] = nodeName.match(/_*$/);
-        const suggestedName = leadingUnderscore + renameToName + trailingUnderscore;
+        const [leadingUnderscores] = nodeName.match(/^_*/);
+        const [trailingUnderscores] = nodeName.match(/_*$/);
+        const suggestedName = leadingUnderscores + renameToName + trailingUnderscores;
         context.report({
           loc: getLocation(node.loc, node.value),
           message: `${nodeType} "${nodeName}" should ${errorMessage}`,
@@ -275,6 +292,9 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
         renameToName: string;
       } | void {
         const name = nodeName.replace(/(^_+)|(_+$)/g, '');
+        if (ignorePattern && new RegExp(ignorePattern, 'u').test(name)) {
+          return;
+        }
         if (prefix && !name.startsWith(prefix)) {
           return {
             errorMessage: `have "${prefix}" prefix`,
@@ -301,8 +321,12 @@ const rule: GraphQLESLintRule<[NamingConventionRuleConfig]> = {
             renameToName: name.replace(new RegExp(`${forbiddenSuffix}$`), ''),
           };
         }
+        // Style is optional
+        if (!style) {
+          return;
+        }
         const caseRegex = StyleToRegex[style];
-        if (caseRegex && !caseRegex.test(name)) {
+        if (!caseRegex.test(name)) {
           return {
             errorMessage: `be in ${style} format`,
             renameToName: convertCase(style, name),

packages/plugin/tests/naming-convention.spec.ts

@@ -112,6 +112,34 @@ ruleTester.runGraphQLTests<[NamingConventionRuleConfig]>('naming-convention', ru
       options: [{ OperationDefinition: { style: 'PascalCase' } }],
     },
     '{ test { __typename ok_ } }',
+    {
+      name: 'should ignore fields',
+      code: /* GraphQL */ `
+        type Test {
+          EU: ID
+          EUIntlFlag: ID
+          IE: ID
+          IEIntlFlag: ID
+          GB: ID
+          UKFlag: ID
+          UKService_Badge: ID
+          CCBleaching: ID
+          CCDryCleaning: ID
+          CCIroning: ID
+          UPC: ID
+          CMWA: ID
+          EAN13: ID
+        }
+      `,
+      options: [
+        {
+          FieldDefinition: {
+            style: 'camelCase',
+            ignorePattern: '^(EU|IE|GB|UK|CC|UPC|CMWA|EAN13)',
+          },
+        },
+      ],
+    },
   ],
   invalid: [
     {