feat: report an error when naming pattern object isnt a object type

Author: dukeluo

lib/rules/filename-blocklist.js

@@ -1,11 +1,14 @@
 /**
  * @file The filename should be blocklisted.
- * @author Florian Ehmke
+ * @author Florian Ehmke, Duke Luo
  */
 'use strict';
 
 const { getFilename, getFilePath } = require('../utils/filename');
-const { checkSettings, globPatternValidator } = require('../utils/settings');
+const {
+  validateNamingPatternObject,
+  globPatternValidator,
+} = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
 const { matchRule } = require('../utils/match');
 
@@ -36,21 +39,16 @@ module.exports = {
     return {
       Program: (node) => {
         const rules = context.options[0];
-
-        const invalidPattern = checkSettings(
+        const message = validateNamingPatternObject(
           rules,
           globPatternValidator,
           globPatternValidator
         );
 
-        if (invalidPattern) {
+        if (message) {
           context.report({
             node,
-            message:
-              'There is an invalid pattern "{{invalidPattern}}", please check it',
-            data: {
-              invalidPattern,
-            },
+            message,
           });
           return;
         }

lib/rules/filename-naming-convention.js

@@ -7,7 +7,7 @@
 const { transformRuleWithPrefinedMatchSyntax } = require('../utils/transform');
 const { getFilename, getBasename, getFilePath } = require('../utils/filename');
 const {
-  checkSettings,
+  validateNamingPatternObject,
   filenameNamingPatternValidator,
   globPatternValidator,
 } = require('../utils/settings');
@@ -46,30 +46,25 @@ module.exports = {
   create(context) {
     return {
       Program: (node) => {
-        const filenameWithPath = getFilePath(context);
-        const filename = getFilename(filenameWithPath);
-
-        const rules = context.options[0] || {};
-        const { ignoreMiddleExtensions } = context.options[1] || {};
-
-        const invalidPattern = checkSettings(
+        const rules = context.options[0];
+        const message = validateNamingPatternObject(
           rules,
           globPatternValidator,
           filenameNamingPatternValidator
         );
 
-        if (invalidPattern) {
+        if (message) {
           context.report({
             node,
-            message:
-              'There is an invalid pattern "{{invalidPattern}}", please check it',
-            data: {
-              invalidPattern,
-            },
+            message,
           });
           return;
         }
 
+        const filenameWithPath = getFilePath(context);
+        const filename = getFilename(filenameWithPath);
+        const { ignoreMiddleExtensions } = context.options[1] || {};
+
         for (const [
           originalFilenamePattern,
           originalNamingPattern,

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

@@ -9,7 +9,10 @@ const {
   getFilename,
   getFilePath,
 } = require('../utils/filename');
-const { checkSettings, globPatternValidator } = require('../utils/settings');
+const {
+  validateNamingPatternObject,
+  globPatternValidator,
+} = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
 const { matchRule } = require('../utils/match');
 
@@ -41,21 +44,16 @@ module.exports = {
     return {
       Program: (node) => {
         const rules = context.options[0];
-
-        const invalidPattern = checkSettings(
+        const message = validateNamingPatternObject(
           rules,
           globPatternValidator,
           globPatternValidator
         );
 
-        if (invalidPattern) {
+        if (message) {
           context.report({
             node,
-            message:
-              'There is an invalid pattern "{{invalidPattern}}", please check it',
-            data: {
-              invalidPattern,
-            },
+            message,
           });
           return;
         }

lib/rules/folder-naming-convention.js

@@ -12,7 +12,7 @@ const {
   getFilePath,
 } = require('../utils/filename');
 const {
-  checkSettings,
+  validateNamingPatternObject,
   namingPatternValidator,
   globPatternValidator,
 } = require('../utils/settings');
@@ -46,20 +46,16 @@ module.exports = {
     return {
       Program: (node) => {
         const rules = context.options[0];
-        const invalidPattern = checkSettings(
+        const message = validateNamingPatternObject(
           rules,
           globPatternValidator,
           namingPatternValidator
         );
 
-        if (invalidPattern) {
+        if (message) {
           context.report({
             node,
-            message:
-              'There is an invalid pattern "{{invalidPattern}}", please check it',
-            data: {
-              invalidPattern,
-            },
+            message,
           });
           return;
         }

lib/utils/settings.js

@@ -7,6 +7,7 @@
 const isGlob = require('is-glob');
 const NAMING_CONVENTION = require('../constants/naming-convention');
 const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
+const { isObject } = require('./utility');
 
 /**
  * Validator
@@ -15,17 +16,20 @@ const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
  * @param {string} p pattern string
  */
 /**
- * @returns {string | undefined} undefined or invalid field
- * @param {object} settings rule settings configurated by user
+ * @returns {string | undefined} undefined or error message
+ * @param {any} config naming pattern object configurated by user
  * @param {validator} keyValidator settings key validator
  * @param {validator} valueValidator settings value validator
  */
-const checkSettings = (settings, keyValidator, valueValidator) => {
-  for (const [key, value] of Object.entries(settings)) {
+const validateNamingPatternObject = (config, keyValidator, valueValidator) => {
+  if (!isObject(config)) {
+    return `The naming pattern object "${config}" doesn't appear to be an Object type, please double-check it and try again`;
+  }
+  for (const [key, value] of Object.entries(config)) {
     if (!keyValidator(key)) {
-      return key;
+      return `There is an invalid pattern "${key}", please check it`;
     } else if (!valueValidator(value)) {
-      return value;
+      return `There is an invalid pattern "${value}", please check it`;
     }
   }
 };
@@ -58,7 +62,7 @@ const filenameNamingPatternValidator = (namingPattern) => {
 const globPatternValidator = isGlob;
 
 module.exports = {
-  checkSettings,
+  validateNamingPatternObject,
   namingPatternValidator,
   filenameNamingPatternValidator,
   globPatternValidator,

lib/utils/utility.js

@@ -0,0 +1,17 @@
+/**
+ * @file A utility file containing useful functions
+ * @author Duke Luo
+ */
+'use strict';
+
+/**
+ * Checks if the given argument is an object
+ *
+ * @param {any} x - The argument to check
+ * @returns {boolean} - True if the argument is an object, false otherwise
+ */
+const isObject = (x) => Object.prototype.toString.call(x) === '[object Object]';
+
+module.exports = {
+  isObject,
+};

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

@@ -212,3 +212,22 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run('filename-blocklist with option: []', rule, {
+  valid: [],
+
+  invalid: [
+    {
+      code: "var foo = 'bar';",
+      filename: 'src/foo.models.ts',
+      options: [],
+      errors: [
+        {
+          message: `The naming pattern object "undefined" doesn't appear to be an Object type, please double-check it and try again`,
+          column: 1,
+          line: 1,
+        },
+      ],
+    },
+  ],
+});

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

@@ -140,3 +140,22 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run('filename-blocklist with option on Windows: []', rule, {
+  valid: [],
+
+  invalid: [
+    {
+      code: "var foo = 'bar';",
+      filename: 'src\\foo.models.ts',
+      options: [],
+      errors: [
+        {
+          message: `The naming pattern object "undefined" doesn't appear to be an Object type, please double-check it and try again`,
+          column: 1,
+          line: 1,
+        },
+      ],
+    },
+  ],
+});

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

@@ -1362,3 +1362,21 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run('filename-naming-convention with option: []', rule, {
+  valid: [],
+  invalid: [
+    {
+      code: "var foo = 'bar';",
+      filename: 'src/components/featureA/featureA.jsx',
+      options: [],
+      errors: [
+        {
+          message: `The naming pattern object "undefined" doesn't appear to be an Object type, please double-check it and try again`,
+          column: 1,
+          line: 1,
+        },
+      ],
+    },
+  ],
+});

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

@@ -919,3 +919,21 @@ ruleTester.run(
     ],
   }
 );
+
+ruleTester.run('filename-naming-convention with option: []', rule, {
+  valid: [],
+  invalid: [
+    {
+      code: "var foo = 'bar';",
+      filename: 'src\\components\\featureA\\featureA.jsx',
+      options: [],
+      errors: [
+        {
+          message: `The naming pattern object "undefined" doesn't appear to be an Object type, please double-check it and try again`,
+          column: 1,
+          line: 1,
+        },
+      ],
+    },
+  ],
+});