npm-update-package 1.2.26 → 1.3.0

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 CHANGED
@@ -19,6 +19,7 @@ CLI tool for creating pull requests to update npm packages
19
19
  - [`--assignees`](#--assignees)
20
20
  - [`--assignees-sample-size`](#--assignees-sample-size)
21
21
  - [`--commit-message`](#--commit-message)
22
+ - [`--dependency-types`](#--dependency-types)
22
23
  - [`--fetch-release-notes`](#--fetch-release-notes)
23
24
  - [`--fetch-sleep-time`](#--fetch-sleep-time)
24
25
  - [`--git-user-email`](#--git-user-email)
@@ -76,7 +77,6 @@ User names to assign to pull request.
76
77
  |---|---|
77
78
  |type|string[]|
78
79
  |required|-|
79
- |added version|v0.46.0|
80
80
 
81
81
  Example:
82
82
 
@@ -94,7 +94,6 @@ How many members to be assigned to assignees.
94
94
  |---|---|
95
95
  |type|number|
96
96
  |required|-|
97
- |added version|v0.56.0|
98
97
 
99
98
  Example:
100
99
 
@@ -114,7 +113,6 @@ Commit message template.
114
113
  |type|string|
115
114
  |required|-|
116
115
  |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
117
- |added version|v0.5.0|
118
116
 
119
117
  Available variables:
120
118
 
@@ -124,7 +122,7 @@ Available variables:
124
122
  |`newVersion`|New package version|
125
123
  |`packageName`|Package name|
126
124
  |`level`|Semver level (`major`/`minor`/`patch`)|
127
- |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
125
+ |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`bundledDependencies`/`optionalDependencies`)|
128
126
 
129
127
  Example:
130
128
 
@@ -134,6 +132,35 @@ npx npm-update-package \
134
132
  --commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
135
133
  ```
136
134
 
135
+ ### `--dependency-types`
136
+
137
+ Dependency types to be updated.
138
+
139
+ |Name|Value|
140
+ |---|---|
141
+ |type|string[]|
142
+ |required|-|
143
+ |default|`dependencies`, `devDependencies`, `peerDependencies`, `bundledDependencies`, `optionalDependencies`|
144
+
145
+ Available variables:
146
+
147
+ |Variable|Description|
148
+ |---|---|
149
+ |`dependencies`|dependencies|
150
+ |`devDependencies`|devDependencies|
151
+ |`peerDependencies`|peerDependencies|
152
+ |`bundledDependencies`|bundledDependencies|
153
+ |`optionalDependencies`|optionalDependencies|
154
+
155
+
156
+ Example:
157
+
158
+ ```sh
159
+ npx npm-update-package \
160
+ --github-token $GITHUB_TOKEN \
161
+ --dependency-types dependencies devDependencies
162
+ ```
163
+
137
164
  ### `--fetch-release-notes`
138
165
 
139
166
  Whether to fetch release notes.
@@ -143,7 +170,6 @@ Whether to fetch release notes.
143
170
  |type|boolean|
144
171
  |required|-|
145
172
  |default|`true`|
146
- |added version|v0.51.0|
147
173
 
148
174
  Example:
149
175
 
@@ -162,7 +188,6 @@ Sleep time between fetching (ms).
162
188
  |type|number|
163
189
  |required|-|
164
190
  |default|`1000`|
165
- |added version|v0.50.0|
166
191
 
167
192
  Example:
168
193
 
@@ -180,7 +205,6 @@ Git user email.
180
205
  |---|---|
181
206
  |type|string|
182
207
  |required|-|
183
- |added version|v0.53.0|
184
208
 
185
209
  Example:
186
210
 
@@ -198,7 +222,6 @@ Git user name.
198
222
  |---|---|
199
223
  |type|string|
200
224
  |required|-|
201
- |added version|v0.53.0|
202
225
 
203
226
  Example:
204
227
 
@@ -216,7 +239,6 @@ npx npm-update-package \
216
239
  |---|---|
217
240
  |type|string|
218
241
  |required|✔️|
219
- |added version|v0.1.0|
220
242
 
221
243
  ### `--ignore-packages`
222
244
 
@@ -226,7 +248,6 @@ Package names to ignore.
226
248
  |---|---|
227
249
  |type|string[]|
228
250
  |required|-|
229
- |added version|v0.43.0|
230
251
 
231
252
  Example:
232
253
 
@@ -245,7 +266,6 @@ Log level to show.
245
266
  |type|string|
246
267
  |required|-|
247
268
  |default|`info`|
248
- |added version|v0.1.0|
249
269
 
250
270
  Allowed values:
251
271
 
@@ -276,7 +296,6 @@ What to do when outdated pull requests exist.
276
296
  |type|string|
277
297
  |required|-|
278
298
  |default|`recreate`|
279
- |added version|v0.58.0|
280
299
 
281
300
  Allowed values:
282
301
 
@@ -303,7 +322,6 @@ Since npm-update-package automatically determines which package manager to use,
303
322
  |---|---|
304
323
  |type|string|
305
324
  |required|-|
306
- |added version|v0.1.0|
307
325
 
308
326
  Allowed values:
309
327
 
@@ -329,7 +347,6 @@ GitHub host of pull request body.
329
347
  |type|string|
330
348
  |required|-|
331
349
  |default|`togithub.com`|
332
- |added version|v0.55.0|
333
350
 
334
351
  Example:
335
352
 
@@ -347,7 +364,6 @@ Additional notes for Pull request body.
347
364
  |---|---|
348
365
  |type|string|
349
366
  |required|-|
350
- |added version|v0.45.0|
351
367
 
352
368
  Example:
353
369
 
@@ -366,7 +382,6 @@ Pull request title template.
366
382
  |type|string|
367
383
  |required|-|
368
384
  |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
369
- |added version|v0.44.0|
370
385
 
371
386
  Available variables:
372
387
 
@@ -376,7 +391,7 @@ Available variables:
376
391
  |`newVersion`|New package version|
377
392
  |`packageName`|Package name|
378
393
  |`level`|Semver level (`major`/`minor`/`patch`)|
379
- |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
394
+ |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`bundledDependencies`/`optionalDependencies`)|
380
395
 
381
396
  Example:
382
397
 
@@ -394,7 +409,6 @@ User names to request reviews.
394
409
  |---|---|
395
410
  |type|string[]|
396
411
  |required|-|
397
- |added version|v0.26.0|
398
412
 
399
413
  Example:
400
414
 
@@ -412,7 +426,6 @@ How many members to be assigned to reviewers.
412
426
  |---|---|
413
427
  |type|number|
414
428
  |required|-|
415
- |added version|v0.57.0|
416
429
 
417
430
  Example:
418
431
 
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "1.2.26",
3
+ "version": "1.3.0",
4
4
  "description": "CLI tool for creating pull requests to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",
@@ -16,7 +16,7 @@
16
16
  },
17
17
  "dependencies": {
18
18
  "@octokit/rest": "19.0.3",
19
- "commander": "9.3.0",
19
+ "commander": "9.4.0",
20
20
  "execa": "5.1.1",
21
21
  "fp-ts": "2.12.1",
22
22
  "http-status-codes": "2.2.0",
@@ -32,33 +32,33 @@
32
32
  "type-guards": "0.15.0"
33
33
  },
34
34
  "devDependencies": {
35
- "@jest/types": "28.1.1",
35
+ "@jest/types": "28.1.3",
36
36
  "@tsconfig/node14": "1.0.3",
37
- "@types/jest": "28.1.5",
37
+ "@types/jest": "28.1.6",
38
38
  "@types/lodash": "4.14.182",
39
39
  "@types/mustache": "4.1.3",
40
- "@types/node": "14.18.21",
40
+ "@types/node": "14.18.22",
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.30.6",
45
- "eslint": "8.19.0",
44
+ "@typescript-eslint/eslint-plugin": "5.30.7",
45
+ "eslint": "8.20.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.5.3",
50
+ "eslint-plugin-jest": "26.6.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",
54
54
  "eslint-plugin-tsdoc": "0.2.16",
55
- "eslint-plugin-unicorn": "43.0.1",
55
+ "eslint-plugin-unicorn": "43.0.2",
56
56
  "eslint-plugin-you-dont-need-lodash-underscore": "6.12.0",
57
- "jest": "28.1.2",
57
+ "jest": "28.1.3",
58
58
  "npm-run-all": "4.1.5",
59
59
  "rimraf": "3.0.2",
60
- "ts-jest": "28.0.5",
61
- "ts-node": "10.8.2",
60
+ "ts-jest": "28.0.7",
61
+ "ts-node": "10.9.1",
62
62
  "typescript": "4.7.4",
63
63
  "utility-types": "3.10.0"
64
64
  },
@@ -17,9 +17,30 @@ class Ncu {
17
17
  return await this.run({
18
18
  packageManager: this.options.packageManager,
19
19
  jsonUpgraded: true,
20
+ dep: this.createDepOptionValue(),
20
21
  reject: this.options.ignorePackages
21
22
  });
22
23
  }
24
+ createDepOptionValue() {
25
+ return this.options.dependencyTypes
26
+ .map((dependencyType) => {
27
+ switch (dependencyType) {
28
+ case package_json_1.DependencyType.Dependencies:
29
+ return 'prod';
30
+ case package_json_1.DependencyType.DevDependencies:
31
+ return 'dev';
32
+ case package_json_1.DependencyType.PeerDependencies:
33
+ return 'peer';
34
+ case package_json_1.DependencyType.BundledDependencies:
35
+ return 'bundle';
36
+ case package_json_1.DependencyType.OptionalDependencies:
37
+ return 'optional';
38
+ default:
39
+ throw new Error();
40
+ }
41
+ })
42
+ .join(',');
43
+ }
23
44
  async update(outdatedPackage) {
24
45
  return await this.run({
25
46
  packageManager: this.options.packageManager,
@@ -38,7 +59,7 @@ class Ncu {
38
59
  if (!(0, NcuResult_1.isNcuResult)(result)) {
39
60
  throw new Error('Failed to running ncu.');
40
61
  }
41
- const { dependencies, devDependencies, peerDependencies, optionalDependencies } = pkg;
62
+ const { dependencies, devDependencies, peerDependencies, bundledDependencies, optionalDependencies } = pkg;
42
63
  const toCurrentVersionString = (packageName) => {
43
64
  if (dependencies?.[packageName] !== undefined) {
44
65
  return dependencies[packageName];
@@ -49,6 +70,9 @@ class Ncu {
49
70
  else if (peerDependencies?.[packageName] !== undefined) {
50
71
  return peerDependencies[packageName];
51
72
  }
73
+ else if (bundledDependencies?.[packageName] !== undefined) {
74
+ return bundledDependencies[packageName];
75
+ }
52
76
  else if (optionalDependencies?.[packageName] !== undefined) {
53
77
  return optionalDependencies[packageName];
54
78
  }
@@ -63,6 +87,9 @@ class Ncu {
63
87
  else if (peerDependencies?.[packageName] !== undefined) {
64
88
  return package_json_1.DependencyType.PeerDependencies;
65
89
  }
90
+ else if (bundledDependencies?.[packageName] !== undefined) {
91
+ return package_json_1.DependencyType.BundledDependencies;
92
+ }
66
93
  else if (optionalDependencies?.[packageName] !== undefined) {
67
94
  return package_json_1.DependencyType.OptionalDependencies;
68
95
  }
@@ -4,10 +4,18 @@ exports.isOptions = void 0;
4
4
  const io_ts_1 = require("io-ts");
5
5
  const logger_1 = require("../logger");
6
6
  const outdated_package_processor_1 = require("../outdated-package-processor");
7
+ const package_json_1 = require("../package-json");
7
8
  const package_manager_1 = require("../package-manager");
8
9
  const Options = (0, io_ts_1.intersection)([
9
10
  (0, io_ts_1.type)({
10
11
  commitMessage: io_ts_1.string,
12
+ dependencyTypes: (0, io_ts_1.array)((0, io_ts_1.union)([
13
+ (0, io_ts_1.literal)(package_json_1.DependencyType.Dependencies),
14
+ (0, io_ts_1.literal)(package_json_1.DependencyType.DevDependencies),
15
+ (0, io_ts_1.literal)(package_json_1.DependencyType.PeerDependencies),
16
+ (0, io_ts_1.literal)(package_json_1.DependencyType.BundledDependencies),
17
+ (0, io_ts_1.literal)(package_json_1.DependencyType.OptionalDependencies)
18
+ ])),
11
19
  fetchReleaseNotes: io_ts_1.boolean,
12
20
  fetchSleepTime: io_ts_1.number,
13
21
  githubToken: io_ts_1.string,
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.cliOptions = void 0;
4
4
  const logger_1 = require("../logger");
5
5
  const outdated_package_processor_1 = require("../outdated-package-processor");
6
+ const package_json_1 = require("../package-json");
6
7
  const package_manager_1 = require("../package-manager");
7
8
  const OptionType_1 = require("./OptionType");
8
9
  exports.cliOptions = [
@@ -25,6 +26,26 @@ exports.cliOptions = [
25
26
  required: false,
26
27
  default: 'chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}'
27
28
  },
29
+ {
30
+ name: 'dependency-types',
31
+ description: 'Dependency types to be updated',
32
+ type: OptionType_1.OptionType.StringArray,
33
+ required: false,
34
+ choices: [
35
+ package_json_1.DependencyType.Dependencies,
36
+ package_json_1.DependencyType.DevDependencies,
37
+ package_json_1.DependencyType.PeerDependencies,
38
+ package_json_1.DependencyType.BundledDependencies,
39
+ package_json_1.DependencyType.OptionalDependencies
40
+ ],
41
+ default: [
42
+ package_json_1.DependencyType.Dependencies,
43
+ package_json_1.DependencyType.DevDependencies,
44
+ package_json_1.DependencyType.PeerDependencies,
45
+ package_json_1.DependencyType.BundledDependencies,
46
+ package_json_1.DependencyType.OptionalDependencies
47
+ ]
48
+ },
28
49
  {
29
50
  name: 'fetch-release-notes',
30
51
  description: 'Whether to fetch release notes',
@@ -5,6 +5,7 @@ exports.DependencyType = {
5
5
  Dependencies: 'dependencies',
6
6
  DevDependencies: 'devDependencies',
7
7
  PeerDependencies: 'peerDependencies',
8
+ BundledDependencies: 'bundledDependencies',
8
9
  OptionalDependencies: 'optionalDependencies'
9
10
  };
10
11
  const dependencyTypes = Object.values(exports.DependencyType);
@@ -13,6 +13,7 @@ const PackageMetadata = (0, io_ts_1.intersection)([
13
13
  dependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
14
14
  devDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
15
15
  peerDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
16
+ bundledDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
16
17
  optionalDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
17
18
  repository: (0, io_ts_1.union)([io_ts_1.string, PackageMetadataRepository_1.PackageMetadataRepository])
18
19
  })
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "1.2.26",
3
+ "version": "1.3.0",
4
4
  "description": "CLI tool for creating pull requests to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",
@@ -16,7 +16,7 @@
16
16
  },
17
17
  "dependencies": {
18
18
  "@octokit/rest": "19.0.3",
19
- "commander": "9.3.0",
19
+ "commander": "9.4.0",
20
20
  "execa": "5.1.1",
21
21
  "fp-ts": "2.12.1",
22
22
  "http-status-codes": "2.2.0",
@@ -32,33 +32,33 @@
32
32
  "type-guards": "0.15.0"
33
33
  },
34
34
  "devDependencies": {
35
- "@jest/types": "28.1.1",
35
+ "@jest/types": "28.1.3",
36
36
  "@tsconfig/node14": "1.0.3",
37
- "@types/jest": "28.1.5",
37
+ "@types/jest": "28.1.6",
38
38
  "@types/lodash": "4.14.182",
39
39
  "@types/mustache": "4.1.3",
40
- "@types/node": "14.18.21",
40
+ "@types/node": "14.18.22",
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.30.6",
45
- "eslint": "8.19.0",
44
+ "@typescript-eslint/eslint-plugin": "5.30.7",
45
+ "eslint": "8.20.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.5.3",
50
+ "eslint-plugin-jest": "26.6.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",
54
54
  "eslint-plugin-tsdoc": "0.2.16",
55
- "eslint-plugin-unicorn": "43.0.1",
55
+ "eslint-plugin-unicorn": "43.0.2",
56
56
  "eslint-plugin-you-dont-need-lodash-underscore": "6.12.0",
57
- "jest": "28.1.2",
57
+ "jest": "28.1.3",
58
58
  "npm-run-all": "4.1.5",
59
59
  "rimraf": "3.0.2",
60
- "ts-jest": "28.0.5",
61
- "ts-node": "10.8.2",
60
+ "ts-jest": "28.0.7",
61
+ "ts-node": "10.9.1",
62
62
  "typescript": "4.7.4",
63
63
  "utility-types": "3.10.0"
64
64
  },