esbuild-plugin-import-map

A ESBuild plugin to apply import map mapping to ECMAScript modules (ESM) ahead of time.

Installation

$ npm install esbuild-plugin-import-map

Usage

import * as importMap from "esbuild-plugin-import-map";

importMap.load({
    imports: {
        'lit-element': 'https://cdn.eik.dev/lit-element/v2'
    }
});

esbuild.build({
    entryPoints: ['source/main.js'],
    bundle: true,
    format: 'esm',
    minify: false,
    sourcemap: false,
    target: ['chrome58', 'firefox57', 'safari11', 'edge16'],
    plugins: [importMap.plugin()],
    outfile: 'out.js',
}).catch(() => process.exit(1))

Description

This plugin transforms import specifiers in ESM based on mappings defined in one or more import maps. Import maps are an emerging specification yet to be implemented in browsers, however this module can be used to apply import maps ahead of time.

One use case for import maps is to transform ESM bare import statements to an import statement which is an absolute URL to the same module on a CDN.

Lets say we have the following in our ESM when developing locally with node.js:

import {html, render} from 'lit-html';

Then on build we can apply the following import map:

{
  "imports": {
    "lit-html": "https://cdn.eik.dev/npm/lit-html/v1/lit-html.js",
  }
}

When applied, our output wil be:

import * as lit from 'https://cdn.eik.dev/npm/lit-html/v1/lit-html.js'

API

This module has the following API:

.load([map])

The load() methods can take a absolute path to a import map or an import map as an object directly. Values can be passed on as a single value or an Array of multiple values.

An absolute path to a import map file:

import * as importMap from "esbuild-plugin-import-map";

importMap.load('source/import-map.json');

Absolute paths to multiple import map files:

import * as importMap from "esbuild-plugin-import-map";

importMap.load([
    'source/import-map-a.json',
    'source/import-map-b.json',
    'source/import-map-c.json',
]);

Mix of absolute paths to import map files and import maps provided as an object:

import * as importMap from "esbuild-plugin-import-map";

importMap.load([
    'source/import-map-a.json',
    {
    "imports": {
        "lit-html": "https://cdn.eik.dev/npm/lit-html/v1/lit-html.js",
    }
    },
    'source/import-map-b.json',
]);

When an array of import maps is provided and multiple import maps use the same import specifier, the last import specifier in the array will be the one which is applied.

.plugin()

Returns the plugin which will apply the loaded import maps during build. The returned plugin should be appended to the ESBuild plugin array.

import * as importMap from "esbuild-plugin-import-map";

importMap.load('source/import-map.json');

esbuild.build({
    entryPoints: ['source/main.js'],
    bundle: true,
    format: 'esm',
    minify: false,
    sourcemap: false,
    target: ['chrome58', 'firefox57', 'safari11', 'edge16'],
    plugins: [importMap.plugin()],
    outfile: 'out.js',
}).catch(() => process.exit(1))

.clear()

Clears the loaded import maps from the plugins internal cache.

License

Copyright (c) 2020 Trygve Lie

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.