npm-update-package 0.52.1 → 0.54.0

package/README.md

@@ -13,11 +13,15 @@ CLI tool for creating pull requests to update npm packages
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Usage](#usage)
+- [Requirements](#requirements)
+- [Supported platforms](#supported-platforms)
 - [Options](#options)
   - [assignees](#assignees)
   - [commitMessage](#commitmessage)
   - [fetchReleaseNotes](#fetchreleasenotes)
   - [fetchSleepTime](#fetchsleeptime)
+  - [gitUserEmail](#gituseremail)
+  - [gitUserName](#gitusername)
   - [githubToken](#githubtoken)
   - [ignorePackages](#ignorepackages)
   - [logLevel](#loglevel)
@@ -45,6 +49,17 @@ CLI tool for creating pull requests to update npm packages
 npx npm-update-package --github-token $GITHUB_TOKEN
 ```
 
+## Requirements
+
+- Git
+- Node.js
+- npm or Yarn
+
+## Supported platforms
+
+- GitHub
+- GitHub Enterprise
+
 ## Options
 
 You can customize behavior via CLI options.  
@@ -135,6 +150,42 @@ npx npm-update-package \
   --fetch-sleep-time 2000
 ```
 
+### 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).
@@ -196,14 +247,14 @@ npx npm-update-package \
 
 ### packageManager
 
-Package manager of your project.
+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|
-|default|`npm`|
 
 Allowed values:
 
@@ -330,9 +381,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
       - run: |
-          git config user.name $GIT_USER_NAME
-          git config user.email $GIT_USER_EMAIL
-          npx npm-update-package --github-token $GITHUB_TOKEN
+          npx npm-update-package \
+            --github-token $GITHUB_TOKEN \
+            --git-user-name $GIT_USER_NAME \
+            --git-user-email $GIT_USER_EMAIL
         env:
           GIT_USER_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
           GIT_USER_NAME: github-actions[bot]
@@ -361,9 +413,10 @@ jobs:
           app_id: ${{ secrets.APP_ID }}
           private_key: ${{ secrets.PRIVATE_KEY }}
       - run: |
-          git config user.name $GIT_USER_NAME
-          git config user.email $GIT_USER_EMAIL
-          npx npm-update-package --github-token $GITHUB_TOKEN
+          npx npm-update-package \
+            --github-token $GITHUB_TOKEN \
+            --git-user-name $GIT_USER_NAME \
+            --git-user-email $GIT_USER_EMAIL
         env:
           # TODO: Replace with your GitHub App's email
           GIT_USER_EMAIL: 97396142+npm-update-package[bot]@users.noreply.github.com
@@ -388,9 +441,10 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
       - run: |
-          git config user.name $GIT_USER_NAME
-          git config user.email $GIT_USER_EMAIL
-          npx npm-update-package --github-token $GITHUB_TOKEN
+          npx npm-update-package \
+            --github-token $GITHUB_TOKEN \
+            --git-user-name $GIT_USER_NAME \
+            --git-user-email $GIT_USER_EMAIL
         env:
           # TODO: Replace with your email
           GIT_USER_EMAIL: 97961304+npm-update-package-bot@users.noreply.github.com
@@ -421,9 +475,11 @@ jobs:
           app_id: ${{ secrets.APP_ID }}
           private_key: ${{ secrets.PRIVATE_KEY }}
       - run: |
-          git config user.name $GIT_USER_NAME
-          git config user.email $GIT_USER_EMAIL
-          npx npm-update-package --github-token $GITHUB_TOKEN --package-manager yarn
+          npx npm-update-package \
+            --github-token $GITHUB_TOKEN \
+            --git-user-name $GIT_USER_NAME \
+            --git-user-email $GIT_USER_EMAIL \
+            --package-manager yarn
         env:
           # TODO: Replace with your GitHub App's email
           GIT_USER_EMAIL: 97396142+npm-update-package[bot]@users.noreply.github.com

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.52.1",
+    "version": "0.54.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",
@@ -24,7 +24,7 @@
         "log4js": "6.4.4",
         "mustache": "4.1.0",
         "node-fetch": "2.6.7",
-        "npm-check-updates": "12.5.4",
+        "npm-check-updates": "12.5.5",
         "parse-github-url": "1.0.2",
         "semver": "7.3.5",
         "sleep-promise": "9.1.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": "12.20.47",
         "@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/file/canReadWrite.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.canReadWrite = void 0;
+const fs_1 = __importDefault(require("fs"));
+// TODO: Add test
+const canReadWrite = async (path) => {
+    try {
+        await fs_1.default.promises.access(path, fs_1.default.constants.R_OK | fs_1.default.constants.W_OK);
+    }
+    catch {
+        return false;
+    }
+    return true;
+};
+exports.canReadWrite = canReadWrite;

package/dist/src/file/index.js

@@ -14,4 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./canReadWrite"), exports);
 __exportStar(require("./readFile"), exports);

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/main.js

@@ -63,10 +63,11 @@ const main = async ({ options, logger }) => {
         color: 'A00F21'
     });
     const branchFinder = new github_1.BranchFinder(branches);
-    const packageManager = (0, package_manager_1.createPackageManager)({
-        terminal,
-        packageManager: options.packageManager
+    const packageManagerCreator = new package_manager_1.PackageManagerCreator({
+        options,
+        logger
     });
+    const packageManager = await packageManagerCreator.create(terminal);
     const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.prTitle);
     const releasesFetcher = new github_1.ReleasesFetcher({
         options,
@@ -108,6 +109,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/ncu/Ncu.js

@@ -15,12 +15,14 @@ class Ncu {
     }
     async check() {
         return await this.run({
+            packageManager: this.options.packageManager,
             jsonUpgraded: true,
             reject: this.options.ignorePackages
         });
     }
     async update(outdatedPackage) {
         return await this.run({
+            packageManager: this.options.packageManager,
             jsonUpgraded: true,
             filter: outdatedPackage.name,
             upgrade: true

package/dist/src/options/Options.js

@@ -19,15 +19,17 @@ const Options = (0, io_ts_1.intersection)([
             (0, io_ts_1.literal)(logger_1.LogLevel.Debug),
             (0, io_ts_1.literal)(logger_1.LogLevel.Trace)
         ]),
-        packageManager: (0, io_ts_1.union)([
-            (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Npm),
-            (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Yarn)
-        ]),
         prTitle: io_ts_1.string
     }),
     (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),
+        packageManager: (0, io_ts_1.union)([
+            (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Npm),
+            (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Yarn)
+        ]),
         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',
@@ -68,8 +80,7 @@ exports.cliOptions = [
         choices: [
             package_manager_1.PackageManagerName.Npm,
             package_manager_1.PackageManagerName.Yarn
-        ],
-        default: package_manager_1.PackageManagerName.Npm
+        ]
     },
     {
         name: 'pr-body-notes',

package/dist/src/package-manager/PackageManagerCreator.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageManagerCreator = void 0;
+const detectPackageManager_1 = require("./detectPackageManager");
+const Npm_1 = require("./Npm");
+const PackageManagerName_1 = require("./PackageManagerName");
+const Yarn_1 = require("./Yarn");
+class PackageManagerCreator {
+    constructor({ options, logger }) {
+        this.options = options;
+        this.logger = logger;
+    }
+    async create(terminal) {
+        const packageManagerName = await this.getPackageManagerName();
+        this.logger.trace(`packageManagerName=${packageManagerName}`);
+        switch (packageManagerName) {
+            case PackageManagerName_1.PackageManagerName.Npm:
+                this.logger.info('Use npm as package manager');
+                return new Npm_1.Npm(terminal);
+            case PackageManagerName_1.PackageManagerName.Yarn:
+                this.logger.info('Use Yarn as package manager');
+                return new Yarn_1.Yarn(terminal);
+        }
+    }
+    async getPackageManagerName() {
+        if (this.options.packageManager !== undefined) {
+            return this.options.packageManager;
+        }
+        this.logger.info('Try to detect package manager from lock file.');
+        return await (0, detectPackageManager_1.detectPackageManager)();
+    }
+}
+exports.PackageManagerCreator = PackageManagerCreator;

package/dist/src/package-manager/detectPackageManager.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.detectPackageManager = void 0;
+const file_1 = require("../file");
+const PackageManagerName_1 = require("./PackageManagerName");
+const detectPackageManager = async () => {
+    if (await (0, file_1.canReadWrite)('package-lock.json')) {
+        return PackageManagerName_1.PackageManagerName.Npm;
+    }
+    if (await (0, file_1.canReadWrite)('yarn.lock')) {
+        return PackageManagerName_1.PackageManagerName.Yarn;
+    }
+    throw new Error('No lock file exists.');
+};
+exports.detectPackageManager = detectPackageManager;

package/dist/src/package-manager/index.js

@@ -14,8 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./createPackageManager"), exports);
 __exportStar(require("./Npm"), exports);
 __exportStar(require("./PackageManager"), exports);
+__exportStar(require("./PackageManagerCreator"), exports);
 __exportStar(require("./PackageManagerName"), exports);
 __exportStar(require("./Yarn"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.52.1",
+  "version": "0.54.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",
@@ -24,7 +24,7 @@
     "log4js": "6.4.4",
     "mustache": "4.1.0",
     "node-fetch": "2.6.7",
-    "npm-check-updates": "12.5.4",
+    "npm-check-updates": "12.5.5",
     "parse-github-url": "1.0.2",
     "semver": "7.3.5",
     "sleep-promise": "9.1.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": "12.20.47",
     "@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/package-manager/createPackageManager.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPackageManager = void 0;
-const Npm_1 = require("./Npm");
-const PackageManagerName_1 = require("./PackageManagerName");
-const Yarn_1 = require("./Yarn");
-const createPackageManager = ({ terminal, packageManager }) => {
-    switch (packageManager) {
-        case PackageManagerName_1.PackageManagerName.Npm:
-            return new Npm_1.Npm(terminal);
-        case PackageManagerName_1.PackageManagerName.Yarn:
-            return new Yarn_1.Yarn(terminal);
-    }
-};
-exports.createPackageManager = createPackageManager;