8000 fix(docs): Document default `--keep true` (#110) · bahmutov/next-update@6182d56 · GitHub
[go: up one dir, main page]

Skip to content

Commit 6182d56

Browse files
karlhorkybahmutov
authored andcommitted
fix(docs): Document default --keep true (#110)
As of cc3038a the default behavior of `next-update` is to keep the upgraded versions.
1 parent ce2d442 commit 6182d56

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ in the folder with module *foo*. Here is the example output:
5656
0.2.6 PASS
5757
0.2.7 PASS
5858
0.2.8 PASS
59+
60+
> next updates:
61+
express 3.21.2 -> 4.15.3
62+
async 3.21.2 -> 0.2.8
63+
64+
> kept working updates
5965

60-
61-
Both *package.json* file and *node_modules* folder are left unchanged,
62-
and now you know that you can safely upgrade both libraries to later versions.
63-
64-
#### It even tells you the install command ;)
65-
66-
Use the following command to install working versions
67-
npm install --save lodash@2.1.0
66+
If your tests pass, the dependencies will be upgraded to the new working versions in
67+
*package.json* and the *node_modules* folder.
6868

6969
This might not appear like a big deal for a single module that is using
7070
popular 3rd party libraries with stable apis only. *next-update* is most useful
@@ -89,30 +89,29 @@ grunt-bump 0.0.13 0.0.12 100% 4
8989

9090
### Install
9191

92-
You can install this tool globally
92+
You can install this tool globally:
9393

94-
npm install -g next-update // installs module globally
95-
next-update --help // shows command line options
94+
npm install -g next-update // install module globally
95+
next-update --help // show command line options
9696

97-
Then run inside any package folder
97+
Then run inside any package folder:
9898

9999
/git/my-awesome-module
100100
$ next-update
101101

102-
Or you can use this module as a devDependency and a script command
102+
Or you can use this module as a devDependency and a script command:
103103

104104
npm install --save-dev next-update
105105

106106
```json
107107
{
108108
"scripts": {
109-
"next-update": "next-update -k true --tldr"
109+
"next-update": "next-update --tldr"
110110
}
111111
}
112112
```
113113

114-
This command will keep the successfuly version upgrades in the package.json file,
115-
but will not be very verbose when run.
114+
This command will use the `--tldr` flag, which causes it to be less verbose when run.
116115

117116
### Anonymous usage collection
118117

@@ -231,7 +230,8 @@ like this `changed foo` (*foo* is package name)
231230
* install new versions of the desired modules using standard `npm i dependency@version --save`
232231
* You can use custom test command, for example `next-update -t "grunt test"`
233232
* `npm test` is used by default.
234-
* You can keep each working version in package.json by using `--keep` flag.
233+
* You can disable the behavior to automatically upgrade to new working versions by passing
234+
the `--keep false` option.
235235

236236

237237

0 commit comments

Comments
 (0)
0