https://github.com/modernpoacher/deps
Update your package dependencies to their latest version
https://github.com/modernpoacher/deps
dependencies devdependencies peerdependencies
Last synced: 5 months ago
JSON representation
Update your package dependencies to their latest version
- Host: GitHub
- URL: https://github.com/modernpoacher/deps
- Owner: modernpoacher
- Created: 2019-09-11T22:35:02.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-06T04:11:08.000Z (6 months ago)
- Last Synced: 2024-12-06T19:46:35.140Z (6 months ago)
- Topics: dependencies, devdependencies, peerdependencies
- Language: JavaScript
- Homepage:
- Size: 3.24 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @modernpoacher/deps
*Deps* updates your `package.json` dependencies to their latest version.
*Deps* updates both `dependencies` and `devDependencies` by default. You can [choose to update only _production_ or _development_ dependencies](#using-deps).
Where a dependency has an _exact_ version, *Deps* does not update that dependency by default. *Deps* can be configured to [update to an _exact_ version or to `latest` as an _exact_ version](#using-depsrc).
## Installing Deps
Globally:
```bash
npm i -g @modernpoacher/deps
```
To your project:
```bash
npm i -D @modernpoacher/deps
```
## Using Deps
When installed globally, change into the root directory of the package you want to update and execute the command:
```bash
deps
```
When installed locally, or not installed, use `npx`:
```bash
npx @modernpoacher/deps
```
Alternatively, use `npm` with a script target in your project's `package.json`:
```json
{
"scripts": {
"deps": "deps"
}
}
```
Then:
```bash
npm run deps
```
### Updating only production dependencies
To update only _production_ dependencies (on the `dependencies` field):
```bash
deps --save-prod # or -P
```
Or:
```bash
npx @modernpoacher/deps --save-prod # or -P
```
Or:
```bash
npm run deps -- --save-prod # or -P
```
### Updating only development dependencies
To update only _development_ dependencies (dependencies on the `devDependencies` field):
```bash
deps --save-dev # or -D
```
Or:
```bash
npx @modernpoacher/deps --save-dev # or -D
```
Or:
```bash
npm run deps -- --save-dev # or -D
```
## Using `.depsrc`
To configure *Deps* create a file named `.depsrc` in the root directory of the package you want to update.
It should contain *JSON* and be structured as `package.json`:
```json
{
"dependencies": {
"express": "5.0.0-alpha.8"
},
"devDependencies": {
"gulp": "latest"
}
}
```
### Author
Add an `author` field to `.depsrc`:
```json
{
"author": "Jonathan Perry "
}
```
### Ignore
Instruct *Deps* not to update your package with an `ignore` field in `.depsrc`:
```json
{
"ignore": true
}
```
Without a `.depsrc` configuration file, whenever *Deps* encounters an _exact_ version, it will assume that _an exact version should not be updated_.
The `.depsrc` configuration file enables this behaviour to be changed.
In the example above, the `dependencies` field defines `express` with an _exact_ version while `devDependencies` defines `gulp` with `latest`.
### Configuration with an _exact_ version number
With the `.depsrc` configuration file as the example above:
- If `package.json` defines `express` at version `5.0.0-alpha.7` then *Deps* will upgrade to `5.0.0-alpha.8`
- If `package.json` defines `5.0.0-alpha.8` then *Deps* will not update the version at all (in which case, the entry in `.depsrc` is meaningless and can be deleted)
- If `package.json` defines `5.0.0-alpha.9` then *Deps* will downgrade to `5.0.0-alpha.8`. (If the entry in `.depsrc` is out of date, change the entry, or delete it)
*Deps* only refers to the `.depsrc` configuration file when it encounters an _exact_ version in `package.json`. If there is no entry for that dependency in the `.depsrc` configuration file then *Deps* will not upgrade, downgrade or otherwise modify it.
You need not duplicate an _exact_ version in `.depsrc`. (Let `package.json` be the source of truth.)
Typically, an entry in the `.depsrc` configuration file will contain `latest`.
### Configuration with `latest`
Again, with the `.depsrc` configuration file as the example above:
- If `package.json` defines `gulp` at version `4.0.2` then *Deps* will update to the latest version
## *Deps* with the shell
```bash
deps \
--save-prod \ # Boolean
--save-dev \ # Boolean
--save-optional \ # Boolean
--save-bundle \ # Boolean
--registry '' \
--force # Boolean
deps-execute \
--path '' \
--from '' \
--only '' \
--registry '' \
--force \ # Boolean
--message '' \
--author ''
deps-install \
--prod \ # Boolean
--dev \ # Boolean
--optional \ # Boolean
--bundle \ # Boolean
--peer \ # Boolean
--save \ # Boolean
--registry '' \
--force # Boolean
deps-deps \
--path . \
--from . \
--only .
deps-wipe --path .
deps-push --path .
deps-head --path .
```
## *Deps* with its own script targets
```bash
npm run deps -- \
--save-prod \ # Boolean
--save-dev \ # Boolean
--save-optional \ # Boolean
--save-bundle \ # Boolean
--registry '' \
--force # Boolean
npm run deps-execute -- \
--path '' \
--from '' \
--only '' \
--registry '' \
--force \ # Boolean
--message '' \
--author ''
npm run deps-install -- \
--prod \ # Boolean
--dev \ # Boolean
--optional \ # Boolean
--bundle \ # Boolean
--peer \ # Boolean
--save \ # Boolean
--registry '' \
--force # Boolean
npm run deps-deps -- \
--path . \
--from . \
--only .
npm run deps-wipe -- --path .
npm run deps-push -- --path .
npm run deps-head -- --path .
```