https://github.com/orlin/npm-interlink
because `npm ...` can be tedious
https://github.com/orlin/npm-interlink
Last synced: 2 months ago
JSON representation
because `npm ...` can be tedious
- Host: GitHub
- URL: https://github.com/orlin/npm-interlink
- Owner: orlin
- License: mit
- Created: 2015-10-20T09:26:10.000Z (over 9 years ago)
- Default Branch: active
- Last Pushed: 2015-11-06T15:20:23.000Z (over 9 years ago)
- Last Synced: 2025-03-21T07:33:47.776Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 184 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# npm-interlink
[](https://www.npmjs.com/package/npm-interlink)
[](https://david-dm.org/orlin/npm-interlink)
[](http://standardjs.com)
Sets up several node projects for local development using `npm link`.
Especially useful in the context of `nvm` and / or having many projects that depend on each other.
## Why
1. quickly setup a bunch of modules for local development or experimentation (install or link)
2. link a bunch of modules among themselves, without having to remember the interdependencies
3. relink the same modules in another context, e.g. because `nvm` links modules per node version
4. easily link the modules incrementally, just rerun it and new modules get linked / interlinked
## How
All it needs are project paths, or it tries the immediate subdirectories of the current dir.
Any dir with `package.json` will be `npm link`ed - making its module global.
Any dir with `package.json` dependencies referencing a linked module will get them linked to its `node_modules`.
Already linked modules that are not explicitly part of an *interlink* set will not be linked to.
## Use
[](https://www.npmjs.org/package/npm-interlink)
Clone some node.js projects and run `npm-interlink` in their parent directory.
Clone is really a metaphor here, as `npm-interlink` is agnostic to version control.
$ `npm-interlink -?`
### Options
Because `npm-interlink` makes it easy to setup many node projects, potentially saving a lot of time that would be otherwise spent waiting to oversee command results, I added some options that can ask it to do something other than its default behavior.
* `-i` or `--install` will install the `node_modules` for each package and skip linking altogether - keep in mind that `npm link` and thus `npm-interlink` without options will also install, so this is for install only
* `-o` or `--only` will only interlink modules that are already linked, this is perhaps because one wants partially interlinked modules, also `npm link module` is a very fast command compared to `npm install` or `npm link` (self), thus linking incrementally is a good pattern, perhaps this should be the default...
### Configure
Create a `.npm-interlink` file containing the list of dirs / modules to interlink.
Use relative or absolute paths - one per line.
For example, here is how I interlink the [gulpsome beverage](https://github.com/gulpsome) modules, plus a couple of other projects of mine that they depend on:
```text
be-goods
beverage
beverage-cli
../childish-process
gulp-cause
gulp-harp
gulp-npm-run
gulp-npm-test
hal-rc
../sourcegate
../es2015-mod # is babel-preset-es2015-mod renamed
```
How you setup the directory structure is entirely up to you, though this obviously works well for organizations (collections of repos). One can start with a subset and add more projects as the need to work on them arises.
## Develop [](https://david-dm.org/orlin/npm-interlink#info=devDependencies)
[](https://github.com/feross/standard)
## License
[MIT](http://orlin.mit-license.org)