refactor: move matchRule method and rename file

Author: dukeluo

lib/rules/filename-blocklist.js

@@ -10,8 +10,8 @@ const {
   globPatternValidator,
 } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
-const { matchRule } = require('../utils/match');
 const { FILENAME_BLOCKLIST_ERROR_MESSAGE } = require('../constants/message');
+const { matchRule } = require('../utils/rule');
 
 /** @typedef {module:eslint} ESLint */
 /**

lib/rules/filename-naming-convention.js

@@ -4,15 +4,17 @@
  */
 'use strict';
 
-const { transformRuleWithPrefinedMatchSyntax } = require('../utils/transform');
+const {
+  transformRuleWithPrefinedMatchSyntax,
+  matchRule,
+} = require('../utils/rule');
 const { getFilename, getBasename, getFilePath } = require('../utils/filename');
 const {
   validateNamingPatternObject,
   filenameNamingPatternValidator,
   globPatternValidator,
 } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
-const { matchRule } = require('../utils/match');
 const {
   FILENAME_NAMING_CONVENTION_ERROR_MESSAGE,
 } = require('../constants/message');

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

@@ -14,8 +14,8 @@ const {
   globPatternValidator,
 } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
-const { matchRule } = require('../utils/match');
 const { FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE } = require('../constants/message');
+const { matchRule } = require('../utils/rule');
 
 /** @typedef {module:eslint} ESLint */
 /**

lib/utils/match.js

@@ -1,14 +1,14 @@
-/* eslint-disable jsdoc/valid-types */
 /**
- * @file Utils about prefined match syntax
+ * @file Utils about rule
  * @author David Ratier, Duke Luo
  */
 'use strict';
 
 const micromatch = require('micromatch');
-const { isNil, isEmpty } = require('../utils/utility');
+const { isNil, isEmpty } = require('./utility');
 const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
 const { PREFINED_MATCH_SYNTAX_ERROR_MESSAGE } = require('../constants/message');
+const NAMING_CONVENTION = require('../constants/naming-convention');
 
 /**
  * Takes in a rule and transforms it if it contains prefined match syntax
@@ -57,6 +57,39 @@ const transformRuleWithPrefinedMatchSyntax = (
   return [filenamePattern, newNamingPattern];
 };
 
+/**
+ * @returns {object | undefined} undefined or object with non-matching file path and naming pattern
+ * @param {string} filePath file path
+ * @param {string} targetFilePathPattern path pattern of the target file
+ * @param {string} [targetNaming] target naming
+ * @param {string} [targetNamingPattern] naming pattern of the target naming
+ */
+const matchRule = (
+  filePath,
+  targetFilePathPattern,
+  targetNaming,
+  targetNamingPattern
+) => {
+  if (!micromatch.isMatch(filePath, targetFilePathPattern)) {
+    return;
+  } else if (
+    targetNaming &&
+    targetNamingPattern &&
+    micromatch.isMatch(
+      targetNaming,
+      NAMING_CONVENTION[targetNamingPattern] || targetNamingPattern
+    )
+  ) {
+    return;
+  } else {
+    return {
+      path: filePath,
+      pattern: targetNamingPattern,
+    };
+  }
+};
+
 module.exports = {
   transformRuleWithPrefinedMatchSyntax,
+  matchRule,
 };