npm-update-package 1.2.25 → 1.3.1

package/README.md

@@ -16,23 +16,24 @@ CLI tool for creating pull requests to update npm packages
 - [Supported platforms](#supported-platforms)
 - [Usage](#usage)
 - [Options](#options)
-  - [assignees](#assignees)
-  - [assigneesSampleSize](#assigneessamplesize)
-  - [commitMessage](#commitmessage)
-  - [fetchReleaseNotes](#fetchreleasenotes)
-  - [fetchSleepTime](#fetchsleeptime)
-  - [gitUserEmail](#gituseremail)
-  - [gitUserName](#gitusername)
-  - [githubToken](#githubtoken)
-  - [ignorePackages](#ignorepackages)
-  - [logLevel](#loglevel)
-  - [outdatedPrStrategy](#outdatedprstrategy)
-  - [packageManager](#packagemanager)
-  - [prBodyGithubHost](#prbodygithubhost)
-  - [prBodyNotes](#prbodynotes)
-  - [prTitle](#prtitle)
-  - [reviewers](#reviewers)
-  - [reviewersSampleSize](#reviewerssamplesize)
+  - [`--assignees`](#--assignees)
+  - [`--assignees-sample-size`](#--assignees-sample-size)
+  - [`--commit-message`](#--commit-message)
+  - [`--dependency-types`](#--dependency-types)
+  - [`--fetch-release-notes`](#--fetch-release-notes)
+  - [`--fetch-sleep-time`](#--fetch-sleep-time)
+  - [`--git-user-email`](#--git-user-email)
+  - [`--git-user-name`](#--git-user-name)
+  - [`--github-token`](#--github-token)
+  - [`--ignore-packages`](#--ignore-packages)
+  - [`--log-level`](#--log-level)
+  - [`--outdated-pr-strategy`](#--outdated-pr-strategy)
+  - [`--package-manager`](#--package-manager)
+  - [`--pr-body-github-host`](#--pr-body-github-host)
+  - [`--pr-body-notes`](#--pr-body-notes)
+  - [`--pr-title`](#--pr-title)
+  - [`--reviewers`](#--reviewers)
+  - [`--reviewers-sample-size`](#--reviewers-sample-size)
 - [GitHub token](#github-token)
 - [Examples](#examples)
   - [Use token of GitHub Actions](#use-token-of-github-actions)
@@ -68,16 +69,14 @@ npx npm-update-package --github-token $GITHUB_TOKEN
 You can customize behavior via CLI options.  
 Some options can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
 
-### assignees
+### `--assignees`
 
 User names to assign to pull request.
 
 |Name|Value|
 |---|---|
-|cli|`--assignees`|
 |type|string[]|
-|required|false|
-|added version|v0.46.0|
+|required|-|
 
 Example:
 
@@ -87,16 +86,14 @@ npx npm-update-package \
   --assignees alice bob
 ```
 
-### assigneesSampleSize
+### `--assignees-sample-size`
 
 How many members to be assigned to assignees.
 
 |Name|Value|
 |---|---|
-|cli|`--assignees-sample-size`|
 |type|number|
-|required|false|
-|added version|v0.56.0|
+|required|-|
 
 Example:
 
@@ -107,17 +104,15 @@ npx npm-update-package \
   --assignees-sample-size 1
 ```
 
-### commitMessage
+### `--commit-message`
 
 Commit message template.
 
 |Name|Value|
 |---|---|
-|cli|`--commit-message`|
 |type|string|
-|required|false|
+|required|-|
 |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
-|added version|v0.5.0|
 
 Available variables:
 
@@ -127,7 +122,7 @@ Available variables:
 |`newVersion`|New package version|
 |`packageName`|Package name|
 |`level`|Semver level (`major`/`minor`/`patch`)|
-|`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
+|`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`bundledDependencies`/`optionalDependencies`)|
 
 Example:
 
@@ -137,17 +132,44 @@ npx npm-update-package \
   --commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
 ```
 
-### fetchReleaseNotes
+### `--dependency-types`
+
+Dependency types to be updated.
+
+|Name|Value|
+|---|---|
+|type|string[]|
+|required|-|
+|default|`dependencies`, `devDependencies`, `peerDependencies`, `bundledDependencies`, `optionalDependencies`|
+
+Allowed values:
+
+|Value|Description|
+|---|---|
+|`dependencies`|dependencies|
+|`devDependencies`|devDependencies|
+|`peerDependencies`|peerDependencies|
+|`bundledDependencies`|bundledDependencies|
+|`optionalDependencies`|optionalDependencies|
+
+
+Example:
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --dependency-types dependencies devDependencies
+```
+
+### `--fetch-release-notes`
 
 Whether to fetch release notes.
 
 |Name|Value|
 |---|---|
-|cli|`--fetch-release-notes`|
 |type|boolean|
-|required|false|
+|required|-|
 |default|`true`|
-|added version|v0.51.0|
 
 Example:
 
@@ -157,17 +179,15 @@ npx npm-update-package \
   --fetch-release-notes false
 ```
 
-### fetchSleepTime
+### `--fetch-sleep-time`
 
 Sleep time between fetching (ms).
 
 |Name|Value|
 |---|---|
-|cli|`--fetch-sleep-time`|
 |type|number|
-|required|false|
+|required|-|
 |default|`1000`|
-|added version|v0.50.0|
 
 Example:
 
@@ -177,16 +197,14 @@ npx npm-update-package \
   --fetch-sleep-time 2000
 ```
 
-### gitUserEmail
+### `--git-user-email`
 
 Git user email.
 
 |Name|Value|
 |---|---|
-|cli|`--git-user-email`|
 |type|string|
-|required|false|
-|added version|v0.53.0|
+|required|-|
 
 Example:
 
@@ -196,16 +214,14 @@ npx npm-update-package \
   --git-user-email alice@example.com
 ```
 
-### gitUserName
+### `--git-user-name`
 
 Git user name.
 
 |Name|Value|
 |---|---|
-|cli|`--git-user-name`|
 |type|string|
-|required|false|
-|added version|v0.53.0|
+|required|-|
 
 Example:
 
@@ -215,27 +231,23 @@ npx npm-update-package \
   --git-user-name alice
 ```
 
-### githubToken
+### `--github-token`
 
 [GitHub token](#github-token).
 
 |Name|Value|
 |---|---|
-|cli|`--github-token`|
 |type|string|
-|required|true|
-|added version|v0.1.0|
+|required|✔️|
 
-### ignorePackages
+### `--ignore-packages`
 
 Package names to ignore.
 
 |Name|Value|
 |---|---|
-|cli|`--ignore-packages`|
 |type|string[]|
-|required|false|
-|added version|v0.43.0|
+|required|-|
 
 Example:
 
@@ -245,17 +257,15 @@ npx npm-update-package \
   --ignore-packages @types/jest jest
 ```
 
-### logLevel
+### `--log-level`
 
 Log level to show.
 
 |Name|Value|
 |---|---|
-|cli|`--log-level`|
 |type|string|
-|required|false|
+|required|-|
 |default|`info`|
-|added version|v0.1.0|
 
 Allowed values:
 
@@ -277,17 +287,15 @@ npx npm-update-package \
   --log-level debug
 ```
 
-### outdatedPrStrategy
+### `--outdated-pr-strategy`
 
 What to do when outdated pull requests exist.
 
 |Name|Value|
 |---|---|
-|cli|`--outdated-pr-strategy`|
 |type|string|
-|required|false|
+|required|-|
 |default|`recreate`|
-|added version|v0.58.0|
 
 Allowed values:
 
@@ -305,17 +313,15 @@ npx npm-update-package \
   --outdated-pr-strategy create
 ```
 
-### packageManager
+### `--package-manager`
 
 Package manager of your project.  
 Since npm-update-package automatically determines which package manager to use, it is usually not necessary to specify this option.
 
 |Name|Value|
 |---|---|
-|cli|`--package-manager`|
 |type|string|
-|required|false|
-|added version|v0.1.0|
+|required|-|
 
 Allowed values:
 
@@ -332,17 +338,15 @@ npx npm-update-package \
   --package-manager yarn
 ```
 
-### prBodyGithubHost
+### `--pr-body-github-host`
 
 GitHub host of pull request body.
 
 |Name|Value|
 |---|---|
-|cli|`--pr-body-github-host`|
 |type|string|
-|required|false|
+|required|-|
 |default|`togithub.com`|
-|added version|v0.55.0|
 
 Example:
 
@@ -352,16 +356,14 @@ npx npm-update-package \
   --pr-body-github-host "github.example"
 ```
 
-### prBodyNotes
+### `--pr-body-notes`
 
 Additional notes for Pull request body.
 
 |Name|Value|
 |---|---|
-|cli|`--pr-body-notes`|
 |type|string|
-|required|false|
-|added version|v0.45.0|
+|required|-|
 
 Example:
 
@@ -371,17 +373,15 @@ npx npm-update-package \
   --pr-body-notes "**:warning: Please see diff and release notes before merging.**"
 ```
 
-### prTitle
+### `--pr-title`
 
 Pull request title template.
 
 |Name|Value|
 |---|---|
-|cli|`--pr-title`|
 |type|string|
-|required|false|
+|required|-|
 |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
-|added version|v0.44.0|
 
 Available variables:
 
@@ -391,7 +391,7 @@ Available variables:
 |`newVersion`|New package version|
 |`packageName`|Package name|
 |`level`|Semver level (`major`/`minor`/`patch`)|
-|`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
+|`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`bundledDependencies`/`optionalDependencies`)|
 
 Example:
 
@@ -401,16 +401,14 @@ npx npm-update-package \
   --pr-title "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
 ```
 
-### reviewers
+### `--reviewers`
 
 User names to request reviews.
 
 |Name|Value|
 |---|---|
-|cli|`--reviewers`|
 |type|string[]|
-|required|false|
-|added version|v0.26.0|
+|required|-|
 
 Example:
 
@@ -420,16 +418,14 @@ npx npm-update-package \
   --reviewers alice bob
 ```
 
-### reviewersSampleSize
+### `--reviewers-sample-size`
 
 How many members to be assigned to reviewers.
 
 |Name|Value|
 |---|---|
-|cli|`--reviewers-sample-size`|
 |type|number|
-|required|false|
-|added version|v0.57.0|
+|required|-|
 
 Example:
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "1.2.25",
+    "version": "1.3.1",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -16,7 +16,7 @@
     },
     "dependencies": {
         "@octokit/rest": "19.0.3",
-        "commander": "9.3.0",
+        "commander": "9.4.0",
         "execa": "5.1.1",
         "fp-ts": "2.12.1",
         "http-status-codes": "2.2.0",
@@ -32,33 +32,33 @@
         "type-guards": "0.15.0"
     },
     "devDependencies": {
-        "@jest/types": "28.1.1",
+        "@jest/types": "28.1.3",
         "@tsconfig/node14": "1.0.3",
-        "@types/jest": "28.1.4",
+        "@types/jest": "28.1.6",
         "@types/lodash": "4.14.182",
         "@types/mustache": "4.1.3",
-        "@types/node": "14.18.21",
+        "@types/node": "14.18.22",
         "@types/node-fetch": "2.6.2",
         "@types/parse-github-url": "1.0.0",
         "@types/semver": "7.3.10",
-        "@typescript-eslint/eslint-plugin": "5.30.5",
-        "eslint": "8.19.0",
+        "@typescript-eslint/eslint-plugin": "5.30.7",
+        "eslint": "8.20.0",
         "eslint-config-lodash": "1.1.0",
-        "eslint-config-standard-with-typescript": "21.0.1",
+        "eslint-config-standard-with-typescript": "22.0.0",
         "eslint-plugin-eslint-comments": "3.2.0",
         "eslint-plugin-import": "2.26.0",
-        "eslint-plugin-jest": "26.5.3",
+        "eslint-plugin-jest": "26.6.0",
         "eslint-plugin-lodash": "7.4.0",
-        "eslint-plugin-node": "11.1.0",
+        "eslint-plugin-n": "15.2.4",
         "eslint-plugin-promise": "6.0.0",
         "eslint-plugin-tsdoc": "0.2.16",
-        "eslint-plugin-unicorn": "42.0.0",
+        "eslint-plugin-unicorn": "43.0.2",
         "eslint-plugin-you-dont-need-lodash-underscore": "6.12.0",
-        "jest": "28.1.2",
+        "jest": "28.1.3",
         "npm-run-all": "4.1.5",
         "rimraf": "3.0.2",
-        "ts-jest": "28.0.5",
-        "ts-node": "10.8.2",
+        "ts-jest": "28.0.7",
+        "ts-node": "10.9.1",
         "typescript": "4.7.4",
         "utility-types": "3.10.0"
     },

package/dist/src/ncu/Ncu.js

@@ -17,9 +17,30 @@ class Ncu {
         return await this.run({
             packageManager: this.options.packageManager,
             jsonUpgraded: true,
+            dep: this.createDepOptionValue(),
             reject: this.options.ignorePackages
         });
     }
+    createDepOptionValue() {
+        return this.options.dependencyTypes
+            .map((dependencyType) => {
+            switch (dependencyType) {
+                case package_json_1.DependencyType.Dependencies:
+                    return 'prod';
+                case package_json_1.DependencyType.DevDependencies:
+                    return 'dev';
+                case package_json_1.DependencyType.PeerDependencies:
+                    return 'peer';
+                case package_json_1.DependencyType.BundledDependencies:
+                    return 'bundle';
+                case package_json_1.DependencyType.OptionalDependencies:
+                    return 'optional';
+                default:
+                    throw new Error();
+            }
+        })
+            .join(',');
+    }
     async update(outdatedPackage) {
         return await this.run({
             packageManager: this.options.packageManager,
@@ -38,7 +59,7 @@ class Ncu {
         if (!(0, NcuResult_1.isNcuResult)(result)) {
             throw new Error('Failed to running ncu.');
         }
-        const { dependencies, devDependencies, peerDependencies, optionalDependencies } = pkg;
+        const { dependencies, devDependencies, peerDependencies, bundledDependencies, optionalDependencies } = pkg;
         const toCurrentVersionString = (packageName) => {
             if (dependencies?.[packageName] !== undefined) {
                 return dependencies[packageName];
@@ -49,6 +70,9 @@ class Ncu {
             else if (peerDependencies?.[packageName] !== undefined) {
                 return peerDependencies[packageName];
             }
+            else if (bundledDependencies?.[packageName] !== undefined) {
+                return bundledDependencies[packageName];
+            }
             else if (optionalDependencies?.[packageName] !== undefined) {
                 return optionalDependencies[packageName];
             }
@@ -63,6 +87,9 @@ class Ncu {
             else if (peerDependencies?.[packageName] !== undefined) {
                 return package_json_1.DependencyType.PeerDependencies;
             }
+            else if (bundledDependencies?.[packageName] !== undefined) {
+                return package_json_1.DependencyType.BundledDependencies;
+            }
             else if (optionalDependencies?.[packageName] !== undefined) {
                 return package_json_1.DependencyType.OptionalDependencies;
             }

package/dist/src/options/Options.js

@@ -4,10 +4,18 @@ exports.isOptions = void 0;
 const io_ts_1 = require("io-ts");
 const logger_1 = require("../logger");
 const outdated_package_processor_1 = require("../outdated-package-processor");
+const package_json_1 = require("../package-json");
 const package_manager_1 = require("../package-manager");
 const Options = (0, io_ts_1.intersection)([
     (0, io_ts_1.type)({
         commitMessage: io_ts_1.string,
+        dependencyTypes: (0, io_ts_1.array)((0, io_ts_1.union)([
+            (0, io_ts_1.literal)(package_json_1.DependencyType.Dependencies),
+            (0, io_ts_1.literal)(package_json_1.DependencyType.DevDependencies),
+            (0, io_ts_1.literal)(package_json_1.DependencyType.PeerDependencies),
+            (0, io_ts_1.literal)(package_json_1.DependencyType.BundledDependencies),
+            (0, io_ts_1.literal)(package_json_1.DependencyType.OptionalDependencies)
+        ])),
         fetchReleaseNotes: io_ts_1.boolean,
         fetchSleepTime: io_ts_1.number,
         githubToken: io_ts_1.string,

package/dist/src/options/cliOptions.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cliOptions = void 0;
 const logger_1 = require("../logger");
 const outdated_package_processor_1 = require("../outdated-package-processor");
+const package_json_1 = require("../package-json");
 const package_manager_1 = require("../package-manager");
 const OptionType_1 = require("./OptionType");
 exports.cliOptions = [
@@ -25,6 +26,26 @@ exports.cliOptions = [
         required: false,
         default: 'chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}'
     },
+    {
+        name: 'dependency-types',
+        description: 'Dependency types to be updated',
+        type: OptionType_1.OptionType.StringArray,
+        required: false,
+        choices: [
+            package_json_1.DependencyType.Dependencies,
+            package_json_1.DependencyType.DevDependencies,
+            package_json_1.DependencyType.PeerDependencies,
+            package_json_1.DependencyType.BundledDependencies,
+            package_json_1.DependencyType.OptionalDependencies
+        ],
+        default: [
+            package_json_1.DependencyType.Dependencies,
+            package_json_1.DependencyType.DevDependencies,
+            package_json_1.DependencyType.PeerDependencies,
+            package_json_1.DependencyType.BundledDependencies,
+            package_json_1.DependencyType.OptionalDependencies
+        ]
+    },
     {
         name: 'fetch-release-notes',
         description: 'Whether to fetch release notes',

package/dist/src/package-json/DependencyType.js

@@ -5,6 +5,7 @@ exports.DependencyType = {
     Dependencies: 'dependencies',
     DevDependencies: 'devDependencies',
     PeerDependencies: 'peerDependencies',
+    BundledDependencies: 'bundledDependencies',
     OptionalDependencies: 'optionalDependencies'
 };
 const dependencyTypes = Object.values(exports.DependencyType);

package/dist/src/package-json/PackageMetadata.js

@@ -13,6 +13,7 @@ const PackageMetadata = (0, io_ts_1.intersection)([
         dependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
         devDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
         peerDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
+        bundledDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
         optionalDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
         repository: (0, io_ts_1.union)([io_ts_1.string, PackageMetadataRepository_1.PackageMetadataRepository])
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "1.2.25",
+  "version": "1.3.1",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "@octokit/rest": "19.0.3",
-    "commander": "9.3.0",
+    "commander": "9.4.0",
     "execa": "5.1.1",
     "fp-ts": "2.12.1",
     "http-status-codes": "2.2.0",
@@ -32,33 +32,33 @@
     "type-guards": "0.15.0"
   },
   "devDependencies": {
-    "@jest/types": "28.1.1",
+    "@jest/types": "28.1.3",
     "@tsconfig/node14": "1.0.3",
-    "@types/jest": "28.1.4",
+    "@types/jest": "28.1.6",
     "@types/lodash": "4.14.182",
     "@types/mustache": "4.1.3",
-    "@types/node": "14.18.21",
+    "@types/node": "14.18.22",
     "@types/node-fetch": "2.6.2",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.10",
-    "@typescript-eslint/eslint-plugin": "5.30.5",
-    "eslint": "8.19.0",
+    "@typescript-eslint/eslint-plugin": "5.30.7",
+    "eslint": "8.20.0",
     "eslint-config-lodash": "1.1.0",
-    "eslint-config-standard-with-typescript": "21.0.1",
+    "eslint-config-standard-with-typescript": "22.0.0",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jest": "26.5.3",
+    "eslint-plugin-jest": "26.6.0",
     "eslint-plugin-lodash": "7.4.0",
-    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-n": "15.2.4",
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-tsdoc": "0.2.16",
-    "eslint-plugin-unicorn": "42.0.0",
+    "eslint-plugin-unicorn": "43.0.2",
     "eslint-plugin-you-dont-need-lodash-underscore": "6.12.0",
-    "jest": "28.1.2",
+    "jest": "28.1.3",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
-    "ts-jest": "28.0.5",
-    "ts-node": "10.8.2",
+    "ts-jest": "28.0.7",
+    "ts-node": "10.9.1",
     "typescript": "4.7.4",
     "utility-types": "3.10.0"
   },