docs: update API example to ESM - #611
Merged
gustavohenke merged 1 commit intoAug 18, 2026
Merged
Conversation
concurrently v10 is pure ESM (type: module, and exports maps only
./dist/lib/index.js), so the README example no longer runs as written:
const concurrently = require('concurrently'); // -> namespace object
concurrently([...]); // TypeError: not a function
Verified against the published concurrently@10.0.5 on Node 22.
Switch the example to a named ESM import and replace __dirname, which does
not exist in an ES module, with import.meta.dirname (Node >=20.11; package
engines already require >=22).
Closes open-cli-tools#606
|
coverage: 98.757%. remained the same — Bibin-VR:docs/esm-usage-example into open-cli-tools:main |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
concurrently v10 is pure ESM (type: module, and exports maps only ./dist/lib/index.js), so the README example no longer runs as written:
const concurrently = require('concurrently'); // -> namespace object
concurrently([...]); // TypeError: not a function
Verified against the published concurrently@10.0.5 on Node 22.
Switch the example to a named ESM import and replace __dirname, which does not exist in an ES module, with import.meta.dirname (Node >=20.11; package engines already require >=22).
Closes #606