refactor: extract constant, rename variable and fix jsdoc

Author: dukeluo

lib/constants/regex.js

@@ -0,0 +1,14 @@
+/**
+ * @file Regex pattern constants
+ * @author Duke Luo
+ */
+'use strict';
+
+/**
+ * @example <1>
+ */
+const PREFINED_MATCH_SYNTAX_REGEXP = /^<(\d+)>$/;
+
+module.exports = {
+  PREFINED_MATCH_SYNTAX_REGEXP,
+};

lib/rules/filename-naming-convention.js

@@ -4,11 +4,11 @@
  */
 'use strict';
 
-const { transformRuleWithGroupCapture } = require('../utils/transform');
+const { transformRuleWithPrefinedMatchSyntax } = require('../utils/transform');
 const { getFilename, getBasename, getFilePath } = require('../utils/filename');
 const {
   checkSettings,
-  fileNamingPatternValidator,
+  filenameNamingPatternValidator,
   globPatternValidator,
 } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
@@ -55,7 +55,7 @@ module.exports = {
         const invalidPattern = checkSettings(
           rules,
           globPatternValidator,
-          fileNamingPatternValidator
+          filenameNamingPatternValidator
         );
 
         if (invalidPattern) {
@@ -71,18 +71,19 @@ module.exports = {
         }
 
         for (const [
-          originalFexPattern,
+          originalFilenamePattern,
           originalNamingPattern,
         ] of Object.entries(rules)) {
           try {
-            const [fexPattern, namingPattern] = transformRuleWithGroupCapture(
-              [originalFexPattern, originalNamingPattern],
-              filenameWithPath
-            );
+            const [filenamePattern, namingPattern] =
+              transformRuleWithPrefinedMatchSyntax(
+                [originalFilenamePattern, originalNamingPattern],
+                filenameWithPath
+              );
 
             const matchResult = matchRule(
               filenameWithPath,
-              fexPattern,
+              filenamePattern,
               getBasename(filename, ignoreMiddleExtensions),
               namingPattern
             );

lib/utils/settings.js

@@ -6,6 +6,7 @@
 
 const isGlob = require('is-glob');
 const NAMING_CONVENTION = require('../constants/naming-convention');
+const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
 
 /**
  * Validator
@@ -40,12 +41,13 @@ const namingPatternValidator = (namingPattern) => {
 };
 
 /**
- * @returns {boolean} true if pattern is a valid naming pattern
+ * @returns {boolean} true if pattern is a valid filename naming pattern
  * @param {string} namingPattern pattern string
  */
-const fileNamingPatternValidator = (namingPattern) => {
+const filenameNamingPatternValidator = (namingPattern) => {
   return (
-    namingPatternValidator(namingPattern) || !!/^<\d+>$/.test(namingPattern)
+    namingPatternValidator(namingPattern) ||
+    PREFINED_MATCH_SYNTAX_REGEXP.test(namingPattern)
   );
 };
 
@@ -58,6 +60,6 @@ const globPatternValidator = isGlob;
 module.exports = {
   checkSettings,
   namingPatternValidator,
-  fileNamingPatternValidator,
+  filenameNamingPatternValidator,
   globPatternValidator,
 };

lib/utils/transform.js

@@ -1,41 +1,60 @@
+/* eslint-disable jsdoc/valid-types */
+/**
+ * @file Utils about prefined match syntax
+ * @author David Ratier, Duke Luo
+ */
+'use strict';
+
 const micromatch = require('micromatch');
+const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
 
 /**
- * Takes in a ruleset and transforms it if it contains capture groups
+ * Takes in a rule and transforms it if it contains prefined match syntax
  *
- * @param {Array} ruleset ruleset
- * @param {Array} ruleset.0 glob
- * @param {Array} ruleset.1 rule to transform
+ * @typedef {string} filenamePattern original filename pattern
+ * @typedef {string} namingPattern original naming pattern
+ * @typedef {[filenamePattern, namingPattern]} rule
+ * @param {rule} rule original rule
  * @param {string} filenameWithPath filename with path
- * @returns {Array} [glob, rule]
+ * @returns {rule} new rule
+ * @throws {Error} if a cprefined match syntax referenced in the naming pattern is not found in the filename pattern
  */
-function transformRuleWithGroupCapture([glob, rule], filenameWithPath) {
-  const keyCaptureGroups = micromatch.capture(glob, filenameWithPath);
+const transformRuleWithPrefinedMatchSyntax = (
+  [filenamePattern, namingPattern],
+  filenameWithPath
+) => {
+  const keyCaptureGroups = micromatch.capture(
+    filenamePattern,
+    filenameWithPath
+  );
 
   if (!keyCaptureGroups) {
-    return [glob, rule];
+    return [filenamePattern, namingPattern];
   }
 
-  const valueCaptureGroupRegex = /<(\d+)>/g;
-  const valueCaptureGroups = [...rule.matchAll(valueCaptureGroupRegex)];
+  const valueCaptureGroups = [
+    ...namingPattern.matchAll(new RegExp(PREFINED_MATCH_SYNTAX_REGEXP, 'g')),
+  ];
 
   if (!valueCaptureGroups || !valueCaptureGroups.length) {
-    return [glob, rule];
+    return [filenamePattern, namingPattern];
   }
 
-  const newRule = valueCaptureGroups.reduce((value, group) => {
+  const newNamingPattern = valueCaptureGroups.reduce((value, group) => {
     const groupIndex = +group[1];
+
     if (!keyCaptureGroups || keyCaptureGroups[groupIndex] === undefined) {
       throw new Error(
-        `The capture group "${rule}" is not found in the glob "${glob}"`
+        `The capture group "${namingPattern}" is not found in the glob "${filenamePattern}"`
       );
     }
-    return value.replace(group[0], keyCaptureGroups[+group[1]]);
-  }, rule);
 
-  return [glob, newRule];
-}
+    return value.replace(group[0], keyCaptureGroups[groupIndex]);
+  }, namingPattern);
+
+  return [filenamePattern, newNamingPattern];
+};
 
 module.exports = {
-  transformRuleWithGroupCapture,
+  transformRuleWithPrefinedMatchSyntax,
 };