npm-update-package 0.57.0 → 0.58.0

package/README.md

@@ -26,6 +26,7 @@ CLI tool for creating pull requests to update npm packages
   - [githubToken](#githubtoken)
   - [ignorePackages](#ignorepackages)
   - [logLevel](#loglevel)
+  - [outdatedPrStrategy](#outdatedprstrategy)
   - [packageManager](#packagemanager)
   - [prBodyGithubHost](#prbodygithubhost)
   - [prBodyNotes](#prbodynotes)
@@ -266,6 +267,33 @@ npx npm-update-package \
   --log-level debug
 ```
 
+### outdatedPrStrategy
+
+What to do when outdated pull requests exist.
+
+|Name|Value|
+|---|---|
+|cli|`--outdated-pr-strategy`|
+|type|string|
+|required|false|
+|default|`recreate`|
+
+Allowed values:
+
+|Value|Description|
+|---|---|
+|`create`|Create new pull request.|
+|`recreate`|Close old pull requests and create new pull request.|
+|`skip`|Skip creating pull request.|
+
+Example:
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --outdated-pr-strategy create
+```
+
 ### packageManager
 
 Package manager of your project.  

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.57.0",
+    "version": "0.58.0",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -41,13 +41,13 @@
         "@types/parse-github-url": "1.0.0",
         "@types/semver": "7.3.9",
         "@typescript-eslint/eslint-plugin": "5.18.0",
-        "eslint": "8.12.0",
+        "eslint": "8.13.0",
         "eslint-config-standard-with-typescript": "21.0.1",
         "eslint-plugin-import": "2.26.0",
-        "eslint-plugin-jest": "26.1.3",
+        "eslint-plugin-jest": "26.1.4",
         "eslint-plugin-node": "11.1.0",
         "eslint-plugin-promise": "6.0.0",
-        "eslint-plugin-tsdoc": "0.2.15",
+        "eslint-plugin-tsdoc": "0.2.16",
         "husky": "7.0.4",
         "jest": "27.4.7",
         "lint-staged": "12.3.7",

package/dist/src/core/Create.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Create = void 0;
+const Either_1 = require("fp-ts/lib/Either");
+const git_1 = require("../git");
+const logger_1 = require("../logger");
+// TODO: Add test
+class Create {
+    constructor({ git, packageManager, pullRequestCreator, branchFinder, commitMessageCreator, packageUpdater }) {
+        this.git = git;
+        this.packageManager = packageManager;
+        this.pullRequestCreator = pullRequestCreator;
+        this.branchFinder = branchFinder;
+        this.commitMessageCreator = commitMessageCreator;
+        this.packageUpdater = packageUpdater;
+    }
+    async process(outdatedPackage) {
+        const branchName = (0, git_1.createBranchName)(outdatedPackage);
+        logger_1.logger.trace(`branchName=${branchName}`);
+        if (this.branchFinder.findByName(branchName) !== undefined) {
+            logger_1.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`);
+            return (0, Either_1.right)({
+                outdatedPackage,
+                skipped: true
+            });
+        }
+        const transaction = new git_1.GitTransaction({
+            git: this.git,
+            branchName,
+            files: [this.packageManager.packageFile, this.packageManager.lockFile]
+        });
+        return await transaction.run(async ({ git, branchName }) => {
+            try {
+                await this.packageUpdater.update(outdatedPackage);
+            }
+            catch (error) {
+                logger_1.logger.error(error);
+                return (0, Either_1.left)({
+                    outdatedPackage,
+                    error
+                });
+            }
+            logger_1.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
+            await git.add(this.packageManager.packageFile, this.packageManager.lockFile);
+            const message = this.commitMessageCreator.create(outdatedPackage);
+            logger_1.logger.trace(`message=${message}`);
+            await git.commit(message);
+            await git.push(branchName);
+            const pullRequest = await this.pullRequestCreator.create({
+                outdatedPackage,
+                branchName
+            });
+            logger_1.logger.trace(`pullRequest=${JSON.stringify(pullRequest)}`);
+            logger_1.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`);
+            return (0, Either_1.right)({
+                outdatedPackage,
+                created: true
+            });
+        });
+    }
+}
+exports.Create = Create;

package/dist/src/core/OutdatedPackageProcessor.js

@@ -1,76 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OutdatedPackageProcessor = void 0;
-const Either_1 = require("fp-ts/lib/Either");
-const git_1 = require("../git");
-const logger_1 = require("../logger");
-// TODO: Add test
-// TODO: Split into multiple classes and functions
-class OutdatedPackageProcessor {
-    constructor({ git, packageManager, pullRequestCreator, branchFinder, commitMessageCreator, pullRequestFinder, pullRequestsCloser, packageUpdater }) {
-        this.git = git;
-        this.packageManager = packageManager;
-        this.pullRequestCreator = pullRequestCreator;
-        this.branchFinder = branchFinder;
-        this.commitMessageCreator = commitMessageCreator;
-        this.pullRequestFinder = pullRequestFinder;
-        this.pullRequestsCloser = pullRequestsCloser;
-        this.packageUpdater = packageUpdater;
-    }
-    /**
-     * Don't run in parallel because it includes file operations.
-     */
-    async process(outdatedPackage) {
-        const branchName = (0, git_1.createBranchName)(outdatedPackage);
-        logger_1.logger.debug(`branchName=${branchName}`);
-        if (this.branchFinder.findByName(branchName) !== undefined) {
-            logger_1.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`);
-            return (0, Either_1.right)({
-                outdatedPackage,
-                skipped: true
-            });
-        }
-        await this.git.createBranch(branchName);
-        logger_1.logger.info(`${branchName} branch has created.`);
-        try {
-            try {
-                await this.packageUpdater.update(outdatedPackage);
-            }
-            catch (error) {
-                logger_1.logger.error(error);
-                return (0, Either_1.left)({
-                    outdatedPackage,
-                    error
-                });
-            }
-            logger_1.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
-            await this.git.add(this.packageManager.packageFile, this.packageManager.lockFile);
-            const message = this.commitMessageCreator.create(outdatedPackage);
-            logger_1.logger.debug(`message=${message}`);
-            await this.git.commit(message);
-            await this.git.push(branchName);
-            const pullRequest = await this.pullRequestCreator.create({
-                outdatedPackage,
-                branchName
-            });
-            logger_1.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`);
-            await this.closeOldPullRequests(outdatedPackage);
-            return (0, Either_1.right)({
-                outdatedPackage,
-                created: true
-            });
-        }
-        finally {
-            await this.git.restore(this.packageManager.packageFile, this.packageManager.lockFile);
-            await this.git.switch('-');
-            await this.git.removeBranch(branchName);
-            logger_1.logger.info(`${branchName} branch has removed.`);
-        }
-    }
-    async closeOldPullRequests(outdatedPackage) {
-        const pullRequests = this.pullRequestFinder.findByPackageName(outdatedPackage.name);
-        logger_1.logger.debug(`pullRequests=${JSON.stringify(pullRequests)}`);
-        await this.pullRequestsCloser.close(pullRequests);
-    }
-}
-exports.OutdatedPackageProcessor = OutdatedPackageProcessor;

package/dist/src/core/OutdatedPackageProcessorCreator.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OutdatedPackageProcessorCreator = void 0;
+const Create_1 = require("./Create");
+const OutdatedPullRequestStrategy_1 = require("./OutdatedPullRequestStrategy");
+const Recreate_1 = require("./Recreate");
+const Skip_1 = require("./Skip");
+// TODO: Add test
+class OutdatedPackageProcessorCreator {
+    constructor(options) {
+        this.options = options;
+    }
+    create({ git, packageManager, pullRequestCreator, branchFinder, commitMessageCreator, pullRequestFinder, pullRequestsCloser, packageUpdater }) {
+        switch (this.options.outdatedPrStrategy) {
+            case OutdatedPullRequestStrategy_1.OutdatedPullRequestStrategy.Create:
+                return new Create_1.Create({
+                    git,
+                    packageManager,
+                    pullRequestCreator,
+                    branchFinder,
+                    commitMessageCreator,
+                    packageUpdater
+                });
+            case OutdatedPullRequestStrategy_1.OutdatedPullRequestStrategy.Recreate:
+                return new Recreate_1.Recreate({
+                    git,
+                    packageManager,
+                    pullRequestCreator,
+                    branchFinder,
+                    commitMessageCreator,
+                    pullRequestFinder,
+                    pullRequestsCloser,
+                    packageUpdater
+                });
+            case OutdatedPullRequestStrategy_1.OutdatedPullRequestStrategy.Skip:
+                return new Skip_1.Skip({
+                    git,
+                    packageManager,
+                    pullRequestCreator,
+                    branchFinder,
+                    commitMessageCreator,
+                    pullRequestFinder,
+                    packageUpdater
+                });
+        }
+    }
+}
+exports.OutdatedPackageProcessorCreator = OutdatedPackageProcessorCreator;

package/dist/src/core/OutdatedPullRequestStrategy.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOutdatedPullRequestStrategy = exports.OutdatedPullRequestStrategy = void 0;
+exports.OutdatedPullRequestStrategy = {
+    Create: 'create',
+    Recreate: 'recreate',
+    Skip: 'skip'
+};
+const outdatedPullRequestStrategies = Object.values(exports.OutdatedPullRequestStrategy);
+const isOutdatedPullRequestStrategy = (value) => outdatedPullRequestStrategies.includes(value);
+exports.isOutdatedPullRequestStrategy = isOutdatedPullRequestStrategy;

package/dist/src/core/Recreate.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Recreate = void 0;
+const Either_1 = require("fp-ts/lib/Either");
+const git_1 = require("../git");
+const logger_1 = require("../logger");
+// TODO: Add test
+class Recreate {
+    constructor({ git, packageManager, pullRequestCreator, branchFinder, commitMessageCreator, packageUpdater, pullRequestFinder, pullRequestsCloser }) {
+        this.git = git;
+        this.packageManager = packageManager;
+        this.pullRequestCreator = pullRequestCreator;
+        this.branchFinder = branchFinder;
+        this.commitMessageCreator = commitMessageCreator;
+        this.packageUpdater = packageUpdater;
+        this.pullRequestFinder = pullRequestFinder;
+        this.pullRequestsCloser = pullRequestsCloser;
+    }
+    async process(outdatedPackage) {
+        const branchName = (0, git_1.createBranchName)(outdatedPackage);
+        logger_1.logger.trace(`branchName=${branchName}`);
+        if (this.branchFinder.findByName(branchName) !== undefined) {
+            logger_1.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`);
+            return (0, Either_1.right)({
+                outdatedPackage,
+                skipped: true
+            });
+        }
+        const transaction = new git_1.GitTransaction({
+            git: this.git,
+            branchName,
+            files: [this.packageManager.packageFile, this.packageManager.lockFile]
+        });
+        return await transaction.run(async ({ git, branchName }) => {
+            try {
+                await this.packageUpdater.update(outdatedPackage);
+            }
+            catch (error) {
+                logger_1.logger.error(error);
+                return (0, Either_1.left)({
+                    outdatedPackage,
+                    error
+                });
+            }
+            logger_1.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
+            await git.add(this.packageManager.packageFile, this.packageManager.lockFile);
+            const message = this.commitMessageCreator.create(outdatedPackage);
+            logger_1.logger.trace(`message=${message}`);
+            await git.commit(message);
+            await git.push(branchName);
+            const pullRequest = await this.pullRequestCreator.create({
+                outdatedPackage,
+                branchName
+            });
+            logger_1.logger.trace(`pullRequest=${JSON.stringify(pullRequest)}`);
+            logger_1.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`);
+            const pullRequests = this.pullRequestFinder.findByPackageName(outdatedPackage.name);
+            logger_1.logger.trace(`pullRequests=${JSON.stringify(pullRequests)}`);
+            await this.pullRequestsCloser.close(pullRequests);
+            return (0, Either_1.right)({
+                outdatedPackage,
+                created: true
+            });
+        });
+    }
+}
+exports.Recreate = Recreate;

package/dist/src/core/Skip.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Skip = void 0;
+const Either_1 = require("fp-ts/lib/Either");
+const git_1 = require("../git");
+const logger_1 = require("../logger");
+// TODO: Add test
+class Skip {
+    constructor({ git, packageManager, pullRequestCreator, branchFinder, commitMessageCreator, packageUpdater, pullRequestFinder }) {
+        this.git = git;
+        this.packageManager = packageManager;
+        this.pullRequestCreator = pullRequestCreator;
+        this.branchFinder = branchFinder;
+        this.commitMessageCreator = commitMessageCreator;
+        this.packageUpdater = packageUpdater;
+        this.pullRequestFinder = pullRequestFinder;
+    }
+    async process(outdatedPackage) {
+        const branchName = (0, git_1.createBranchName)(outdatedPackage);
+        logger_1.logger.trace(`branchName=${branchName}`);
+        if (this.branchFinder.findByName(branchName) !== undefined) {
+            logger_1.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`);
+            return (0, Either_1.right)({
+                outdatedPackage,
+                skipped: true
+            });
+        }
+        const pullRequests = this.pullRequestFinder.findByPackageName(outdatedPackage.name);
+        logger_1.logger.trace(`pullRequests=${JSON.stringify(pullRequests)}`);
+        if (pullRequests.length > 0) {
+            logger_1.logger.info(`Skip ${outdatedPackage.name} because outdated pull requests exist.`);
+            return (0, Either_1.right)({
+                outdatedPackage,
+                skipped: true
+            });
+        }
+        const transaction = new git_1.GitTransaction({
+            git: this.git,
+            branchName,
+            files: [this.packageManager.packageFile, this.packageManager.lockFile]
+        });
+        return await transaction.run(async ({ git, branchName }) => {
+            try {
+                await this.packageUpdater.update(outdatedPackage);
+            }
+            catch (error) {
+                logger_1.logger.error(error);
+                return (0, Either_1.left)({
+                    outdatedPackage,
+                    error
+                });
+            }
+            logger_1.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
+            await git.add(this.packageManager.packageFile, this.packageManager.lockFile);
+            const message = this.commitMessageCreator.create(outdatedPackage);
+            logger_1.logger.trace(`message=${message}`);
+            await git.commit(message);
+            await git.push(branchName);
+            const pullRequest = await this.pullRequestCreator.create({
+                outdatedPackage,
+                branchName
+            });
+            logger_1.logger.trace(`pullRequest=${JSON.stringify(pullRequest)}`);
+            logger_1.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`);
+            return (0, Either_1.right)({
+                outdatedPackage,
+                created: true
+            });
+        });
+    }
+}
+exports.Skip = Skip;

package/dist/src/core/index.js

@@ -17,6 +17,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./FailedResult"), exports);
 __exportStar(require("./OutdatedPackage"), exports);
 __exportStar(require("./OutdatedPackageProcessor"), exports);
+__exportStar(require("./OutdatedPackageProcessorCreator"), exports);
 __exportStar(require("./OutdatedPackagesProcessor"), exports);
+__exportStar(require("./OutdatedPullRequestStrategy"), exports);
 __exportStar(require("./PackageUpdater"), exports);
 __exportStar(require("./SucceededResult"), exports);

package/dist/src/git/GitTransaction.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitTransaction = void 0;
+const logger_1 = require("../logger");
+// TODO: Add test
+class GitTransaction {
+    constructor({ git, branchName, files }) {
+        this.git = git;
+        this.branchName = branchName;
+        this.files = files;
+    }
+    async run(operation) {
+        await this.git.createBranch(this.branchName);
+        logger_1.logger.info(`${this.branchName} branch has created.`);
+        try {
+            return await operation({
+                git: this.git,
+                branchName: this.branchName,
+                files: this.files
+            });
+        }
+        finally {
+            await this.rollback();
+        }
+    }
+    async rollback() {
+        await this.git.restore(...this.files);
+        await this.git.switch('-');
+        await this.git.removeBranch(this.branchName);
+        logger_1.logger.info(`${this.branchName} branch has removed.`);
+    }
+}
+exports.GitTransaction = GitTransaction;

package/dist/src/git/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./createBranchName"), exports);
 __exportStar(require("./Git"), exports);
 __exportStar(require("./GitConfigInitializer"), exports);
 __exportStar(require("./GitRepository"), exports);
+__exportStar(require("./GitTransaction"), exports);

package/dist/src/main.js

@@ -102,7 +102,8 @@ const main = async (options) => {
         packageManager,
         ncu
     });
-    const outdatedPackageProcessor = new core_1.OutdatedPackageProcessor({
+    const outdatedPackageProcessorCreator = new core_1.OutdatedPackageProcessorCreator(options);
+    const outdatedPackageProcessor = outdatedPackageProcessorCreator.create({
         git,
         packageManager,
         pullRequestCreator,

package/dist/src/options/Options.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isOptions = void 0;
 const io_ts_1 = require("io-ts");
+const core_1 = require("../core");
 const logger_1 = require("../logger");
 const package_manager_1 = require("../package-manager");
 const Options = (0, io_ts_1.intersection)([
@@ -19,6 +20,11 @@ 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)
         ]),
+        outdatedPrStrategy: (0, io_ts_1.union)([
+            (0, io_ts_1.literal)(core_1.OutdatedPullRequestStrategy.Create),
+            (0, io_ts_1.literal)(core_1.OutdatedPullRequestStrategy.Recreate),
+            (0, io_ts_1.literal)(core_1.OutdatedPullRequestStrategy.Skip)
+        ]),
         prBodyGithubHost: io_ts_1.string,
         prTitle: io_ts_1.string
     }),

package/dist/src/options/cliOptions.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cliOptions = void 0;
+const core_1 = require("../core");
 const logger_1 = require("../logger");
 const package_manager_1 = require("../package-manager");
 const OptionType_1 = require("./OptionType");
@@ -78,6 +79,18 @@ exports.cliOptions = [
         ],
         default: logger_1.LogLevel.Info
     },
+    {
+        name: 'outdated-pr-strategy',
+        description: 'What to do when outdated pull requests exist',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        choices: [
+            core_1.OutdatedPullRequestStrategy.Create,
+            core_1.OutdatedPullRequestStrategy.Recreate,
+            core_1.OutdatedPullRequestStrategy.Skip
+        ],
+        default: core_1.OutdatedPullRequestStrategy.Recreate
+    },
     {
         name: 'package-manager',
         description: 'Package manager of your project',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.57.0",
+  "version": "0.58.0",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -41,13 +41,13 @@
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
     "@typescript-eslint/eslint-plugin": "5.18.0",
-    "eslint": "8.12.0",
+    "eslint": "8.13.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jest": "26.1.3",
+    "eslint-plugin-jest": "26.1.4",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.0.0",
-    "eslint-plugin-tsdoc": "0.2.15",
+    "eslint-plugin-tsdoc": "0.2.16",
     "husky": "7.0.4",
     "jest": "27.4.7",
     "lint-staged": "12.3.7",