fix: addressed pr comments, updated readme, added tests

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

@@ -22,7 +22,7 @@ export const FILENAME_BLOCKLIST_ERROR_MESSAGE = template(
 );
 
 export const FILENAME_BLOCKLIST_NONPATTERN_ERROR_MESSAGE = template(
-  'The filename "$0" matches the blocklisted "$1" pattern, this is not allowed because "$2"'
+  'The filename "$0" matches the blocklisted "$1" pattern, this is not allowed $2'
 );
 
 export const FILENAME_NAMING_CONVENTION_ERROR_MESSAGE = template(

lib/rules/filename-blocklist.js

@@ -13,7 +13,6 @@ import { matchRule } from '../utils/rule.js';
 import {
   validateNamingPatternObject,
   globPatternValidator,
-  stringResponseValidator,
 } from '../utils/validation.js';
 
 /**
@@ -36,8 +35,9 @@ export default {
         },
       },
       {
-        stringResponse: {
-          type: 'boolean',
+        type: 'object',
+        properties: {
+          nonGlobSuggestion: { type: 'boolean' },
         },
       },
     ],
@@ -47,11 +47,13 @@ export default {
     return {
       Program: (node) => {
         const rules = context.options[0];
-        const stringResponse = context.options[1];
+        const { nonGlobSuggestion } = context.options[1] || {
+          nonGlobSuggestion: false,
+        };
         const message = validateNamingPatternObject(
           rules,
           globPatternValidator,
-          stringResponse ? stringResponseValidator : globPatternValidator
+          nonGlobSuggestion ? () => true : globPatternValidator
         );
 
         if (message) {
@@ -77,7 +79,7 @@ export default {
             // it's a legacy feature, will be removed in the future
             matchRule(filename, blockListPattern);
 
-          const messageFN = stringResponse
+          const messageFN = nonGlobSuggestion
             ? FILENAME_BLOCKLIST_NONPATTERN_ERROR_MESSAGE
             : FILENAME_BLOCKLIST_ERROR_MESSAGE;
 

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

@@ -238,7 +238,7 @@ ruleTester.run('filename-blocklist with option: []', rule, {
 });
 
 ruleTester.run(
-  "filename-blocklist with option: [{'*.models.ts': 'Some Non Glob reason'}, true]",
+  "filename-blocklist with option: [{'*.models.ts': 'for some Non Glob related reason'}, true]",
   rule,
   {
     valid: [
@@ -247,13 +247,42 @@ ruleTester.run(
         filename: 'src/foo.apis.ts',
         options: [
           {
-            '*.models.ts': 'Some Non Glob reason',
+            '*.models.ts': 'for some Non Glob related reason',
           },
-          true,
+          { nonGlobSuggestion: true },
         ],
       },
     ],
 
     invalid: [],
   }
 );
+
+ruleTester.run(
+  "filename-blocklist with option: [{'*.models.ts': 'for some Non Glob related reason'}, { nonGlobSuggestion: true, }]",
+  rule,
+  {
+    valid: [],
+
+    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,51 @@ ruleTester.run('filename-blocklist with option on Windows: []', rule, {
     },
   ],
 });
+
+ruleTester.run(
+  "filename-blocklist with option: [{'*.models.ts': 'for some Non Glob related reason'}, { nonGlobSuggestion: true, }]  on Windows: []",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src\\foo.apis.ts',
+        options: [
+          {
+            '*.models.ts': 'for some Non Glob related reason',
+          },
+          { nonGlobSuggestion: true },
+        ],
+      },
+    ],
+
+    invalid: [],
+  }
+);
+
+ruleTester.run(
+  "filename-blocklist with option: [{'*.models.ts': 'for some Non Glob related reason'}, { nonGlobSuggestion: true, }]  on Windows: []",
+  rule,
+  {
+    valid: [],
+
+    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,
+          },
+        ],
+      },
+    ],
+  }
+);