npm-update-package 1.2.23 → 1.2.26

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.
Files changed (3) hide show
  1. package/README.md +51 -68
  2. package/dist/package.json +12 -15
  3. package/package.json +12 -15
package/README.md CHANGED
@@ -16,23 +16,23 @@ CLI tool for creating pull requests to update npm packages
16
16
  - [Supported platforms](#supported-platforms)
17
17
  - [Usage](#usage)
18
18
  - [Options](#options)
19
- - [assignees](#assignees)
20
- - [assigneesSampleSize](#assigneessamplesize)
21
- - [commitMessage](#commitmessage)
22
- - [fetchReleaseNotes](#fetchreleasenotes)
23
- - [fetchSleepTime](#fetchsleeptime)
24
- - [gitUserEmail](#gituseremail)
25
- - [gitUserName](#gitusername)
26
- - [githubToken](#githubtoken)
27
- - [ignorePackages](#ignorepackages)
28
- - [logLevel](#loglevel)
29
- - [outdatedPrStrategy](#outdatedprstrategy)
30
- - [packageManager](#packagemanager)
31
- - [prBodyGithubHost](#prbodygithubhost)
32
- - [prBodyNotes](#prbodynotes)
33
- - [prTitle](#prtitle)
34
- - [reviewers](#reviewers)
35
- - [reviewersSampleSize](#reviewerssamplesize)
19
+ - [`--assignees`](#--assignees)
20
+ - [`--assignees-sample-size`](#--assignees-sample-size)
21
+ - [`--commit-message`](#--commit-message)
22
+ - [`--fetch-release-notes`](#--fetch-release-notes)
23
+ - [`--fetch-sleep-time`](#--fetch-sleep-time)
24
+ - [`--git-user-email`](#--git-user-email)
25
+ - [`--git-user-name`](#--git-user-name)
26
+ - [`--github-token`](#--github-token)
27
+ - [`--ignore-packages`](#--ignore-packages)
28
+ - [`--log-level`](#--log-level)
29
+ - [`--outdated-pr-strategy`](#--outdated-pr-strategy)
30
+ - [`--package-manager`](#--package-manager)
31
+ - [`--pr-body-github-host`](#--pr-body-github-host)
32
+ - [`--pr-body-notes`](#--pr-body-notes)
33
+ - [`--pr-title`](#--pr-title)
34
+ - [`--reviewers`](#--reviewers)
35
+ - [`--reviewers-sample-size`](#--reviewers-sample-size)
36
36
  - [GitHub token](#github-token)
37
37
  - [Examples](#examples)
38
38
  - [Use token of GitHub Actions](#use-token-of-github-actions)
@@ -68,15 +68,14 @@ npx npm-update-package --github-token $GITHUB_TOKEN
68
68
  You can customize behavior via CLI options.
69
69
  Some options can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
70
70
 
71
- ### assignees
71
+ ### `--assignees`
72
72
 
73
73
  User names to assign to pull request.
74
74
 
75
75
  |Name|Value|
76
76
  |---|---|
77
- |cli|`--assignees`|
78
77
  |type|string[]|
79
- |required|false|
78
+ |required|-|
80
79
  |added version|v0.46.0|
81
80
 
82
81
  Example:
@@ -87,15 +86,14 @@ npx npm-update-package \
87
86
  --assignees alice bob
88
87
  ```
89
88
 
90
- ### assigneesSampleSize
89
+ ### `--assignees-sample-size`
91
90
 
92
91
  How many members to be assigned to assignees.
93
92
 
94
93
  |Name|Value|
95
94
  |---|---|
96
- |cli|`--assignees-sample-size`|
97
95
  |type|number|
98
- |required|false|
96
+ |required|-|
99
97
  |added version|v0.56.0|
100
98
 
101
99
  Example:
@@ -107,15 +105,14 @@ npx npm-update-package \
107
105
  --assignees-sample-size 1
108
106
  ```
109
107
 
110
- ### commitMessage
108
+ ### `--commit-message`
111
109
 
112
110
  Commit message template.
113
111
 
114
112
  |Name|Value|
115
113
  |---|---|
116
- |cli|`--commit-message`|
117
114
  |type|string|
118
- |required|false|
115
+ |required|-|
119
116
  |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
120
117
  |added version|v0.5.0|
121
118
 
@@ -137,15 +134,14 @@ npx npm-update-package \
137
134
  --commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
138
135
  ```
139
136
 
140
- ### fetchReleaseNotes
137
+ ### `--fetch-release-notes`
141
138
 
142
139
  Whether to fetch release notes.
143
140
 
144
141
  |Name|Value|
145
142
  |---|---|
146
- |cli|`--fetch-release-notes`|
147
143
  |type|boolean|
148
- |required|false|
144
+ |required|-|
149
145
  |default|`true`|
150
146
  |added version|v0.51.0|
151
147
 
@@ -157,15 +153,14 @@ npx npm-update-package \
157
153
  --fetch-release-notes false
158
154
  ```
159
155
 
160
- ### fetchSleepTime
156
+ ### `--fetch-sleep-time`
161
157
 
162
158
  Sleep time between fetching (ms).
163
159
 
164
160
  |Name|Value|
165
161
  |---|---|
166
- |cli|`--fetch-sleep-time`|
167
162
  |type|number|
168
- |required|false|
163
+ |required|-|
169
164
  |default|`1000`|
170
165
  |added version|v0.50.0|
171
166
 
@@ -177,15 +172,14 @@ npx npm-update-package \
177
172
  --fetch-sleep-time 2000
178
173
  ```
179
174
 
180
- ### gitUserEmail
175
+ ### `--git-user-email`
181
176
 
182
177
  Git user email.
183
178
 
184
179
  |Name|Value|
185
180
  |---|---|
186
- |cli|`--git-user-email`|
187
181
  |type|string|
188
- |required|false|
182
+ |required|-|
189
183
  |added version|v0.53.0|
190
184
 
191
185
  Example:
@@ -196,15 +190,14 @@ npx npm-update-package \
196
190
  --git-user-email alice@example.com
197
191
  ```
198
192
 
199
- ### gitUserName
193
+ ### `--git-user-name`
200
194
 
201
195
  Git user name.
202
196
 
203
197
  |Name|Value|
204
198
  |---|---|
205
- |cli|`--git-user-name`|
206
199
  |type|string|
207
- |required|false|
200
+ |required|-|
208
201
  |added version|v0.53.0|
209
202
 
210
203
  Example:
@@ -215,26 +208,24 @@ npx npm-update-package \
215
208
  --git-user-name alice
216
209
  ```
217
210
 
218
- ### githubToken
211
+ ### `--github-token`
219
212
 
220
213
  [GitHub token](#github-token).
221
214
 
222
215
  |Name|Value|
223
216
  |---|---|
224
- |cli|`--github-token`|
225
217
  |type|string|
226
- |required|true|
218
+ |required|✔️|
227
219
  |added version|v0.1.0|
228
220
 
229
- ### ignorePackages
221
+ ### `--ignore-packages`
230
222
 
231
223
  Package names to ignore.
232
224
 
233
225
  |Name|Value|
234
226
  |---|---|
235
- |cli|`--ignore-packages`|
236
227
  |type|string[]|
237
- |required|false|
228
+ |required|-|
238
229
  |added version|v0.43.0|
239
230
 
240
231
  Example:
@@ -245,15 +236,14 @@ npx npm-update-package \
245
236
  --ignore-packages @types/jest jest
246
237
  ```
247
238
 
248
- ### logLevel
239
+ ### `--log-level`
249
240
 
250
241
  Log level to show.
251
242
 
252
243
  |Name|Value|
253
244
  |---|---|
254
- |cli|`--log-level`|
255
245
  |type|string|
256
- |required|false|
246
+ |required|-|
257
247
  |default|`info`|
258
248
  |added version|v0.1.0|
259
249
 
@@ -277,15 +267,14 @@ npx npm-update-package \
277
267
  --log-level debug
278
268
  ```
279
269
 
280
- ### outdatedPrStrategy
270
+ ### `--outdated-pr-strategy`
281
271
 
282
272
  What to do when outdated pull requests exist.
283
273
 
284
274
  |Name|Value|
285
275
  |---|---|
286
- |cli|`--outdated-pr-strategy`|
287
276
  |type|string|
288
- |required|false|
277
+ |required|-|
289
278
  |default|`recreate`|
290
279
  |added version|v0.58.0|
291
280
 
@@ -305,16 +294,15 @@ npx npm-update-package \
305
294
  --outdated-pr-strategy create
306
295
  ```
307
296
 
308
- ### packageManager
297
+ ### `--package-manager`
309
298
 
310
299
  Package manager of your project.
311
300
  Since npm-update-package automatically determines which package manager to use, it is usually not necessary to specify this option.
312
301
 
313
302
  |Name|Value|
314
303
  |---|---|
315
- |cli|`--package-manager`|
316
304
  |type|string|
317
- |required|false|
305
+ |required|-|
318
306
  |added version|v0.1.0|
319
307
 
320
308
  Allowed values:
@@ -332,15 +320,14 @@ npx npm-update-package \
332
320
  --package-manager yarn
333
321
  ```
334
322
 
335
- ### prBodyGithubHost
323
+ ### `--pr-body-github-host`
336
324
 
337
325
  GitHub host of pull request body.
338
326
 
339
327
  |Name|Value|
340
328
  |---|---|
341
- |cli|`--pr-body-github-host`|
342
329
  |type|string|
343
- |required|false|
330
+ |required|-|
344
331
  |default|`togithub.com`|
345
332
  |added version|v0.55.0|
346
333
 
@@ -352,15 +339,14 @@ npx npm-update-package \
352
339
  --pr-body-github-host "github.example"
353
340
  ```
354
341
 
355
- ### prBodyNotes
342
+ ### `--pr-body-notes`
356
343
 
357
344
  Additional notes for Pull request body.
358
345
 
359
346
  |Name|Value|
360
347
  |---|---|
361
- |cli|`--pr-body-notes`|
362
348
  |type|string|
363
- |required|false|
349
+ |required|-|
364
350
  |added version|v0.45.0|
365
351
 
366
352
  Example:
@@ -371,15 +357,14 @@ npx npm-update-package \
371
357
  --pr-body-notes "**:warning: Please see diff and release notes before merging.**"
372
358
  ```
373
359
 
374
- ### prTitle
360
+ ### `--pr-title`
375
361
 
376
362
  Pull request title template.
377
363
 
378
364
  |Name|Value|
379
365
  |---|---|
380
- |cli|`--pr-title`|
381
366
  |type|string|
382
- |required|false|
367
+ |required|-|
383
368
  |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
384
369
  |added version|v0.44.0|
385
370
 
@@ -401,15 +386,14 @@ npx npm-update-package \
401
386
  --pr-title "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
402
387
  ```
403
388
 
404
- ### reviewers
389
+ ### `--reviewers`
405
390
 
406
391
  User names to request reviews.
407
392
 
408
393
  |Name|Value|
409
394
  |---|---|
410
- |cli|`--reviewers`|
411
395
  |type|string[]|
412
- |required|false|
396
+ |required|-|
413
397
  |added version|v0.26.0|
414
398
 
415
399
  Example:
@@ -420,15 +404,14 @@ npx npm-update-package \
420
404
  --reviewers alice bob
421
405
  ```
422
406
 
423
- ### reviewersSampleSize
407
+ ### `--reviewers-sample-size`
424
408
 
425
409
  How many members to be assigned to reviewers.
426
410
 
427
411
  |Name|Value|
428
412
  |---|---|
429
- |cli|`--reviewers-sample-size`|
430
413
  |type|number|
431
- |required|false|
414
+ |required|-|
432
415
  |added version|v0.57.0|
433
416
 
434
417
  Example:
package/dist/package.json CHANGED
@@ -1,13 +1,12 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "1.2.23",
3
+ "version": "1.2.26",
4
4
  "description": "CLI tool for creating pull requests to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",
7
7
  "clean": "rimraf dist",
8
8
  "lint": "eslint '**/*.{js,ts}'",
9
9
  "prebuild": "npm run clean",
10
- "prepare": "husky install",
11
10
  "prepublishOnly": "npm-run-all lint test build",
12
11
  "test": "jest"
13
12
  },
@@ -16,17 +15,17 @@
16
15
  "node": ">=14"
17
16
  },
18
17
  "dependencies": {
19
- "@octokit/rest": "18.12.0",
18
+ "@octokit/rest": "19.0.3",
20
19
  "commander": "9.3.0",
21
20
  "execa": "5.1.1",
22
21
  "fp-ts": "2.12.1",
23
22
  "http-status-codes": "2.2.0",
24
23
  "io-ts": "2.2.16",
25
24
  "lodash": "4.14.2",
26
- "log4js": "6.5.2",
25
+ "log4js": "6.6.0",
27
26
  "mustache": "4.1.0",
28
27
  "node-fetch": "2.6.7",
29
- "npm-check-updates": "14.0.2",
28
+ "npm-check-updates": "15.2.6",
30
29
  "parse-github-url": "1.0.2",
31
30
  "semver": "7.3.7",
32
31
  "sleep-promise": "9.1.0",
@@ -35,33 +34,31 @@
35
34
  "devDependencies": {
36
35
  "@jest/types": "28.1.1",
37
36
  "@tsconfig/node14": "1.0.3",
38
- "@types/jest": "28.1.3",
37
+ "@types/jest": "28.1.5",
39
38
  "@types/lodash": "4.14.182",
40
39
  "@types/mustache": "4.1.3",
41
40
  "@types/node": "14.18.21",
42
41
  "@types/node-fetch": "2.6.2",
43
42
  "@types/parse-github-url": "1.0.0",
44
43
  "@types/semver": "7.3.10",
45
- "@typescript-eslint/eslint-plugin": "5.29.0",
46
- "eslint": "8.18.0",
44
+ "@typescript-eslint/eslint-plugin": "5.30.6",
45
+ "eslint": "8.19.0",
47
46
  "eslint-config-lodash": "1.1.0",
48
- "eslint-config-standard-with-typescript": "21.0.1",
47
+ "eslint-config-standard-with-typescript": "22.0.0",
49
48
  "eslint-plugin-eslint-comments": "3.2.0",
50
49
  "eslint-plugin-import": "2.26.0",
51
50
  "eslint-plugin-jest": "26.5.3",
52
51
  "eslint-plugin-lodash": "7.4.0",
53
- "eslint-plugin-node": "11.1.0",
52
+ "eslint-plugin-n": "15.2.4",
54
53
  "eslint-plugin-promise": "6.0.0",
55
54
  "eslint-plugin-tsdoc": "0.2.16",
56
- "eslint-plugin-unicorn": "42.0.0",
55
+ "eslint-plugin-unicorn": "43.0.1",
57
56
  "eslint-plugin-you-dont-need-lodash-underscore": "6.12.0",
58
- "husky": "8.0.1",
59
- "jest": "28.1.1",
60
- "lint-staged": "13.0.2",
57
+ "jest": "28.1.2",
61
58
  "npm-run-all": "4.1.5",
62
59
  "rimraf": "3.0.2",
63
60
  "ts-jest": "28.0.5",
64
- "ts-node": "10.8.1",
61
+ "ts-node": "10.8.2",
65
62
  "typescript": "4.7.4",
66
63
  "utility-types": "3.10.0"
67
64
  },
package/package.json CHANGED
@@ -1,13 +1,12 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "1.2.23",
3
+ "version": "1.2.26",
4
4
  "description": "CLI tool for creating pull requests to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",
7
7
  "clean": "rimraf dist",
8
8
  "lint": "eslint '**/*.{js,ts}'",
9
9
  "prebuild": "npm run clean",
10
- "prepare": "husky install",
11
10
  "prepublishOnly": "npm-run-all lint test build",
12
11
  "test": "jest"
13
12
  },
@@ -16,17 +15,17 @@
16
15
  "node": ">=14"
17
16
  },
18
17
  "dependencies": {
19
- "@octokit/rest": "18.12.0",
18
+ "@octokit/rest": "19.0.3",
20
19
  "commander": "9.3.0",
21
20
  "execa": "5.1.1",
22
21
  "fp-ts": "2.12.1",
23
22
  "http-status-codes": "2.2.0",
24
23
  "io-ts": "2.2.16",
25
24
  "lodash": "4.14.2",
26
- "log4js": "6.5.2",
25
+ "log4js": "6.6.0",
27
26
  "mustache": "4.1.0",
28
27
  "node-fetch": "2.6.7",
29
- "npm-check-updates": "14.0.2",
28
+ "npm-check-updates": "15.2.6",
30
29
  "parse-github-url": "1.0.2",
31
30
  "semver": "7.3.7",
32
31
  "sleep-promise": "9.1.0",
@@ -35,33 +34,31 @@
35
34
  "devDependencies": {
36
35
  "@jest/types": "28.1.1",
37
36
  "@tsconfig/node14": "1.0.3",
38
- "@types/jest": "28.1.3",
37
+ "@types/jest": "28.1.5",
39
38
  "@types/lodash": "4.14.182",
40
39
  "@types/mustache": "4.1.3",
41
40
  "@types/node": "14.18.21",
42
41
  "@types/node-fetch": "2.6.2",
43
42
  "@types/parse-github-url": "1.0.0",
44
43
  "@types/semver": "7.3.10",
45
- "@typescript-eslint/eslint-plugin": "5.29.0",
46
- "eslint": "8.18.0",
44
+ "@typescript-eslint/eslint-plugin": "5.30.6",
45
+ "eslint": "8.19.0",
47
46
  "eslint-config-lodash": "1.1.0",
48
- "eslint-config-standard-with-typescript": "21.0.1",
47
+ "eslint-config-standard-with-typescript": "22.0.0",
49
48
  "eslint-plugin-eslint-comments": "3.2.0",
50
49
  "eslint-plugin-import": "2.26.0",
51
50
  "eslint-plugin-jest": "26.5.3",
52
51
  "eslint-plugin-lodash": "7.4.0",
53
- "eslint-plugin-node": "11.1.0",
52
+ "eslint-plugin-n": "15.2.4",
54
53
  "eslint-plugin-promise": "6.0.0",
55
54
  "eslint-plugin-tsdoc": "0.2.16",
56
- "eslint-plugin-unicorn": "42.0.0",
55
+ "eslint-plugin-unicorn": "43.0.1",
57
56
  "eslint-plugin-you-dont-need-lodash-underscore": "6.12.0",
58
- "husky": "8.0.1",
59
- "jest": "28.1.1",
60
- "lint-staged": "13.0.2",
57
+ "jest": "28.1.2",
61
58
  "npm-run-all": "4.1.5",
62
59
  "rimraf": "3.0.2",
63
60
  "ts-jest": "28.0.5",
64
- "ts-node": "10.8.1",
61
+ "ts-node": "10.8.2",
65
62
  "typescript": "4.7.4",
66
63
  "utility-types": "3.10.0"
67
64
  },