npm-update-package 0.44.0 → 0.45.2

package/README.md

@@ -71,6 +71,13 @@ Package manager of your project
   - `yarn`: Yarn
 - default: `npm`
 
+### `--pr-body-notes`
+
+Additional notes for Pull request body
+
+- type: string
+- required: false
+
 ### `--pr-title`
 
 Pull request title template

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.44.0",
+    "version": "0.45.2",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",

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

@@ -10,49 +10,59 @@ const json_1 = require("../../../json");
 const package_json_2 = require("../../../package-json");
 const metadata_1 = require("../metadata");
 class PullRequestBodyCreator {
-    constructor({ releasesFetcher }) {
+    constructor({ options, releasesFetcher }) {
+        this.options = options;
         this.releasesFetcher = releasesFetcher;
     }
     async create(outdatedPackage) {
-        const gitRepo = await this.extractRepository(outdatedPackage);
+        const sections = [];
         const outdatedPackagesTable = this.createOutdatedPackagesTable(outdatedPackage);
+        sections.push(`This PR updates these packages:\n\n${outdatedPackagesTable}`);
+        const gitRepo = await this.extractRepository(outdatedPackage);
+        if (gitRepo !== undefined) {
+            const releaseNotesSection = await this.createReleaseNotesSection({
+                outdatedPackage,
+                gitRepo
+            });
+            if (releaseNotesSection !== undefined) {
+                sections.push(releaseNotesSection);
+            }
+        }
+        const notesSection = this.createNotesSection();
+        if (notesSection !== undefined) {
+            sections.push(notesSection);
+        }
         const metadataSection = this.createMetadataSection(outdatedPackage);
+        sections.push(`---\n${metadataSection}`);
         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;
+        sections.push(`---\n${footer}`);
+        return sections.join('\n\n');
+    }
+    createFooter() {
+        return `This PR has been generated by [${package_json_1.default.name}](${package_json_1.default.homepage}) v${package_json_1.default.version}`;
+    }
+    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}|`;
+    }
+    createNotesSection() {
+        if (this.options.prBodyNotes === undefined) {
+            return undefined;
         }
-        return `This PR updates these packages:
+        return `## Notes
 
-${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);
+${this.options.prBodyNotes}`;
     }
     async createReleaseNotesSection({ outdatedPackage, gitRepo }) {
         const releases = await this.releasesFetcher.fetch({
@@ -68,20 +78,10 @@ ${footer}`;
 
 ${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}|`;
+    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);
     }
     createMetadataSection(outdatedPackage) {
         const metadata = (0, metadata_1.createPullRequestMetadata)([outdatedPackage]);
@@ -100,8 +100,5 @@ ${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/main.js

@@ -69,6 +69,7 @@ const main = async ({ options, logger }) => {
     });
     const releasesFetcher = new github_1.ReleasesFetcher(githubWithoutToken);
     const pullRequestBodyCreator = new github_1.PullRequestBodyCreator({
+        options,
         releasesFetcher
     });
     const pullRequestCreator = new github_1.PullRequestCreator({

package/dist/src/options/Options.js

@@ -25,6 +25,7 @@ const Options = (0, io_ts_1.intersection)([
     }),
     (0, io_ts_1.partial)({
         ignorePackages: (0, io_ts_1.array)(io_ts_1.string),
+        prBodyNotes: io_ts_1.string,
         reviewers: (0, io_ts_1.array)(io_ts_1.string)
     })
 ]);

package/dist/src/options/cliOptions.js

@@ -51,6 +51,12 @@ exports.cliOptions = [
         ],
         default: package_manager_1.PackageManagerName.Npm
     },
+    {
+        name: 'pr-body-notes',
+        description: 'Additional notes for Pull request body',
+        type: OptionType_1.OptionType.String,
+        required: false
+    },
     {
         name: 'pr-title',
         description: 'Pull request title template',

package/dist/src/package-manager/Npm.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Npm = void 0;
-// TODO: add test
 class Npm {
     constructor(terminal) {
         this.terminal = terminal;

package/dist/src/package-manager/Yarn.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Yarn = void 0;
-// TODO: add test
 class Yarn {
     constructor(terminal) {
         this.terminal = terminal;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.44.0",
+  "version": "0.45.2",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",