ESM only (#568)

Co-authored-by: Pascal Jufer <[email protected]>

Author: gustavohenke

.editorconfig

@@ -10,6 +10,6 @@ insert_final_newline = true
 indent_style = space
 
 # 4 space indentation and max line length of 100 in JavaScript/TypeScript files
-[*.{mjs,js,ts}]
+[*.{js,ts}]
 indent_size = 4
 max_line_length = 100

bin/concurrently.spec.ts

@@ -11,7 +11,7 @@ import { map } from 'rxjs/operators';
 import stringArgv from 'string-argv';
 import { afterAll, beforeAll, describe, expect, it } from 'vitest';
 
-import { escapeRegExp } from '../src/utils';
+import { escapeRegExp } from '../src/utils.js';
 
 const isWindows = process.platform === 'win32';
 const createKillMessage = (prefix: string, signal: 'SIGTERM' | 'SIGINT' | string) => {
@@ -32,7 +32,10 @@ beforeAll(async () => {
         entryPoints: [path.join(__dirname, 'concurrently.ts')],
         platform: 'node',
         bundle: true,
-        outfile: path.join(tmpDir, 'concurrently.js'),
+        // it doesn't seem like esbuild is able to change a CJS module to ESM, so target CJS instead.
+        // https://github.com/evanw/esbuild/issues/1921
+        format: 'cjs',
+        outfile: path.join(tmpDir, 'concurrently.cjs'),
     });
     fs.copyFileSync(path.join(__dirname, '..', 'package.json'), path.join(tmpDir, 'package.json'));
 }, 8000);
@@ -50,7 +53,7 @@ afterAll(() => {
  */
 const run = (args: string, ctrlcWrapper?: boolean) => {
     const spawnFn = ctrlcWrapper ? spawnWithWrapper : spawn;
-    const child = spawnFn('node', [path.join(tmpDir, 'concurrently.js'), ...stringArgv(args)], {
+    const child = spawnFn('node', [path.join(tmpDir, 'concurrently.cjs'), ...stringArgv(args)], {
         cwd: __dirname,
         env: {
             ...process.env,
@@ -152,30 +155,29 @@ describe('exiting conditions', () => {
     });
 
     it('is of success when --success=first and first command to exit succeeds', async () => {
-        const exit = await run('--success=first "echo foo" "node fixtures/sleep.mjs 0.5 && exit 1"')
+        const exit = await run('--success=first "echo foo" "node fixtures/sleep.js 0.5 && exit 1"')
             .exit;
 
         expect(exit.code).toBe(0);
     });
 
     it('is of failure when --success=first and first command to exit fails', async () => {
-        const exit = await run('--success=first "exit 1" "node fixtures/sleep.mjs 0.5 && echo foo"')
+        const exit = await run('--success=first "exit 1" "node fixtures/sleep.js 0.5 && echo foo"')
             .exit;
 
         expect(exit.code).toBeGreaterThan(0);
     });
 
     describe('is of success when --success=last and last command to exit succeeds', () => {
         it.each(['--success=last', '-s last'])('%s', async (arg) => {
-            const exit = await run(`${arg} "exit 1" "node fixtures/sleep.mjs 0.5 && echo foo"`)
-                .exit;
+            const exit = await run(`${arg} "exit 1" "node fixtures/sleep.js 0.5 && echo foo"`).exit;
 
             expect(exit.code).toBe(0);
         });
     });
 
     it('is of failure when --success=last and last command to exit fails', async () => {
-        const exit = await run('--success=last "echo foo" "node fixtures/sleep.mjs 0.5 && exit 1"')
+        const exit = await run('--success=last "echo foo" "node fixtures/sleep.js 0.5 && exit 1"')
             .exit;
 
         expect(exit.code).toBeGreaterThan(0);
@@ -260,7 +262,7 @@ describe('--hide', () => {
 describe('--group', () => {
     it('groups output per process', async () => {
         const lines = await run(
-            '--group "echo foo && node fixtures/sleep.mjs 1 && echo bar" "echo baz"',
+            '--group "echo foo && node fixtures/sleep.js 1 && echo bar" "echo baz"',
         ).getLogLines();
 
         expect(lines.slice(0, 4)).toEqual([
@@ -334,54 +336,52 @@ describe('--restart-tries', () => {
 describe('--kill-others', () => {
     describe('kills on success', () => {
         it.each(['--kill-others', '-k'])('%s', async (arg) => {
-            const lines = await run(`${arg} "node fixtures/sleep.mjs 10" "exit 0"`).getLogLines();
+            const lines = await run(`${arg} "node fixtures/sleep.js 10" "exit 0"`).getLogLines();
 
             expect(lines).toContainEqual(expect.stringContaining('[1] exit 0 exited with code 0'));
             expect(lines).toContainEqual(
                 expect.stringContaining('Sending SIGTERM to other processes'),
             );
             expect(lines).toContainEqual(
                 expect.stringMatching(
-                    createKillMessage('[0] node fixtures/sleep.mjs 10', 'SIGTERM'),
+                    createKillMessage('[0] node fixtures/sleep.js 10', 'SIGTERM'),
                 ),
             );
         });
     });
 
     it('kills on failure', async () => {
-        const lines = await run(
-            '--kill-others "node fixtures/sleep.mjs 10" "exit 1"',
-        ).getLogLines();
+        const lines = await run('--kill-others "node fixtures/sleep.js 10" "exit 1"').getLogLines();
 
         expect(lines).toContainEqual(expect.stringContaining('[1] exit 1 exited with code 1'));
         expect(lines).toContainEqual(expect.stringContaining('Sending SIGTERM to other processes'));
         expect(lines).toContainEqual(
-            expect.stringMatching(createKillMessage('[0] node fixtures/sleep.mjs 10', 'SIGTERM')),
+            expect.stringMatching(createKillMessage('[0] node fixtures/sleep.js 10', 'SIGTERM')),
         );
     });
 });
 
 describe('--kill-others-on-fail', () => {
     it('does not kill on success', async () => {
         const lines = await run(
-            '--kill-others-on-fail "node fixtures/sleep.mjs 0.5" "exit 0"',
+            '--kill-others-on-fail "node fixtures/sleep.js 0.5" "exit 0"',
         ).getLogLines();
 
         expect(lines).toContainEqual(expect.stringContaining('[1] exit 0 exited with code 0'));
         expect(lines).toContainEqual(
-            expect.stringContaining('[0] node fixtures/sleep.mjs 0.5 exited with code 0'),
+            expect.stringContaining('[0] node fixtures/sleep.js 0.5 exited with code 0'),
         );
     });
 
     it('kills on failure', async () => {
         const lines = await run(
-            '--kill-others-on-fail "node fixtures/sleep.mjs 10" "exit 1"',
+            '--kill-others-on-fail "node fixtures/sleep.js 10" "exit 1"',
         ).getLogLines();
 
         expect(lines).toContainEqual(expect.stringContaining('[1] exit 1 exited with code 1'));
         expect(lines).toContainEqual(expect.stringContaining('Sending SIGTERM to other processes'));
         expect(lines).toContainEqual(
-            expect.stringMatching(createKillMessage('[0] node fixtures/sleep.mjs 10', 'SIGTERM')),
+            expect.stringMatching(createKillMessage('[0] node fixtures/sleep.js 10', 'SIGTERM')),
         );
     });
 });
@@ -482,8 +482,8 @@ describe('--timings', () => {
     const tableBottomBorderRegex = /└[─┴]+┘/g;
 
     const timingsTests = {
-        'shows timings on success': ['node fixtures/sleep.mjs 0.5', 'exit 0'],
-        'shows timings on failure': ['node fixtures/sleep.mjs 0.75', 'exit 1'],
+        'shows timings on success': ['node fixtures/sleep.js 0.5', 'exit 0'],
+        'shows timings on failure': ['node fixtures/sleep.js 0.75', 'exit 1'],
     };
     it.each(Object.entries(timingsTests))('%s', async (_, commands) => {
         const lines = await run(

bin/concurrently.ts

@@ -2,13 +2,13 @@
 import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
-import { assertDeprecated } from '../src/assert';
-import * as defaults from '../src/defaults';
-import { concurrently } from '../src/index';
-import { castArray } from '../src/utils';
-import { readPackage } from './read-package';
+import { assertDeprecated } from '../src/assert.js';
+import * as defaults from '../src/defaults.js';
+import { concurrently } from '../src/index.js';
+import { castArray } from '../src/utils.js';
+import { readPackageJson } from './read-package-json.js';
 
-const version = String(readPackage().version);
+const version = String(readPackageJson().version);
 const epilogue = `For documentation and more examples, visit:\nhttps://github.com/open-cli-tools/concurrently/tree/v${version}/docs`;
 
 // Clean-up arguments (yargs expects only the arguments after the program name)

bin/fixtures/sleep.mjs renamed to bin/fixtures/sleep.js

@@ -0,0 +1,17 @@
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+
+/**
+ * Read the package.json file of `concurrently`
+ */
+export function readPackageJson(): Record<string, unknown> {
+    let resolver;
+    try {
+        resolver = require.resolve;
+    } catch {
+        resolver = createRequire(import.meta.url).resolve;
+    }
+    const path = resolver('concurrently/package.json');
+    const content = readFileSync(path, 'utf8');
+    return JSON.parse(content);
+}

bin/read-package-json.ts

@@ -18,7 +18,6 @@ export default defineConfig(
                 ...globals.node,
             },
             ecmaVersion: 2023,
-            sourceType: 'commonjs',
         },
     },
     eslint.configs.recommended,

bin/read-package.ts

@@ -1,11 +1,8 @@
 /*
  * While in local development, make sure you've run `pnpm run build` first.
  */
+
 import { concurrently } from './dist/src/index.js';
 
 export * from './dist/src/index.js';
-// @ts-expect-error ignore the usage of `export =` along with `export default`.
-// This is seemingly fine, but the file needs to be included in the TS project, which can't be done
-// due to importing from `dist`. See https://stackoverflow.com/q/42609768/2083599
-export = concurrently;
 export default concurrently;

eslint.config.mjs renamed to eslint.config.js

@@ -2,13 +2,7 @@
  * While in local development, make sure you've run `pnpm run build` first.
  */
 
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const concurrently = require('./dist/src/index.js');
+import { concurrently } from './dist/src/index.js';
 
-// For require()
-module.exports = exports = concurrently.concurrently;
-
-// For TS + import syntax; mimics `export default`
-exports.default = exports;
-
-Object.assign(exports, concurrently);
+export * from './dist/src/index.js';
+export default concurrently;