Convert codebase to ESM, mostly

.github/workflows/test.yml

@@ -41,7 +41,7 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - run: npm i
-      - run: npm run test
+      - run: npm run test:node-test
       - uses: codecov/codecov-action@v5
         if: ${{ github.event_name == 'pull_request' }}
         with:

.knip.jsonc

@@ -1,5 +1,5 @@
 {
   "$schema": "https://unpkg.com/knip@5/schema.json",
-  "entry": ["lib/index.js", "bin/*/*.js", "test-workspace/tasks/*.js"],
+  "entry": ["lib/cjs.cjs", "lib/esm.mjs", "bin/*/*.js", "test-workspace/tasks/*.cjs"],
   "ignoreDependencies": ["yarn", "spec"]
 }

README.md

@@ -30,7 +30,7 @@ $ npm install npm-run-all2 --save-dev
 $ yarn add npm-run-all2 --dev
 ```
 
-- It requires `Node@>=14`. It may work on older versions of Node, but no guarantees are given.
+- It requires `Node@>=22`. It may work on older versions of Node, but no guarantees are given.
 
 ## 📖 Usage
 

bin/common/bootstrap.js

@@ -3,34 +3,38 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Public Interface
 // ------------------------------------------------------------------------------
 
-module.exports = function bootstrap (name) {
+export default async function bootstrap (name) {
   const argv = process.argv.slice(2)
 
   switch (argv[0]) {
     case undefined:
     case '-h':
-    case '--help':
-      return require(`../${name}/help`)(process.stdout)
+    case '--help': {
+      const help = await import(`../${name}/help.js`)
+      return help.default(process.stdout)
+    }
 
     case '-v':
-    case '--version':
-      return require('./version')(process.stdout)
+    case '--version': {
+      const version = await import('./version.js')
+      return version.default(process.stdout)
+    }
 
-    default:
+    default: {
       // https://github.com/mysticatea/npm-run-all/issues/105
       // Avoid MaxListenersExceededWarnings.
       process.stdout.setMaxListeners(0)
       process.stderr.setMaxListeners(0)
       process.stdin.setMaxListeners(0)
 
       // Main
-      return require(`../${name}/main`)(
+      const main = await import(`../${name}/main.js`)
+      return main.default(
         argv,
         process.stdout,
         process.stderr
@@ -44,5 +48,6 @@ module.exports = function bootstrap (name) {
           process.exit(1)
         }
       )
+    }
   }
 }

bin/common/parse-cli-args.js

@@ -3,7 +3,6 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Helpers
@@ -238,6 +237,6 @@ function parseCLIArgsCore (set, args) {
  * @param {boolean} options.singleMode - The flag to be single group mode.
  * @returns {ArgumentSet} The parsed CLI arguments.
  */
-module.exports = function parseCLIArgs (args, initialValues, options) {
+export default function parseCLIArgs (args, initialValues, options) {
   return parseCLIArgsCore(new ArgumentSet(initialValues, options), args)
 }

bin/common/version.js

@@ -3,21 +3,30 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Public Interface
 // ------------------------------------------------------------------------------
 
+import { readFile } from 'fs/promises'
+import { fileURLToPath } from 'url'
+import { dirname, resolve } from 'path'
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
 /**
  * Print a version text.
  *
  * @param {stream.Writable} output - A writable stream to print.
  * @returns {Promise} Always a fulfilled promise.
  * @private
  */
-module.exports = function printVersion (output) {
-  const version = require('../../package.json').version
+export default async function printVersion (output) {
+  const packageJson = JSON.parse(
+    await readFile(resolve(__dirname, '../../package.json'), 'utf8')
+  )
+  const version = packageJson.version
 
   output.write(`v${version}\n`)
 

bin/npm-run-all/help.js

@@ -3,7 +3,6 @@
  * @copyright 2015 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Public Interface
@@ -16,7 +15,7 @@
  * @returns {Promise} Always a fulfilled promise.
  * @private
  */
-module.exports = function printHelp (output) {
+export default function printHelp (output) {
   output.write(`
 Usage:
     $ npm-run-all [--help | -h | --version | -v]

bin/npm-run-all/index.js

@@ -4,10 +4,11 @@
  * @copyright 2015 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Main
 // ------------------------------------------------------------------------------
 
-require('../common/bootstrap')('npm-run-all')
+import bootstrap from '../common/bootstrap.js'
+
+bootstrap('npm-run-all')

bin/npm-run-all/main.js

@@ -3,14 +3,13 @@
  * @copyright 2015 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
 
-const runAll = require('../../lib')
-const parseCLIArgs = require('../common/parse-cli-args')
+import runAll from 'npm-run-all2'
+import parseCLIArgs from '../common/parse-cli-args.js'
 
 // ------------------------------------------------------------------------------
 // Public Interface
@@ -25,7 +24,7 @@ const parseCLIArgs = require('../common/parse-cli-args')
  * @returns {Promise} A promise which comes to be fulfilled when all npm-scripts are completed.
  * @private
  */
-module.exports = function npmRunAll (args, stdout, stderr) {
+export default function npmRunAll (args, stdout, stderr) {
   try {
     const stdin = process.stdin
     const argv = parseCLIArgs(args)

bin/run-p/help.js

@@ -3,7 +3,6 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Public Interface
@@ -16,7 +15,7 @@
  * @returns {Promise} Always a fulfilled promise.
  * @private
  */
-module.exports = function printHelp (output) {
+export default function printHelp (output) {
   output.write(`
 Usage:
     $ run-p [--help | -h | --version | -v]

bin/run-p/index.js

@@ -4,10 +4,11 @@
  * @copyright 2015 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Main
 // ------------------------------------------------------------------------------
 
-require('../common/bootstrap')('run-p')
+import bootstrap from '../common/bootstrap.js'
+
+bootstrap('run-p')

bin/run-p/main.js

@@ -3,14 +3,13 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
 
-const runAll = require('../../lib')
-const parseCLIArgs = require('../common/parse-cli-args')
+import runAll from 'npm-run-all2'
+import parseCLIArgs from '../common/parse-cli-args.js'
 
 // ------------------------------------------------------------------------------
 // Public Interface
@@ -25,7 +24,7 @@ const parseCLIArgs = require('../common/parse-cli-args')
  * @returns {Promise} A promise which comes to be fulfilled when all npm-scripts are completed.
  * @private
  */
-module.exports = function npmRunAll (args, stdout, stderr) {
+export default function npmRunAll (args, stdout, stderr) {
   try {
     const stdin = process.stdin
     const argv = parseCLIArgs(args, { parallel: true }, { singleMode: true })

bin/run-s/help.js

@@ -3,7 +3,6 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Public Interface
@@ -16,7 +15,7 @@
  * @returns {Promise} Always a fulfilled promise.
  * @private
  */
-module.exports = function printHelp (output) {
+export default function printHelp (output) {
   output.write(`
 Usage:
     $ run-s [--help | -h | --version | -v]

bin/run-s/index.js

@@ -4,10 +4,11 @@
  * @copyright 2015 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Main
 // ------------------------------------------------------------------------------
 
-require('../common/bootstrap')('run-s')
+import bootstrap from '../common/bootstrap.js'
+
+bootstrap('run-s')

bin/run-s/main.js

@@ -3,14 +3,13 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
 
-const runAll = require('../../lib')
-const parseCLIArgs = require('../common/parse-cli-args')
+import runAll from 'npm-run-all2'
+import parseCLIArgs from '../common/parse-cli-args.js'
 
 // ------------------------------------------------------------------------------
 // Public Interface
@@ -25,7 +24,7 @@ const parseCLIArgs = require('../common/parse-cli-args')
  * @returns {Promise} A promise which comes to be fulfilled when all npm-scripts are completed.
  * @private
  */
-module.exports = function npmRunAll (args, stdout, stderr) {
+export default function npmRunAll (args, stdout, stderr) {
   try {
     const stdin = process.stdin
     const argv = parseCLIArgs(args, { parallel: false }, { singleMode: true })

eslint.config.js

@@ -1,9 +1,8 @@
-'use strict'
+import neostandard from 'neostandard'
 
-module.exports = [
-  ...require('neostandard')({
-    env: ['node', 'mocha'],
-    ignores: require('neostandard').resolveIgnoresFromGitignore(),
+export default [
+  ...neostandard({
+    ignores: neostandard.resolveIgnoresFromGitignore(),
     ts: true,
   }),
 ]

lib/cjs.cjs

@@ -0,0 +1,10 @@
+const { default: npmRunAll } = require('./esm.mjs')
+
+// Didn't manage to get this ito the last breaking change, so adding a cjs as the primary export
+// maintiains a compatible layer for cjs consumers. If we export esm by default, the best cjs can
+// get is a default exoport field (breaking).
+//
+// TODO: Next breaking change, drop this file in favor of a named ESM export.
+//
+// ESM consumers can import 'npm-run-all2/esm.js' directly if they want to bypass this indirect.
+module.exports = npmRunAll

lib/create-header.js

@@ -4,7 +4,6 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Public Interface
@@ -20,7 +19,7 @@
  * @param {boolean} isTTY - The flag to color the header.
  * @returns {string} The header of a given task.
  */
-module.exports = function createHeader (nameAndArgs, packageInfo, isTTY, ansiStyles) {
+export default function createHeader (nameAndArgs, packageInfo, isTTY, ansiStyles) {
   if (!packageInfo) {
     return `\n> ${nameAndArgs}\n\n`
   }

lib/create-prefix-transform-stream.js

@@ -4,13 +4,12 @@
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
-'use strict'
 
 // ------------------------------------------------------------------------------
 // Requirements
 // ------------------------------------------------------------------------------
 
-const stream = require('stream')
+import stream from 'stream'
 
 // ------------------------------------------------------------------------------
 // Helpers
@@ -86,6 +85,6 @@ class PrefixTransform extends stream.Transform {
  * @param {boolean} state.lastIsLinebreak -The flag to check whether the last output is a line break or not.
  * @returns {stream.Transform} The created transform stream.
  */
-module.exports = function createPrefixTransform (prefix, state) {
+export default function createPrefixTransform (prefix, state) {
   return new PrefixTransform(prefix, state)
 }