Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add ESM support #252

Merged
merged 9 commits into from
Nov 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ jobs:
node-version: ${{ matrix.node }}
- run: npm install
- run: npm test
- run: npm run test-esm
- uses: coverallsapp/[email protected]
if: matrix.node == 18
with:
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
node_modules/
coverage/
umd/
dist/
.tern-port
3 changes: 2 additions & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -131,4 +131,5 @@ declare namespace EventEmitter {
export const EventEmitter: EventEmitterStatic;
}

export = EventEmitter;
unional marked this conversation as resolved.
Show resolved Hide resolved
export { EventEmitter }
export default EventEmitter;
4 changes: 4 additions & 0 deletions index.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import EventEmitter from './index.js'

export { EventEmitter }
export default EventEmitter
27 changes: 19 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,29 @@
"name": "eventemitter3",
"version": "4.0.7",
"description": "EventEmitter3 focuses on performance while maintaining a Node.js AND browser compatible interface.",
"exports": {
".": {
"import": "./index.mjs",
"require": "./index.js",
"types": "./index.d.ts"
},
"./package.json": "./package.json"
},
"main": "index.js",
"typings": "index.d.ts",
"types": "index.d.ts",
"scripts": {
"browserify": "rm -rf umd && mkdir umd && browserify index.js -s EventEmitter3 -o umd/eventemitter3.js",
"minify": "uglifyjs umd/eventemitter3.js --source-map -cm -o umd/eventemitter3.min.js",
"rollup": "rimraf dist umd && rollup -c",
"benchmark": "find benchmarks/run -name '*.js' -exec benchmarks/start.sh {} \\;",
"test": "c8 --reporter=lcov --reporter=text mocha test/test.js",
"prepublishOnly": "npm run browserify && npm run minify",
"test-esm": "mocha test/test.mjs",
"prepublishOnly": "npm run rollup",
"test-browser": "node test/browser.js"
},
"files": [
"index.js",
"index.mjs",
"index.d.ts",
"umd"
"dist"
],
"repository": {
"type": "git",
Expand Down Expand Up @@ -44,13 +53,15 @@
"url": "https://github.com/primus/eventemitter3/issues"
},
"devDependencies": {
"@rollup/plugin-commonjs": "^23.0.2",
"@rollup/plugin-terser": "^0.1.0",
"assume": "^2.2.0",
"browserify": "^17.0.0",
"c8": "^7.3.1",
"mocha": "^10.0.0",
"pre-commit": "^1.2.0",
"rimraf": "^3.0.2",
"rollup": "^3.4.0",
"sauce-browsers": "^3.0.0",
"sauce-test": "^1.3.3",
"uglify-js": "^3.9.0"
"sauce-test": "^1.3.3"
}
}
36 changes: 36 additions & 0 deletions rollup.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import commonjs from '@rollup/plugin-commonjs';
import terser from '@rollup/plugin-terser';

export default [{
input: './index.mjs',
output: {
file: 'dist/eventemitter3.esm.js',
unional marked this conversation as resolved.
Show resolved Hide resolved
format: 'es'
},
plugins: [commonjs()]
}, {
input: './index.mjs',
output: {
compact: true,
file: 'dist/eventemitter3.esm.min.js',
format: 'es'
},
plugins: [commonjs(), terser()]
}, {
input: './index.js',
output: {
file: 'dist/eventemitter3.umd.js',
format: 'umd',
name: 'EventEmitter3'
},
plugins: [commonjs()]
}, {
input: './index.js',
output: {
compact: true,
file: 'dist/eventemitter3.umd.min.js',
format: 'umd',
name: 'EventEmitter3'
},
plugins: [commonjs(), terser()]
}];
9 changes: 9 additions & 0 deletions test/test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import EventEmitterDefault, { EventEmitter } from '../index.mjs';

it('exports `EventEmitter` as default export', () => {
new EventEmitterDefault();
})

it('exports `EventEmitter` as a named export', () => {
new EventEmitter();
})