npm-update-package 0.33.0 → 0.36.0

package/README.md

@@ -74,7 +74,7 @@ Pull request title template
   - `newVersion`: new package version
   - `packageName`: package name
   - `level`: semver level (major/minor/patch)
-- default: `chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}`
+- default: `chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`
 
 ### `--reviewers`
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.33.0",
+    "version": "0.36.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/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/pull-request/creator/PullRequestCreator.js

@@ -14,7 +14,7 @@ class PullRequestCreator {
     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 (0, createPullRequestBody_1.createPullRequestBody)(outdatedPackage);
         this.logger.debug(`body=${body}`);
         const pullRequest = await this.github.createPullRequest({
             owner: this.gitRepo.owner,

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

@@ -5,21 +5,48 @@ var __importDefault = (this && this.__importDefault) || function (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 = (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 });
+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:
 
-|Package|Level|Current version|New version|
-|---|---|---|---|
-|[${packageName}](https://www.npmjs.com/package/${packageName})|${level}|\`${currentVersion}\`|\`${newVersion}\`|
+${outdatedPackagesTable}
 
-<details>
+${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.**
@@ -27,13 +54,9 @@ const createPullRequestBody = (outdatedPackage) => {
 <div id="npm-update-package-metadata">
 
 \`\`\`json
-${metadata}
+${json}
 \`\`\`
 
 </div>
-</details>
-
----
-This PR has been generated by [${package_json_1.default.name}](${package_json_1.default.homepage}) v${package_json_1.default.version}`;
+</details>`;
 };
-exports.createPullRequestBody = createPullRequestBody;

package/dist/src/options/cliOptions.js

@@ -50,7 +50,7 @@ exports.cliOptions = [
         description: 'Pull request title template',
         type: OptionType_1.OptionType.String,
         required: false,
-        default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
+        default: 'chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}'
     },
     {
         name: '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.33.0",
+  "version": "0.36.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",