refactor: move to ESM

BREAKING CHANGE: require Node.js v12

bin/cli.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 
-const meow = require("meow");
-const { toPairs, set } = require("lodash");
-const runner = require("./runner");
+import meow from "meow";
+import { toPairs, set } from "lodash-es";
+import runner from "./runner.js";
+
 const cli = meow(
 	`
   Usage

bin/runner.js

@@ -1,11 +1,15 @@
-module.exports = (flags) => {
+import {createRequire} from "module";
+
+export default async (flags) => {
+	const require = createRequire(import.meta.url);
+
 	if (flags.debug) {
 		require("debug").enable("msr:*");
 	}
 
 	// Imports.
-	const getPackagePaths = require("../lib/getPackagePaths");
-	const multiSemanticRelease = require("../lib/multiSemanticRelease");
+	const getPackagePaths = (await import("../lib/getPackagePaths.js")).default;
+	const multiSemanticRelease = (await import("../lib/multiSemanticRelease.js")).default;
 	const multisemrelPkgJson = require("../package.json");
 	const semrelPkgJson = require("semantic-release/package.json");
 

lib/RescopedStream.js

@@ -1,5 +1,5 @@
-const { Writable } = require("stream");
-const { check } = require("./blork");
+import { Writable } from "stream";
+import { check } from "./blork.js";
 
 /**
  * Create a stream that passes messages through while rewriting scope.
@@ -29,4 +29,4 @@ class RescopedStream extends Writable {
 }
 
 // Exports.
-module.exports = RescopedStream;
+export default RescopedStream;

lib/blork.js

@@ -1,7 +1,7 @@
-const { existsSync, lstatSync } = require("fs");
-const { checker, check, add, ValueError } = require("blork");
-const { Writable } = require("stream");
-const { WritableStreamBuffer } = require("stream-buffers");
+import { existsSync, lstatSync } from "fs";
+import { checker, check, add, ValueError } from "blork";
+import { Writable } from "stream";
+import { WritableStreamBuffer } from "stream-buffers";
 
 // Get some checkers.
 const isAbsolute = checker("absolute");
@@ -22,4 +22,4 @@ add(
 );
 
 // Exports.
-module.exports = { checker, check, ValueError };
+export { checker, check, ValueError };

lib/cleanPath.js

@@ -1,5 +1,5 @@
-const { normalize, isAbsolute, join } = require("path");
-const { check } = require("./blork");
+import { normalize, isAbsolute, join } from "path";
+import { check } from "./blork.js";
 
 /**
  * Normalize and make a path absolute, optionally using a custom CWD.
@@ -21,4 +21,4 @@ function cleanPath(path, cwd = process.cwd()) {
 }
 
 // Exports.
-module.exports = cleanPath;
+export default cleanPath;

lib/createInlinePluginCreator.js

@@ -1,6 +1,8 @@
-const debug = require("debug")("msr:inlinePlugin");
-const getCommitsFiltered = require("./getCommitsFiltered");
-const { updateManifestDeps, resolveReleaseType } = require("./updateDeps");
+import dbg from "debug";
+import getCommitsFiltered from "./getCommitsFiltered.js";
+import { updateManifestDeps, resolveReleaseType } from "./updateDeps.js";
+
+const debug = dbg("msr:inlinePlugin");
 
 /**
  * Create an inline plugin creator for a multirelease.
@@ -212,13 +214,11 @@ function createInlinePluginCreator(packages, multiContext, synchronizer, flags)
 		};
 
 		const publish = async (pluginOptions, context) => {
-			const resPromise = plugins.publish(context);
-			next();
-
-			const res = await resPromise;
+			const res = await plugins.publish(context);
 			pkg._published = true;
-
 			debug(debugPrefix, "published");
+
+			next();
 			await waitForAll("_published", (p) => p._nextType);
 
 			// istanbul ignore next
@@ -252,4 +252,4 @@ function createInlinePluginCreator(packages, multiContext, synchronizer, flags)
 }
 
 // Exports.
-module.exports = createInlinePluginCreator;
+export default createInlinePluginCreator;

lib/getCommitsFiltered.js

@@ -1,10 +1,12 @@
-const { relative, resolve } = require("path");
-const gitLogParser = require("git-log-parser");
-const execa = require("execa");
-const { check, ValueError } = require("./blork");
-const getStream = require("get-stream");
-const cleanPath = require("./cleanPath");
-const debug = require("debug")("msr:commitsFilter");
+import { relative, resolve } from "path";
+import gitLogParser from "git-log-parser";
+import getStream from "get-stream";
+import execa from "execa";
+import { check, ValueError } from "./blork.js";
+import cleanPath from "./cleanPath.js";
+import dbg from "debug";
+
+const debug = dbg("msr:commitsFilter");
 
 /**
  * Retrieve the list of commits on the current branch since the commit sha associated with the last release, or all the commits of the current branch if there is no last released version.
@@ -63,4 +65,4 @@ async function getCommitsFiltered(cwd, dir, lastHead = undefined, firstParentBra
 }
 
 // Exports.
-module.exports = getCommitsFiltered;
+export default getCommitsFiltered;

lib/getConfig.js

@@ -1,4 +1,4 @@
-const { cosmiconfig } = require("cosmiconfig");
+import { cosmiconfig } from "cosmiconfig";
 
 // Copied from get-config.js in semantic-release
 const CONFIG_NAME = "release";
@@ -22,7 +22,7 @@ const CONFIG_FILES = [
  *
  * @internal
  */
-module.exports = async function getConfig(cwd) {
+export default async function getConfig(cwd) {
 	// Call cosmiconfig.
 	const config = await cosmiconfig(CONFIG_NAME, { searchPlaces: CONFIG_FILES }).search(cwd);
 

lib/getConfigSemantic.js

@@ -1,6 +1,8 @@
-const semanticGetConfig = require("semantic-release/lib/get-config");
-const { WritableStreamBuffer } = require("stream-buffers");
-const { Signale } = require("signale");
+import semanticGetConfig from "semantic-release/lib/get-config.js";
+import { WritableStreamBuffer } from "stream-buffers";
+import signale from "signale";
+
+const { Signale } = signale;
 
 /**
  * Get the release configuration options for a given directory.
@@ -29,4 +31,4 @@ async function getConfigSemantic({ cwd, env, stdout, stderr, logger }, options)
 }
 
 // Exports.
-module.exports = getConfigSemantic;
+export default getConfigSemantic;

lib/getLogger.js

@@ -1,4 +1,5 @@
-const { Signale } = require("signale");
+import signale from "signale";
+const { Signale } = signale;
 
 /**
  * Return a new Signale instance.
@@ -25,4 +26,4 @@ function getLogger({ stdout, stderr }) {
 }
 
 // Exports.
-module.exports = getLogger;
+export default getLogger;

lib/getManifest.js

@@ -1,4 +1,4 @@
-const { existsSync, lstatSync, readFileSync } = require("fs");
+import { existsSync, lstatSync, readFileSync } from "fs";
 
 /**
  * Read the content of target package.json if exists.
@@ -79,4 +79,4 @@ function getManifest(path) {
 }
 
 // Exports.
-module.exports = getManifest;
+export default getManifest;

lib/getPackagePaths.js

@@ -1,8 +1,8 @@
-const getManifest = require("./getManifest");
-const glob = require("./glob");
-const { slash } = require("./utils");
-const path = require("path");
-const { getPackagesSync } = require("@manypkg/get-packages");
+import path from "path";
+import { getPackagesSync } from "@manypkg/get-packages";
+import getManifest from "./getManifest.js";
+import glob from "./glob.js";
+import { slash } from "./utils.js";
 
 /**
  * Return array of package.json for workspace packages.
@@ -54,4 +54,4 @@ function getPackagePaths(cwd, ignorePackages = null) {
 }
 
 // Exports.
-module.exports = getPackagePaths;
+export default getPackagePaths;

lib/getSynchronizer.js

@@ -1,6 +1,8 @@
-const EventEmitter = require("promise-events");
-const { identity } = require("lodash");
-const debug = require("debug")("msr:synchronizer");
+import EventEmitter from "promise-events";
+import { identity } from "lodash-es";
+import dbg from "debug";
+
+const debug = dbg("msr:synchronizer");
 
 /**
  * Cross-packages synchronization context.
@@ -93,4 +95,4 @@ const getSynchronizer = (packages) => {
 	};
 };
 
-module.exports = getSynchronizer;
+export default getSynchronizer;

lib/git.js

@@ -1,4 +1,4 @@
-const execa = require("execa");
+import execa from "execa";
 
 /**
  * Get all the tags for a given branch.
@@ -25,6 +25,4 @@ function getTags(branch, execaOptions, filters) {
 	return tags.filter((tag) => validateSubstr(tag, filters));
 }
 
-module.exports = {
-	getTags,
-};
+export { getTags };

lib/glob.js

@@ -1,6 +1,6 @@
-const globby = require("globby");
+import globby from "globby";
 
-module.exports = (...args) => {
+export default (...args) => {
 	const [pattern, ...options] = args;
 
 	return globby.sync(pattern, ...options);

lib/isCyclicProject.js

@@ -9,4 +9,4 @@ const isCyclicProject = (pkgs) => {
 	);
 };
 
-module.exports = isCyclicProject;
+export default isCyclicProject;

lib/multiSemanticRelease.js

@@ -1,16 +1,16 @@
-const { dirname } = require("path");
-const semanticRelease = require("semantic-release");
-const { uniq, template } = require("lodash");
-const { check, ValueError } = require("./blork");
-const getLogger = require("./getLogger");
-const getSynchronizer = require("./getSynchronizer");
-const getConfig = require("./getConfig");
-const getConfigSemantic = require("./getConfigSemantic");
-const getManifest = require("./getManifest");
-const cleanPath = require("./cleanPath");
-const RescopedStream = require("./RescopedStream");
-const createInlinePluginCreator = require("./createInlinePluginCreator");
-const isCyclicProject = require("./isCyclicProject");
+import { dirname } from "path";
+import semanticRelease from "semantic-release";
+import { uniq, template } from "lodash-es";
+import { check, ValueError } from "./blork.js";
+import getLogger from "./getLogger.js";
+import getSynchronizer from "./getSynchronizer.js";
+import getConfig from "./getConfig.js";
+import getConfigSemantic from "./getConfigSemantic.js";
+import getManifest from "./getManifest.js";
+import cleanPath from "./cleanPath.js";
+import RescopedStream from "./RescopedStream.js";
+import createInlinePluginCreator from "./createInlinePluginCreator.js";
+import isCyclicProject from "./isCyclicProject.js";
 
 /**
  * The multirelease context.
@@ -111,8 +111,6 @@ async function multiSemanticRelease(
 	return packages;
 }
 
-// Exports.
-module.exports = multiSemanticRelease;
 
 /**
  * Load details about a package.
@@ -217,3 +215,6 @@ function normalizeFlags(_flags) {
 		..._flags,
 	};
 }
+
+// Exports.
+export default multiSemanticRelease;

lib/recognizeFormat.js

@@ -1,5 +1,5 @@
-const detectNewline = require("detect-newline");
-const detectIndent = require("detect-indent");
+import detectNewline from "detect-newline";
+import detectIndent from "detect-indent";
 
 /**
  * Information about the format of a file.
@@ -22,4 +22,4 @@ function recognizeFormat(contents) {
 }
 
 // Exports.
-module.exports = recognizeFormat;
+export default recognizeFormat;

lib/updateDeps.js

@@ -1,11 +1,13 @@
-const { writeFileSync } = require("fs");
-const semver = require("semver");
-const { isObject, isEqual, transform } = require("lodash");
-const recognizeFormat = require("./recognizeFormat");
-const getManifest = require("./getManifest");
-const { getHighestVersion, getLatestVersion } = require("./utils");
-const { getTags } = require("./git");
-const debug = require("debug")("msr:updateDeps");
+import { writeFileSync } from "fs";
+import dbg from "debug";
+import semver from "semver";
+import { isObject, isEqual, transform } from "lodash-es";
+import recognizeFormat from "./recognizeFormat.js";
+import getManifest from "./getManifest.js";
+import { getHighestVersion, getLatestVersion } from "./utils.js";
+import { getTags } from "./git.js";
+
+const debug = dbg("msr:updateDeps");
 
 /**
  * Resolve next package version.
@@ -329,7 +331,7 @@ const auditManifestChanges = (actualManifest, path) => {
 	return false;
 };
 
-module.exports = {
+export {
 	getNextVersion,
 	getNextPreVersion,
 	getPreReleaseTag,

lib/utils.js

@@ -3,7 +3,8 @@
  * https://github.com/semantic-release/semantic-release/blob/master/lib/utils.js
  */
 
-const { gt, lt, prerelease, rcompare } = require("semver");
+import semver from "semver";
+const { gt, lt, prerelease, rcompare } = semver;
 
 /**
  * Get tag objects and convert them to a list of stringified versions.
@@ -64,7 +65,7 @@ function slash(path) {
 	return path.replace(/\\/g, "/");
 }
 
-module.exports = {
+export {
 	tagsToVersions,
 	getHighestVersion,
 	getLowestVersion,