npm-update-package 0.34.0 → 0.37.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.34.0",
+    "version": "0.37.0",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -35,7 +35,7 @@
         "@types/node": "12.20.40",
         "@types/parse-github-url": "1.0.0",
         "@types/semver": "7.3.9",
-        "@typescript-eslint/eslint-plugin": "5.12.0",
+        "@typescript-eslint/eslint-plugin": "5.12.1",
         "eslint": "8.9.0",
         "eslint-config-standard-with-typescript": "21.0.1",
         "eslint-plugin-import": "2.25.4",

package/dist/src/git/GitRepository.js

@@ -4,38 +4,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GitRepository = void 0;
+const url_1 = require("url");
 const parse_github_url_1 = __importDefault(require("parse-github-url"));
 class GitRepository {
-    constructor({ host, owner, name }) {
-        this.host = host;
+    constructor({ url, owner, name }) {
+        this.url = url;
         this.owner = owner;
         this.name = name;
     }
-    static of(url) {
-        const parsed = (0, parse_github_url_1.default)(url);
+    static of(repository) {
+        var _a;
+        const parsed = (0, parse_github_url_1.default)(repository);
         if (parsed === null) {
-            throw new Error(`Failed to parse url. url=${url}`);
+            throw new Error(`Failed to parse repository. repository=${repository}`);
         }
         const { host, owner, name } = parsed;
         if (host === null || owner === null || name === null) {
-            throw new Error(`Failed to parse url. url=${url}`);
+            throw new Error(`Failed to parse repository. repository=${repository}`);
         }
+        const protocol = (_a = parsed.protocol) !== null && _a !== void 0 ? _a : 'https:';
         return new GitRepository({
-            host,
+            url: new url_1.URL(`${protocol}//${host}/${owner}/${name}`),
             owner,
             name
         });
     }
-    get apiEndPoint() {
-        if (this.isGitHubDotCom) {
-            return 'https://api.github.com';
-        }
-        else {
-            return `https://${this.host}/api/v3`;
-        }
-    }
-    get isGitHubDotCom() {
-        return this.host === 'github.com';
-    }
 }
 exports.GitRepository = GitRepository;

package/dist/src/github/GitHub.js

@@ -75,6 +75,22 @@ class GitHub {
         });
         return data;
     }
+    async fetchReleases({ owner, repo }) {
+        const releases = [];
+        for (let page = 1;; page++) {
+            const { data } = await this.octokit.repos.listReleases({
+                owner,
+                repo,
+                per_page: 100,
+                page
+            });
+            if (data.length === 0) {
+                break;
+            }
+            releases.push(...data);
+        }
+        return releases;
+    }
     async fetchRepository({ owner, repo }) {
         const { data } = await this.octokit.repos.get({
             owner,

package/dist/src/github/createOctokit.js

@@ -7,9 +7,10 @@ exports.createOctokit = void 0;
 const rest_1 = require("@octokit/rest");
 const package_json_1 = __importDefault(require("../../package.json"));
 const createOctokit = ({ repository, token }) => {
+    const { host } = repository.url;
     const auth = `token ${token}`;
     const userAgent = `${package_json_1.default.name}/${package_json_1.default.version}`;
-    if (repository.isGitHubDotCom) {
+    if (host === 'github.com') {
         return new rest_1.Octokit({
             auth,
             userAgent
@@ -19,7 +20,7 @@ const createOctokit = ({ repository, token }) => {
         return new rest_1.Octokit({
             auth,
             userAgent,
-            baseUrl: repository.apiEndPoint
+            baseUrl: `https://${host}/api/v3`
         });
     }
 };

package/dist/src/github/index.js

@@ -15,3 +15,4 @@ __exportStar(require("./createGitHub"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./label"), exports);
 __exportStar(require("./pull-request"), exports);
+__exportStar(require("./releases"), exports);

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

@@ -0,0 +1,103 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestBodyCreator = void 0;
+const package_json_1 = __importDefault(require("../../../../package.json"));
+const file_1 = require("../../../file");
+const json_1 = require("../../../json");
+const package_json_2 = require("../../../package-json");
+const metadata_1 = require("../metadata");
+class PullRequestBodyCreator {
+    constructor({ releasesFetcher }) {
+        this.releasesFetcher = releasesFetcher;
+    }
+    async create(outdatedPackage) {
+        const gitRepo = await this.extractRepository(outdatedPackage);
+        const outdatedPackagesTable = this.createOutdatedPackagesTable({
+            outdatedPackage,
+            gitRepo
+        });
+        const metadataSection = this.createMetadataSection(outdatedPackage);
+        const footer = this.createFooter();
+        if (gitRepo === undefined) {
+            return `This PR updates these packages:
+
+${outdatedPackagesTable}
+
+---
+${metadataSection}
+
+---
+${footer}`;
+        }
+        const releaseNotesSection = await this.createReleaseNotesSection({
+            outdatedPackage,
+            gitRepo
+        });
+        return `This PR updates these packages:
+
+${outdatedPackagesTable}
+
+${releaseNotesSection}
+
+---
+${metadataSection}
+
+---
+${footer}`;
+    }
+    async extractRepository(outdatedPackage) {
+        const packageJson = await (0, file_1.readFile)(`node_modules/${outdatedPackage.name}/package.json`);
+        const pkg = (0, package_json_2.parsePackageJson)(packageJson);
+        return (0, package_json_2.extractRepository)(pkg);
+    }
+    async createReleaseNotesSection({ outdatedPackage, gitRepo }) {
+        const releases = await this.releasesFetcher.fetch({
+            gitRepo,
+            from: outdatedPackage.currentVersion,
+            to: outdatedPackage.newVersion
+        });
+        const items = releases.map(release => `- [${release.tag_name}](${release.html_url})`);
+        return `## Release notes
+
+${items.join('\n')}`;
+    }
+    createOutdatedPackagesTable({ outdatedPackage, gitRepo }) {
+        const packageName = outdatedPackage.name;
+        const packageLink = `[${packageName}](https://www.npmjs.com/package/${packageName})`;
+        const repositoryLink = gitRepo !== undefined ? `[${gitRepo.owner}/${gitRepo.name}](${gitRepo.url.toString()})` : '-';
+        const level = outdatedPackage.level;
+        const currentVersion = outdatedPackage.currentVersion.version;
+        const currentVersionLink = `[\`${currentVersion}\`](https://www.npmjs.com/package/${packageName}/v/${currentVersion})`;
+        const newVersion = outdatedPackage.newVersion.version;
+        const newVersionLink = `[\`${newVersion}\`](https://www.npmjs.com/package/${packageName}/v/${newVersion})`;
+        const diffLink = `[diff](https://renovatebot.com/diffs/npm/${packageName}/${currentVersion}/${newVersion})`;
+        const version = `${currentVersionLink} -> ${newVersionLink} (${diffLink})`;
+        return `|Package|Repository|Level|Version|
+|---|---|---|---|
+|${packageLink}|${repositoryLink}|${level}|${version}|`;
+    }
+    createMetadataSection(outdatedPackage) {
+        const metadata = (0, metadata_1.createPullRequestMetadata)([outdatedPackage]);
+        const json = (0, json_1.toJSON)(metadata, { pretty: true });
+        return `<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
+${json}
+\`\`\`
+
+</div>
+</details>`;
+    }
+    createFooter() {
+        return `This PR has been generated by [${package_json_1.default.name}](${package_json_1.default.homepage}) v${package_json_1.default.version}`;
+    }
+}
+exports.PullRequestBodyCreator = PullRequestBodyCreator;

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

@@ -1,20 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCreator = void 0;
-const createPullRequestBody_1 = require("./createPullRequestBody");
 class PullRequestCreator {
-    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, logger, reviewers }) {
+    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger, reviewers }) {
         this.github = github;
         this.gitRepo = gitRepo;
         this.githubRepo = githubRepo;
         this.pullRequestTitleCreator = pullRequestTitleCreator;
+        this.pullRequestBodyCreator = pullRequestBodyCreator;
         this.logger = logger;
         this.reviewers = reviewers;
     }
     async create({ outdatedPackage, branchName }) {
         const title = this.pullRequestTitleCreator.create(outdatedPackage);
         this.logger.debug(`title=${title}`);
-        const body = (0, createPullRequestBody_1.createPullRequestBody)(outdatedPackage);
+        const body = await this.pullRequestBodyCreator.create(outdatedPackage);
         this.logger.debug(`body=${body}`);
         const pullRequest = await this.github.createPullRequest({
             owner: this.gitRepo.owner,

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

@@ -10,5 +10,6 @@ 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("./PullRequestBodyCreator"), exports);
 __exportStar(require("./PullRequestCreator"), exports);
 __exportStar(require("./PullRequestTitleCreator"), exports);

package/dist/src/github/releases/fetcher/ReleasesFetcher.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReleasesFetcher = void 0;
+const semver_1 = require("semver");
+// TODO: Add test
+class ReleasesFetcher {
+    constructor(github) {
+        this.github = github;
+    }
+    async fetch({ gitRepo, from, to }) {
+        const releases = await this.github.fetchReleases({
+            owner: gitRepo.owner,
+            repo: gitRepo.name
+        });
+        return releases.filter(({ tag_name: version }) => (0, semver_1.gte)(version, from.version) && (0, semver_1.lte)(version, to.version));
+    }
+}
+exports.ReleasesFetcher = ReleasesFetcher;

package/dist/src/github/releases/fetcher/index.js

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

package/dist/src/github/releases/index.js

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

package/dist/src/main.js

@@ -61,11 +61,16 @@ const main = async ({ options, logger }) => {
         packageManager: options.packageManager
     });
     const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.pullRequestTitle);
+    const releasesFetcher = new github_1.ReleasesFetcher(github);
+    const pullRequestBodyCreator = new github_1.PullRequestBodyCreator({
+        releasesFetcher
+    });
     const pullRequestCreator = new github_1.PullRequestCreator({
         github,
         gitRepo,
         githubRepo,
         pullRequestTitleCreator,
+        pullRequestBodyCreator,
         logger,
         reviewers: options.reviewers
     });

package/dist/src/package-json/PackageMetadata.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isPackageMetadata = void 0;
 const io_ts_1 = require("io-ts");
 const PackageMetadataDependencies_1 = require("./PackageMetadataDependencies");
+const PackageMetadataRepository_1 = require("./PackageMetadataRepository");
 const PackageMetadata = (0, io_ts_1.intersection)([
     (0, io_ts_1.type)({
         name: io_ts_1.string,
@@ -12,7 +13,8 @@ const PackageMetadata = (0, io_ts_1.intersection)([
         dependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
         devDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
         peerDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
-        optionalDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies
+        optionalDependencies: PackageMetadataDependencies_1.PackageMetadataDependencies,
+        repository: (0, io_ts_1.union)([io_ts_1.string, PackageMetadataRepository_1.PackageMetadataRepository])
     })
 ]);
 exports.isPackageMetadata = PackageMetadata.is;

package/dist/src/package-json/PackageMetadataRepository.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackageMetadataRepository = exports.PackageMetadataRepository = void 0;
+const io_ts_1 = require("io-ts");
+exports.PackageMetadataRepository = (0, io_ts_1.type)({
+    url: io_ts_1.string
+});
+exports.isPackageMetadataRepository = exports.PackageMetadataRepository.is;

package/dist/src/package-json/extractRepository.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractRepository = void 0;
+const git_1 = require("../git");
+const parseRepositoryString_1 = require("./parseRepositoryString");
+const extractRepository = ({ repository }) => {
+    if (repository === undefined) {
+        return undefined;
+    }
+    if (typeof repository === 'string') {
+        const { owner, repo, isGitHub } = (0, parseRepositoryString_1.parseRepositoryString)(repository);
+        if (!isGitHub) {
+            return undefined;
+        }
+        return git_1.GitRepository.of(`${owner}/${repo}`);
+    }
+    const { url } = repository;
+    return git_1.GitRepository.of(url.replace(/^git\+/, ''));
+};
+exports.extractRepository = extractRepository;

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

@@ -10,5 +10,6 @@ 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("./extractRepository"), exports);
 __exportStar(require("./PackageMetadata"), exports);
 __exportStar(require("./parsePackageJson"), exports);

package/dist/src/package-json/parseRepositoryString.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseRepositoryString = void 0;
+const parseRepositoryString = (repository) => {
+    const matched = repository.match(/^((.+):)?(.+)\/(.+)/);
+    if (matched === null) {
+        throw new Error(`Failed to parse repository. repository=${repository}`);
+    }
+    const [, , type, owner, repo] = matched;
+    /* istanbul ignore if: I can't write a test to reach here. */
+    if (owner === undefined || repo === undefined) {
+        throw new Error(`Failed to parse repository. repository=${repository}`);
+    }
+    return {
+        owner,
+        repo,
+        isGitHub: type === undefined || type === 'github'
+    };
+};
+exports.parseRepositoryString = parseRepositoryString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.34.0",
+  "version": "0.37.0",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -35,7 +35,7 @@
     "@types/node": "12.20.40",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.12.0",
+    "@typescript-eslint/eslint-plugin": "5.12.1",
     "eslint": "8.9.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",

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

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPullRequestBody = void 0;
-const package_json_1 = __importDefault(require("../../../../package.json"));
-const json_1 = require("../../../json");
-const metadata_1 = require("../metadata");
-const createPullRequestBody = (outdatedPackage) => {
-    const currentVersion = outdatedPackage.currentVersion.version;
-    const newVersion = outdatedPackage.newVersion.version;
-    const packageName = outdatedPackage.name;
-    const level = outdatedPackage.level;
-    const metadata = (0, json_1.toJSON)((0, metadata_1.createPullRequestMetadata)([outdatedPackage]), { pretty: true });
-    return `This PR updates these packages:
-
-|Package|Level|Current version|New version|
-|---|---|---|---|
-|[${packageName}](https://www.npmjs.com/package/${packageName})|${level}|\`${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
-${metadata}
-\`\`\`
-
-</div>
-</details>
-
----
-This PR has been generated by [${package_json_1.default.name}](${package_json_1.default.homepage}) v${package_json_1.default.version}`;
-};
-exports.createPullRequestBody = createPullRequestBody;