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 Import Maps support #759

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
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
5 changes: 5 additions & 0 deletions .changeset/two-ducks-shave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'microbundle': minor
---

Support ESM Import Maps
5 changes: 5 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@
"pretty-bytes": "^5.4.1",
"rollup": "^2.35.1",
"rollup-plugin-bundle-size": "^1.0.3",
"rollup-plugin-import-map": "^2.2.2",
"rollup-plugin-postcss": "^4.0.0",
"rollup-plugin-terser": "^7.0.2",
"rollup-plugin-typescript2": "^0.29.0",
Expand Down
4 changes: 4 additions & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import glob from 'tiny-glob/sync';
import autoprefixer from 'autoprefixer';
import { rollup, watch } from 'rollup';
import builtinModules from 'builtin-modules';
import { rollupImportMapPlugin as importMap } from 'rollup-plugin-import-map';
import resolveFrom from 'resolve-from';
import commonjs from '@rollup/plugin-commonjs';
import babel from '@rollup/plugin-babel';
Expand Down Expand Up @@ -439,6 +440,9 @@ function createConfig(options, entry, format, writeMeta) {

plugins: []
.concat(
(modern || format === 'es') &&
options['import-map'] &&
importMap(options['import-map']),
postcss({
plugins: [autoprefixer()],
autoModules: shouldCssModules(options),
Expand Down
5 changes: 5 additions & 0 deletions src/prog.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,11 @@ export default handler => {
.example('microbundle --define API_KEY=1234')
.option('--alias', `Map imports to different modules`)
.example('microbundle --alias react=preact')
.option(
'--import-map',
'Import ESM packages from a CDN, instead of including them in the ESM bundle',
)
.example('microbundle --import-map import-map.json')
.option('--compress', 'Compress output using Terser', null)
.option('--strict', 'Enforce undefined global context and add "use strict"')
.option('--name', 'Specify name exposed in UMD builds')
Expand Down
27 changes: 27 additions & 0 deletions test/__snapshots__/index.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -1679,6 +1679,33 @@ exports[`fixtures build esnext-ts with microbundle 6`] = `
"
`;

exports[`fixtures build import-map with microbundle 1`] = `
"Used script: microbundle -f modern --import-map import-map.json

Directory tree:

import-map
dist
import-map.modern.js
import-map.modern.js.map
import-map.json
index.js
package.json


Build \\"importMap\\" to dist:
119 B: import-map.modern.js.gz
100 B: import-map.modern.js.br"
`;

exports[`fixtures build import-map with microbundle 2`] = `2`;

exports[`fixtures build import-map with microbundle 3`] = `
"import{getCLS as o,getFID as l,getLCP as e}from\\"https://unpkg.com/web-vitals?module\\";o(console.log),l(console.log),e(console.log);
//# sourceMappingURL=import-map.modern.js.map
"
`;

exports[`fixtures build inline-source-map with microbundle 1`] = `
"Used script: microbundle --sourcemap inline

Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/import-map/import-map.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"imports": {
"web-vitals": "https://unpkg.com/web-vitals?module"
}
}
6 changes: 6 additions & 0 deletions test/fixtures/import-map/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/* eslint-disable no-console */
import { getLCP, getFID, getCLS } from 'web-vitals';

getCLS(console.log);
getFID(console.log);
getLCP(console.log);
6 changes: 6 additions & 0 deletions test/fixtures/import-map/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "import-map",
"scripts": {
"build": "microbundle -f modern --import-map import-map.json"
}
}