refactor(#35): replace nonGlobSuggestion with errorMessage

dukeluo · dukeluo · commit e0b1e5fead6b · 2024-02-17T19:55:10.000+08:00
diff --git a/docs/rules/filename-blocklist.md b/docs/rules/filename-blocklist.md
@@ -59,31 +59,29 @@ module.exports = {
 
 #### rule configuration object
 
-##### `nonGlobSuggestion`
+##### `errorMessage`
 
-If `true`, it allows the blocklist reason to be any string, instead of a strict glob pattern.
+Customizes the error message displayed when a file is blocked due to matching a blocklisted filename pattern. It offers two placeholders for dynamic content:
+
+- `{{ target }}`: Represents the filename of the blocked file.
+- `{{ pattern }}`: Represents the blocklisted filename pattern.
 
 ```js
 module.exports = {
   plugins: ['check-file'],
   rules: {
     'check-file/filename-blocklist': [
       'error',
+      { '*.models.ts': '*.model.ts' },
       {
-        '**/*.model.ts': 'see the repo rules at http://some/example.com',
-        '**/*.util.ts': 'for a non glob related reason',
+        errorMessage:
+          'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details',
       },
-      { nonGlobSuggestion: true },
     ],
   },
 };
 ```
 
-These rules would produce errors that look like:
-
-- `The filename "model.ts" matches the blocklisted "**/*.model.ts" pattern, this is not allowed see the repo rules at http://some/example.com`
-- `The filename "util.ts" matches the blocklisted "**/*.util.ts" pattern, this is not allowed for a non glob related reason`
-
 ## Further Reading
 
 - [micromatch](https://github.com/micromatch/micromatch)
diff --git a/lib/constants/message.js b/lib/constants/message.js
@@ -15,9 +15,6 @@ export const PREFINED_MATCH_SYNTAX_ERROR_MESSAGE =
 export const FILENAME_BLOCKLIST_ERROR_MESSAGE =
   'The filename "{{ filename }}" matches the blocklisted "{{ blockListPattern }}" pattern, use a pattern like "{{ suggestion }}" instead';
 
-export const FILENAME_BLOCKLIST_NON_GLOB_ERROR_MESSAGE =
-  'The filename "{{ filename }}" matches the blocklisted "{{ blockListPattern }}" pattern, this is not allowed {{ suggestion }}';
-
 export const FILENAME_NAMING_CONVENTION_ERROR_MESSAGE =
   'The filename "{{ filename }}" does not match the "{{ originalNamingPattern }}" pattern';
 
diff --git a/lib/rules/filename-blocklist.js b/lib/rules/filename-blocklist.js
@@ -5,13 +5,13 @@
 
 import {
   FILENAME_BLOCKLIST_ERROR_MESSAGE,
-  FILENAME_BLOCKLIST_NON_GLOB_ERROR_MESSAGE,
   NAMING_PATTERN_OBJECT_ERROR_MESSAGE,
   PATTERN_ERROR_MESSAGE,
 } from '../constants/message.js';
 import { getDocUrl } from '../utils/doc.js';
 import { getFilePath, getFilename } from '../utils/filename.js';
 import { matchRule } from '../utils/rule.js';
+import { isNotEmpty } from '../utils/utility.js';
 import {
   validateNamingPatternObject,
   globPatternValidator,
@@ -39,29 +39,28 @@ export default {
       {
         type: 'object',
         properties: {
-          nonGlobSuggestion: { type: 'boolean' },
+          errorMessage: { type: 'string' },
         },
       },
     ],
     messages: {
       invalidObject: NAMING_PATTERN_OBJECT_ERROR_MESSAGE,
       invalidPattern: PATTERN_ERROR_MESSAGE,
       noMatch: FILENAME_BLOCKLIST_ERROR_MESSAGE,
-      noMatchWithNonGlob: FILENAME_BLOCKLIST_NON_GLOB_ERROR_MESSAGE,
     },
   },
 
   create(context) {
     return {
       Program: (node) => {
         const rules = context.options[0];
-        const { nonGlobSuggestion } = context.options[1] || {
-          nonGlobSuggestion: false,
+        const { errorMessage } = context.options[1] || {
+          errorMessage: '',
         };
         const error = validateNamingPatternObject(
           rules,
           globPatternValidator,
-          nonGlobSuggestion ? () => true : globPatternValidator
+          globPatternValidator
         );
 
         if (error) {
@@ -78,10 +77,9 @@ export default {
         const filenameWithPath = getFilePath(context);
         const filename = getFilename(filenameWithPath);
 
-        for (const [
-          blockListPattern,
-          useInsteadPatternOrString,
-        ] of Object.entries(rules)) {
+        for (const [blockListPattern, useInsteadPattern] of Object.entries(
+          rules
+        )) {
           const matchResult =
             matchRule(filenameWithPath, blockListPattern) ||
             // TODO: remove this in next major version
@@ -91,15 +89,25 @@ export default {
             matchRule(filename, blockListPattern);
 
           if (matchResult) {
-            context.report({
-              node,
-              messageId: nonGlobSuggestion ? 'noMatchWithNonGlob' : 'noMatch',
-              data: {
-                filename,
-                blockListPattern,
-                suggestion: useInsteadPatternOrString,
-              },
-            });
+            isNotEmpty(errorMessage)
+              ? context.report({
+                  node,
+                  // eslint-disable-next-line eslint-plugin/prefer-message-ids
+                  message: errorMessage,
+                  data: {
+                    target: filename,
+                    pattern: blockListPattern,
+                  },
+                })
+              : context.report({
+                  node,
+                  messageId: 'noMatch',
+                  data: {
+                    filename,
+                    blockListPattern,
+                    suggestion: useInsteadPattern,
+                  },
+                });
             return;
           }
         }
diff --git a/tests/lib/rules/filename-blocklist.posix.js b/tests/lib/rules/filename-blocklist.posix.js
@@ -238,18 +238,19 @@ ruleTester.run('filename-blocklist with option: []', rule, {
 });
 
 ruleTester.run(
-  "filename-blocklist with option: [{'*.models.ts': 'for some Non Glob related reason'}, { nonGlobSuggestion: true }]",
+  "filename-blocklist with option: [{'*.models.ts': '*.model.ts'}, { errorMessage: 'The file \"{{ target }}\" is blocked since it since it matches the blocklisted pattern \"{{ pattern }}\", see contribute.md for details' }]",
   rule,
   {
     valid: [
       {
         code: "var foo = 'bar';",
         filename: 'src/foo.apis.ts',
         options: [
+          { '*.models.ts': '*.model.ts' },
           {
-            '*.models.ts': 'for some Non Glob related reason',
+            errorMessage:
+              'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details',
           },
-          { nonGlobSuggestion: true },
         ],
       },
     ],
@@ -259,15 +260,16 @@ ruleTester.run(
         code: "var foo = 'bar';",
         filename: 'src/foo.models.ts',
         options: [
+          { '*.models.ts': '*.model.ts' },
           {
-            '*.models.ts': 'for some Non Glob related reason',
+            errorMessage:
+              'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details',
           },
-          { nonGlobSuggestion: true },
         ],
         errors: [
           {
             message:
-              'The filename "foo.models.ts" matches the blocklisted "*.models.ts" pattern, this is not allowed for some Non Glob related reason',
+              'The file "foo.models.ts" is blocked since it since it matches the blocklisted pattern "*.models.ts", see contribute.md for details',
             column: 1,
             line: 1,
           },
diff --git a/tests/lib/rules/filename-blocklist.windows.js b/tests/lib/rules/filename-blocklist.windows.js
@@ -166,18 +166,19 @@ ruleTester.run('filename-blocklist with option on Windows: []', rule, {
 });
 
 ruleTester.run(
-  "filename-blocklist with option on Windows: [{'*.models.ts': 'for some Non Glob related reason'}, { nonGlobSuggestion: true }]",
+  "filename-blocklist with option on Windows: [{'*.models.ts': '*.model.ts'}, { errorMessage: 'The file \"{{ target }}\" is blocked since it since it matches the blocklisted pattern \"{{ pattern }}\", see contribute.md for details' }]",
   rule,
   {
     valid: [
       {
         code: "var foo = 'bar';",
         filename: 'src\\foo.apis.ts',
         options: [
+          { '*.models.ts': '*.model.ts' },
           {
-            '*.models.ts': 'for some Non Glob related reason',
+            errorMessage:
+              'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details',
           },
-          { nonGlobSuggestion: true },
         ],
       },
     ],
@@ -187,13 +188,16 @@ ruleTester.run(
         code: "var foo = 'bar';",
         filename: 'src\\foo.models.ts',
         options: [
-          { '*.models.ts': 'for some Non Glob related reason' },
-          { nonGlobSuggestion: true },
+          { '*.models.ts': '*.model.ts' },
+          {
+            errorMessage:
+              'The file "{{ target }}" is blocked since it since it matches the blocklisted pattern "{{ pattern }}", see contribute.md for details',
+          },
         ],
         errors: [
           {
             message:
-              'The filename "foo.models.ts" matches the blocklisted "*.models.ts" pattern, this is not allowed for some Non Glob related reason',
+              'The file "foo.models.ts" is blocked since it since it matches the blocklisted pattern "*.models.ts", see contribute.md for details',
             column: 1,
             line: 1,
           },
