Merged
Conversation
Add index.mjs as an ESM wrapper and the exports field in package.json so that ES module consumers can use `import StatsD from 'hot-shots'`. CJS require continues to work as before.
Add wildcard subpath export ("./*": "./*") so existing consumers
importing deep paths like hot-shots/lib/statsd.js or
hot-shots/package.json are not broken by the new exports map.
Update test script to run the ESM test in CI, and change the ESM
test to import via the package name so the exports map is exercised.
Test that deep imports with extensions (lib/statsd.js, lib/helpers.js) and package.json remain accessible through the exports map.
Switch deep subpath assertions from createRequire() to await import() so they actually test ESM resolution. Keep createRequire only for package.json where JSON import compatibility across Node 18 is a concern. Also update CHANGES.md to use Unreleased heading.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds first-class ES module entrypoint support for hot-shots by introducing an ESM wrapper and configuring package.json exports, enabling import StatsD from 'hot-shots' (and a named StatsD export) while keeping CommonJS behavior intact.
Changes:
- Add
package.jsonexportsmap plusindex.mjsESM wrapper for dual ESM/CJS entrypoints. - Export
StatsDas a named export in the type definitions to match the new ESM surface. - Add an ESM import smoke test and document ESM usage in the README.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| types.d.ts | Adds named export StatsD in typings. |
| test/esm-import.mjs | New test validating ESM default + named import behavior and deep imports. |
| README.md | Documents ESM import usage alongside existing CommonJS example. |
| package.json | Adds exports map and runs the new ESM import test in npm test. |
| index.mjs | Provides ESM entrypoint that re-exports from existing CJS entry. |
| CLAUDE.md | Updates internal documentation to mention the ESM entrypoint and Node requirement. |
| CHANGES.md | Records the ESM entrypoint change under “Unreleased”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| "coverage": "nyc --reporter=lcov --reporter=text npm test", | ||
| "test": "mocha -R spec --timeout 5000 test/*.js", | ||
| "test": "mocha -R spec --timeout 5000 test/*.js && node test/esm-import.mjs", | ||
| "lint": "eslint \"./lib/**/*.js\" \"./test/**/*.js\"", |
There was a problem hiding this comment.
npm test now runs test/esm-import.mjs, but the lint script still only targets ./test/**/*.js, so this new test file won’t be linted (even though pretest runs lint). Consider updating the lint glob(s) to include .mjs tests to keep the same lint coverage for all executed tests.
Suggested change
| "lint": "eslint \"./lib/**/*.js\" \"./test/**/*.js\"", | |
| "lint": "eslint \"./lib/**/*.js\" \"./test/**/*.{js,mjs}\"", |
Update lint glob to cover test/*.mjs files. Add ESLint override for .mjs files with sourceType: module and ecmaVersion 2022 to support ES module syntax and top-level await.
Add ./*.mjs to the lint glob so index.mjs is also linted.
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
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.
Add ESM support via
exportsfield in package.json andindex.mjswrapper, enablingimport StatsD from 'hot-shots'in ES module projects