refactor: extract all message constants

Author: dukeluo

lib/constants/message.js

@@ -0,0 +1,49 @@
+/**
+ * @file Message constants
+ * @author Duke Luo
+ */
+'use strict';
+
+const { template } = require('../utils/utility');
+
+const NAMING_PATTERN_OBJECT_ERROR_MESSAGE = template(
+  `The naming pattern object "$0" doesn't appear to be an Object type, please double-check it and try again`
+);
+
+const PATTERN_ERROR_MESSAGE = template(
+  'There is an invalid pattern "$0", please check it'
+);
+
+const PREFINED_MATCH_SYNTAX_ERROR_MESSAGE = template(
+  'The capture group "$0" is not found in the glob "$1"'
+);
+
+const FILENAME_BLOCKLIST_ERROR_MESSAGE = template(
+  'The filename "$0" matches the blocklisted "$1" pattern. Use a pattern like "$2" instead.'
+);
+
+const FILENAME_NAMING_CONVENTION_ERROR_MESSAGE = template(
+  'The filename "$0" does not match the "$1" style'
+);
+
+const FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE = template(
+  'The folder of the file "$0" does not match "$1"'
+);
+
+const FOLDER_NAMING_CONVENTION_ERROR_MESSAGE = template(
+  'The folder "$0" does not match the "$1" style'
+);
+
+const NO_INDEX_ERROR_MESSAGE =
+  'The filename "index" is not allowed, please use another one';
+
+module.exports = {
+  NAMING_PATTERN_OBJECT_ERROR_MESSAGE,
+  PATTERN_ERROR_MESSAGE,
+  PREFINED_MATCH_SYNTAX_ERROR_MESSAGE,
+  FILENAME_BLOCKLIST_ERROR_MESSAGE,
+  FILENAME_NAMING_CONVENTION_ERROR_MESSAGE,
+  FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE,
+  FOLDER_NAMING_CONVENTION_ERROR_MESSAGE,
+  NO_INDEX_ERROR_MESSAGE,
+};

lib/constants/regex.js

@@ -14,7 +14,13 @@ const PREFINED_MATCH_SYNTAX_REGEXP = /^<(\d+)>$/;
  */
 const WINDOWS_DRIVE_LETTER_REGEXP = /^[A-Za-z]:\\/;
 
+/**
+ * @example $0
+ */
+const TEMPLATE_VARIABLE_REGEXP = /\$(\d*)/;
+
 module.exports = {
   PREFINED_MATCH_SYNTAX_REGEXP,
   WINDOWS_DRIVE_LETTER_REGEXP,
+  TEMPLATE_VARIABLE_REGEXP,
 };

lib/rules/filename-blocklist.js

@@ -11,6 +11,7 @@ const {
 } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
 const { matchRule } = require('../utils/match');
+const { FILENAME_BLOCKLIST_ERROR_MESSAGE } = require('../constants/message');
 
 /** @typedef {module:eslint} ESLint */
 /**
@@ -69,13 +70,11 @@ module.exports = {
           if (matchResult) {
             context.report({
               node,
-              message:
-                'The filename "{{ filename }}" matches the blocklisted "{{ blockListPattern }}" pattern. Use a pattern like "{{ useInsteadPattern }}" instead.',
-              data: {
+              message: FILENAME_BLOCKLIST_ERROR_MESSAGE(
                 filename,
                 blockListPattern,
-                useInsteadPattern,
-              },
+                useInsteadPattern
+              ),
             });
             return;
           }

lib/rules/filename-naming-convention.js

@@ -13,6 +13,9 @@ const {
 } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
 const { matchRule } = require('../utils/match');
+const {
+  FILENAME_NAMING_CONVENTION_ERROR_MESSAGE,
+} = require('../constants/message');
 
 /** @typedef {module:eslint} ESLint */
 /**
@@ -85,7 +88,10 @@ module.exports = {
 
             if (matchResult) {
               throw new Error(
-                `The filename "${filename}" does not match the "${originalNamingPattern}" style`
+                FILENAME_NAMING_CONVENTION_ERROR_MESSAGE(
+                  filename,
+                  originalNamingPattern
+                )
               );
             }
           } catch (error) {

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

@@ -15,6 +15,7 @@ const {
 } = require('../utils/settings');
 const { getDocUrl } = require('../utils/doc');
 const { matchRule } = require('../utils/match');
+const { FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE } = require('../constants/message');
 
 /** @typedef {module:eslint} ESLint */
 /**
@@ -74,12 +75,10 @@ module.exports = {
             const { pattern } = matchResult;
             context.report({
               node,
-              message:
-                'The folder of the file "{{filenameWithPath}}" does not match "{{pattern}}"',
-              data: {
+              message: FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE(
                 filenameWithPath,
-                pattern,
-              },
+                pattern
+              ),
             });
             return;
           }

lib/rules/folder-naming-convention.js

@@ -19,6 +19,9 @@ const {
 const { getDocUrl } = require('../utils/doc');
 const { isNotEmpty } = require('../utils/utility');
 const NAMING_CONVENTION = require('../constants/naming-convention');
+const {
+  FOLDER_NAMING_CONVENTION_ERROR_MESSAGE,
+} = require('../constants/message');
 
 /** @typedef {module:eslint} ESLint */
 /**
@@ -85,12 +88,10 @@ module.exports = {
                 ) {
                   context.report({
                     node,
-                    message:
-                      'The folder "{{folder}}" does not match the "{{namingPattern}}" style',
-                    data: {
+                    message: FOLDER_NAMING_CONVENTION_ERROR_MESSAGE(
                       folder,
-                      namingPattern,
-                    },
+                      namingPattern
+                    ),
                   });
                   return;
                 }

lib/rules/no-index.js

@@ -6,6 +6,7 @@
 
 const { getDocUrl } = require('../utils/doc');
 const { getFilename, getBasename, getFilePath } = require('../utils/filename');
+const { NO_INDEX_ERROR_MESSAGE } = require('../constants/message');
 
 /** @typedef {module:eslint} ESLint */
 /**
@@ -34,8 +35,7 @@ module.exports = {
         if (basename === 'index') {
           context.report({
             node,
-            message:
-              'The filename "index" is not allowed, please use another one',
+            message: NO_INDEX_ERROR_MESSAGE,
           });
           return;
         }

lib/utils/settings.js

@@ -8,6 +8,10 @@ const isGlob = require('is-glob');
 const NAMING_CONVENTION = require('../constants/naming-convention');
 const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
 const { isObject } = require('./utility');
+const {
+  NAMING_PATTERN_OBJECT_ERROR_MESSAGE,
+  PATTERN_ERROR_MESSAGE,
+} = require('../constants/message');
 
 /**
  * Validator
@@ -23,13 +27,13 @@ const { isObject } = require('./utility');
  */
 const validateNamingPatternObject = (config, keyValidator, valueValidator) => {
   if (!isObject(config)) {
-    return `The naming pattern object "${config}" doesn't appear to be an Object type, please double-check it and try again`;
+    return NAMING_PATTERN_OBJECT_ERROR_MESSAGE(config);
   }
   for (const [key, value] of Object.entries(config)) {
     if (!keyValidator(key)) {
-      return `There is an invalid pattern "${key}", please check it`;
+      return PATTERN_ERROR_MESSAGE(key);
     } else if (!valueValidator(value)) {
-      return `There is an invalid pattern "${value}", please check it`;
+      return PATTERN_ERROR_MESSAGE(value);
     }
   }
 };

lib/utils/transform.js

@@ -8,6 +8,7 @@
 const micromatch = require('micromatch');
 const { isNil, isEmpty } = require('../utils/utility');
 const { PREFINED_MATCH_SYNTAX_REGEXP } = require('../constants/regex');
+const { PREFINED_MATCH_SYNTAX_ERROR_MESSAGE } = require('../constants/message');
 
 /**
  * Takes in a rule and transforms it if it contains prefined match syntax
@@ -46,7 +47,7 @@ const transformRuleWithPrefinedMatchSyntax = (
 
     if (isNil(keyCaptureGroups[groupIndex])) {
       throw new Error(
-        `The capture group "${namingPattern}" is not found in the glob "${filenamePattern}"`
+        PREFINED_MATCH_SYNTAX_ERROR_MESSAGE(namingPattern, filenamePattern)
       );
     }
 

lib/utils/utility.js

@@ -4,6 +4,8 @@
  */
 'use strict';
 
+const { TEMPLATE_VARIABLE_REGEXP } = require('../constants/regex');
+
 /**
  * Checks if the given argument is an object
  *
@@ -73,10 +75,32 @@ const pipe =
  */
 const isNotEmpty = pipe(isEmpty, not);
 
+/**
+ * Template function with the specified template
+ *
+ * @callback templateFunction
+ * @param {...string} data - param array
+ * @returns {string} - String with replaced template variables
+ */
+/**
+ * Get template function for a template string
+ *
+ * @param {string} tpl - The template string to be replaced
+ * @returns {templateFunction} - A function that takes in data and replaces the template variables with the corresponding values from the data object
+ */
+const template =
+  (tpl) =>
+  (...data) =>
+    tpl.replace(
+      new RegExp(TEMPLATE_VARIABLE_REGEXP, 'g'),
+      (_, key) => data[key.trim()]
+    );
+
 module.exports = {
   isObject,
   isNil,
   isEmpty,
   isNotEmpty,
   pipe,
+  template,
 };