Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shgysk8zer0/importmap

Front-End dependencies based on `<script type="importmap">`
https://github.com/shgysk8zer0/importmap

importmap node npm rollup

Last synced: 2 days ago
JSON representation

Front-End dependencies based on `<script type="importmap">`

Host: GitHub
URL: https://github.com/shgysk8zer0/importmap
Owner: shgysk8zer0
License: mit
Created: 2023-05-31T02:18:19.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2024-04-30T14:16:39.000Z (5 months ago)
Last Synced: 2024-05-02T03:04:53.040Z (5 months ago)
Topics: importmap, node, npm, rollup
Language: JavaScript
Homepage: https://www.npmjs.com/package/@shgysk8zer0/importmap
Size: 338 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # @shgysk8zer0/importmap

Front-End dependencies based on [``](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap)

Intended for use with [`rollup`](https://rollupjs.org/) and [`@shgysk8zer0/rollup-import`](https://www.npmjs.com/package/@shgysk8zer0/rollup-import).

- - -

[![CodeQL](https://github.com/shgysk8zer0/importmap/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/shgysk8zer0/importmap/actions/workflows/codeql-analysis.yml)

![Node CI](https://github.com/shgysk8zer0/importmap/workflows/Node%20CI/badge.svg)

![Lint Code Base](https://github.com/shgysk8zer0/importmap/workflows/Lint%20Code%20Base/badge.svg)

[![GitHub license](https://img.shields.io/github/license/shgysk8zer0/importmap.svg)](https://github.com/shgysk8zer0/importmap/blob/master/LICENSE)

[![GitHub last commit](https://img.shields.io/github/last-commit/shgysk8zer0/importmap.svg)](https://github.com/shgysk8zer0/importmap/commits/master)

[![GitHub release](https://img.shields.io/github/release/shgysk8zer0/importmap?logo=github)](https://github.com/shgysk8zer0/importmap/releases)

[![GitHub Sponsors](https://img.shields.io/github/sponsors/shgysk8zer0?logo=github)](https://github.com/sponsors/shgysk8zer0)

[![npm](https://img.shields.io/npm/v/@shgysk8zer0/importmap)](https://www.npmjs.com/package/@shgysk8zer0/importmap)

![node-current](https://img.shields.io/node/v/@shgysk8zer0/importmap)

![npm bundle size gzipped](https://img.shields.io/bundlephobia/minzip/@shgysk8zer0/importmap)

[![npm](https://img.shields.io/npm/dw/@shgysk8zer0/importmap?logo=npm)](https://www.npmjs.com/package/@shgysk8zer0/importmap)

[![GitHub followers](https://img.shields.io/github/followers/shgysk8zer0.svg?style=social)](https://github.com/shgysk8zer0)

![GitHub forks](https://img.shields.io/github/forks/shgysk8zer0/importmap.svg?style=social)

![GitHub stars](https://img.shields.io/github/stars/shgysk8zer0/importmap.svg?style=social)

[![Twitter Follow](https://img.shields.io/twitter/follow/shgysk8zer0.svg?style=social)](https://twitter.com/shgysk8zer0)

[![Donate using Liberapay](https://img.shields.io/liberapay/receives/shgysk8zer0.svg?logo=liberapay)](https://liberapay.com/shgysk8zer0/donate "Donate using Liberapay")

- - -

- [Code of Conduct](./.github/CODE_OF_CONDUCT.md)

- [Contributing](./.github/CONTRIBUTING.md)

<!-- - [Security Policy](./.github/SECURITY.md) -->

## Installation

```bash

npm i @shgysk8zer0/importmap

```

## Example

```js

// rollup.config.js

import { rollupImport } from '@shgysk8zer0/rollup-import';

import { imports } from '@shgysk8zer0/importmap';

export default {

	input: 'index.js',

	output: {

		file: 'index.min.js',

		format: 'iife',

		sourcemap: true,

	},

	plugins: [rollupImport({ imports })],

};

```

## For `<script type="importmap">`

The module exports `getImportMapScript()`, which can be used to generate the

required importmap `<script>`:

```js

import { getImportMapScript } from '@shgysk8zer0/importmap';

getImportMapScript();

```

Which results in:

```html

<script type="importmap" integrity="sha384-...">{"imports": {}, "scope": {}}

```

## CLI

Create / update local importmap JSON or YAML files.

```

Usage: importmap-utils [options]

CLI utility for updating importmap files

Options:

  -V, --version              output the version number

  -i, --input [input]        local JSON or YAML importmap file

  -e, --encoding [encoding]  encoding (default: "utf8")

  -f, --format [format]      output format

  -o, --output       output file

  -h, --help                 display help for command

```

### CLI Example

```bash

importmap-utils -o importmap.json

# Or...

importmap-utils -i importmap.json -o importmap.yml -f yaml

```