feat: add errorMessage for folder-match-with-fex

Author: dukeluo

docs/rules/folder-match-with-fex.md

@@ -33,18 +33,54 @@ bar/__tests__/foo.test.js
 The key is used to select target files, while the value is used to declare the naming pattern for their folder names. You can specify a different folder naming pattern for different target files. The plugin will only check files you explicitly provided:
 
 ```js
-module.exports = {
-  plugins: ['check-file'],
-  rules: {
-    'check-file/folder-match-with-fex': [
-      'error',
-      {
-        '*.test.{js,jsx,ts,tsx}': '**/__tests__/',
-        '*.styled.{jsx,tsx}': '**/pages/',
-      },
-    ],
+export default [
+  {
+    plugins: {
+      'check-file': checkFile,
+    },
+    rules: {
+      'check-file/folder-match-with-fex': [
+        'error',
+        {
+          '*.test.{js,jsx,ts,tsx}': '**/__tests__/',
+          '*.styled.{jsx,tsx}': '**/pages/',
+        },
+      ],
+    },
   },
-};
+];
+```
+
+#### rule configuration object
+
+##### `errorMessage`
+
+Customizes the error message displayed when a file's folder does not match the naming pattern. It offers two placeholders for dynamic content:
+
+- `{{ target }}`: Represents the target file.
+- `{{ pattern }}`: Represents the naming pattern for the target file's folder name.
+
+```js
+export default [
+  {
+    plugins: {
+      'check-file': checkFile,
+    },
+    rules: {
+      'check-file/folder-match-with-fex': [
+        'error',
+        {
+          '*.test.{js,jsx,ts,tsx}': '**/__tests__/',
+          '*.styled.{jsx,tsx}': '**/pages/',
+        },
+        {
+          errorMessage:
+            'The folder of the file "{{ target }}" does not match the "{{ pattern }}" pattern, see contribute.md for details',
+        },
+      ],
+    },
+  },
+];
 ```
 
 ## Further Reading

lib/rules/folder-match-with-fex.js

@@ -11,6 +11,7 @@ import {
 import { getDocUrl } from '../utils/doc.js';
 import { getFilePath, getFilename, getFolderPath } from '../utils/filename.js';
 import { matchRule } from '../utils/rule.js';
+import { isNotEmpty } from '../utils/utility.js';
 import {
   globPatternValidator,
   validateNamingPatternObject,
@@ -36,6 +37,12 @@ export default {
           type: 'string',
         },
       },
+      {
+        type: 'object',
+        properties: {
+          errorMessage: { type: 'string' },
+        },
+      },
     ],
     messages: {
       invalidObject: NAMING_PATTERN_OBJECT_ERROR_MESSAGE,
@@ -68,6 +75,7 @@ export default {
         const filenameWithPath = getFilePath(context);
         const filename = getFilename(filenameWithPath);
         const folderPath = getFolderPath(filenameWithPath);
+        const errorMessage = context.options[1]?.errorMessage ?? '';
 
         for (const [fexPattern, folderPattern] of Object.entries(rules)) {
           const matchResult = matchRule(
@@ -78,14 +86,24 @@ export default {
           );
 
           if (matchResult) {
-            context.report({
-              node,
-              messageId: 'noMatch',
-              data: {
-                filenameWithPath,
-                folderPattern,
-              },
-            });
+            isNotEmpty(errorMessage)
+              ? context.report({
+                  node,
+                  // eslint-disable-next-line eslint-plugin/prefer-message-ids
+                  message: errorMessage,
+                  data: {
+                    target: filename,
+                    pattern: folderPattern,
+                  },
+                })
+              : context.report({
+                  node,
+                  messageId: 'noMatch',
+                  data: {
+                    filenameWithPath,
+                    folderPattern,
+                  },
+                });
             return;
           }
         }

lib/rules/no-index.js

@@ -38,14 +38,15 @@ export default {
   create(context) {
     return {
       Program: (node) => {
-        const { ignoreMiddleExtensions, errorMessage } =
-          context.options[0] || {};
+        const ignoreMiddleExtensions =
+          context.options[0]?.ignoreMiddleExtensions ?? false;
+        const errorMessage = context.options[0]?.errorMessage ?? '';
         const filenameWithPath = getFilePath(context);
         const filename = getFilename(filenameWithPath);
         const basename = getBasename(filename, ignoreMiddleExtensions);
 
         if (basename === 'index') {
-          errorMessage && isNotEmpty(errorMessage)
+          isNotEmpty(errorMessage)
             ? context.report({
                 node,
                 // eslint-disable-next-line eslint-plugin/prefer-message-ids

tests/lib/rules/folder-match-with-fex.posix.js

@@ -332,3 +332,45 @@ ruleTester.run('folder-match-with-fex with option: []', rule, {
     },
   ],
 });
+
+ruleTester.run(
+  "folder-match-with-fex with option: [{ '*.test.js': '*/__tests__/' }, { errorMessage: 'The folder of the file {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details' }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'bar/__tests__/foo.test.js',
+        options: [
+          { '*.test.js': '*/__tests__/' },
+          {
+            errorMessage:
+              'The folder of the file {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'bar/_tests_/foo.test.js',
+        options: [
+          { '*.test.js': '*/__tests__/' },
+          {
+            errorMessage:
+              'The folder of the file {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+        errors: [
+          {
+            message:
+              'The folder of the file foo.test.js does not match the */__tests__/ pattern, see contribute.md for details',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);

tests/lib/rules/folder-match-with-fex.windows.js

@@ -331,3 +331,45 @@ ruleTester.run('folder-match-with-fex with option on Windows: []', rule, {
     },
   ],
 });
+
+ruleTester.run(
+  "folder-match-with-fex with option on Windows: [{ '*.test.js': '*/__tests__/' }, { errorMessage: 'The folder of the file {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details' }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'bar\\__tests__\\foo.test.js',
+        options: [
+          { '*.test.js': '*/__tests__/' },
+          {
+            errorMessage:
+              'The folder of the file {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'bar\\_tests_\\foo.test.js',
+        options: [
+          { '*.test.js': '*/__tests__/' },
+          {
+            errorMessage:
+              'The folder of the file {{ target }} does not match the {{ pattern }} pattern, see contribute.md for details',
+          },
+        ],
+        errors: [
+          {
+            message:
+              'The folder of the file foo.test.js does not match the */__tests__/ pattern, see contribute.md for details',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);