npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

rollup-plugin-eik-import-map

v1.0.0

Published

Rollup plugin that uses Eik defined import map files to transform bare import specifiers to absolute URLs in ES modules

Downloads

5

Readme

rollup-plugin-eik-import-map

Rollup Eik plugin to support the use of import maps to map "bare" import specifiers in ES modules.

Installation

$ npm install rollup-plugin-eik-import-map

Usage

import eikImportMapPlugin from "rollup-plugin-eik-import-map";

export default {
  input: "source/main.js",
  plugins: [eikImportMapPlugin()],
  output: {
    file: "build.js",
    format: "esm",
  },
};

Description

This plugin transforms "bare" import specifiers to absolute URL specifiers in ES modules. The module refered to by the "bare" import specifier will be treated as external and its source will not be included in the bundle but refered to by URL.

The plugin will attempt to read import map URLs from eik.json if present.

export default {
  input: "source/main.js",
  plugins: [eikImportMapPlugin()],
  output: {
    file: "build.js",
    format: "esm",
  },
};

The path to the location of an eik.json file can be specified with the path option.

export default {
  input: "source/main.js",
  plugins: [eikImportMapPlugin({ path: "/path/to/eik.json" })],
  output: {
    file: "build.js",
    format: "esm",
  },
};

The plugin can also be told which URLs to load import maps from directly using the urls option.

export default {
  input: "source/main.js",
  plugins: [eikImportMapPlugin({ urls: `http://myserver/import-map` })],
  output: {
    file: "build.js",
    format: "esm",
  },
};

Additionally, individual mappings can be specified using the imports option.

export default {
  input: "source/main.js",
  plugins: [
    eikImportMapPlugin({
      imports: {
        "lit-element": "https://cdn.pika.dev/lit-element/v2",
      },
    }),
  ],
  output: {
    file: "build.js",
    format: "esm",
  },
};

If several of these options are used, imports takes precedence over urls which takes precedence over values loaded from an eik.json file.

ie. in the following example

export default {
    input: 'source/main.js',
    plugins: [eikImportMapPlugin({
        path: '/path/to/eik.json',
        urls: ['http://myserver/import-map']
        imports: {
            'lit-element': 'https://cdn.pika.dev/lit-element/v2',
        },
    })],
    output: {
        file: 'build.js',
        format: 'esm'
    }
};

Any import map URLs in eik.json will be loaded first, then merged with (and overridden if necessary by) the result of fetching from http://myserver/import-map before finally being merged with (and overriden if necessary by) specific mappings defined in imports. (In this case lit-element)

Plugin result

Bundles will have bare imports mapped to absolute URLs.

Ie. Something like this...

import { LitElement, html, css } from "lit-element";

Will be mapped to something like this...

import { LitElement, html, css } from "https://cdn.pika.dev/lit-element/v2";

Options

This plugin takes an import map as options:

| option | default | type | required | details | | ------- | -------------- | -------- | -------- | ----------------------------------------------------------- | | path | cwd/eik.json | string | false | Path to eik.json file. | | urls | [] | array | false | Array of import map URLs to fetch from. | | imports | {} | object | false | Mapping between "bare" import specifiers and absolute URLs. |

This module only cares about "bare" import specifiers which map to absolute URLs in the import map. Any other import specifiers defined in the import map are ignored.

Note on the rollup external option

Any mappings defined by any of the means described above must not occur in the Rollup external option. If so, this module will throw.

In other words, this will not work:

export default {
  input: "source/main.js",
  external: ["lit-element"],
  plugins: [
    eikImportMapPlugin({
      imports: {
        "lit-element": "https://cdn.pika.dev/lit-element/v2",
      },
    }),
  ],
  output: {
    file: "build.js",
    format: "esm",
  },
};

ESM only

This module will only work when the output is ES modules.

License

Copyright (c) 2020 Finn.no

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.