Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mweststrate/relative-deps
Installs local dependencies for optimal developer experience
https://github.com/mweststrate/relative-deps
Last synced: 23 days ago
JSON representation
Installs local dependencies for optimal developer experience
- Host: GitHub
- URL: https://github.com/mweststrate/relative-deps
- Owner: mweststrate
- License: mit
- Created: 2019-06-21T13:50:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T11:47:49.000Z (over 1 year ago)
- Last Synced: 2024-05-16T14:21:41.715Z (6 months ago)
- Language: JavaScript
- Size: 235 KB
- Stars: 426
- Watchers: 7
- Forks: 32
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# relative-deps
[](https://www.paypal.me/michelweststrate)
_Installs dependencies from a local checkout, and keeps them in sync, without the limitations of `link`_
---
# Summary
Relative deps introduces an additional dependency section in `package.json`, called `relativeDependencies`.
This section contains paths to the local sources of any dependency, that will be built and installed over the publicly available versions, when needed.
Example `package.json`:
```json
{
"name": "my-project",
"dependencies": {
"my-cool-library": "0.1.0"
},
"relativeDependencies": {
"my-cool-library": "../../packages/my-cool-library"
},
"scripts": {
"prepare": "relative-deps"
},
"devDependencies": {
"relative-deps": "^1.0.0"
}
}
```
When the relative path can be found, the library at this path will be re-built and re-installed into this project, if the source files have been changed during `prepare`.
The normal `my-cool-library` dependency will be defaulted to, for those that don't have a local checkout of `my-cool-library`, and to resolve transitive dependencies.
An example setup, where examples project are linked to their hosting library, can be found [here](https://github.com/mobxjs/mst-gql/pull/40/commits/4d2c0858f8c44a562c0244466b56f79b0ed7591b).
# Why
### The problem
Working on libraries that have examples embedded in the same git repository is usually tricky, as the examples are usually built against the public, published version of the library; the version that is mentioned in their `package.json`.
When working maintaining a project though, it is much more useful to work against the locally checked out version of the library. Published or not.
### The problems with existing solutions
There are a few existing solutions, but they have their own limitations:
- `yarn link` / `npm link`. These work only if there are no peer / shared dependencies involved. If there are shared dependencies, the linked library will resolve those in their _own_ `node_modules`, instead of the `node_modules` of the hosting project, where it would normally be looked up. This results in peer dependencies ending up "twice" in the dependency tree, which often causes confusing behavior.
- `yarn workspaces`. Those solve the above issue by putting all dependencies in one large root level `node_modules`. However, this setup is in practice quite obtrusive to the whole development setup.
### How is relative deps different?
Relative deps doesn't fight the problem but tries to emulate a "normal" install. It builds the "linked" library on `prepare` (that is, after installing all deps), packs it, and unpacks it in the `node_modules` of the hosting project. Since there is no linking, or shared `node_modules` involved, the folder structure ends up to be exactly the same as if the thing was installed directly from `yarn` / `npm`. Which avoids a plethora of problems.
Since building a linked package every time `yarn install` is run is expensive, this tool will take a hash of the directory contents of the library first, and only build and install if something changed.
# Usage
## Installation
```bash
npx relative-deps init
```
Options:
- `--script`
Alias `-S`. Default: `prepare`. Script name which is using for running `relative-deps`.
Running this script will install `relative-deps`, add script and initialize empty `relativeDependencies` section.
```json
{
"name": "my-project",
"devDependencies": {
"relative-deps": "^1.0.0"
},
"relativeDependencies": {},
"scripts": {
"prepare": "relative-deps"
}
}
```
Optionally, you can add this step also for more scripts, for example before starting or building your project, for example:
```json
{
"name": "my-project",
"scripts": {
"prepare": "relative-deps",
"prestart": "relative-deps",
"prebuild": "relative-deps",
"pretest": "relative-deps"
}
}
```
In general, this doesn't add to much overhead, since usually relative-deps is able to determine rather quickly (~0.5 sec) that there are no changes.
## Adding a relative dependency
Running following script will initialize `relative-deps` if not initialized yet, find the package at the provided path, install it as normal dependency and pack relative-dependency.
```bash
npx relative-deps add ../../packages/my-cool-library
```
Options:
- `--dev`
Alias `-D`. Installs relative dependency in `devDependencies` section.
```json
{
"name": "my-project",
"dependencies": {
"my-cool-library": "0.1.0"
},
"relativeDependencies": {
"my-cool-library": "../../packages/my-cool-library"
},
"scripts": {
"prepare": "relative-deps"
},
"devDependencies": {
"relative-deps": "^1.0.0"
}
}
```
Example of a [repository migration to relative-deps](https://github.com/mobxjs/mst-gql/pull/40/commits/4d2c0858f8c44a562c0244466b56f79b0ed7591b)
## Run `npx relative-deps` when devving!
The relative deps will automatically be checked for changes, based on the hooks you've set up during [installation](#installation).
However, you can always trigger a manual check-and-build-if-needed by running `npx relative-deps` (or just `yarn`). If you are working on a project that supports
hot reloading, this will makes sure the changes in the relative dependency will automatically show up in your project!
## Watch mode
You can run `relative-deps watch` and it'll run `relative-deps` command when one of the relative dependecies changed, debounced with 500ms.
This can go along with config of your project to watch over the relevant packages and it will automate the process completely,
allowing you to change a library code and to enjoy the befefit of hot-reload.
# How
Roughly, it works like this (obviously this can get out of date quickly):
```
- pre: yarn.lock exists or die
- read relativeDeps from nearest package.json
- doesn't exist? warn & exit
- for each relativeDep:
- check if target path exists
- if not, do we have the module from normal install?
- yes: warn
- no: error
- if target path exists, does it have node modules?
- no: run yarn / npm install (guess which one)
- find last modified timestamp of all files in target dir
(excluding node_modules, .git, excluding the directory that contains the calling project if applicable, only use git versioned files)
- take hash and store / compare with stored
- if changed:
- run yarn / npm build
- run pack
- extract package (mind scoped package names!)
- run yarn install --no-dev-deps in target dir
- done
```
# Tips
Tip: use the `postinstall` hook wherever applicable, if your dependency manager does not support `prepare` hooks yet.