feat: rule filename-naming-convention can specify target file by file path

Author: dukeluo

lib/rules/filename-naming-convention.js

@@ -4,15 +4,14 @@
  */
 'use strict';
 
-const micromatch = require('micromatch');
 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');
+const { matchRule } = require('../utils/match');
 
 /**
  * @type {import('eslint').Rule.RuleModule}
@@ -62,23 +61,32 @@ module.exports = {
         const filename = getFilename(filenameWithPath);
 
         for (const [fexPattern, namingPattern] of Object.entries(rules)) {
-          if (!micromatch.isMatch(filename, fexPattern)) {
-            continue;
-          } else if (
-            micromatch.isMatch(
+          const matchResult =
+            matchRule(
+              filenameWithPath,
+              fexPattern,
               getBasename(filename),
-              NAMING_CONVENTION[namingPattern] || namingPattern
-            )
-          ) {
-            return;
-          } else {
+              namingPattern
+            ) ||
+            // legacy support for version below v1.2.0
+            // file only can be specified by fex pattern, not by file path pattern
+            // it's a legacy feature, will be removed in the future
+            matchRule(
+              filename,
+              fexPattern,
+              getBasename(filename),
+              namingPattern
+            );
+
+          if (matchResult) {
+            const { path, pattern } = matchResult;
             context.report({
               node,
               message:
-                'The filename "{{filename}}" does not match the "{{namingPattern}}" style',
+                'The filename "{{path}}" does not match the "{{pattern}}" style',
               data: {
-                filename,
-                namingPattern,
+                path,
+                pattern,
               },
             });
             return;

lib/utils/match.js

@@ -0,0 +1,42 @@
+/**
+ * @fileoverview Utils about matching rule
+ * @author Duke Luo
+ */
+'use strict';
+
+const micromatch = require('micromatch');
+const NAMING_CONVENTION = require('../constants/naming-convention');
+
+/**
+ * @type {object | undefined} undefined or object with non-matching file path and naming pattern
+ * @param filePath
+ * @param targetFilePathPattern
+ * @param targetNaming
+ * @param targetNamingPattern
+ */
+const matchRule = (
+  filePath,
+  targetFilePathPattern,
+  targetNaming,
+  targetNamingPattern
+) => {
+  if (!micromatch.isMatch(filePath, targetFilePathPattern)) {
+    return;
+  } else if (
+    micromatch.isMatch(
+      targetNaming,
+      NAMING_CONVENTION[targetNamingPattern] || targetNamingPattern
+    )
+  ) {
+    return;
+  } else {
+    return {
+      path: filePath,
+      pattern: targetNamingPattern,
+    };
+  }
+};
+
+module.exports = {
+  matchRule,
+};