arcanis / build-pnm

Generate package-name-maps files by consuming the PnP API

build-pnm

Experimental package-name-maps generator

Installation

yarn add -D build-pnm

Usage

Simply add a postinstall script that runs the build-pnm binary, then run yarn again (note that you need to have Plug'n'Play enabled - in case you haven't enabled it already, just use --pnp the next time you run Yarn; you won't have to do it again afterwards):

{
  "devDependencies": {
    "build-pnm": "*",
  },
  "scripts": {
    "postinstall": "build-pnm"
  }
}

It will automatically generate a suitable package-name-maps.json file in the local directory.

License (MIT)

Copyright © 2016 Maël Nison

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.

build-pnm's Issues

flag for packages that need to be unique

First thanks for starting something like this 👍

I am curius where you wana go with it e.g. what is planned? for example did you see the possible overhaul of the package-name-maps (maybe even with rename)? WICG/import-maps#53

I would like to use something like this to generate maps that can be used with web components.
However they need to be unique.

Given the following dependency tree

$ npm ls
├─┬ [email protected]
│ └── [email protected]
└─┬ [email protected]
  └── [email protected]

We should get an Error/Question while creating package name map.

Possible example flow:

Could not find a sadisfying version for 'test-webcomponent'. Which one would you like to use in your package name map?
  > v1.0.0 (required by [email protected])
    v2.0.0 (required by [email protected])

I made an example Repository
https://github.com/daKmoR/build-pnm-webcomponent-issue

and published all needed packages to test it.

I'm curious on what you think? if I can help out in any way just let me know.