npm-update-package 0.54.0 → 0.55.0

package/README.md

@@ -26,6 +26,7 @@ CLI tool for creating pull requests to update npm packages
   - [ignorePackages](#ignorepackages)
   - [logLevel](#loglevel)
   - [packageManager](#packagemanager)
+  - [prBodyGithubHost](#prbodygithubhost)
   - [prBodyNotes](#prbodynotes)
   - [prTitle](#prtitle)
   - [reviewers](#reviewers)
@@ -34,7 +35,6 @@ CLI tool for creating pull requests to update npm packages
   - [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)
@@ -271,6 +271,25 @@ npx npm-update-package \
   --package-manager yarn
 ```
 
+### prBodyGithubHost
+
+GitHub host of pull request body.
+
+|Name|Value|
+|---|---|
+|cli|`--pr-body-github-host`|
+|type|string|
+|required|false|
+|default|`togithub.com`|
+
+Example:
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --pr-body-github-host "github.example"
+```
+
 ### prBodyNotes
 
 Additional notes for Pull request body.
@@ -455,41 +474,6 @@ jobs:
 
 See working example on [example-pat](https://github.com/npm-update-package/example-pat).
 
-### Use Yarn
-
-```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
-      - name: Generate token
-        id: generate_token
-        uses: tibdex/github-app-token@v1
-        with:
-          app_id: ${{ secrets.APP_ID }}
-          private_key: ${{ secrets.PRIVATE_KEY }}
-      - run: |
-          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
-          # TODO: Replace with your GitHub App's user name
-          GIT_USER_NAME: npm-update-package[bot]
-          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.54.0",
+    "version": "0.55.0",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -20,11 +20,10 @@
         "fp-ts": "2.11.9",
         "http-status-codes": "2.2.0",
         "io-ts": "2.2.16",
-        "lodash": "4.14.2",
         "log4js": "6.4.4",
         "mustache": "4.1.0",
         "node-fetch": "2.6.7",
-        "npm-check-updates": "12.5.5",
+        "npm-check-updates": "12.5.7",
         "parse-github-url": "1.0.2",
         "semver": "7.3.5",
         "sleep-promise": "9.1.0",
@@ -34,13 +33,12 @@
         "@jest/types": "27.4.2",
         "@tsconfig/node12": "1.0.9",
         "@types/jest": "27.4.1",
-        "@types/lodash": "4.14.181",
         "@types/mustache": "4.1.2",
         "@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.17.0",
+        "@typescript-eslint/eslint-plugin": "5.18.0",
         "eslint": "8.12.0",
         "eslint-config-standard-with-typescript": "21.0.1",
         "eslint-plugin-import": "2.25.4",

package/dist/src/github/GitHub.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GitHub = void 0;
-const lodash_1 = require("lodash");
+const number_1 = require("../number");
 class GitHub {
     constructor(octokit) {
         this.octokit = octokit;
@@ -59,7 +59,7 @@ class GitHub {
     }
     async fetchBranches({ owner, repo }) {
         const branches = [];
-        for (const page of (0, lodash_1.range)(1, 11)) {
+        for (const page of (0, number_1.range)(1, 11)) {
             const { data } = await this.octokit.repos.listBranches({
                 owner,
                 repo,
@@ -83,7 +83,7 @@ class GitHub {
     }
     async fetchPullRequests({ owner, repo }) {
         const pullRequests = [];
-        for (const page of (0, lodash_1.range)(1, 11)) {
+        for (const page of (0, number_1.range)(1, 11)) {
             const { data } = await this.octokit.pulls.list({
                 owner,
                 repo,

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

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHubUrlOptimizer = void 0;
+const url_1 = require("url");
+class GitHubUrlOptimizer {
+    constructor(options) {
+        this.options = options;
+    }
+    /**
+     * Convert URL to prevent linking to other repositories.
+     */
+    optimize(url) {
+        const newUrl = url instanceof url_1.URL ? url : new url_1.URL(url);
+        if (newUrl.host === 'github.com') {
+            newUrl.host = this.options.prBodyGithubHost;
+        }
+        return newUrl;
+    }
+}
+exports.GitHubUrlOptimizer = GitHubUrlOptimizer;

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageDiffsSectionCreator = void 0;
+class PackageDiffsSectionCreator {
+    constructor(gitHubUrlOptimizer) {
+        this.gitHubUrlOptimizer = gitHubUrlOptimizer;
+    }
+    create({ outdatedPackage, gitRepo }) {
+        const packageName = outdatedPackage.name;
+        const currentVersion = outdatedPackage.currentVersion.version;
+        const newVersion = outdatedPackage.newVersion.version;
+        const links = [];
+        if ((gitRepo === null || gitRepo === void 0 ? void 0 : gitRepo.isGitHub) === true) {
+            const url = `${gitRepo.url.toString()}/compare/v${currentVersion}...v${newVersion}`;
+            const optimizedUrl = this.gitHubUrlOptimizer.optimize(url).toString();
+            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
+
+${links.join('\n')}`;
+    }
+}
+exports.PackageDiffsSectionCreator = PackageDiffsSectionCreator;

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

@@ -7,20 +7,20 @@ const createFooter_1 = require("./createFooter");
 const createMetadataSection_1 = require("./createMetadataSection");
 const createNotesSection_1 = require("./createNotesSection");
 const createOutdatedPackagesTable_1 = require("./createOutdatedPackagesTable");
-const createPackageDiffsSection_1 = require("./createPackageDiffsSection");
-const createReleaseNotesSection_1 = require("./createReleaseNotesSection");
 // TODO: Split into multiple classes and functions
 class PullRequestBodyCreator {
-    constructor({ options, releasesFetcher }) {
+    constructor({ options, releasesFetcher, packageDiffsSectionCreator, releaseNotesSectionCreator }) {
         this.options = options;
         this.releasesFetcher = releasesFetcher;
+        this.packageDiffsSectionCreator = packageDiffsSectionCreator;
+        this.releaseNotesSectionCreator = releaseNotesSectionCreator;
     }
     async create(outdatedPackage) {
         const sections = [];
         const outdatedPackagesTable = (0, createOutdatedPackagesTable_1.createOutdatedPackagesTable)(outdatedPackage);
         sections.push(`This PR updates these packages:\n\n${outdatedPackagesTable}`);
         const gitRepo = await this.extractRepository(outdatedPackage);
-        const diffSection = (0, createPackageDiffsSection_1.createPackageDiffsSection)({
+        const diffSection = this.packageDiffsSectionCreator.create({
             outdatedPackage,
             gitRepo
         });
@@ -33,7 +33,7 @@ class PullRequestBodyCreator {
                 to: outdatedPackage.newVersion
             });
             if (releases.length > 0) {
-                const releaseNotesSection = (0, createReleaseNotesSection_1.createReleaseNotesSection)(releases);
+                const releaseNotesSection = this.releaseNotesSectionCreator.create(releases);
                 sections.push(releaseNotesSection);
             }
         }

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReleaseNotesSectionCreator = void 0;
+class ReleaseNotesSectionCreator {
+    constructor(gitHubUrlOptimizer) {
+        this.gitHubUrlOptimizer = gitHubUrlOptimizer;
+    }
+    create(releases) {
+        const items = releases.map(({ tag, url }) => {
+            const optimizedUrl = this.gitHubUrlOptimizer.optimize(url).toString();
+            return `- [${tag}](${optimizedUrl})`;
+        });
+        return `## Release notes
+
+${items.join('\n')}`;
+    }
+}
+exports.ReleaseNotesSectionCreator = ReleaseNotesSectionCreator;

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

@@ -14,6 +14,9 @@ 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("./GitHubUrlOptimizer"), exports);
+__exportStar(require("./PackageDiffsSectionCreator"), exports);
 __exportStar(require("./PullRequestBodyCreator"), exports);
 __exportStar(require("./PullRequestCreator"), exports);
 __exportStar(require("./PullRequestTitleCreator"), exports);
+__exportStar(require("./ReleaseNotesSectionCreator"), exports);

package/dist/src/main.js

@@ -73,9 +73,14 @@ const main = async ({ options, logger }) => {
         options,
         packageManager
     });
+    const githubUrlOptimizer = new github_1.GitHubUrlOptimizer(options);
+    const packageDiffsSectionCreator = new github_1.PackageDiffsSectionCreator(githubUrlOptimizer);
+    const releaseNotesSectionCreator = new github_1.ReleaseNotesSectionCreator(githubUrlOptimizer);
     const pullRequestBodyCreator = new github_1.PullRequestBodyCreator({
         options,
-        releasesFetcher
+        releasesFetcher,
+        packageDiffsSectionCreator,
+        releaseNotesSectionCreator
     });
     const pullRequestCreator = new github_1.PullRequestCreator({
         github,

package/dist/src/number/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./range"), exports);

package/dist/src/number/range.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.range = void 0;
+// TODO: Add test
+function* range(start, end) {
+    for (let i = start; i <= end; i++) {
+        yield i;
+    }
+}
+exports.range = range;

package/dist/src/options/Options.js

@@ -19,6 +19,7 @@ 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)
         ]),
+        prBodyGithubHost: io_ts_1.string,
         prTitle: io_ts_1.string
     }),
     (0, io_ts_1.partial)({

package/dist/src/options/cliOptions.js

@@ -82,6 +82,13 @@ exports.cliOptions = [
             package_manager_1.PackageManagerName.Yarn
         ]
     },
+    {
+        name: 'pr-body-github-host',
+        description: 'GitHub host of pull request body',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        default: 'togithub.com'
+    },
     {
         name: 'pr-body-notes',
         description: 'Additional notes for Pull request body',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.54.0",
+  "version": "0.55.0",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -20,11 +20,10 @@
     "fp-ts": "2.11.9",
     "http-status-codes": "2.2.0",
     "io-ts": "2.2.16",
-    "lodash": "4.14.2",
     "log4js": "6.4.4",
     "mustache": "4.1.0",
     "node-fetch": "2.6.7",
-    "npm-check-updates": "12.5.5",
+    "npm-check-updates": "12.5.7",
     "parse-github-url": "1.0.2",
     "semver": "7.3.5",
     "sleep-promise": "9.1.0",
@@ -34,13 +33,12 @@
     "@jest/types": "27.4.2",
     "@tsconfig/node12": "1.0.9",
     "@types/jest": "27.4.1",
-    "@types/lodash": "4.14.181",
     "@types/mustache": "4.1.2",
     "@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.17.0",
+    "@typescript-eslint/eslint-plugin": "5.18.0",
     "eslint": "8.12.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",

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

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPackageDiffsSection = void 0;
-const optimizeGitHubUrl_1 = require("./optimizeGitHubUrl");
-const createPackageDiffsSection = ({ outdatedPackage, gitRepo }) => {
-    const packageName = outdatedPackage.name;
-    const currentVersion = outdatedPackage.currentVersion.version;
-    const newVersion = outdatedPackage.newVersion.version;
-    const links = [];
-    if ((gitRepo === null || gitRepo === void 0 ? void 0 : gitRepo.isGitHub) === true) {
-        const url = `${gitRepo.url.toString()}/compare/v${currentVersion}...v${newVersion}`;
-        const optimizedUrl = (0, optimizeGitHubUrl_1.optimizeGitHubUrl)(url).toString();
-        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
-
-${links.join('\n')}`;
-};
-exports.createPackageDiffsSection = createPackageDiffsSection;

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

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createReleaseNotesSection = void 0;
-const optimizeGitHubUrl_1 = require("./optimizeGitHubUrl");
-const createReleaseNotesSection = (releases) => {
-    const items = releases.map(({ tag, url }) => {
-        const optimizedUrl = (0, optimizeGitHubUrl_1.optimizeGitHubUrl)(url).toString();
-        return `- [${tag}](${optimizedUrl})`;
-    });
-    return `## Release notes
-
-${items.join('\n')}`;
-};
-exports.createReleaseNotesSection = createReleaseNotesSection;

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

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.optimizeGitHubUrl = void 0;
-const url_1 = require("url");
-/**
- * Convert URL to prevent linking to other repositories.
- */
-const optimizeGitHubUrl = (url) => {
-    const newUrl = url instanceof url_1.URL ? url : new url_1.URL(url);
-    if (newUrl.host === 'github.com') {
-        newUrl.host = 'togithub.com';
-    }
-    return newUrl;
-};
-exports.optimizeGitHubUrl = optimizeGitHubUrl;