feat: support only ESM (#950)

BREAKING CHANGE: Node.js 12.20+ is required and CommonJS is unsupported
ybiquitous · May 6, 2021 · f7271d6 · f7271d6
1 parent 6afdb1d
commit f7271d6
Show file tree

Hide file tree

Showing 16 changed files with 128 additions and 150 deletions.
diff --git a/lib/cli.js b/lib/cli.js
@@ -1,17 +1,15 @@
 #!/usr/bin/env node
-const yargs = require("yargs");
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers"; // eslint-disable-line sort-imports
 
-function cli() {
-  // eslint-disable-next-line no-unused-expressions
-  yargs
+export default async function cli() {
+  yargs(hideBin(process.argv)) // eslint-disable-line no-unused-expressions
     .usage("$0 <command>")
-    .command(require("./init"))
+    .command(await import("./init.js")) // eslint-disable-line node/no-unsupported-features/es-syntax
     .demandCommand(1)
     .strict()
     .alias("help", "h")
     .alias("version", "v").argv;
 }
 
 cli();
-
-module.exports = cli;
diff --git a/lib/index.js b/lib/index.js
@@ -1,3 +1 @@
-const { init } = require("./init");
-
-module.exports.init = init;
+export { init } from "./init.js";
diff --git a/lib/init.js b/lib/init.js
@@ -1,19 +1,22 @@
-const path = require("path");
-const { promisify } = require("util");
-const fs = require("fs");
-const originalPackage = require("../package.json");
-const { defaultLogger } = require("./logger");
+import { promises as fsPromises } from "fs";
+import { join, relative, resolve } from "path"; // eslint-disable-line sort-imports
+import { inspect } from "util";
+import { defaultLogger } from "./logger.js"; // eslint-disable-line sort-imports
 
-const copy = promisify(fs.copyFile);
-const write = promisify(fs.writeFile);
-const read = promisify(fs.readFile);
-const mkdir = promisify(fs.mkdir);
+const { copyFile, mkdir, readFile, writeFile } = fsPromises;
+
+/**
+ * @param {unknown} value
+ */
+const emphasize = (value) => inspect(value, { colors: true });
+
+const PACKAGE_DIR = new URL("..", import.meta.url).pathname;
 
 /**
  * @param {string} elem
  * @param {...string} elems
  */
-const packagePath = (elem, ...elems) => path.join(...[__dirname, "..", elem, ...elems]);
+const packagePath = (elem, ...elems) => join(PACKAGE_DIR, elem, ...elems);
 
 /**
  * @param {string} baseDir
@@ -25,37 +28,37 @@ const initCommand = (baseDir, logger) => {
    * @param {string} elem
    * @param {...string} elems
    */
-  const currentPath = (elem, ...elems) => path.join(...[baseDir, elem, ...elems]);
+  const currentPath = (elem, ...elems) => join(baseDir, elem, ...elems);
 
   /**
    * @param {string} fileName
    */
-  const readFile = (fileName) => read(currentPath(fileName), "utf8");
+  const read = (fileName) => readFile(currentPath(fileName), "utf8");
 
   /**
    * @param {string} src
    * @param {string} dest
    */
-  const copyFile = async (src, dest) => {
-    await mkdir(path.resolve(dest, ".."), { recursive: true });
-    await copy(src, dest);
-    logger(`=> \`${path.relative(baseDir, dest)}\` was updated`);
+  const copy = async (src, dest) => {
+    await mkdir(resolve(dest, ".."), { recursive: true });
+    await copyFile(src, dest);
+    logger(`=> ${emphasize(relative(baseDir, dest))} was updated`);
   };
 
   /**
    * @param {string} fileName
    * @param {string} fileContent
    */
-  const writeFile = async (fileName, fileContent) => {
+  const write = async (fileName, fileContent) => {
     const file = currentPath(fileName);
-    await write(file, `${fileContent}\n`);
-    logger(`=> \`${path.relative(baseDir, file)}\` was updated`);
+    await writeFile(file, `${fileContent}\n`);
+    logger(`=> ${emphasize(relative(baseDir, file))} was updated`);
   };
 
   return {
     // eslint-disable-next-line max-statements, max-lines-per-function
     async updatePackageFile() {
-      const packageInfo = JSON.parse(await readFile("package.json"));
+      const packageInfo = JSON.parse(await read("package.json"));
 
       // update 'scripts'
       if (!("scripts" in packageInfo)) {
@@ -68,6 +71,11 @@ const initCommand = (baseDir, logger) => {
       scripts["test:watch"] = `${scripts.test} --watch`;
       scripts["test:coverage"] = `${scripts.test} --coverage`;
 
+      const originalPackage = JSON.parse(
+        // @ts-expect-error
+        await readFile(new URL("../package.json", import.meta.url))
+      );
+
       for (const [key, script] of Object.entries(originalPackage.scripts)) {
         if (!(key === "test" || key.startsWith("test:"))) {
           scripts[key] = script;
@@ -87,13 +95,15 @@ const initCommand = (baseDir, logger) => {
       updateOtherKey("standard-version");
       updateOtherKey("remarkConfig");
 
+      // eslint-disable-next-line require-atomic-updates
       packageInfo.commitlint = {
         extends: ["@commitlint/config-conventional"],
         rules: {
           "body-max-line-length": [1, "always", 100],
         },
       };
 
+      // eslint-disable-next-line require-atomic-updates
       packageInfo.eslintConfig = {
         root: true,
         extends: ["ybiquitous"],
@@ -104,22 +114,22 @@ const initCommand = (baseDir, logger) => {
       // Delete husky v4 configuration.
       delete packageInfo.husky;
 
-      await writeFile("package.json", JSON.stringify(packageInfo, null, 2));
+      await write("package.json", JSON.stringify(packageInfo, null, 2));
     },
 
     /**
      * @param {string} name
      * @param {...string} names
      */
     async writePackageFile(name, ...names) {
-      await copyFile(packagePath(name, ...names), currentPath(name, ...names));
+      await copy(packagePath(name, ...names), currentPath(name, ...names));
     },
   };
 };
 
 /** @type {import("../types/ybiq").InitCommand} */
 // eslint-disable-next-line max-statements
-async function init({ cwd = process.cwd(), logger = defaultLogger } = {}) {
+export async function init({ cwd = process.cwd(), logger = defaultLogger } = {}) {
   const cmd = initCommand(cwd, logger);
 
   await cmd.updatePackageFile();
@@ -133,16 +143,11 @@ async function init({ cwd = process.cwd(), logger = defaultLogger } = {}) {
   await cmd.writePackageFile(".husky", "post-commit");
   await cmd.writePackageFile(".husky", "pre-commit");
 }
-module.exports.init = init;
 
-module.exports.command = "init";
+export const command = "init";
 
-module.exports.describe = `Setup npm project:
-- Update \`package.json\`
-- Create \`.editorconfig\`
-- Create \`.remarkignore\`
-- Create \`.github/workflows/*.yml\``;
+export const describe = "Setup npm project, e.g. update 'package.json'";
 
-module.exports.handler = async () => {
+export const handler = async () => {
   await init();
 };
diff --git a/lib/logger.js b/lib/logger.js
@@ -1,6 +1,6 @@
-const { EOL } = require("os");
+import { EOL } from "os";
 
 /** @type {import("../types/ybiq").Logger} */
-module.exports.defaultLogger = (msg) => {
+export const defaultLogger = (msg) => {
   process.stdout.write(`${msg}${EOL}`);
 };
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -11,6 +11,7 @@
     "utility",
     "tool"
   ],
+  "type": "module",
   "main": "lib/index.js",
   "bin": "lib/cli.js",
   "types": "types/ybiq.d.ts",
@@ -28,7 +29,7 @@
     ".husky/pre-commit"
   ],
   "engines": {
-    "node": ">=12.13.0"
+    "node": "^12.20 || >=14.13"
   },
   "dependencies": {
     "@commitlint/cli": "^12.1.1",
@@ -53,9 +54,9 @@
     "typescript": "^4.2.4"
   },
   "scripts": {
-    "test": "jest --coverage && npm run test:types",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
+    "test": "NODE_OPTIONS=--experimental-vm-modules jest --coverage && npm run test:types",
+    "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch",
+    "test:coverage": "NODE_OPTIONS=--experimental-vm-modules jest --coverage",
     "test:types": "tsc --project test/tsconfig.test.json --noEmit",
     "lint:js": "eslint .",
     "lint:js:fix": "npm run lint:js -- --fix",
@@ -135,8 +136,17 @@
     "extends": [
       "ybiquitous/node"
     ],
+    "parserOptions": {
+      "ecmaVersion": 2020,
+      "sourceType": "module"
+    },
+    "env": {
+      "es2020": true
+    },
     "rules": {
-      "import/no-internal-modules": "off"
+      "import/extensions": "off",
+      "import/no-internal-modules": "off",
+      "import/prefer-default-export": "off"
     },
     "overrides": [
       {

diff --git a/test/__snapshots__/help.test.js.snap b/test/__snapshots__/help.test.js.snap
@@ -4,11 +4,7 @@ exports[`with "--help" option 1`] = `
 "cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]
@@ -20,11 +16,7 @@ exports[`with "-h" option 1`] = `
 "cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]
@@ -37,11 +29,7 @@ exports[`with arguments [] 1`] = `
 cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]
@@ -56,11 +44,7 @@ exports[`with arguments []: stderr 1`] = `
 cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]
@@ -75,11 +59,7 @@ exports[`with arguments [unknown, xyz] 1`] = `
 cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]
@@ -94,11 +74,7 @@ exports[`with arguments [unknown, xyz]: stderr 1`] = `
 cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]
@@ -113,11 +89,7 @@ exports[`with arguments [unknown] 1`] = `
 cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]
@@ -132,11 +104,7 @@ exports[`with arguments [unknown]: stderr 1`] = `
 cli.js <command>
 
 Commands:
-  cli.js init  Setup npm project:
-               - Update \`package.json\`
-               - Create \`.editorconfig\`
-               - Create \`.remarkignore\`
-               - Create \`.github/workflows/*.yml\`
+  cli.js init  Setup npm project, e.g. update 'package.json'
 
 Options:
   -h, --help     Show help                                             [boolean]

diff --git a/test/help.test.js b/test/help.test.js
@@ -1,5 +1,5 @@
-const pkg = require("../package.json");
-const exec = require("./helpers/exec");
+import { exec } from "./helpers/exec.js";
+import { pkg } from "./helpers/pkg.js";
 
 [[], ["unknown"], ["unknown", "xyz"]].forEach((args) => {
   test(`with arguments [${args.join(", ")}]`, async () => {

diff --git a/test/helpers/exec.js b/test/helpers/exec.js
@@ -1,6 +1,9 @@
-const cp = require("child_process");
+import { execFile as originalExecFile } from "child_process";
+import { promisify } from "util";
 
-module.exports = function exec(commandFile, ...args) {
+const execFile = promisify(originalExecFile);
+
+export function exec(commandFile, ...args) {
   const options = {
     env: { ...process.env, LC_ALL: "C" },
   };
@@ -11,17 +14,5 @@ module.exports = function exec(commandFile, ...args) {
     options.cwd = lastArg.cwd;
     newArgs = args.slice(0, lastArgIndex);
   }
-  return new Promise((resolve, reject) => {
-    cp.execFile(commandFile, newArgs, options, (error, stdout, stderr) => {
-      if (error) {
-        /* eslint-disable no-param-reassign */
-        error.stdout = stdout;
-        error.stderr = stderr;
-        /* eslint-enable no-param-reassign */
-        reject(error);
-      } else {
-        resolve({ stdout, stderr });
-      }
-    });
-  });
-};
+  return execFile(commandFile, newArgs, options);
+}
diff --git a/test/helpers/pkg.js b/test/helpers/pkg.js
@@ -0,0 +1,3 @@
+import { readFileSync } from "fs";
+
+export const pkg = JSON.parse(readFileSync(new URL("../../package.json", import.meta.url)));
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { readFileSync } from "fs";

		export const pkg = JSON.parse(readFileSync(new URL("../../package.json", import.meta.url)));