khrome / wing-kong

generate importmaps from your dependencies for native module support

wing-kong imports

Because writing importmaps and maintaining them by hand when you're doing native module development is pointless and infuriating, and the use case for this is super basic: You want to deliver from one or more CDNs on a site that allows file hosting via URL, but does not allow dependency insallation (ex: gh-pages) and another which you want to be locally hosted (like a browser test suite or a static local dev server).

This makes that simple: pulling dependencies, then rendering importmaps based on your configuration. The basic profile & generate runs client + server, though the CL tools only run server side.

Waltz in and out like the wind. (Usage)

1. Add it to your project

• install with npm

      npm i wing-kong

2. Add the generator to your scripts:

• in your package.json

      {
          "scripts": {
              "regenerate-test-importmap" : "wing-kong -i .import-config.json -f ./test/test.html rewrite dependencies",
              "generate-importmap" : "wing-kong -i .import-config.json generate dependencies"
          }
      }

• in your import-endpoints.json

      {
          "unpkg" : "https://unpkg.com/${name}${version}/",
          "jsdeliver" : "https://cdn.jsdelivr.net/npm/${name}${version}/",
          "local" : "./${name}"
      }

• When you generate generate-public-importmap it will use unpkg (falling back to jsdeliver then local). Because it doesn't use an import map, generate-importmap defaults to your local node_modules, assuming you are running a local server.

3. If you want to further automate:

• you could add it to your git hooks

      npm install simple-git-hooks

• Then add a hook to regenerate these files on merge, so any deps changes come in and any cross branch merging gets normalized.

      {
          "simple-git-hooks" : {
              "post-merge" : " if [[ \"$(git rev-parse --abbrev-ref HEAD)\" == \"gh-pages\" ]]; then npm run generate-public-importmap; else npm run generate-importmap; fi"
          }
      }

As two... I said I was coming (Testing)

Testing is easy:

npm run test

To run the same in a container

npm run container-test