npm-update-package 0.38.0 → 0.41.0

package/README.md

@@ -27,6 +27,7 @@ Commit message template
   - `newVersion`: new package version
   - `packageName`: package name
   - `level`: semver level (major/minor/patch)
+  - `dependencyType`: dependency type (dependencies/devDependencies/peerDependencies/optionalDependencies)
 - default: `chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`
 
 ### `--github-token`
@@ -74,6 +75,7 @@ Pull request title template
   - `newVersion`: new package version
   - `packageName`: package name
   - `level`: semver level (major/minor/patch)
+  - `dependencyType`: dependency type (dependencies/devDependencies/peerDependencies/optionalDependencies)
 - default: `chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`
 
 ### `--reviewers`

package/dist/package.json

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

package/dist/src/git/CommitMessageCreator.js

@@ -11,11 +11,13 @@ class CommitMessageCreator {
         const currentVersion = outdatedPackage.currentVersion.version;
         const newVersion = outdatedPackage.newVersion.version;
         const level = outdatedPackage.level;
+        const dependencyType = outdatedPackage.dependencyType;
         return (0, mustache_1.render)(this.template, {
             packageName,
             currentVersion,
             newVersion,
-            level
+            level,
+            dependencyType
         });
     }
 }

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/createGitHub.js

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createGitHub = void 0;
 const createOctokit_1 = require("./createOctokit");
 const GitHub_1 = require("./GitHub");
-const createGitHub = ({ repository, token }) => {
+const createGitHub = ({ host, token }) => {
     const octokit = (0, createOctokit_1.createOctokit)({
-        repository,
+        host,
         token
     });
     return new GitHub_1.GitHub(octokit);

package/dist/src/github/createOctokit.js

@@ -6,22 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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 createOctokit = ({ host, token }) => {
     const userAgent = `${package_json_1.default.name}/${package_json_1.default.version}`;
-    if (host === 'github.com') {
+    if (token === undefined) {
         return new rest_1.Octokit({
-            auth,
             userAgent
         });
     }
-    else {
+    const auth = `token ${token}`;
+    if (host === 'github.com') {
         return new rest_1.Octokit({
             auth,
-            userAgent,
-            baseUrl: `https://${host}/api/v3`
+            userAgent
         });
     }
+    return new rest_1.Octokit({
+        auth,
+        userAgent,
+        baseUrl: `https://${host}/api/v3`
+    });
 };
 exports.createOctokit = createOctokit;

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,107 @@
+"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);
+        const metadataSection = this.createMetadataSection(outdatedPackage);
+        const footer = this.createFooter();
+        const body = `This PR updates these packages:
+
+${outdatedPackagesTable}
+
+---
+${metadataSection}
+
+---
+${footer}`;
+        if (gitRepo === undefined) {
+            return body;
+        }
+        const releaseNotesSection = await this.createReleaseNotesSection({
+            outdatedPackage,
+            gitRepo
+        });
+        if (releaseNotesSection === undefined) {
+            return body;
+        }
+        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
+        });
+        if (releases.length === 0) {
+            return undefined;
+        }
+        const items = releases.map(release => `- [${release.tag_name}](${release.html_url})`);
+        return `## Release notes
+
+${items.join('\n')}`;
+    }
+    createOutdatedPackagesTable(outdatedPackage) {
+        const packageName = outdatedPackage.name;
+        const packageLink = `[${packageName}](https://www.npmjs.com/package/${packageName})`;
+        const dependencyType = outdatedPackage.dependencyType;
+        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|Dependency type|Level|Version|
+|---|---|---|---|
+|${packageLink}|${dependencyType}|${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 = await (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/PullRequestTitleCreator.js

@@ -11,11 +11,13 @@ class PullRequestTitleCreator {
         const currentVersion = outdatedPackage.currentVersion.version;
         const newVersion = outdatedPackage.newVersion.version;
         const level = outdatedPackage.level;
+        const dependencyType = outdatedPackage.dependencyType;
         return (0, mustache_1.render)(this.template, {
             packageName,
             currentVersion,
             newVersion,
-            level
+            level,
+            dependencyType
         });
     }
 }

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,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReleasesFetcher = void 0;
+const semver_1 = require("semver");
+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

@@ -27,7 +27,7 @@ const main = async ({ options, logger }) => {
     const gitRepo = await git.getRepository();
     logger.debug(`gitRepo=${JSON.stringify(gitRepo)}`);
     const github = (0, github_1.createGitHub)({
-        repository: gitRepo,
+        host: gitRepo.url.host,
         token: options.githubToken
     });
     const githubRepo = await github.fetchRepository({
@@ -61,11 +61,19 @@ const main = async ({ options, logger }) => {
         packageManager: options.packageManager
     });
     const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.pullRequestTitle);
+    const githubWithoutToken = (0, github_1.createGitHub)({
+        host: 'github.com'
+    });
+    const releasesFetcher = new github_1.ReleasesFetcher(githubWithoutToken);
+    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/ncu/Ncu.js

@@ -34,19 +34,46 @@ class Ncu {
         if (!(0, NcuResult_1.isNcuResult)(result)) {
             throw new Error('Failed to running ncu.');
         }
-        const currentDependencies = {
-            ...pkg.dependencies,
-            ...pkg.devDependencies,
-            ...pkg.peerDependencies,
-            ...pkg.optionalDependencies
+        const { dependencies, devDependencies, peerDependencies, optionalDependencies } = pkg;
+        const toCurrentVersionString = (packageName) => {
+            if ((dependencies === null || dependencies === void 0 ? void 0 : dependencies[packageName]) !== undefined) {
+                return dependencies[packageName];
+            }
+            else if ((devDependencies === null || devDependencies === void 0 ? void 0 : devDependencies[packageName]) !== undefined) {
+                return devDependencies[packageName];
+            }
+            else if ((peerDependencies === null || peerDependencies === void 0 ? void 0 : peerDependencies[packageName]) !== undefined) {
+                return peerDependencies[packageName];
+            }
+            else if ((optionalDependencies === null || optionalDependencies === void 0 ? void 0 : optionalDependencies[packageName]) !== undefined) {
+                return optionalDependencies[packageName];
+            }
+        };
+        const toDependencyType = (packageName) => {
+            if ((dependencies === null || dependencies === void 0 ? void 0 : dependencies[packageName]) !== undefined) {
+                return package_json_1.DependencyType.Dependencies;
+            }
+            else if ((devDependencies === null || devDependencies === void 0 ? void 0 : devDependencies[packageName]) !== undefined) {
+                return package_json_1.DependencyType.DevDependencies;
+            }
+            else if ((peerDependencies === null || peerDependencies === void 0 ? void 0 : peerDependencies[packageName]) !== undefined) {
+                return package_json_1.DependencyType.PeerDependencies;
+            }
+            else if ((optionalDependencies === null || optionalDependencies === void 0 ? void 0 : optionalDependencies[packageName]) !== undefined) {
+                return package_json_1.DependencyType.OptionalDependencies;
+            }
         };
         const resultEntries = Object.entries(result);
         const outdatedPackages = resultEntries
             .map(([name, newVersionString]) => {
-            const currentVersionString = currentDependencies[name];
+            const currentVersionString = toCurrentVersionString(name);
             if (currentVersionString === undefined) {
                 return undefined;
             }
+            const dependencyType = toDependencyType(name);
+            if (dependencyType === undefined) {
+                return undefined;
+            }
             const currentVersion = semver_1.SemVer.of(currentVersionString);
             const newVersion = semver_1.SemVer.of(newVersionString);
             const level = (0, semver_1.compareSemVers)(currentVersion, newVersion);
@@ -57,7 +84,8 @@ class Ncu {
                 name,
                 currentVersion,
                 newVersion,
-                level
+                level,
+                dependencyType
             };
             return outdatedPackage;
         })

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isDependencyType = exports.DependencyType = void 0;
+exports.DependencyType = {
+    Dependencies: 'dependencies',
+    DevDependencies: 'devDependencies',
+    PeerDependencies: 'peerDependencies',
+    OptionalDependencies: 'optionalDependencies'
+};
+const dependencyTypes = Object.values(exports.DependencyType);
+const isDependencyType = (value) => dependencyTypes.includes(value);
+exports.isDependencyType = isDependencyType;

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

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

package/package.json

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

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

@@ -1,62 +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 file_1 = require("../../../file");
-const json_1 = require("../../../json");
-const package_json_2 = require("../../../package-json");
-const metadata_1 = require("../metadata");
-const createPullRequestBody = async (outdatedPackage) => {
-    const packageJson = await (0, file_1.readFile)(`node_modules/${outdatedPackage.name}/package.json`);
-    const pkg = (0, package_json_2.parsePackageJson)(packageJson);
-    const repository = (0, package_json_2.extractRepository)(pkg);
-    const outdatedPackagesTable = createOutdatedPackagesTable({
-        outdatedPackage,
-        repository
-    });
-    const metadataSection = createMetadataSection(outdatedPackage);
-    return `This PR updates these packages:
-
-${outdatedPackagesTable}
-
-${metadataSection}
-
----
-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;
-const createOutdatedPackagesTable = ({ outdatedPackage, repository }) => {
-    const packageName = outdatedPackage.name;
-    const packageLink = `[${packageName}](https://www.npmjs.com/package/${packageName})`;
-    const repositoryLink = repository !== undefined ? `[${repository.owner}/${repository.name}](${repository.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}|`;
-};
-const 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>`;
-};