updates/README.md

51 lines
1.2 KiB
Markdown
Raw Normal View History

2017-12-03 11:15:02 +00:00
# updates
[![](https://img.shields.io/npm/v/updates.svg?style=flat)](https://www.npmjs.org/package/updates) [![](https://img.shields.io/npm/dm/updates.svg)](https://www.npmjs.org/package/updates) [![](https://api.travis-ci.org/silverwind/updates.svg?style=flat)](https://travis-ci.org/silverwind/updates)
2017-12-03 11:36:27 +00:00
> Fast npm dependency updating tool
2017-12-03 11:15:02 +00:00
2017-12-03 13:27:35 +00:00
<p align="center">
2017-12-03 13:33:46 +00:00
<img src="https://i.imgur.com/jBjNoKO.png"/>
2017-12-03 13:27:35 +00:00
</p>
2017-12-03 13:14:30 +00:00
2017-12-03 16:15:47 +00:00
`updates` checks for npm dependency updates and optionally updates `package.json`. It is typically able to complete in under a second. It can also output JSON.
2017-12-03 11:15:02 +00:00
2017-12-03 11:38:46 +00:00
## Install
2017-12-03 11:30:39 +00:00
2017-12-03 12:18:53 +00:00
```console
2017-12-03 11:30:39 +00:00
$ npm install -g updates
```
2017-12-03 14:16:59 +00:00
## Examples
2017-12-03 16:08:01 +00:00
### Check for updates
2017-12-03 12:18:53 +00:00
```console
2017-12-03 11:15:56 +00:00
$ updates
2017-12-03 16:08:01 +00:00
PACKAGE OLD NEW
got ^7.1.0 ^8.0.1
p-timeout ^1.2.0 ^2.0.1
2017-12-03 14:16:59 +00:00
```
2017-12-03 16:08:01 +00:00
### Update package.json
2017-12-03 14:16:59 +00:00
```console
2017-12-03 11:15:56 +00:00
$ updates -u
2017-12-03 16:08:01 +00:00
PACKAGE OLD NEW
got ^7.1.0 ^8.0.1
p-timeout ^1.2.0 ^2.0.1
2017-12-03 11:15:56 +00:00
package.json updated!
2017-12-03 14:16:59 +00:00
```
2017-12-03 16:08:01 +00:00
### JSON Output
2017-12-03 16:05:35 +00:00
```console
$ updates -j
[
{
"package": "got",
"old": "^7.1.0",
"new": "^8.0.1"
2017-12-03 16:05:35 +00:00
},
{
"package": "p-timeout",
"old": "^1.2.0",
"new": "^2.0.1"
2017-12-03 16:05:35 +00:00
}
]
```
2017-12-03 11:15:02 +00:00
© [silverwind](https://github.com/silverwind), distributed under BSD licence