npm-update-package 1.3.3 → 1.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -24
- package/dist/package.json +9 -9
- package/dist/src/options/createOptions.js +0 -1
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -1,6 +1,4 @@
|
|
|
1
1
|
[](https://badge.fury.io/js/npm-update-package)
|
|
2
|
-
[](https://github.com/npm-update-package/npm-update-package/actions/workflows/eslint.yml)
|
|
3
|
-
[](https://github.com/npm-update-package/npm-update-package/actions/workflows/test.yml)
|
|
4
2
|
|
|
5
3
|
# npm-update-package
|
|
6
4
|
|
|
@@ -34,11 +32,11 @@ CLI tool for creating pull requests to update npm packages
|
|
|
34
32
|
- [`--reviewers`](#--reviewers)
|
|
35
33
|
- [`--reviewers-sample-size`](#--reviewers-sample-size)
|
|
36
34
|
- [GitHub token](#github-token)
|
|
37
|
-
- [
|
|
35
|
+
- [How to run on GitHub Actions](#how-to-run-on-github-actions)
|
|
38
36
|
- [Use token of GitHub Actions](#use-token-of-github-actions)
|
|
39
37
|
- [Use token of GitHub App](#use-token-of-github-app)
|
|
40
38
|
- [Use Personal access token](#use-personal-access-token)
|
|
41
|
-
- [
|
|
39
|
+
- [Architecture](#architecture)
|
|
42
40
|
- [FAQ](#faq)
|
|
43
41
|
- [What is the purpose of npm-update-package?](#what-is-the-purpose-of-npm-update-package)
|
|
44
42
|
- [What should I do if conflicts occurred in the pull request?](#what-should-i-do-if-conflicts-occurred-in-the-pull-request)
|
|
@@ -60,7 +58,7 @@ CLI tool for creating pull requests to update npm packages
|
|
|
60
58
|
## Usage
|
|
61
59
|
|
|
62
60
|
```sh
|
|
63
|
-
npx npm-update-package --github-token
|
|
61
|
+
npx npm-update-package --github-token <github-token>
|
|
64
62
|
```
|
|
65
63
|
|
|
66
64
|
## Options
|
|
@@ -81,7 +79,7 @@ Example:
|
|
|
81
79
|
|
|
82
80
|
```sh
|
|
83
81
|
npx npm-update-package \
|
|
84
|
-
--github-token
|
|
82
|
+
--github-token <github-token> \
|
|
85
83
|
--assignees alice bob
|
|
86
84
|
```
|
|
87
85
|
|
|
@@ -98,7 +96,7 @@ Example:
|
|
|
98
96
|
|
|
99
97
|
```sh
|
|
100
98
|
npx npm-update-package \
|
|
101
|
-
--github-token
|
|
99
|
+
--github-token <github-token> \
|
|
102
100
|
--assignees alice bob \
|
|
103
101
|
--assignees-sample-size 1
|
|
104
102
|
```
|
|
@@ -127,7 +125,7 @@ Example:
|
|
|
127
125
|
|
|
128
126
|
```sh
|
|
129
127
|
npx npm-update-package \
|
|
130
|
-
--github-token
|
|
128
|
+
--github-token <github-token> \
|
|
131
129
|
--commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
|
|
132
130
|
```
|
|
133
131
|
|
|
@@ -156,7 +154,7 @@ Example:
|
|
|
156
154
|
|
|
157
155
|
```sh
|
|
158
156
|
npx npm-update-package \
|
|
159
|
-
--github-token
|
|
157
|
+
--github-token <github-token> \
|
|
160
158
|
--dependency-types dependencies devDependencies
|
|
161
159
|
```
|
|
162
160
|
|
|
@@ -174,7 +172,7 @@ Example:
|
|
|
174
172
|
|
|
175
173
|
```sh
|
|
176
174
|
npx npm-update-package \
|
|
177
|
-
--github-token
|
|
175
|
+
--github-token <github-token> \
|
|
178
176
|
--fetch-release-notes false
|
|
179
177
|
```
|
|
180
178
|
|
|
@@ -192,7 +190,7 @@ Example:
|
|
|
192
190
|
|
|
193
191
|
```sh
|
|
194
192
|
npx npm-update-package \
|
|
195
|
-
--github-token
|
|
193
|
+
--github-token <github-token> \
|
|
196
194
|
--fetch-sleep-time 2000
|
|
197
195
|
```
|
|
198
196
|
|
|
@@ -209,7 +207,7 @@ Example:
|
|
|
209
207
|
|
|
210
208
|
```sh
|
|
211
209
|
npx npm-update-package \
|
|
212
|
-
--github-token
|
|
210
|
+
--github-token <github-token> \
|
|
213
211
|
--git-user-email alice@example.com
|
|
214
212
|
```
|
|
215
213
|
|
|
@@ -226,7 +224,7 @@ Example:
|
|
|
226
224
|
|
|
227
225
|
```sh
|
|
228
226
|
npx npm-update-package \
|
|
229
|
-
--github-token
|
|
227
|
+
--github-token <github-token> \
|
|
230
228
|
--git-user-name alice
|
|
231
229
|
```
|
|
232
230
|
|
|
@@ -252,7 +250,7 @@ Example:
|
|
|
252
250
|
|
|
253
251
|
```sh
|
|
254
252
|
npx npm-update-package \
|
|
255
|
-
--github-token
|
|
253
|
+
--github-token <github-token> \
|
|
256
254
|
--ignore-packages @types/jest jest
|
|
257
255
|
```
|
|
258
256
|
|
|
@@ -282,7 +280,7 @@ Example:
|
|
|
282
280
|
|
|
283
281
|
```sh
|
|
284
282
|
npx npm-update-package \
|
|
285
|
-
--github-token
|
|
283
|
+
--github-token <github-token> \
|
|
286
284
|
--log-level debug
|
|
287
285
|
```
|
|
288
286
|
|
|
@@ -308,7 +306,7 @@ Example:
|
|
|
308
306
|
|
|
309
307
|
```sh
|
|
310
308
|
npx npm-update-package \
|
|
311
|
-
--github-token
|
|
309
|
+
--github-token <github-token> \
|
|
312
310
|
--outdated-pr-strategy create
|
|
313
311
|
```
|
|
314
312
|
|
|
@@ -333,7 +331,7 @@ Example:
|
|
|
333
331
|
|
|
334
332
|
```sh
|
|
335
333
|
npx npm-update-package \
|
|
336
|
-
--github-token
|
|
334
|
+
--github-token <github-token> \
|
|
337
335
|
--package-manager yarn
|
|
338
336
|
```
|
|
339
337
|
|
|
@@ -351,7 +349,7 @@ Example:
|
|
|
351
349
|
|
|
352
350
|
```sh
|
|
353
351
|
npx npm-update-package \
|
|
354
|
-
--github-token
|
|
352
|
+
--github-token <github-token> \
|
|
355
353
|
--pr-body-github-host "github.example"
|
|
356
354
|
```
|
|
357
355
|
|
|
@@ -368,7 +366,7 @@ Example:
|
|
|
368
366
|
|
|
369
367
|
```sh
|
|
370
368
|
npx npm-update-package \
|
|
371
|
-
--github-token
|
|
369
|
+
--github-token <github-token> \
|
|
372
370
|
--pr-body-notes "**:warning: Please see diff and release notes before merging.**"
|
|
373
371
|
```
|
|
374
372
|
|
|
@@ -396,7 +394,7 @@ Example:
|
|
|
396
394
|
|
|
397
395
|
```sh
|
|
398
396
|
npx npm-update-package \
|
|
399
|
-
--github-token
|
|
397
|
+
--github-token <github-token> \
|
|
400
398
|
--pr-title "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
|
|
401
399
|
```
|
|
402
400
|
|
|
@@ -413,7 +411,7 @@ Example:
|
|
|
413
411
|
|
|
414
412
|
```sh
|
|
415
413
|
npx npm-update-package \
|
|
416
|
-
--github-token
|
|
414
|
+
--github-token <github-token> \
|
|
417
415
|
--reviewers alice bob
|
|
418
416
|
```
|
|
419
417
|
|
|
@@ -430,7 +428,7 @@ Example:
|
|
|
430
428
|
|
|
431
429
|
```sh
|
|
432
430
|
npx npm-update-package \
|
|
433
|
-
--github-token
|
|
431
|
+
--github-token <github-token> \
|
|
434
432
|
--reviewers alice bob \
|
|
435
433
|
--reviewers-sample-size 1
|
|
436
434
|
```
|
|
@@ -464,7 +462,7 @@ We recommend using GitHub App for the following reasons.
|
|
|
464
462
|
|
|
465
463
|
Creating a GitHub App may be tedious, but you only have to do it once the first time.
|
|
466
464
|
|
|
467
|
-
##
|
|
465
|
+
## How to run on GitHub Actions
|
|
468
466
|
|
|
469
467
|
### Use token of GitHub Actions
|
|
470
468
|
|
|
@@ -554,7 +552,7 @@ jobs:
|
|
|
554
552
|
|
|
555
553
|
See working example on [example-pat](https://github.com/npm-update-package/example-pat).
|
|
556
554
|
|
|
557
|
-
##
|
|
555
|
+
## Architecture
|
|
558
556
|
|
|
559
557
|
The following shows the process flow of npm-update-package.
|
|
560
558
|
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-update-package",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.6",
|
|
4
4
|
"description": "CLI tool for creating pull requests to update npm packages",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "tsc --project tsconfig.build.json",
|
|
@@ -18,14 +18,14 @@
|
|
|
18
18
|
"@octokit/rest": "19.0.3",
|
|
19
19
|
"commander": "9.4.0",
|
|
20
20
|
"execa": "5.1.1",
|
|
21
|
-
"fp-ts": "2.12.
|
|
21
|
+
"fp-ts": "2.12.2",
|
|
22
22
|
"http-status-codes": "2.2.0",
|
|
23
|
-
"io-ts": "2.2.
|
|
23
|
+
"io-ts": "2.2.17",
|
|
24
24
|
"lodash": "4.14.2",
|
|
25
|
-
"log4js": "6.6.
|
|
25
|
+
"log4js": "6.6.1",
|
|
26
26
|
"mustache": "4.2.0",
|
|
27
27
|
"node-fetch": "2.6.7",
|
|
28
|
-
"npm-check-updates": "16.0.
|
|
28
|
+
"npm-check-updates": "16.0.5",
|
|
29
29
|
"parse-github-url": "1.0.2",
|
|
30
30
|
"semver": "7.3.7",
|
|
31
31
|
"sleep-promise": "9.1.0",
|
|
@@ -37,17 +37,17 @@
|
|
|
37
37
|
"@types/jest": "28.1.6",
|
|
38
38
|
"@types/lodash": "4.14.182",
|
|
39
39
|
"@types/mustache": "4.2.1",
|
|
40
|
-
"@types/node": "14.18.
|
|
40
|
+
"@types/node": "14.18.23",
|
|
41
41
|
"@types/node-fetch": "2.6.2",
|
|
42
42
|
"@types/parse-github-url": "1.0.0",
|
|
43
43
|
"@types/semver": "7.3.10",
|
|
44
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
45
|
-
"eslint": "8.
|
|
44
|
+
"@typescript-eslint/eslint-plugin": "5.32.0",
|
|
45
|
+
"eslint": "8.21.0",
|
|
46
46
|
"eslint-config-lodash": "1.1.0",
|
|
47
47
|
"eslint-config-standard-with-typescript": "22.0.0",
|
|
48
48
|
"eslint-plugin-eslint-comments": "3.2.0",
|
|
49
49
|
"eslint-plugin-import": "2.26.0",
|
|
50
|
-
"eslint-plugin-jest": "26.
|
|
50
|
+
"eslint-plugin-jest": "26.7.0",
|
|
51
51
|
"eslint-plugin-lodash": "7.4.0",
|
|
52
52
|
"eslint-plugin-n": "15.2.4",
|
|
53
53
|
"eslint-plugin-promise": "6.0.0",
|
|
@@ -8,7 +8,6 @@ const commander_1 = require("commander");
|
|
|
8
8
|
const package_json_1 = __importDefault(require("../../package.json"));
|
|
9
9
|
const Options_1 = require("./Options");
|
|
10
10
|
const toCommanderOption_1 = require("./toCommanderOption");
|
|
11
|
-
// TODO: Add test
|
|
12
11
|
const createOptions = (cliOptions) => {
|
|
13
12
|
commander_1.program.version(package_json_1.default.version);
|
|
14
13
|
cliOptions
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-update-package",
|
|
3
|
-
"version": "1.3.
|
|
3
|
+
"version": "1.3.6",
|
|
4
4
|
"description": "CLI tool for creating pull requests to update npm packages",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "tsc --project tsconfig.build.json",
|
|
@@ -18,14 +18,14 @@
|
|
|
18
18
|
"@octokit/rest": "19.0.3",
|
|
19
19
|
"commander": "9.4.0",
|
|
20
20
|
"execa": "5.1.1",
|
|
21
|
-
"fp-ts": "2.12.
|
|
21
|
+
"fp-ts": "2.12.2",
|
|
22
22
|
"http-status-codes": "2.2.0",
|
|
23
|
-
"io-ts": "2.2.
|
|
23
|
+
"io-ts": "2.2.17",
|
|
24
24
|
"lodash": "4.14.2",
|
|
25
|
-
"log4js": "6.6.
|
|
25
|
+
"log4js": "6.6.1",
|
|
26
26
|
"mustache": "4.2.0",
|
|
27
27
|
"node-fetch": "2.6.7",
|
|
28
|
-
"npm-check-updates": "16.0.
|
|
28
|
+
"npm-check-updates": "16.0.5",
|
|
29
29
|
"parse-github-url": "1.0.2",
|
|
30
30
|
"semver": "7.3.7",
|
|
31
31
|
"sleep-promise": "9.1.0",
|
|
@@ -37,17 +37,17 @@
|
|
|
37
37
|
"@types/jest": "28.1.6",
|
|
38
38
|
"@types/lodash": "4.14.182",
|
|
39
39
|
"@types/mustache": "4.2.1",
|
|
40
|
-
"@types/node": "14.18.
|
|
40
|
+
"@types/node": "14.18.23",
|
|
41
41
|
"@types/node-fetch": "2.6.2",
|
|
42
42
|
"@types/parse-github-url": "1.0.0",
|
|
43
43
|
"@types/semver": "7.3.10",
|
|
44
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
45
|
-
"eslint": "8.
|
|
44
|
+
"@typescript-eslint/eslint-plugin": "5.32.0",
|
|
45
|
+
"eslint": "8.21.0",
|
|
46
46
|
"eslint-config-lodash": "1.1.0",
|
|
47
47
|
"eslint-config-standard-with-typescript": "22.0.0",
|
|
48
48
|
"eslint-plugin-eslint-comments": "3.2.0",
|
|
49
49
|
"eslint-plugin-import": "2.26.0",
|
|
50
|
-
"eslint-plugin-jest": "26.
|
|
50
|
+
"eslint-plugin-jest": "26.7.0",
|
|
51
51
|
"eslint-plugin-lodash": "7.4.0",
|
|
52
52
|
"eslint-plugin-n": "15.2.4",
|
|
53
53
|
"eslint-plugin-promise": "6.0.0",
|