feat(#35): add new errorMessage params for rule filename-naming-convention

Author: dukeluo

docs/rules/filename-naming-convention.md

@@ -130,6 +130,29 @@ module.exports = {
 };
 ```
 
+##### `errorMessage`
+
+Customizes the error message displayed when a file's filename doesn't match the declared naming pattern. It offers two placeholders for dynamic content:
+
+- `{{ target }}`: Represents the filename of the non-matching file.
+- `{{ pattern }}`: Represents the naming pattern.
+
+```js
+module.exports = {
+  plugins: ['check-file'],
+  rules: {
+    'check-file/filename-naming-convention': [
+      'error',
+      { '**/*/!(index).*': '<1>' },
+      {
+        errorMessage:
+          'The file "{{ target }}" does not match file naming convention defined("{{ pattern }}") for this project, see contribute.md for details',
+      },
+    ],
+  },
+};
+```
+
 ## Further Reading
 
 - [micromatch](https://github.com/micromatch/micromatch)

lib/rules/filename-blocklist.js

@@ -54,9 +54,7 @@ export default {
     return {
       Program: (node) => {
         const rules = context.options[0];
-        const { errorMessage } = context.options[1] || {
-          errorMessage: '',
-        };
+        const errorMessage = context.options[1]?.errorMessage ?? '';
         const error = validateNamingPatternObject(
           rules,
           globPatternValidator,

lib/rules/filename-naming-convention.js

@@ -15,6 +15,7 @@ import {
   matchRule,
   transformRuleWithPrefinedMatchSyntax,
 } from '../utils/rule.js';
+import { isNotEmpty } from '../utils/utility.js';
 import {
   filenameNamingPatternValidator,
   globPatternValidator,
@@ -44,6 +45,7 @@ export default {
         type: 'object',
         properties: {
           ignoreMiddleExtensions: { type: 'boolean' },
+          errorMessage: { type: 'string' },
         },
       },
     ],
@@ -78,7 +80,9 @@ export default {
 
         const filenameWithPath = getFilePath(context);
         const filename = getFilename(filenameWithPath);
-        const { ignoreMiddleExtensions } = context.options[1] || {};
+        const ignoreMiddleExtensions =
+          context.options[1]?.ignoreMiddleExtensions ?? false;
+        const errorMessage = context.options[1]?.errorMessage ?? '';
 
         for (const [
           originalFilenamePattern,
@@ -108,11 +112,21 @@ export default {
               };
             }
           } catch (error) {
-            context.report({
-              node,
-              messageId: error.type,
-              data: error.payload,
-            });
+            isNotEmpty(errorMessage) && error.type === 'noMatch'
+              ? context.report({
+                  node,
+                  // eslint-disable-next-line eslint-plugin/prefer-message-ids
+                  message: errorMessage,
+                  data: {
+                    target: error.payload.filename,
+                    pattern: error.payload.originalNamingPattern,
+                  },
+                })
+              : context.report({
+                  node,
+                  messageId: error.type,
+                  data: error.payload,
+                });
           }
         }
       },

tests/lib/rules/filename-naming-convention.posix.js

@@ -1392,6 +1392,35 @@ ruleTester.run(
   }
 );
 
+ruleTester.run(
+  "filename-naming-convention with option: [{ '**/*/!(index).*': '<1>' }, { errorMessage: 'The file \"{{ target }}\" does not match file naming convention defined(\"{{ pattern }}\") for this project, see contribute.md for details'}]",
+  rule,
+  {
+    valid: [],
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/components/featureA/featureB.jsx',
+        options: [
+          { '**/*/!(index).*': '<1>' },
+          {
+            errorMessage:
+              'The file "{{ target }}" does not match file naming convention defined("{{ pattern }}") for this project, see contribute.md for details',
+          },
+        ],
+        errors: [
+          {
+            message:
+              'The file "featureB.jsx" does not match file naming convention defined("<1>") for this project, see contribute.md for details',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);
+
 ruleTester.run('filename-naming-convention with option: []', rule, {
   valid: [],
   invalid: [

tests/lib/rules/filename-naming-convention.windows.js

@@ -861,7 +861,7 @@ ruleTester.run(
 );
 
 ruleTester.run(
-  "filename-naming-convention with option: [{ '**/*/!(index).*': '<1>' }, { ignoreMiddleExtensions: true }]",
+  "filename-naming-convention with option on Windows: [{ '**/*/!(index).*': '<1>' }, { ignoreMiddleExtensions: true }]",
   rule,
   {
     valid: [
@@ -929,7 +929,7 @@ ruleTester.run(
 );
 
 ruleTester.run(
-  "filename-naming-convention with option: [{ '**/*/!(index).*': '<9>' }]",
+  "filename-naming-convention with option on Windows: [{ '**/*/!(index).*': '<9>' }]",
   rule,
   {
     valid: [],
@@ -951,7 +951,36 @@ ruleTester.run(
   }
 );
 
-ruleTester.run('filename-naming-convention with option: []', rule, {
+ruleTester.run(
+  "filename-naming-convention with option on Windows: [{ '**/*/!(index).*': '<1>' }, { errorMessage: 'The file \"{{ target }}\" does not match file naming convention defined(\"{{ pattern }}\") for this project, see contribute.md for details'}]",
+  rule,
+  {
+    valid: [],
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\components\\featureA\\featureB.jsx',
+        options: [
+          { '**/*/!(index).*': '<1>' },
+          {
+            errorMessage:
+              'The file "{{ target }}" does not match file naming convention defined("{{ pattern }}") for this project, see contribute.md for details',
+          },
+        ],
+        errors: [
+          {
+            message:
+              'The file "featureB.jsx" does not match file naming convention defined("<1>") for this project, see contribute.md for details',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);
+
+ruleTester.run('filename-naming-convention with option on Windows: []', rule, {
   valid: [],
   invalid: [
     {