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.

Sign up for GitHub

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 exports map for Native ESM #293

Merged
merged 2 commits into from
Aug 16, 2020
Merged

Feat: Add exports map for Native ESM #293

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59b44a4
feat: add loose `exports` map
lukeed Aug 7, 2020
305ca1d
feat: add "unpkg" entry
lukeed Aug 7, 2020
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
9 changes: 9 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,15 @@
"main": "./lib/index.js",
"module": "./lib/index.es6.js",
"browser": "./dist/diff.js",
"unpkg": "./dist/diff.js",
"exports": {
".": {
"import": "./lib/index.mjs",
"require": "./lib/index.js"
},
"./package.json": "./package.json",
"./": "./"
},
"scripts": {
"clean": "rm -rf lib/ dist/",
"build:node": "yarn babel --out-dir lib --source-maps=inline src",
Expand Down
12 changes: 9 additions & 3 deletions rollup.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@ export default [
output: [
{
name: 'Diff',
file: pkg.browser,
format: 'umd'
format: 'umd',
file: pkg.browser
},
{ file: pkg.module, format: 'es' }
{
format: 'esm',
file: pkg.module
}, {
format: 'esm',
file: pkg['exports']['.'].import
}
Copy link

@calebeby calebeby Aug 13, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lukeed What is the advantage of having two separate ESM builds and output files?

Copy link
Contributor Author

@lukeed lukeed Aug 13, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two things:

  1. I'm primarily preserving diff's existing output files, so that anyone who was import/requiring into the module (eg, require('diff/lib/index.es6.js')) doesn't find a surprise.

  2. I did not add "type": "module" (nor do I want to) since that'd be a breaking change. Without that, need .mjs extension for ESM to be activated.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that makes sense!

],
plugins: [
babel({
Expand Down