feat: allow option for non-glob values for filename-blocklist (#34)

* feat: allow option for non-glob values for filename-blocklist

* fix: addressed pr comments, updated readme, added tests

* refactor: rebase main branch

---------

Co-authored-by: Huan Luo <dukeluo@outlook.com>

Author: AtlasTom

docs/rules/filename-blocklist.md

@@ -54,6 +54,29 @@ module.exports = {
 };
 ```
 
+An optional "nonGlobSuggestion" argument can be passed that allows the blocklist reason to be any string, instead of a strict glob pattern
+
+```js
+module.exports = {
+  plugins: [
+    'check-file',
+  ],
+  rules: {
+    'check-file/filename-blocklist': ['error', {
+      '**/*.model.ts': 'see the repo rules at http://some/example.com',
+      '**/*.util.ts': 'for a non glob related reason',
+    },
+      { nonGlobSuggestion: true, }
+    ],
+  },
+};
+```
+
+These rules would produce errors that look like:
+1. 'The filename "model.ts" matches the blocklisted "**/*.model.ts" pattern,  this is not allowed see the repo rules at http://some/example.com'
+2. '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)

lib/constants/message.js

@@ -13,7 +13,10 @@ export const PREFINED_MATCH_SYNTAX_ERROR_MESSAGE =
   'The prefined match "{{ namingPattern }}" is not found in the pattern "{{ filenamePattern }}", please double-check it and try again';
 
 export const FILENAME_BLOCKLIST_ERROR_MESSAGE =
-  'The filename "{{ filename }}" matches the blocklisted "{{ blockListPattern }}" pattern, use a pattern like "{{ useInsteadPattern }}" instead';
+  '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';

lib/rules/filename-blocklist.js

@@ -5,6 +5,7 @@
 
 import {
   FILENAME_BLOCKLIST_ERROR_MESSAGE,
+  FILENAME_BLOCKLIST_NON_GLOB_ERROR_MESSAGE,
   NAMING_PATTERN_OBJECT_ERROR_MESSAGE,
   PATTERN_ERROR_MESSAGE,
 } from '../constants/message.js';
@@ -35,22 +36,32 @@ export default {
           type: 'string',
         },
       },
+      {
+        type: 'object',
+        properties: {
+          nonGlobSuggestion: { type: 'boolean' },
+        },
+      },
     ],
     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 error = validateNamingPatternObject(
           rules,
           globPatternValidator,
-          globPatternValidator
+          nonGlobSuggestion ? () => true : globPatternValidator
         );
 
         if (error) {
@@ -67,9 +78,10 @@ export default {
         const filenameWithPath = getFilePath(context);
         const filename = getFilename(filenameWithPath);
 
-        for (const [blockListPattern, useInsteadPattern] of Object.entries(
-          rules
-        )) {
+        for (const [
+          blockListPattern,
+          useInsteadPatternOrString,
+        ] of Object.entries(rules)) {
           const matchResult =
             matchRule(filenameWithPath, blockListPattern) ||
             // TODO: remove this in next major version
@@ -81,11 +93,11 @@ export default {
           if (matchResult) {
             context.report({
               node,
-              messageId: 'noMatch',
+              messageId: nonGlobSuggestion ? 'noMatchWithNonGlob' : 'noMatch',
               data: {
                 filename,
                 blockListPattern,
-                useInsteadPattern,
+                suggestion: useInsteadPatternOrString,
               },
             });
             return;

tests/lib/rules/filename-blocklist.posix.js

@@ -236,3 +236,43 @@ ruleTester.run('filename-blocklist with option: []', rule, {
     },
   ],
 });
+
+ruleTester.run(
+  "filename-blocklist with option: [{'*.models.ts': 'for some Non Glob related reason'}, { nonGlobSuggestion: true }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/foo.apis.ts',
+        options: [
+          {
+            '*.models.ts': 'for some Non Glob related reason',
+          },
+          { nonGlobSuggestion: true },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/foo.models.ts',
+        options: [
+          {
+            '*.models.ts': 'for some Non Glob related reason',
+          },
+          { 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',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);

tests/lib/rules/filename-blocklist.windows.js

@@ -164,3 +164,41 @@ 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 }]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\foo.apis.ts',
+        options: [
+          {
+            '*.models.ts': 'for some Non Glob related reason',
+          },
+          { nonGlobSuggestion: true },
+        ],
+      },
+    ],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\foo.models.ts',
+        options: [
+          { '*.models.ts': 'for some Non Glob related reason' },
+          { 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',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);