fix(eslint-plugin): [naming-convention] cover case that requires quot…

…es (#4582) * fix: cover case that requires quotes * test: cover more cases * chore: fix lint style * test: use noFormat for better testing case * nit add comment to test Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
typescript-eslint · Mar 1, 2022 · 3ea0947 · 3ea0947
1 parent fabfc2b
commit 3ea0947
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 6 deletions.
diff --git a/packages/eslint-plugin/src/rules/naming-convention-utils/validator.ts b/packages/eslint-plugin/src/rules/naming-convention-utils/validator.ts
@@ -127,7 +127,9 @@ function createValidator(
         return;
       }
 
-      if (!validatePredefinedFormat(config, name, node, originalName)) {
+      if (
+        !validatePredefinedFormat(config, name, node, originalName, modifiers)
+      ) {
         // fail
         return;
       }
@@ -376,16 +378,19 @@ function createValidator(
     name: string,
     node: TSESTree.Identifier | TSESTree.PrivateIdentifier | TSESTree.Literal,
     originalName: string,
+    modifiers: Set<Modifiers>,
   ): boolean {
     const formats = config.format;
     if (formats === null || formats.length === 0) {
       return true;
     }
 
-    for (const format of formats) {
-      const checker = PredefinedFormatToCheckFunction[format];
-      if (checker(name)) {
-        return true;
+    if (!modifiers.has(Modifiers.requiresQuotes)) {
+      for (const format of formats) {
+        const checker = PredefinedFormatToCheckFunction[format];
+        if (checker(name)) {
+          return true;
+        }
       }
     }
 

diff --git a/packages/eslint-plugin/tests/rules/naming-convention.test.ts b/packages/eslint-plugin/tests/rules/naming-convention.test.ts
@@ -6,7 +6,7 @@ import {
   Selector,
   selectorTypeToMessageString,
 } from '../../src/rules/naming-convention-utils';
-import { getFixturesRootDir, RuleTester } from '../RuleTester';
+import { getFixturesRootDir, noFormat, RuleTester } from '../RuleTester';
 
 const ruleTester = new RuleTester({
   parser: '@typescript-eslint/parser',
@@ -2224,5 +2224,23 @@ ruleTester.run('naming-convention', rule, {
       ],
       errors: Array(13).fill({ messageId: 'doesNotMatchFormat' }),
     },
+    {
+      code: noFormat`
+        type Foo = {
+          'foo     Bar': string;
+          '': string;
+          '0': string;
+          'foo': string;
+          'foo-bar': string;
+          '#foo-bar': string;
+        };
+
+        interface Bar {
+          'boo-----foo': string;
+        }
+      `,
+      // 6, not 7 because 'foo' is valid
+      errors: Array(6).fill({ messageId: 'doesNotMatchFormat' }),
+    },
   ],
 });