feat: add ignoreWords parameter to folder-naming-convention rule (#59)

* feat: add skipWords parameter

* fix: rollback package-lock.json

Author: camsong

docs/rules/folder-naming-convention.md

@@ -113,6 +113,36 @@ Customizes the error message displayed when a folder does not match the naming p
 - `{{ target }}`: Represents the target folder.
 - `{{ pattern }}`: Represents the naming pattern for the target folder.
 
+##### `ignoreWords`
+
+An array of folder names to ignore during naming convention validation. Folders whose names exactly match any string in this array will be skipped and not validated against the naming pattern.
+
+```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',
+          ignoreWords: ['skip_word_a', 'skip_word_b'],
+        },
+      ],
+    },
+  },
+];
+```
+
+With this configuration, folders named `skip_word_a` or `skip_word_b` will not be validated against the naming pattern, allowing paths like `mocks/skip_word_a/app-mock.ts` to pass validation even though `skip_word_a` doesn't follow the `KEBAB_CASE` pattern.
+
 ```js
 export default [
   {

lib/rules/folder-naming-convention.js

@@ -48,6 +48,10 @@ export default {
         type: 'object',
         properties: {
           errorMessage: { type: 'string' },
+          ignoreWords: {
+            type: 'array',
+            items: { type: 'string' },
+          },
         },
       },
     ],
@@ -81,6 +85,7 @@ export default {
       const filenameWithPath = getFilePath(context);
       const folderPath = getFolderPath(filenameWithPath);
       const errorMessage = context.options[1]?.errorMessage ?? '';
+      const ignoreWords = context.options[1]?.ignoreWords ?? [];
 
       for (const [folderPattern, namingPattern] of Object.entries(rules)) {
         if (
@@ -100,6 +105,11 @@ export default {
             .reduce((s, p) => s.concat(getAllFolders(p)), []);
 
           for (const folder of folders) {
+            // Skip validation if the folder name is in the ignore list
+            if (ignoreWords.includes(folder)) {
+              continue;
+            }
+
             if (
               !micromatch.isMatch(
                 folder,

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

@@ -659,3 +659,55 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run(
+  "folder-naming-convention with option: [{ 'mocks/**/': 'KEBAB_CASE' }, { ignoreWords: ['skip_word_a', 'skip_word_b'] }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks/skip_word_a/app-mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks/skip_word_b/another-mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks/valid-kebab-case/mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks/InvalidCamelCase/mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+        errors: [
+          {
+            message:
+              'The folder "InvalidCamelCase" does not match the "KEBAB_CASE" pattern',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);

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

@@ -662,3 +662,55 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run(
+  "folder-naming-convention with option: [{ 'mocks/**/': 'KEBAB_CASE' }, { ignoreWords: ['skip_word_a', 'skip_word_b'] }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks\\skip_word_a\\app-mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks\\skip_word_b\\another-mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+      },
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks\\valid-kebab-case\\mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'mocks\\InvalidCamelCase\\mock.ts',
+        options: [
+          { 'mocks/**/': 'KEBAB_CASE' },
+          { ignoreWords: ['skip_word_a', 'skip_word_b'] },
+        ],
+        errors: [
+          {
+            message:
+              'The folder "InvalidCamelCase" does not match the "KEBAB_CASE" pattern',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);