Requires npm 2.0.0 and above. Links both development and production dependencies.
npm install -g linklocal
Usage: linklocal [options] <dir>
Options:
-h, --help output usage information
-V, --version output the version number
-u, --unlink Unlink local dependencies
-l, --link Link local dependencies [default]
-r, --recursive Link recursively [probably what you want]
Examples:
$ linklocal # link local deps in current dir
$ linklocal -r # link local deps recursively
$ linklocal unlink # unlink only in current dir
$ linklocal unlink -r # unlink recursively
$ linklocal -- mydir # link local deps in mydir
$ linklocal unlink -- mydir # unlink local deps in mydir
linklocal creates symlinks to any local dependencies it finds in your package.json.
# from test/banana
> linklocal
Linked 1 dependencies
Linked node_modules/apple
> ls -l node_modules
total 8
lrwxr-xr-x 1 timoxley staff 11 20 Sep 01:39 apple -> ../../apple
You can unlink all local links using linklocal --unlink.
# from test/banana
> linklocal --unlink
Unlinked 1 dependencies
Unlinked node_modules/apple
> ls -l node_modules
>
If your local dependencies might have local dependencies, you can use
linklocal -r to recursively link all local dependencies:
banana depends on apple
apple does not get linked
# from test/bowl
> linklocal
Linked 3 dependencies
Linked node_modules/@nuts/almond
Linked node_modules/banana
Linked node_modules/apple
apple gets linked
# from test/bowl
> linklocal -r
Linked 4 dependencies
Linked node_modules/@nuts/almond
Linked node_modules/apple
Linked node_modules/banana
Linked node_modules/banana/node_modules/apple
npm 2.0.0 supports specifying local dependencies in your package.json:
> npm install --save ../apple
> cat package.json
{
"name": "bowl",
"version": "1.0.0",
"dependencies": {
"apple": "file:../apple"
}
}
npm install will copy (and npm install) the package into the target's node_module's hierarchy.
This is not an ideal workflow during development as any time you modify your local dependency, you must reinstall it in every location that depends on it. If you do not update all copies, you will have different versions of the same code, probably under the same version number.
Global npm link dependencies are also not ideal as packages clobber each other across projects.
By symlinking local dependencies while in development, changes can be instantly consumed by dependees, effects are limited to the current package and you can be more certain local dependees are using the latest changes.
Note that linklocal does not run npm install for you.
MIT
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent