npm-update-package 0.21.0 → 0.22.0

package/README.md

@@ -14,20 +14,7 @@ npx npm-update-package --github-token $GITHUB_TOKEN
 ## Options
 
 You can customize behavior via command-line options.  
-Template strings such as `--branch-name` can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
-
-### `--branch-name`
-
-Branch name template
-
-- type: string
-- variables:
-  - `currentVersion`
-  - `newVersion`
-  - `packageName`
-  - `updateType`
-- required: false
-- default: `npm-update-package/{{{packageName}}}/v{{newVersion}}`
+Template strings such as `--commit-message` can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
 
 ### `--commit-message`
 
@@ -73,13 +60,6 @@ Package manager of your project
 - required: false
 - default: `npm`
 
-### `--pull-request-labels`
-
-Pull request labels
-
-- type: string array
-- required: false
-
 ### `--pull-request-title`
 
 Pull request title template
@@ -138,6 +118,9 @@ if (All packages are up-to-date) then (yes)
 else (no)
 endif
 
+:Get remote branches;
+:Get pull requests;
+
 group OutdatedPackagesProcessor
 repeat
   group OutdatedPackageProcessor
@@ -146,6 +129,7 @@ repeat
     :Create branch;
     :Update package;
     :Create pull request;
+    :Close old pull requests;
     :Remove branch;
   endif
   end group
@@ -158,7 +142,7 @@ end
 ```
 -->
 
-[![](http://www.plantuml.com/plantuml/svg/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)](http://www.plantuml.com/plantuml/uml/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)
+[![](http://www.plantuml.com/plantuml/svg/RL0nKiCm4Epl5LlQHJuGDs4ew23330yGzYRs85j2Ea7uFNPanoP38vtsLhUxTuXgWgRUohMGSt39epVT8FidAbpInYWRU5D_c3DZ9TATK3nOUuDW0f7yJjrkufRGbWEA7yPI00wDq4QY65mfuwixIPuTs3ibteCPwdQSd56Vh4NWPsBK4PiTlSm-ZhFcCRYQCReWWPv61VYNkFA0oVVhLXEyTAF8dU7LB03i7mFDxKULiJS_QImBgBR4F_wNZdMHSBQv2vUxawMlhS1rH_dEeUQC-6uxInJFlEYYlKIGbRoMKoM7yKYz_GK0)](http://www.plantuml.com/plantuml/uml/RL0nKiCm4Epl5LlQHJuGDs4ew23330yGzYRs85j2Ea7uFNPanoP38vtsLhUxTuXgWgRUohMGSt39epVT8FidAbpInYWRU5D_c3DZ9TATK3nOUuDW0f7yJjrkufRGbWEA7yPI00wDq4QY65mfuwixIPuTs3ibteCPwdQSd56Vh4NWPsBK4PiTlSm-ZhFcCRYQCReWWPv61VYNkFA0oVVhLXEyTAF8dU7LB03i7mFDxKULiJS_QImBgBR4F_wNZdMHSBQv2vUxawMlhS1rH_dEeUQC-6uxInJFlEYYlKIGbRoMKoM7yKYz_GK0)
 
 ## FAQ
 

package/dist/app.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.app = void 0;
 exports.app = {
     name: 'npm-update-package',
-    version: '0.21.0',
+    version: '0.22.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/git/BranchNameCreator.js

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BranchNameCreator = void 0;
 const mustache_1 = require("mustache");
 class BranchNameCreator {
-    constructor(template) {
-        this.template = template;
+    constructor() {
+        this.template = 'npm-update-package/{{{packageName}}}/v{{newVersion}}';
     }
     create(outdatedPackage) {
         const packageName = outdatedPackage.name;

package/dist/github/CreatedPullRequest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/github/GitHub.js

@@ -10,12 +10,30 @@ class GitHub {
         const { data } = await this.octokit.issues.addLabels(params);
         return data;
     }
+    async closePullRequest(params) {
+        await this.octokit.pulls.update({
+            ...params,
+            state: 'closed'
+        });
+    }
     async createPullRequest(params) {
         const { data } = await this.octokit.pulls.create(params);
         return data;
     }
+    // TODO: fetch all branches with page option
     async fetchBranches(params) {
-        const { data } = await this.octokit.repos.listBranches(params);
+        const { data } = await this.octokit.repos.listBranches({
+            ...params,
+            per_page: 100
+        });
+        return data;
+    }
+    // TODO: fetch all pull requests with page option
+    async fetchPullRequests(params) {
+        const { data } = await this.octokit.pulls.list({
+            ...params,
+            per_page: 100
+        });
         return data;
     }
     async fetchRepository(params) {

package/dist/github/PullRequestBodyCreator.js

@@ -11,6 +11,30 @@ class PullRequestBodyCreator {
 |---|---|---|---|
 |[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
 
+<details>
+<summary>Metadata</summary>
+
+**Don't remove or edit this section because it will be used by npm-update-package.**
+
+<div id="npm-update-package-metadata">
+
+\`\`\`json
+{
+  "version": "{{appVersion}}",
+  "packages": [
+    {
+      "name": "{{{packageName}}}",
+      "type": "{{updateType}}",
+      "currentVersion": "{{currentVersion}}",
+      "newVersion": "{{newVersion}}"
+    }
+  ]
+}
+\`\`\`
+
+</div>
+</details>
+
 ---
 This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`;
     }

package/dist/github/PullRequestCloser.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestCloser = void 0;
+// TODO: Add test
+class PullRequestCloser {
+    constructor(github) {
+        this.github = github;
+    }
+    async close(pullRequest) {
+        await this.github.closePullRequest({
+            owner: pullRequest.base.repo.owner.login,
+            repo: pullRequest.base.repo.name,
+            pull_number: pullRequest.number
+        });
+    }
+}
+exports.PullRequestCloser = PullRequestCloser;

package/dist/github/PullRequestCreator.js

@@ -2,14 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCreator = void 0;
 class PullRequestCreator {
-    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger, labels }) {
+    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger }) {
         this.github = github;
         this.gitRepo = gitRepo;
         this.githubRepo = githubRepo;
         this.pullRequestTitleCreator = pullRequestTitleCreator;
         this.pullRequestBodyCreator = pullRequestBodyCreator;
         this.logger = logger;
-        this.labels = labels;
     }
     async create({ outdatedPackage, branchName }) {
         const title = this.pullRequestTitleCreator.create(outdatedPackage);
@@ -25,16 +24,13 @@ class PullRequestCreator {
             body
         });
         this.logger.debug(`pullRequest=${JSON.stringify(pullRequest)}`);
-        if (this.labels !== undefined) {
-            const labels = await this.github.addLabels({
-                owner: this.gitRepo.owner,
-                repo: this.gitRepo.name,
-                issue_number: pullRequest.number,
-                labels: this.labels
-            });
-            this.logger.debug(`labels=${JSON.stringify(labels)}`);
-        }
-        this.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`);
+        await this.github.addLabels({
+            owner: this.gitRepo.owner,
+            repo: this.gitRepo.name,
+            issue_number: pullRequest.number,
+            labels: ['npm-update-package']
+        });
+        return pullRequest;
     }
 }
 exports.PullRequestCreator = PullRequestCreator;

package/dist/github/PullRequestFinder.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestFinder = void 0;
+const extractPullRequestMetadata_1 = require("./extractPullRequestMetadata");
+const isPullRequestByNpmUpdatePackage_1 = require("./isPullRequestByNpmUpdatePackage");
+// TODO: Add test
+class PullRequestFinder {
+    constructor(pullRequests) {
+        this.pullRequests = pullRequests;
+    }
+    findByPackageName(packageName) {
+        return this.pullRequests
+            .filter(isPullRequestByNpmUpdatePackage_1.isPullRequestByNpmUpdatePackage)
+            .filter(({ body }) => {
+            if (body === null) {
+                return false;
+            }
+            const metadata = (0, extractPullRequestMetadata_1.extractPullRequestMetadata)(body);
+            if (metadata === undefined) {
+                return false;
+            }
+            return metadata.packages.some(({ name }) => name === packageName);
+        });
+    }
+}
+exports.PullRequestFinder = PullRequestFinder;

package/dist/github/PullRequestMetadata.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPullRequestMetadata = void 0;
+const io_ts_1 = require("io-ts");
+const ncu_1 = require("../ncu");
+const PullRequestMetadata = (0, io_ts_1.type)({
+    version: io_ts_1.string,
+    packages: (0, io_ts_1.array)((0, io_ts_1.type)({
+        name: io_ts_1.string,
+        currentVersion: io_ts_1.string,
+        newVersion: io_ts_1.string,
+        type: (0, io_ts_1.union)([(0, io_ts_1.literal)(ncu_1.UpdateType.Major), (0, io_ts_1.literal)(ncu_1.UpdateType.Minor), (0, io_ts_1.literal)(ncu_1.UpdateType.Patch)])
+    }))
+});
+exports.isPullRequestMetadata = PullRequestMetadata.is;

package/dist/github/extractPullRequestMetadata.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractPullRequestMetadata = void 0;
+const PullRequestMetadata_1 = require("./PullRequestMetadata");
+const extractPullRequestMetadata = (pullRequestBody) => {
+    const matched = pullRequestBody.match(/<div id="npm-update-package-metadata">\s*```json\s*([\s\S]+?)\s*```\s*<\/div>/);
+    const json = matched === null || matched === void 0 ? void 0 : matched[1];
+    if (json === undefined) {
+        return undefined;
+    }
+    const metadata = JSON.parse(json);
+    if (!(0, PullRequestMetadata_1.isPullRequestMetadata)(metadata)) {
+        return undefined;
+    }
+    return metadata;
+};
+exports.extractPullRequestMetadata = extractPullRequestMetadata;

package/dist/github/index.js

@@ -1,14 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteBranchExistenceChecker = exports.PullRequestTitleCreator = exports.PullRequestCreator = exports.PullRequestBodyCreator = exports.GitHub = exports.createGitHub = void 0;
+exports.RemoteBranchExistenceChecker = exports.PullRequestTitleCreator = exports.PullRequestFinder = exports.PullRequestCreator = exports.PullRequestBodyCreator = exports.PullRequestCloser = exports.GitHub = exports.createGitHub = void 0;
 var createGitHub_1 = require("./createGitHub");
 Object.defineProperty(exports, "createGitHub", { enumerable: true, get: function () { return createGitHub_1.createGitHub; } });
 var GitHub_1 = require("./GitHub");
 Object.defineProperty(exports, "GitHub", { enumerable: true, get: function () { return GitHub_1.GitHub; } });
+var PullRequestCloser_1 = require("./PullRequestCloser");
+Object.defineProperty(exports, "PullRequestCloser", { enumerable: true, get: function () { return PullRequestCloser_1.PullRequestCloser; } });
 var PullRequestBodyCreator_1 = require("./PullRequestBodyCreator");
 Object.defineProperty(exports, "PullRequestBodyCreator", { enumerable: true, get: function () { return PullRequestBodyCreator_1.PullRequestBodyCreator; } });
 var PullRequestCreator_1 = require("./PullRequestCreator");
 Object.defineProperty(exports, "PullRequestCreator", { enumerable: true, get: function () { return PullRequestCreator_1.PullRequestCreator; } });
+var PullRequestFinder_1 = require("./PullRequestFinder");
+Object.defineProperty(exports, "PullRequestFinder", { enumerable: true, get: function () { return PullRequestFinder_1.PullRequestFinder; } });
 var PullRequestTitleCreator_1 = require("./PullRequestTitleCreator");
 Object.defineProperty(exports, "PullRequestTitleCreator", { enumerable: true, get: function () { return PullRequestTitleCreator_1.PullRequestTitleCreator; } });
 var RemoteBranchExistenceChecker_1 = require("./RemoteBranchExistenceChecker");

package/dist/github/isPullRequestByNpmUpdatePackage.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPullRequestByNpmUpdatePackage = void 0;
+const isPullRequestByNpmUpdatePackage = (pullRequest) => {
+    return pullRequest.labels.some(({ name }) => name === 'npm-update-package');
+};
+exports.isPullRequestByNpmUpdatePackage = isPullRequestByNpmUpdatePackage;

package/dist/main.js

@@ -50,6 +50,11 @@ const main = async ({ options, logger }) => {
         repo: gitRepo.name
     });
     logger.debug(`remoteBranches=${JSON.stringify(remoteBranches)}`);
+    const pullRequests = await github.fetchPullRequests({
+        owner: gitRepo.owner,
+        repo: gitRepo.name
+    });
+    logger.debug(`pullRequests=${JSON.stringify(pullRequests)}`);
     const remoteBranchExistenceChecker = github_1.RemoteBranchExistenceChecker.of(remoteBranches);
     const packageManager = (0, package_manager_1.createPackageManager)({
         terminal,
@@ -63,11 +68,12 @@ const main = async ({ options, logger }) => {
         githubRepo,
         pullRequestTitleCreator,
         pullRequestBodyCreator,
-        logger,
-        labels: options.pullRequestLabels
+        logger
     });
-    const branchNameCreator = new git_1.BranchNameCreator(options.branchName);
+    const branchNameCreator = new git_1.BranchNameCreator();
     const commitMessageCreator = new git_1.CommitMessageCreator(options.commitMessage);
+    const pullRequestFinder = new github_1.PullRequestFinder(pullRequests);
+    const pullRequestCloser = new github_1.PullRequestCloser(github);
     const outdatedPackageProcessor = new processors_1.OutdatedPackageProcessor({
         git,
         ncu,
@@ -76,7 +82,9 @@ const main = async ({ options, logger }) => {
         remoteBranchExistenceChecker,
         logger,
         branchNameCreator,
-        commitMessageCreator
+        commitMessageCreator,
+        pullRequestFinder,
+        pullRequestCloser
     });
     const outdatedPackagesProcessor = new processors_1.OutdatedPackagesProcessor({
         outdatedPackageProcessor,

package/dist/options/Options.js

@@ -4,17 +4,11 @@ exports.isOptions = void 0;
 const io_ts_1 = require("io-ts");
 const logger_1 = require("../logger");
 const package_manager_1 = require("../package-manager");
-const Options = (0, io_ts_1.intersection)([
-    (0, io_ts_1.type)({
-        branchName: io_ts_1.string,
-        commitMessage: io_ts_1.string,
-        githubToken: io_ts_1.string,
-        logLevel: (0, io_ts_1.union)([(0, io_ts_1.literal)(logger_1.LogLevel.Off), (0, io_ts_1.literal)(logger_1.LogLevel.Error), (0, io_ts_1.literal)(logger_1.LogLevel.Info), (0, io_ts_1.literal)(logger_1.LogLevel.Debug)]),
-        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)]),
-        pullRequestTitle: io_ts_1.string
-    }),
-    (0, io_ts_1.partial)({
-        pullRequestLabels: (0, io_ts_1.array)(io_ts_1.string)
-    })
-]);
+const Options = (0, io_ts_1.type)({
+    commitMessage: io_ts_1.string,
+    githubToken: io_ts_1.string,
+    logLevel: (0, io_ts_1.union)([(0, io_ts_1.literal)(logger_1.LogLevel.Off), (0, io_ts_1.literal)(logger_1.LogLevel.Error), (0, io_ts_1.literal)(logger_1.LogLevel.Info), (0, io_ts_1.literal)(logger_1.LogLevel.Debug)]),
+    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)]),
+    pullRequestTitle: io_ts_1.string
+});
 exports.isOptions = Options.is;

package/dist/options/cliOptions.js

@@ -5,13 +5,6 @@ const logger_1 = require("../logger");
 const package_manager_1 = require("../package-manager");
 const OptionType_1 = require("./OptionType");
 exports.cliOptions = [
-    {
-        name: 'branch-name',
-        description: 'Branch name template',
-        type: OptionType_1.OptionType.String,
-        required: false,
-        default: 'npm-update-package/{{{packageName}}}/v{{newVersion}}'
-    },
     {
         name: 'commit-message',
         description: 'Commit message template',
@@ -49,12 +42,6 @@ exports.cliOptions = [
         ],
         default: package_manager_1.PackageManagerName.Npm
     },
-    {
-        name: 'pull-request-labels',
-        description: 'Pull request labels',
-        type: OptionType_1.OptionType.StringArray,
-        required: false
-    },
     {
         name: 'pull-request-title',
         description: 'Pull request title template',

package/dist/processors/OutdatedPackageProcessor.js

@@ -4,7 +4,7 @@ exports.OutdatedPackageProcessor = void 0;
 const Either_1 = require("fp-ts/lib/Either");
 // TODO: add test
 class OutdatedPackageProcessor {
-    constructor({ git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger, branchNameCreator, commitMessageCreator }) {
+    constructor({ git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger, branchNameCreator, commitMessageCreator, pullRequestFinder, pullRequestCloser }) {
         this.git = git;
         this.ncu = ncu;
         this.packageManager = packageManager;
@@ -13,6 +13,8 @@ class OutdatedPackageProcessor {
         this.logger = logger;
         this.branchNameCreator = branchNameCreator;
         this.commitMessageCreator = commitMessageCreator;
+        this.pullRequestFinder = pullRequestFinder;
+        this.pullRequestCloser = pullRequestCloser;
     }
     /**
      * Don't run in parallel because it includes file operations.
@@ -50,10 +52,17 @@ class OutdatedPackageProcessor {
             this.logger.debug(`message=${message}`);
             await this.git.commit(message);
             await this.git.push(branchName);
-            await this.pullRequestCreator.create({
+            const pullRequest = await this.pullRequestCreator.create({
                 outdatedPackage,
                 branchName
             });
+            this.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`);
+            const pullRequests = this.pullRequestFinder.findByPackageName(outdatedPackage.name);
+            this.logger.debug(`pullRequests=${JSON.stringify(pullRequests)}`);
+            await Promise.all(pullRequests.map(async (pullRequest) => {
+                await this.pullRequestCloser.close(pullRequest);
+                this.logger.info(`Pull request for ${outdatedPackage.name} has closed. ${pullRequest.html_url}`);
+            }));
             return (0, Either_1.right)({
                 outdatedPackage,
                 updated: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.21.0",
+  "version": "0.22.0",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -46,8 +46,8 @@
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-tsdoc": "0.2.14",
     "husky": "7.0.4",
-    "jest": "27.4.6",
-    "lint-staged": "12.1.5",
+    "jest": "27.4.7",
+    "lint-staged": "12.1.7",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
     "ts-jest": "27.1.2",