npm-update-package 0.16.2 → 0.18.0

package/README.md

@@ -11,35 +11,6 @@ CLI tool for creating pull request to update npm packages
 npx npm-update-package --github-token $GITHUB_TOKEN
 ```
 
-## Examples
-
-Example of running npm-update-package on GitHub Actions at 0:00 (UTC) every day:
-
-```yaml
-name: npm-update-package
-on:
-  schedule:
-    - cron: '0 0 * * *'
-jobs:
-  npm-update-package:
-    runs-on: ubuntu-latest
-    steps:
-      - 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
-        env:
-          GIT_USER_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
-          GIT_USER_NAME: github-actions[bot]
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
-
-Actual working examples can be seen in these repositories.
-
-- [npm-update-package/example-npm](https://github.com/npm-update-package/example-npm)
-
 ## Options
 
 You can customize behavior via command-line options.  
@@ -129,6 +100,13 @@ This PR updates these packages:
 This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}
 ```
 
+### `--pull-request-labels`
+
+Pull request labels
+
+- type: string array
+- required: false
+
 ### `--pull-request-title`
 
 Pull request title template
@@ -142,8 +120,79 @@ Pull request title template
 - required: false
 - default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`
 
+## Examples
+
+Example of running npm-update-package on GitHub Actions at 0:00 (UTC) every day:
+
+```yaml
+name: npm-update-package
+on:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  npm-update-package:
+    runs-on: ubuntu-latest
+    steps:
+      - 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
+        env:
+          GIT_USER_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
+          GIT_USER_NAME: github-actions[bot]
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+Actual working examples can be seen in these repositories.
+
+- [npm-update-package/example-npm](https://github.com/npm-update-package/example-npm)
+
+## Flow
+
+The following shows the process flow of npm-update-package:
+
+[![](http://www.plantuml.com/plantuml/svg/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)](http://www.plantuml.com/plantuml/uml/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)
+
+<!--
+```plantuml
+@startuml
+start
+group main
+:Get outdated packages;
+
+if (All packages are up-to-date) then (yes)
+  end
+else (no)
+endif
+
+group OutdatedPackagesProcessor
+repeat
+  group OutdatedPackageProcessor
+  if (Remote branch exists) then (yes)
+  else (no)
+    :Create branch;
+    :Update package;
+    :Create pull request;
+    :Remove branch;
+  endif
+  end group
+repeat while (Next package exists)
+end group
+
+end group
+end
+@enduml
+```
+-->
+
 ## FAQ
 
+### What is the purpose of npm-update-package?
+
+npm-update-package can be used in environments where Renovate cannot be used for some reason.
+
 ### Conflicts have occurred in PR. What should I do?
 
 If conflicts have occurred in PR, close it and run npm-update-package again.

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.16.2',
+    version: '0.18.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/github/GitHub.js

@@ -6,6 +6,10 @@ class GitHub {
     constructor(octokit) {
         this.octokit = octokit;
     }
+    async addLabels(params) {
+        const { data } = await this.octokit.issues.addLabels(params);
+        return data;
+    }
     async createPullRequest(params) {
         const { data } = await this.octokit.pulls.create(params);
         return data;

package/dist/github/Label.js

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

package/dist/github/PullRequestCreator.js

@@ -2,13 +2,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCreator = void 0;
 class PullRequestCreator {
-    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger }) {
+    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger, labels }) {
         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);
@@ -24,6 +25,15 @@ 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}`);
     }
 }

package/dist/main.js

@@ -59,7 +59,8 @@ const main = async ({ options, logger }) => {
         githubRepo,
         pullRequestTitleCreator,
         pullRequestBodyCreator,
-        logger
+        logger,
+        labels: options.pullRequestLabels
     });
     const branchNameCreator = new git_1.BranchNameCreator(options.branchName);
     const commitMessageCreator = new git_1.CommitMessageCreator(options.commitMessage);

package/dist/ncu/NcuResultConverter.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NcuResultConverter = void 0;
+const type_guards_1 = require("type-guards");
 const PackageVersion_1 = require("./PackageVersion");
 const toUpdateType_1 = require("./toUpdateType");
 // TODO: add test
@@ -9,18 +10,28 @@ class NcuResultConverter {
         this.currentDependencies = currentDependencies;
     }
     toOutdatedPackages(result) {
-        return Object.entries(result)
-            .map(([name, newVersion]) => ({
-            name,
-            currentVersion: PackageVersion_1.PackageVersion.of(this.currentDependencies[name]),
-            newVersion: PackageVersion_1.PackageVersion.of(newVersion)
-        }))
-            .map(({ name, currentVersion, newVersion }) => ({
-            name,
-            currentVersion,
-            newVersion,
-            type: (0, toUpdateType_1.toUpdateType)(currentVersion, newVersion)
-        }));
+        const resultEntries = Object.entries(result);
+        const outdatedPackages = resultEntries
+            .map(([name, newVersionString]) => {
+            const currentVersionString = this.currentDependencies[name];
+            if (currentVersionString === undefined) {
+                return undefined;
+            }
+            const currentVersion = PackageVersion_1.PackageVersion.of(currentVersionString);
+            const newVersion = PackageVersion_1.PackageVersion.of(newVersionString);
+            const type = (0, toUpdateType_1.toUpdateType)(currentVersion, newVersion);
+            return {
+                name,
+                currentVersion,
+                newVersion,
+                type
+            };
+        })
+            .filter(type_guards_1.isNotUndefined);
+        if (resultEntries.length !== outdatedPackages.length) {
+            throw new Error('Failed to convert to outdatedPackages from NcuResult.');
+        }
+        return outdatedPackages;
     }
 }
 exports.NcuResultConverter = NcuResultConverter;

package/dist/options/Options.js

@@ -4,13 +4,18 @@ 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.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)]),
-    pullRequestBody: io_ts_1.string,
-    pullRequestTitle: io_ts_1.string
-});
+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)]),
+        pullRequestBody: io_ts_1.string,
+        pullRequestTitle: io_ts_1.string
+    }),
+    (0, io_ts_1.partial)({
+        pullRequestLabels: (0, io_ts_1.array)(io_ts_1.string)
+    })
+]);
 exports.isOptions = Options.is;

package/dist/options/cliOptions.js

@@ -63,6 +63,12 @@ exports.cliOptions = [
 ---
 This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`
     },
+    {
+        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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.16.2",
+  "version": "0.18.0",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -26,21 +26,22 @@
     "mustache": "4.1.0",
     "npm-check-updates": "12.0.5",
     "parse-github-url": "1.0.2",
-    "semver": "7.3.5"
+    "semver": "7.3.5",
+    "type-guards": "0.15.0"
   },
   "devDependencies": {
     "@jest/types": "27.0.6",
-    "@tsconfig/node12": "1.0.9",
+    "@tsconfig/node14": "1.0.1",
     "@types/jest": "27.0.3",
     "@types/mustache": "4.1.2",
-    "@types/node": "12.20.15",
+    "@types/node": "14.18.3",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.8.0",
+    "@typescript-eslint/eslint-plugin": "5.8.1",
     "eslint": "8.5.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.3",
-    "eslint-plugin-jest": "25.3.0",
+    "eslint-plugin-jest": "25.3.2",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-tsdoc": "0.2.14",