feat: add build in pattern support for rule filename-naming-convention

Author: dukeluo

lib/rules/filename-naming-convention.js

@@ -4,6 +4,23 @@
  */
 'use strict';
 
+const micromatch = require('micromatch');
+const { getFilename, getBasename } = require('../utils/filename');
+const NAMING_CONVENTION = require('../constants/naming-convention');
+
+/**
+ * @type {string} invalid naming pattern
+ * @param {string} rules naming pattern configurated by user
+ */
+const checkNamingConfig = (rules) => {
+  const buildInPatterns = Object.keys(NAMING_CONVENTION);
+  const isValidPattern = (pattern) =>
+    (typeof pattern === 'string' && buildInPatterns.includes(pattern)) ||
+    pattern instanceof RegExp;
+
+  return Object.values(rules).find((pattern) => !isValidPattern(pattern));
+};
+
 /**
  * @type {import('eslint').Rule.RuleModule}
  */
@@ -17,10 +34,57 @@ module.exports = {
       url: null, // TODO: URL to the documentation page for this rule
     },
     fixable: null, // Or `code` or `whitespace`
-    schema: [], // Add a schema if the rule has options
+    schema: [
+      {
+        additionalProperties: {
+          type: 'string',
+        },
+      },
+    ],
   },
 
-  create() {
-    return {};
+  create(context) {
+    return {
+      Program: (node) => {
+        const rules = context.options[0];
+        const invalidPatter = checkNamingConfig(rules);
+
+        if (invalidPatter) {
+          context.report({
+            node,
+            message:
+              'There is an unsupported naming pattern "{{invalidPatter}}", please check it.',
+            data: {
+              invalidPatter,
+            },
+          });
+          return;
+        }
+
+        const filenameWithPath = context.getFilename();
+        const filename = getFilename(filenameWithPath);
+
+        for (const [fexPattern, pattern] of Object.entries(rules)) {
+          if (!micromatch.isMatch(filename, fexPattern)) {
+            continue;
+          } else if (
+            (NAMING_CONVENTION[pattern] || pattern).test(getBasename(filename))
+          ) {
+            return;
+          } else {
+            context.report({
+              node,
+              message:
+                'The filename "{{filename}}" does not match the "{{pattern}}" style',
+              data: {
+                filename,
+                pattern,
+              },
+            });
+            return;
+          }
+        }
+      },
+    };
   },
 };

lib/utils/filename.js

@@ -9,14 +9,23 @@
  * @param {string} path filename concat with path
  */
 const getFilename = (path) => path.substring(path.lastIndexOf('/') + 1);
+// TODO: deal with filename in root path
 
 /**
  * @type {string} folder
  * @param {string} path filename concat with path
  */
 const getFolder = (path) => path.substring(0, path.lastIndexOf('/') + 1);
 
+/**
+ * @type {string} base name
+ * @param {string} filename filename without path
+ */
+const getBasename = (filename) =>
+  filename.substring(0, filename.lastIndexOf('.'));
+
 module.exports = {
   getFolder,
   getFilename,
+  getBasename,
 };