feat: add errorMessage for folder-naming-convention

Author: dukeluo

docs/rules/folder-naming-convention.md

@@ -94,18 +94,54 @@ While `NEXT_JS_APP_ROUTER_CASE` covers many naming cases, it's possible that som
 The key is used to select target folders, while the value is used to declare the naming pattern for the folder name. You can specify a different naming pattern for different target folders. The plugin will only check folders you explicitly provided:
 
 ```js
-module.exports = {
-  plugins: ['check-file'],
-  rules: {
-    'check-file/folder-naming-convention': [
-      'error',
-      {
-        'src/**/': 'CAMEL_CASE',
-        'mocks/*/': 'KEBAB_CASE',
-      },
-    ],
+export default [
+  {
+    plugins: {
+      'check-file': checkFile,
+    },
+    rules: {
+      'check-file/folder-naming-convention': [
+        'error',
+        {
+          'src/**/': 'CAMEL_CASE',
+          'mocks/*/': 'KEBAB_CASE',
+        },
+      ],
+    },
   },
-};
+];
+```
+
+#### rule configuration object
+
+##### `errorMessage`
+
+Customizes the error message displayed when a folder does not match the naming pattern. It offers two placeholders for dynamic content:
+
+- `{{ target }}`: Represents the target folder.
+- `{{ pattern }}`: Represents the naming pattern for the target folder.
+
+```js
+export default [
+  {
+    plugins: {
+      'check-file': checkFile,
+    },
+    rules: {
+      'check-file/folder-naming-convention': [
+        'error',
+        {
+          'src/**/': 'CAMEL_CASE',
+          'mocks/*/': 'KEBAB_CASE',
+        },
+        {
+          errorMessage:
+            'The folder "{{ target }}" does not match the "{{ pattern }}" pattern, see contribute.md for details',
+        },
+      ],
+    },
+  },
+];
 ```
 
 ## Further Reading

lib/rules/folder-naming-convention.js

@@ -44,6 +44,12 @@ export default {
           type: 'string',
         },
       },
+      {
+        type: 'object',
+        properties: {
+          errorMessage: { type: 'string' },
+        },
+      },
     ],
     messages: {
       invalidObject: NAMING_PATTERN_OBJECT_ERROR_MESSAGE,
@@ -75,6 +81,7 @@ export default {
 
         const filenameWithPath = getFilePath(context);
         const folderPath = getFolderPath(filenameWithPath);
+        const errorMessage = context.options[1]?.errorMessage ?? '';
 
         for (const [folderPattern, namingPattern] of Object.entries(rules)) {
           if (
@@ -102,14 +109,24 @@ export default {
                     namingPattern
                 )
               ) {
-                context.report({
-                  node,
-                  messageId: 'noMatch',
-                  data: {
-                    folder,
-                    namingPattern,
-                  },
-                });
+                isNotEmpty(errorMessage)
+                  ? context.report({
+                      node,
+                      // eslint-disable-next-line eslint-plugin/prefer-message-ids
+                      message: errorMessage,
+                      data: {
+                        target: folder,
+                        pattern: namingPattern,
+                      },
+                    })
+                  : context.report({
+                      node,
+                      messageId: 'noMatch',
+                      data: {
+                        folder,
+                        namingPattern,
+                      },
+                    });
                 return;
               }
             }

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

@@ -562,3 +562,45 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run(
+  "folder-naming-convention with option: [{ 'src/**/': 'CAMEL_CASE' }, { errorMessage: 'The folder {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details' }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/components/displayLabel/displayLabel.js',
+        options: [
+          { 'src/**/': 'CAMEL_CASE' },
+          {
+            errorMessage:
+              'The folder {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/components/DisplayLabel/displayLabel.js',
+        options: [
+          { 'src/**/': 'CAMEL_CASE' },
+          {
+            errorMessage:
+              'The folder {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+        errors: [
+          {
+            message:
+              'The folder DisplayLabel does not match the CAMEL_CASE pattern, see contribute.md for details',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);

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

@@ -565,3 +565,45 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run(
+  "folder-naming-convention with option on Windows: [{ 'src/**/': 'CAMEL_CASE' }, { errorMessage: 'The folder {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details' }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\components\\displayLabel\\displayLabel.js',
+        options: [
+          { 'src/**/': 'CAMEL_CASE' },
+          {
+            errorMessage:
+              'The folder {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\components\\DisplayLabel\\displayLabel.js',
+        options: [
+          { 'src/**/': 'CAMEL_CASE' },
+          {
+            errorMessage:
+              'The folder {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+        errors: [
+          {
+            message:
+              'The folder DisplayLabel does not match the CAMEL_CASE pattern, see contribute.md for details',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);