feat: add rule settings validation for rule folder-match-with-fex

Author: dukeluo

lib/rules/filename-naming-convention.js

@@ -5,30 +5,15 @@
 'use strict';
 
 const micromatch = require('micromatch');
-const isGlob = require('is-glob');
 const { getFilename, getBasename } = require('../utils/filename');
+const {
+  checkSettings,
+  namingPatternValidator,
+  globPatternValidator,
+} = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
 const NAMING_CONVENTION = require('../constants/naming-convention');
 
-/**
- * @type {string} invalid naming pattern
- * @param rules naming pattern configurated by user
- */
-const checkNamingConfig = (rules) => {
-  const buildInPatterns = Object.keys(NAMING_CONVENTION);
-
-  for (const [fexPattern, namingPattern] of Object.entries(rules)) {
-    if (!isGlob(fexPattern)) {
-      return fexPattern;
-    } else if (
-      !isGlob(namingPattern) &&
-      !buildInPatterns.includes(namingPattern)
-    ) {
-      return namingPattern;
-    }
-  }
-};
-
 /**
  * @type {import('eslint').Rule.RuleModule}
  */
@@ -55,7 +40,11 @@ module.exports = {
     return {
       Program: (node) => {
         const rules = context.options[0];
-        const invalidPattern = checkNamingConfig(rules);
+        const invalidPattern = checkSettings(
+          rules,
+          globPatternValidator,
+          namingPatternValidator
+        );
 
         if (invalidPattern) {
           context.report({

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

@@ -6,6 +6,7 @@
 
 const micromatch = require('micromatch');
 const { getFolder, getFilename } = require('../utils/filename');
+const { checkSettings, globPatternValidator } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
 
 /**
@@ -34,10 +35,29 @@ module.exports = {
   create(context) {
     return {
       Program: (node) => {
+        const rules = context.options[0];
+
+        const invalidPattern = checkSettings(
+          rules,
+          globPatternValidator,
+          globPatternValidator
+        );
+
+        if (invalidPattern) {
+          context.report({
+            node,
+            message:
+              'There is an invalid pattern "{{invalidPattern}}", please check it',
+            data: {
+              invalidPattern,
+            },
+          });
+          return;
+        }
+
         const filenameWithPath = context.getFilename();
         const filename = getFilename(filenameWithPath);
         const folder = getFolder(filenameWithPath);
-        const rules = context.options[0];
 
         for (const [fexPattern, folderPattern] of Object.entries(rules)) {
           if (!micromatch.isMatch(filename, fexPattern)) {

lib/utils/settings.js

@@ -0,0 +1,46 @@
+/**
+ * @fileoverview Utils about rule settings
+ * @author Duke Luo
+ */
+'use strict';
+
+const isGlob = require('is-glob');
+const NAMING_CONVENTION = require('../constants/naming-convention');
+
+/**
+ * @type {string} invalid key or value
+ * @param settings rule settings configurated by user
+ * @param keyValidator settings key validator
+ * @param valueValidator settings value validator
+ */
+const checkSettings = (settings, keyValidator, valueValidator) => {
+  for (const [key, value] of Object.entries(settings)) {
+    if (!keyValidator(key)) {
+      return key;
+    } else if (!valueValidator(value)) {
+      return value;
+    }
+  }
+};
+
+/**
+ * @type {boolean}
+ * @param namingPattern pattern string
+ */
+const namingPatternValidator = (namingPattern) => {
+  const buildInPatterns = Object.keys(NAMING_CONVENTION);
+
+  return isGlob(namingPattern) || buildInPatterns.includes(namingPattern);
+};
+
+/**
+ * @type {boolean}
+ * @param pattern pattern string
+ */
+const globPatternValidator = isGlob;
+
+module.exports = {
+  checkSettings,
+  namingPatternValidator,
+  globPatternValidator,
+};

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

@@ -258,3 +258,49 @@ ruleTester.run('folder-match-with-fex with fex that has not been set', rule, {
 
   invalid: [],
 });
+
+ruleTester.run(
+  "folder-match-with-fex with option: [{ '*.test.js': 'FOO', '*.test.ts': '*/__tests__/' }]",
+  rule,
+  {
+    valid: [],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'bar/__tests__/foo.test.js',
+        options: [{ '*.test.js': 'FOO', '*.test.ts': '*/__tests__/' }],
+        errors: [
+          {
+            message: 'There is an invalid pattern "FOO", please check it',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);
+
+ruleTester.run(
+  "folder-match-with-fex with option: [{ '*.test.js': '*/__tests__/', '.test.ts': '*/__tests__/' }]",
+  rule,
+  {
+    valid: [],
+
+    invalid: [
+      {
+        code: "var foo = 'bar';",
+        filename: 'bar/__tests__/foo.test.js',
+        options: [{ '*.test.js': '*/__tests__/', '.test.ts': '*/__tests__/' }],
+        errors: [
+          {
+            message: 'There is an invalid pattern ".test.ts", please check it',
+            column: 1,
+            line: 1,
+          },
+        ],
+      },
+    ],
+  }
+);