npm-update-package 0.51.0 → 0.53.0

package/README.md

@@ -7,6 +7,40 @@
 
 CLI tool for creating pull requests to update npm packages
 
+## Table of Contents
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Usage](#usage)
+- [Options](#options)
+  - [assignees](#assignees)
+  - [commitMessage](#commitmessage)
+  - [fetchReleaseNotes](#fetchreleasenotes)
+  - [fetchSleepTime](#fetchsleeptime)
+  - [gitUserEmail](#gituseremail)
+  - [gitUserName](#gitusername)
+  - [githubToken](#githubtoken)
+  - [ignorePackages](#ignorepackages)
+  - [logLevel](#loglevel)
+  - [packageManager](#packagemanager)
+  - [prBodyNotes](#prbodynotes)
+  - [prTitle](#prtitle)
+  - [reviewers](#reviewers)
+- [GitHub token](#github-token)
+- [Examples](#examples)
+  - [Use token of GitHub Actions](#use-token-of-github-actions)
+  - [Use token of GitHub App](#use-token-of-github-app)
+  - [Use Personal access token](#use-personal-access-token)
+  - [Use Yarn](#use-yarn)
+- [Flow](#flow)
+- [FAQ](#faq)
+  - [What is the purpose of npm-update-package?](#what-is-the-purpose-of-npm-update-package)
+  - [What should I do if conflicts occurred in the pull request?](#what-should-i-do-if-conflicts-occurred-in-the-pull-request)
+- [How to development](#how-to-development)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Usage
 
 ```sh
@@ -15,19 +49,20 @@ npx npm-update-package --github-token $GITHUB_TOKEN
 
 ## Options
 
-You can customize behavior via command-line options.  
+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|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -35,17 +70,18 @@ npx npm-update-package \
   --assignees octocat mona
 ```
 
-### `--commit-message`
+### commitMessage
 
 Commit message template.
 
 |Name|Value|
 |---|---|
+|cli|`--commit-message`|
 |type|string|
 |required|false|
 |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
 
-#### Available variables
+Available variables:
 
 |Variable|Description|
 |---|---|
@@ -55,7 +91,7 @@ Commit message template.
 |`level`|Semver level (`major`/`minor`/`patch`)|
 |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -63,17 +99,18 @@ npx npm-update-package \
   --commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
 ```
 
-### `--fetch-release-notes`
+### fetchReleaseNotes
 
 Whether to fetch release notes.
 
 |Name|Value|
 |---|---|
+|cli|`--fetch-release-notes`|
 |type|boolean|
 |required|false|
 |default|`true`|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -81,17 +118,18 @@ npx npm-update-package \
   --fetch-release-notes false
 ```
 
-### `--fetch-sleep-time`
+### fetchSleepTime
 
 Sleep time between fetching (ms).
 
 |Name|Value|
 |---|---|
+|cli|`--fetch-sleep-time`|
 |type|number|
 |required|false|
 |default|`1000`|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -99,25 +137,63 @@ npx npm-update-package \
   --fetch-sleep-time 2000
 ```
 
-### `--github-token`
+### gitUserEmail
+
+Git user email.
+
+|Name|Value|
+|---|---|
+|cli|`--git-user-email`|
+|type|string|
+|required|false|
+
+Example:
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --git-user-email octocat@example.com
+```
+
+### gitUserName
+
+Git user name.
+
+|Name|Value|
+|---|---|
+|cli|`--git-user-name`|
+|type|string|
+|required|false|
+
+Example:
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --git-user-name octocat
+```
+
+### githubToken
 
 [GitHub token](#github-token).
 
 |Name|Value|
 |---|---|
+|cli|`--github-token`|
 |type|string|
 |required|true|
 
-### `--ignore-packages`
+### ignorePackages
 
 Package names to ignore.
 
 |Name|Value|
 |---|---|
+|cli|`--ignore-packages`|
 |type|string[]|
 |required|false|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -125,17 +201,18 @@ npx npm-update-package \
   --ignore-packages @types/jest jest
 ```
 
-### `--log-level`
+### logLevel
 
 Log level to show.
 
 |Name|Value|
 |---|---|
+|cli|`--log-level`|
 |type|string|
 |required|false|
 |default|`info`|
 
-#### Allowed values
+Allowed values:
 
 |Value|Description|
 |---|---|
@@ -147,7 +224,7 @@ Log level to show.
 |`debug`|Output fatal/error/warn/info/debug logs.|
 |`trace`|Output fatal/error/warn/info/debug/trace logs.|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -155,24 +232,25 @@ npx npm-update-package \
   --log-level debug
 ```
 
-### `--package-manager`
+### packageManager
 
 Package manager of your project.
 
 |Name|Value|
 |---|---|
+|cli|`--package-manager`|
 |type|string|
 |required|false|
 |default|`npm`|
 
-#### Allowed values
+Allowed values:
 
 |Value|Description|
 |---|---|
 |`npm`|npm|
 |`yarn`|Yarn|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -180,16 +258,17 @@ npx npm-update-package \
   --package-manager yarn
 ```
 
-### `--pr-body-notes`
+### prBodyNotes
 
 Additional notes for Pull request body.
 
 |Name|Value|
 |---|---|
+|cli|`--pr-body-notes`|
 |type|string|
 |required|false|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -197,17 +276,18 @@ npx npm-update-package \
   --pr-body-notes "**:warning: Please see diff and release notes before merging.**"
 ```
 
-### `--pr-title`
+### prTitle
 
 Pull request title template.
 
 |Name|Value|
 |---|---|
+|cli|`--pr-title`|
 |type|string|
 |required|false|
 |default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
 
-#### Available variables
+Available variables:
 
 |Variable|Description|
 |---|---|
@@ -217,7 +297,7 @@ Pull request title template.
 |`level`|Semver level (`major`/`minor`/`patch`)|
 |`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -225,16 +305,17 @@ 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|
 
-#### Example
+Example:
 
 ```sh
 npx npm-update-package \
@@ -273,7 +354,7 @@ Creating a GitHub App may be tedious, but you only have to do it once the first
 
 ## Examples
 
-- [Use token of GitHub Actions](https://github.com/npm-update-package/example-github-actions)
+### Use token of GitHub Actions
 
 ```yaml
 name: npm-update-package
@@ -296,7 +377,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-- [Use token of GitHub App](https://github.com/npm-update-package/example-github-app)
+See working example on [example-github-actions](https://github.com/npm-update-package/example-github-actions).
+
+### Use token of GitHub App
 
 ```yaml
 name: npm-update-package
@@ -327,7 +410,9 @@ jobs:
           GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
 ```
 
-- [Use Personal access token](https://github.com/npm-update-package/example-pat)
+See working example on [example-github-app](https://github.com/npm-update-package/example-github-app).
+
+### Use Personal access token
 
 ```yaml
 name: npm-update-package
@@ -352,7 +437,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
 ```
 
-- [Use Yarn](https://github.com/npm-update-package/example-yarn)
+See working example on [example-pat](https://github.com/npm-update-package/example-pat).
+
+### Use Yarn
 
 ```yaml
 name: npm-update-package
@@ -383,6 +470,8 @@ jobs:
           GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
 ```
 
+See working example on [example-yarn](https://github.com/npm-update-package/example-yarn).
+
 ## Flow
 
 The following shows the process flow of npm-update-package.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.51.0",
+    "version": "0.53.0",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -15,7 +15,7 @@
     "bin": "dist/src/bin.js",
     "dependencies": {
         "@octokit/rest": "18.12.0",
-        "commander": "8.3.0",
+        "commander": "9.1.0",
         "execa": "5.1.1",
         "fp-ts": "2.11.9",
         "http-status-codes": "2.2.0",
@@ -33,14 +33,14 @@
     "devDependencies": {
         "@jest/types": "27.4.2",
         "@tsconfig/node12": "1.0.9",
-        "@types/jest": "27.4.0",
-        "@types/lodash": "4.14.180",
+        "@types/jest": "27.4.1",
+        "@types/lodash": "4.14.181",
         "@types/mustache": "4.1.2",
         "@types/node": "12.20.40",
         "@types/node-fetch": "2.6.1",
         "@types/parse-github-url": "1.0.0",
         "@types/semver": "7.3.9",
-        "@typescript-eslint/eslint-plugin": "5.16.0",
+        "@typescript-eslint/eslint-plugin": "5.17.0",
         "eslint": "8.12.0",
         "eslint-config-standard-with-typescript": "21.0.1",
         "eslint-plugin-import": "2.25.4",

package/dist/src/git/Git.js

@@ -27,6 +27,9 @@ class Git {
     async restore(...files) {
         await this.terminal.run('git', 'checkout', ...files);
     }
+    async setConfig(key, value) {
+        await this.terminal.run('git', 'config', key, value);
+    }
     async switch(branchName) {
         await this.terminal.run('git', 'checkout', branchName);
     }

package/dist/src/git/GitConfigInitializer.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitConfigInitializer = void 0;
+class GitConfigInitializer {
+    constructor({ options, git }) {
+        this.options = options;
+        this.git = git;
+    }
+    async initialize() {
+        if (this.options.gitUserName !== undefined) {
+            await this.git.setConfig('user.name', this.options.gitUserName);
+        }
+        if (this.options.gitUserEmail !== undefined) {
+            await this.git.setConfig('user.email', this.options.gitUserEmail);
+        }
+    }
+}
+exports.GitConfigInitializer = GitConfigInitializer;

package/dist/src/git/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CommitMessageCreator"), exports);
 __exportStar(require("./createBranchName"), exports);
 __exportStar(require("./Git"), exports);
+__exportStar(require("./GitConfigInitializer"), exports);
 __exportStar(require("./GitRepository"), exports);

package/dist/src/github/pull-request/creator/createPackageDiffsSection.js

@@ -13,6 +13,7 @@ const createPackageDiffsSection = ({ outdatedPackage, gitRepo }) => {
         links.push(`- [GitHub](${optimizedUrl})`);
     }
     links.push(`- [npmfs](https://npmfs.com/compare/${packageName}/${currentVersion}/${newVersion})`);
+    links.push(`- [Package Diff](https://diff.intrinsic.com/${packageName}/${currentVersion}/${newVersion})`);
     links.push(`- [Renovate Bot Package Diff](https://renovatebot.com/diffs/npm/${packageName}/${currentVersion}/${newVersion})`);
     return `## Package diffs
 

package/dist/src/main.js

@@ -108,6 +108,11 @@ const main = async ({ options, logger }) => {
         pullRequestsCloser,
         packageUpdater
     });
+    const gitConfigInitializer = new git_1.GitConfigInitializer({
+        options,
+        git
+    });
+    await gitConfigInitializer.initialize();
     const outdatedPackagesProcessor = new core_1.OutdatedPackagesProcessor({
         outdatedPackageProcessor,
         logger

package/dist/src/options/Options.js

@@ -27,6 +27,8 @@ const Options = (0, io_ts_1.intersection)([
     }),
     (0, io_ts_1.partial)({
         assignees: (0, io_ts_1.array)(io_ts_1.string),
+        gitUserEmail: io_ts_1.string,
+        gitUserName: io_ts_1.string,
         ignorePackages: (0, io_ts_1.array)(io_ts_1.string),
         prBodyNotes: io_ts_1.string,
         reviewers: (0, io_ts_1.array)(io_ts_1.string)

package/dist/src/options/cliOptions.js

@@ -32,6 +32,18 @@ exports.cliOptions = [
         required: false,
         default: 1000
     },
+    {
+        name: 'git-user-email',
+        description: 'Git user email',
+        type: OptionType_1.OptionType.String,
+        required: false
+    },
+    {
+        name: 'git-user-name',
+        description: 'Git user name',
+        type: OptionType_1.OptionType.String,
+        required: false
+    },
     {
         name: 'github-token',
         description: 'GitHub token',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.51.0",
+  "version": "0.53.0",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -15,7 +15,7 @@
   "bin": "dist/src/bin.js",
   "dependencies": {
     "@octokit/rest": "18.12.0",
-    "commander": "8.3.0",
+    "commander": "9.1.0",
     "execa": "5.1.1",
     "fp-ts": "2.11.9",
     "http-status-codes": "2.2.0",
@@ -33,14 +33,14 @@
   "devDependencies": {
     "@jest/types": "27.4.2",
     "@tsconfig/node12": "1.0.9",
-    "@types/jest": "27.4.0",
-    "@types/lodash": "4.14.180",
+    "@types/jest": "27.4.1",
+    "@types/lodash": "4.14.181",
     "@types/mustache": "4.1.2",
     "@types/node": "12.20.40",
     "@types/node-fetch": "2.6.1",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.16.0",
+    "@typescript-eslint/eslint-plugin": "5.17.0",
     "eslint": "8.12.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",