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

Author: AtlasTom

lib/constants/message.js

@@ -21,6 +21,10 @@ export const FILENAME_BLOCKLIST_ERROR_MESSAGE = template(
   'The filename "$0" matches the blocklisted "$1" pattern, use a pattern like "$2" instead'
 );
 
+export const FILENAME_BLOCKLIST_NONPATTERN_ERROR_MESSAGE = template(
+  'The filename "$0" matches the blocklisted "$1" pattern, this is not allowed because "$2"'
+);
+
 export const FILENAME_NAMING_CONVENTION_ERROR_MESSAGE = template(
   'The filename "$0" does not match the "$1" pattern'
 );

lib/rules/filename-blocklist.js

@@ -3,13 +3,17 @@
  * @author Florian Ehmke, Huan Luo
  */
 
-import { FILENAME_BLOCKLIST_ERROR_MESSAGE } from '../constants/message.js';
+import {
+  FILENAME_BLOCKLIST_ERROR_MESSAGE,
+  FILENAME_BLOCKLIST_NONPATTERN_ERROR_MESSAGE,
+} from '../constants/message.js';
 import { getDocUrl } from '../utils/doc.js';
 import { getFilePath, getFilename } from '../utils/filename.js';
 import { matchRule } from '../utils/rule.js';
 import {
   validateNamingPatternObject,
   globPatternValidator,
+  stringResponseValidator,
 } from '../utils/validation.js';
 
 /**
@@ -31,17 +35,23 @@ export default {
           type: 'string',
         },
       },
+      {
+        stringResponse: {
+          type: 'boolean',
+        },
+      },
     ],
   },
 
   create(context) {
     return {
       Program: (node) => {
         const rules = context.options[0];
+        const stringResponse = context.options[1];
         const message = validateNamingPatternObject(
           rules,
           globPatternValidator,
-          globPatternValidator
+          stringResponse ? stringResponseValidator : globPatternValidator
         );
 
         if (message) {
@@ -55,9 +65,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
@@ -66,13 +77,17 @@ export default {
             // it's a legacy feature, will be removed in the future
             matchRule(filename, blockListPattern);
 
+          const messageFN = stringResponse
+            ? FILENAME_BLOCKLIST_NONPATTERN_ERROR_MESSAGE
+            : FILENAME_BLOCKLIST_ERROR_MESSAGE;
+
           if (matchResult) {
             context.report({
               node,
-              message: FILENAME_BLOCKLIST_ERROR_MESSAGE(
+              message: messageFN(
                 filename,
                 blockListPattern,
-                useInsteadPattern
+                useInsteadPatternOrString
               ),
             });
             return;

lib/utils/validation.js

@@ -62,6 +62,12 @@ const nextJsNamingPatternValidator = (namingPattern) =>
  */
 export const globPatternValidator = isGlob;
 
+/**
+ * @returns {boolean} true if reason is a string
+ * @param {any}  reason an arbitrary reason for banning a file naming pattern that isn't a glob pattern
+ */
+export const stringResponseValidator = (reason) => typeof reason === 'string';
+
 /**
  * @returns {boolean} true if pattern is a valid filename naming pattern
  * @param {string} namingPattern pattern string

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

@@ -236,3 +236,24 @@ ruleTester.run('filename-blocklist with option: []', rule, {
     },
   ],
 });
+
+ruleTester.run(
+  "filename-blocklist with option: [{'*.models.ts': 'Some Non Glob reason'}, true]",
+  rule,
+  {
+    valid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'src/foo.apis.ts',
+        options: [
+          {
+            '*.models.ts': 'Some Non Glob reason',
+          },
+          true,
+        ],
+      },
+    ],
+
+    invalid: [],
+  }
+);