karlpokus/npm_link.md

Last active July 13, 2022 15:32

Star (3) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Select an option

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/karlpokus/6db868030092af22099ab26863451572.js"></script>
Save karlpokus/6db868030092af22099ab26863451572 to your computer and use it in GitHub Desktop.

Download ZIP

npm link for dummies

Raw

npm_link.md

Submit PR via https://docs.npmjs.com/cli/link

What you want

You want B to depend on A but
A is not on npm (or it is - but you don't feel like publishing after each fix)

npm link

While standing in A npm link makes a global package of A. Verify by npm ls -g --depth=0.
A can then be used by B by doing npm link A while inside B. Verify by npm ls --depth=0.

npm unlink

To remove the link between A and B go into B and do $ npm unlink A. Verify by npm ls --depth=0.
To remove A as a global package do npm uninstall A -g. Verify by npm ls -g --depth=0.

Note: Automagically --save a link to package.json is currently not implemented so npm ls will have to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment