refactor: migrate cmj to esm

Author: dukeluo

.eslintrc.js

@@ -0,0 +1,37 @@
+{
+  "root": true,
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+    "prettier",
+    "plugin:jsdoc/recommended"
+  ],
+  "plugins": ["prettier", "jsdoc"],
+  "rules": {
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ]
+  },
+  "env": {
+    "node": true
+  },
+  "overrides": [
+    {
+      "files": ["tests/**/*.js"],
+      "env": { "mocha": true }
+    }
+  ],
+  "settings": {
+    "jsdoc": {
+      "mode": "typescript"
+    }
+  }
+}

.eslintrc.json

@@ -1,15 +1,8 @@
 {
   "compilerOptions": {
     "checkJs": true,
-    "target": "es2015",
+    "target": "es2017",
+    "module": "node16"
   },
-  "exclude": [
-    "node_modules",
-    ".nyc_output",
-    ".idea",
-    ".vscode",
-    ".github",
-    ".husky",
-    "docs",
-  ]
+  "include": ["lib", "tests"]
 }

jsconfig.json

@@ -2,47 +2,35 @@
  * @file Message templates
  * @author Huan Luo
  */
-'use strict';
 
-const { template } = require('../utils/utility');
+import { template } from '../utils/utility.js';
 
-const NAMING_PATTERN_OBJECT_ERROR_MESSAGE = template(
+export const NAMING_PATTERN_OBJECT_ERROR_MESSAGE = template(
   'The naming pattern object "$0" does not appear to be an Object type, please double-check it and try again'
 );
 
-const PATTERN_ERROR_MESSAGE = template(
+export const PATTERN_ERROR_MESSAGE = template(
   'There is an invalid pattern "$0", please double-check it and try again'
 );
 
-const PREFINED_MATCH_SYNTAX_ERROR_MESSAGE = template(
+export const PREFINED_MATCH_SYNTAX_ERROR_MESSAGE = template(
   'The prefined match "$0" is not found in the pattern "$1", please double-check it and try again'
 );
 
-const FILENAME_BLOCKLIST_ERROR_MESSAGE = template(
+export 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(
+export const FILENAME_NAMING_CONVENTION_ERROR_MESSAGE = template(
   'The filename "$0" does not match the "$1" pattern'
 );
 
-const FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE = template(
+export const FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE = template(
   'The folder of the file "$0" does not match the "$1" pattern'
 );
 
-const FOLDER_NAMING_CONVENTION_ERROR_MESSAGE = template(
+export const FOLDER_NAMING_CONVENTION_ERROR_MESSAGE = template(
   'The folder "$0" does not match the "$1" pattern'
 );
 
-const NO_INDEX_ERROR_MESSAGE = 'The filename "index" is not allowed';
-
-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,
-};
+export const NO_INDEX_ERROR_MESSAGE = 'The filename "index" is not allowed';

lib/constants/message.js

@@ -2,43 +2,33 @@
  * @file Built in filename naming convention
  * @author Huan Luo
  */
-'use strict';
 
 /**
  * @example hello, helloWorld
  */
-const CAMEL_CASE = '+([a-z])*([a-z0-9])*([A-Z]*([a-z0-9]))';
+export const CAMEL_CASE = '+([a-z])*([a-z0-9])*([A-Z]*([a-z0-9]))';
 
 /**
  * @example Hello, HelloWorld
  */
-const PASCAL_CASE = '*([A-Z]*([a-z0-9]))';
+export const PASCAL_CASE = '*([A-Z]*([a-z0-9]))';
 
 /**
  * @example hello, hello_world
  */
-const SNAKE_CASE = '+([a-z])*([a-z0-9])*(_+([a-z0-9]))';
+export const SNAKE_CASE = '+([a-z])*([a-z0-9])*(_+([a-z0-9]))';
 
 /**
  * @example hello, hello-world
  */
-const KEBAB_CASE = '+([a-z])*([a-z0-9])*(-+([a-z0-9]))';
+export const KEBAB_CASE = '+([a-z])*([a-z0-9])*(-+([a-z0-9]))';
 
 /**
  * @example HELLO, HELLO_WORLD
  */
-const SCREAMING_SNAKE_CASE = '+([A-Z])*([A-Z0-9])*(_+([A-Z0-9]))';
+export const SCREAMING_SNAKE_CASE = '+([A-Z])*([A-Z0-9])*(_+([A-Z0-9]))';
 
 /**
  * @example hello, helloworld
  */
-const FLAT_CASE = '+([a-z0-9])';
-
-module.exports = {
-  CAMEL_CASE,
-  PASCAL_CASE,
-  SNAKE_CASE,
-  KEBAB_CASE,
-  SCREAMING_SNAKE_CASE,
-  FLAT_CASE,
-};
+export const FLAT_CASE = '+([a-z0-9])';

lib/constants/naming-convention.js

@@ -2,9 +2,8 @@
  * @file Built in next js app router naming convention
  * @author Huan Luo
  */
-'use strict';
 
-const { CAMEL_CASE, KEBAB_CASE } = require('./naming-convention');
+import { CAMEL_CASE, KEBAB_CASE } from './naming-convention.js';
 
 /**
  * @example [helpPageId]
@@ -34,8 +33,4 @@ const NEXT_JS_NAMED_SLOTS = `\\@${KEBAB_CASE}`;
 /**
  * @example app, [helpPageId], [...auth], [[...auth]], (auth), \@feed
  */
-const NEXT_JS_APP_ROUTER_CASE = `@(${KEBAB_CASE}|${NEXT_JS_DYNAMIC_SEGMENTS}|${NEXT_JS_CATCH_ALL_SEGMENTS}|${NEXT_JS_OPTIONAL_CATCH_ALL_SEGMENTS}|${NEXT_JS_ROUTE_GROUPS}|${NEXT_JS_NAMED_SLOTS})`;
-
-module.exports = {
-  NEXT_JS_APP_ROUTER_CASE,
-};
+export const NEXT_JS_APP_ROUTER_CASE = `@(${KEBAB_CASE}|${NEXT_JS_DYNAMIC_SEGMENTS}|${NEXT_JS_CATCH_ALL_SEGMENTS}|${NEXT_JS_OPTIONAL_CATCH_ALL_SEGMENTS}|${NEXT_JS_ROUTE_GROUPS}|${NEXT_JS_NAMED_SLOTS})`;

lib/constants/next-js-naming-convention.js

@@ -2,25 +2,18 @@
  * @file Regex pattern constants
  * @author Huan Luo
  */
-'use strict';
 
 /**
  * @example <1>
  */
-const PREFINED_MATCH_SYNTAX_REGEXP = /^<(\d+)>$/;
+export const PREFINED_MATCH_SYNTAX_REGEXP = /^<(\d+)>$/;
 
 /**
  * @example C:\
  */
-const WINDOWS_DRIVE_LETTER_REGEXP = /^[A-Za-z]:\\/;
+export 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,
-};
+export const TEMPLATE_VARIABLE_REGEXP = /\$(\d*)/;

lib/constants/regex.js

@@ -1,9 +1,18 @@
 /**
- * @file check the file folder
+ * @file Entry point for all rules
  * @author Huan Luo
  */
-'use strict';
 
-const requireIndex = require('requireindex');
+import FilenameBlocklist from './rules/filename-blocklist.js';
+import FilenameNamingConvention from './rules/filename-naming-convention.js';
+import FolderMatchWithFex from './rules/folder-match-with-fex.js';
+import FolderNamingConvention from './rules/folder-naming-convention.js';
+import NoIndex from './rules/no-index.js';
 
-module.exports.rules = requireIndex(__dirname + '/rules');
+export const rules = {
+  'filename-blocklist': FilenameBlocklist,
+  'filename-naming-convention': FilenameNamingConvention,
+  'folder-match-with-fex': FolderMatchWithFex,
+  'folder-naming-convention': FolderNamingConvention,
+  'no-index': NoIndex,
+};

lib/index.js

@@ -2,21 +2,20 @@
  * @file The filename should be blocklisted.
  * @author Florian Ehmke, Huan Luo
  */
-'use strict';
 
-const { getFilename, getFilePath } = require('../utils/filename');
-const {
+import { FILENAME_BLOCKLIST_ERROR_MESSAGE } from '../constants/message.js';
+import { getDocUrl } from '../utils/doc.js';
+import { getFilePath, getFilename } from '../utils/filename.js';
+import { matchRule } from '../utils/rule.js';
+import {
   validateNamingPatternObject,
   globPatternValidator,
-} = require('../utils/validation');
-const { getDocUrl } = require('../utils/doc');
-const { FILENAME_BLOCKLIST_ERROR_MESSAGE } = require('../constants/message');
-const { matchRule } = require('../utils/rule');
+} from '../utils/validation.js';
 
 /**
  * @type {import('eslint').Rule.RuleModule}
  */
-module.exports = {
+export default {
   meta: {
     type: 'layout',
     docs: {

lib/rules/filename-blocklist.js

@@ -2,27 +2,24 @@
  * @file The filename should follow the filename naming convention
  * @author Huan Luo
  */
-'use strict';
 
-const {
-  transformRuleWithPrefinedMatchSyntax,
+import { FILENAME_NAMING_CONVENTION_ERROR_MESSAGE } from '../constants/message.js';
+import { getDocUrl } from '../utils/doc.js';
+import { getBasename, getFilePath, getFilename } from '../utils/filename.js';
+import {
   matchRule,
-} = require('../utils/rule');
-const { getFilename, getBasename, getFilePath } = require('../utils/filename');
-const {
-  validateNamingPatternObject,
+  transformRuleWithPrefinedMatchSyntax,
+} from '../utils/rule.js';
+import {
   filenameNamingPatternValidator,
   globPatternValidator,
-} = require('../utils/validation');
-const { getDocUrl } = require('../utils/doc');
-const {
-  FILENAME_NAMING_CONVENTION_ERROR_MESSAGE,
-} = require('../constants/message');
+  validateNamingPatternObject,
+} from '../utils/validation.js';
 
 /**
  * @type {import('eslint').Rule.RuleModule}
  */
-module.exports = {
+export default {
   meta: {
     type: 'layout',
     docs: {

lib/rules/filename-naming-convention.js

@@ -2,25 +2,20 @@
  * @file The folder should match the naming pattern specified by its file
  * @author Huan Luo
  */
-'use strict';
 
-const {
-  getFolderPath,
-  getFilename,
-  getFilePath,
-} = require('../utils/filename');
-const {
-  validateNamingPatternObject,
+import { FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE } from '../constants/message.js';
+import { getDocUrl } from '../utils/doc.js';
+import { getFilePath, getFilename, getFolderPath } from '../utils/filename.js';
+import { matchRule } from '../utils/rule.js';
+import {
   globPatternValidator,
-} = require('../utils/validation');
-const { getDocUrl } = require('../utils/doc');
-const { FOLDER_MATCH_WITH_FEX_ERROR_MESSAGE } = require('../constants/message');
-const { matchRule } = require('../utils/rule');
+  validateNamingPatternObject,
+} from '../utils/validation.js';
 
 /**
  * @type {import('eslint').Rule.RuleModule}
  */
-module.exports = {
+export default {
   meta: {
     type: 'layout',
     docs: {