npm-update-package 0.48.4 → 0.50.0

package/README.md

@@ -60,7 +60,25 @@ Commit message template.
 ```sh
 npx npm-update-package \
   --github-token $GITHUB_TOKEN \
-  --commit-message "chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}"
+  --commit-message "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
+```
+
+### `--fetch-sleep-time`
+
+Sleep time between fetching (ms).
+
+|Name|Value|
+|---|---|
+|type|number|
+|required|false|
+|default|`1000`|
+
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --fetch-sleep-time 2000
 ```
 
 ### `--github-token`
@@ -116,7 +134,7 @@ Log level to show.
 ```sh
 npx npm-update-package \
   --github-token $GITHUB_TOKEN \
-  --log-level info
+  --log-level debug
 ```
 
 ### `--package-manager`
@@ -141,7 +159,7 @@ Package manager of your project.
 ```sh
 npx npm-update-package \
   --github-token $GITHUB_TOKEN \
-  --package-manager npm
+  --package-manager yarn
 ```
 
 ### `--pr-body-notes`
@@ -186,7 +204,7 @@ Pull request title template.
 ```sh
 npx npm-update-package \
   --github-token $GITHUB_TOKEN \
-  --pr-title "chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}"
+  --pr-title "chore({{{dependencyType}}}): {{{level}}} update {{{packageName}}} from {{{currentVersion}}} to v{{{newVersion}}}"
 ```
 
 ### `--reviewers`

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.48.4",
+    "version": "0.50.0",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -41,7 +41,7 @@
         "@types/parse-github-url": "1.0.0",
         "@types/semver": "7.3.9",
         "@typescript-eslint/eslint-plugin": "5.16.0",
-        "eslint": "8.11.0",
+        "eslint": "8.12.0",
         "eslint-config-standard-with-typescript": "21.0.1",
         "eslint-plugin-import": "2.25.4",
         "eslint-plugin-jest": "26.1.3",
@@ -53,9 +53,9 @@
         "lint-staged": "12.3.7",
         "npm-run-all": "4.1.5",
         "rimraf": "3.0.2",
-        "ts-jest": "27.1.3",
+        "ts-jest": "27.1.4",
         "ts-node": "10.7.0",
-        "typescript": "4.6.2",
+        "typescript": "4.6.3",
         "utility-types": "3.10.0"
     },
     "repository": {

package/dist/src/core/OutdatedPackageProcessor.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutdatedPackageProcessor = void 0;
 const Either_1 = require("fp-ts/lib/Either");
 const git_1 = require("../git");
-// TODO: add test
+// TODO: Add test
+// TODO: Split into multiple classes and functions
 class OutdatedPackageProcessor {
     constructor({ git, packageManager, pullRequestCreator, branchFinder, logger, commitMessageCreator, pullRequestFinder, pullRequestsCloser, packageUpdater }) {
         this.git = git;

package/dist/src/github/label/creator/LabelCreator.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LabelCreator = void 0;
 const errors_1 = require("../../errors");
+// TODO: Split into multiple classes and functions
 class LabelCreator {
     constructor({ github, gitRepo, logger }) {
         this.github = github;

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

@@ -1,15 +1,15 @@
 "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");
-const optimizeGitHubUrl_1 = require("./optimizeGitHubUrl");
+const package_json_1 = require("../../../package-json");
+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 }) {
         this.options = options;
@@ -17,102 +17,40 @@ class PullRequestBodyCreator {
     }
     async create(outdatedPackage) {
         const sections = [];
-        const outdatedPackagesTable = this.createOutdatedPackagesTable(outdatedPackage);
+        const outdatedPackagesTable = (0, createOutdatedPackagesTable_1.createOutdatedPackagesTable)(outdatedPackage);
         sections.push(`This PR updates these packages:\n\n${outdatedPackagesTable}`);
-        const diffSection = this.createDiffSection(outdatedPackage);
-        sections.push(diffSection);
         const gitRepo = await this.extractRepository(outdatedPackage);
+        const diffSection = (0, createPackageDiffsSection_1.createPackageDiffsSection)({
+            outdatedPackage,
+            gitRepo
+        });
+        sections.push(diffSection);
         if ((gitRepo === null || gitRepo === void 0 ? void 0 : gitRepo.isGitHub) === true) {
-            const releaseNotesSection = await this.createReleaseNotesSection({
-                outdatedPackage,
-                gitRepo
+            const releases = await this.releasesFetcher.fetch({
+                gitRepo,
+                packageName: outdatedPackage.name,
+                from: outdatedPackage.currentVersion,
+                to: outdatedPackage.newVersion
             });
-            if (releaseNotesSection !== undefined) {
+            if (releases.length > 0) {
+                const releaseNotesSection = (0, createReleaseNotesSection_1.createReleaseNotesSection)(releases);
                 sections.push(releaseNotesSection);
             }
         }
-        const notesSection = this.createNotesSection();
-        if (notesSection !== undefined) {
+        if (this.options.prBodyNotes !== undefined) {
+            const notesSection = (0, createNotesSection_1.createNotesSection)(this.options.prBodyNotes);
             sections.push(notesSection);
         }
-        const metadataSection = this.createMetadataSection(outdatedPackage);
+        const metadataSection = (0, createMetadataSection_1.createMetadataSection)(outdatedPackage);
         sections.push(`---\n${metadataSection}`);
-        const footer = this.createFooter();
+        const footer = (0, createFooter_1.createFooter)();
         sections.push(`---\n${footer}`);
         return sections.join('\n\n');
     }
-    createDiffSection(outdatedPackage) {
-        const packageName = outdatedPackage.name;
-        const currentVersion = outdatedPackage.currentVersion.version;
-        const newVersion = outdatedPackage.newVersion.version;
-        return `## Package diffs
-
-- [npmfs](https://npmfs.com/compare/${packageName}/${currentVersion}/${newVersion})
-- [Renovate Bot Package Diff](https://renovatebot.com/diffs/npm/${packageName}/${currentVersion}/${newVersion})`;
-    }
-    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})`;
-        return `|Package|Dependency type|Level|Current version|New version|
-|---|---|---|---|---|
-|${packageLink}|${dependencyType}|${level}|${currentVersionLink}|${newVersionLink}|`;
-    }
-    createNotesSection() {
-        if (this.options.prBodyNotes === undefined) {
-            return undefined;
-        }
-        return `## Notes
-
-${this.options.prBodyNotes}`;
-    }
-    async createReleaseNotesSection({ outdatedPackage, gitRepo }) {
-        const releases = await this.releasesFetcher.fetch({
-            gitRepo,
-            packageName: outdatedPackage.name,
-            from: outdatedPackage.currentVersion,
-            to: outdatedPackage.newVersion
-        });
-        if (releases.length === 0) {
-            return undefined;
-        }
-        const items = releases.map(({ tag, url }) => {
-            const optimizedUrl = (0, optimizeGitHubUrl_1.optimizeGitHubUrl)(url);
-            return `- [${tag}](${optimizedUrl})`;
-        });
-        return `## Release notes
-
-${items.join('\n')}`;
-    }
     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]);
-        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>`;
+        const pkg = (0, package_json_1.parsePackageJson)(packageJson);
+        return (0, package_json_1.extractRepository)(pkg);
     }
 }
 exports.PullRequestBodyCreator = PullRequestBodyCreator;

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

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFooter = void 0;
+const package_json_1 = __importDefault(require("../../../../package.json"));
+const 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.createFooter = createFooter;

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMetadataSection = void 0;
+const json_1 = require("../../../json");
+const metadata_1 = require("../metadata");
+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>`;
+};
+exports.createMetadataSection = createMetadataSection;

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNotesSection = void 0;
+const createNotesSection = (notes) => {
+    return `## Notes
+
+${notes}`;
+};
+exports.createNotesSection = createNotesSection;

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOutdatedPackagesTable = void 0;
+const 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})`;
+    return `|Package|Dependency type|Level|Current version|New version|
+|---|---|---|---|---|
+|${packageLink}|${dependencyType}|${level}|${currentVersionLink}|${newVersionLink}|`;
+};
+exports.createOutdatedPackagesTable = createOutdatedPackagesTable;

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

@@ -0,0 +1,21 @@
+"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(`- [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

@@ -0,0 +1,14 @@
+"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

@@ -6,10 +6,10 @@ const url_1 = require("url");
  * Convert URL to prevent linking to other repositories.
  */
 const optimizeGitHubUrl = (url) => {
-    const newUrl = new url_1.URL(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.toString();
+    return newUrl;
 };
 exports.optimizeGitHubUrl = optimizeGitHubUrl;

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

@@ -7,9 +7,10 @@ exports.ReleasesFetcher = void 0;
 const node_fetch_1 = __importDefault(require("node-fetch"));
 const semver_1 = require("semver");
 const sleep_promise_1 = __importDefault(require("sleep-promise"));
-const type_guards_1 = require("type-guards");
+// TODO: Split into multiple classes and functions
 class ReleasesFetcher {
-    constructor({ packageManager }) {
+    constructor({ options, packageManager }) {
+        this.options = options;
         this.packageManager = packageManager;
     }
     async fetch({ gitRepo, packageName, from, to }) {
@@ -35,17 +36,20 @@ class ReleasesFetcher {
         }
     }
     async fetchReleasesByTags({ gitRepo, tags }) {
-        const releases = await Promise.all(tags.map(async (tag, i) => {
+        const releases = [];
+        for (const [i, tag] of tags.entries()) {
             if (i > 0) {
-                // NOTE: Sleeps for 1 second between fetches.
-                await (0, sleep_promise_1.default)(1000);
+                await (0, sleep_promise_1.default)(this.options.fetchSleepTime);
             }
-            return await this.fetchReleaseByTag({
+            const release = await this.fetchReleaseByTag({
                 gitRepo,
                 tag
             });
-        }));
-        return releases.filter(type_guards_1.isNotUndefined);
+            if (release !== undefined) {
+                releases.push(release);
+            }
+        }
+        return releases;
     }
     async getVersions({ packageName, from, to }) {
         const versions = await this.packageManager.getVersions(packageName);

package/dist/src/main.js

@@ -8,7 +8,7 @@ const github_1 = require("./github");
 const ncu_1 = require("./ncu");
 const package_manager_1 = require("./package-manager");
 const terminal_1 = require("./terminal");
-// TODO: add test
+// TODO: Add test
 const main = async ({ options, logger }) => {
     logger.debug(`options=${JSON.stringify({
         ...options,
@@ -68,7 +68,10 @@ const main = async ({ options, logger }) => {
         packageManager: options.packageManager
     });
     const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.prTitle);
-    const releasesFetcher = new github_1.ReleasesFetcher({ packageManager });
+    const releasesFetcher = new github_1.ReleasesFetcher({
+        options,
+        packageManager
+    });
     const pullRequestBodyCreator = new github_1.PullRequestBodyCreator({
         options,
         releasesFetcher
@@ -125,7 +128,7 @@ const main = async ({ options, logger }) => {
     logger.debug(`failedResults=${JSON.stringify(failedResults)}`);
     const failedPackages = failedResults.map(({ outdatedPackage }) => outdatedPackage);
     logger.debug(`failedPackages=${JSON.stringify(failedPackages)}`);
-    // TODO: show as table
+    // TODO: Show as table
     logger.info(`Processed ${succeededResults.length + failedPackages.length} packages:
 - ${createdPackages.length} packages: created (${createdPackages.map(({ name }) => name).join(',')})
 - ${skippedPackages.length} packages: skipped: (${skippedPackages.map(({ name }) => name).join(',')})

package/dist/src/ncu/Ncu.js

@@ -7,7 +7,7 @@ const file_1 = require("../file");
 const package_json_1 = require("../package-json");
 const semver_1 = require("../semver");
 const NcuResult_1 = require("./NcuResult");
-// TODO: add test
+// TODO: Add test
 class Ncu {
     constructor({ options, logger }) {
         this.options = options;

package/dist/src/options/OptionType.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isOptionType = exports.OptionType = void 0;
 exports.OptionType = {
+    Number: 'number',
     String: 'string',
     StringArray: 'string[]'
 };

package/dist/src/options/Options.js

@@ -7,6 +7,7 @@ const package_manager_1 = require("../package-manager");
 const Options = (0, io_ts_1.intersection)([
     (0, io_ts_1.type)({
         commitMessage: io_ts_1.string,
+        fetchSleepTime: io_ts_1.number,
         githubToken: io_ts_1.string,
         logLevel: (0, io_ts_1.union)([
             (0, io_ts_1.literal)(logger_1.LogLevel.Off),

package/dist/src/options/cliOptions.js

@@ -18,6 +18,13 @@ exports.cliOptions = [
         required: false,
         default: 'chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}'
     },
+    {
+        name: 'fetch-sleep-time',
+        description: 'Sleep time between fetching (ms)',
+        type: OptionType_1.OptionType.Number,
+        required: false,
+        default: 1000
+    },
     {
         name: 'github-token',
         description: 'GitHub token',

package/dist/src/options/createOptions.js

@@ -8,7 +8,7 @@ const commander_1 = require("commander");
 const package_json_1 = __importDefault(require("../../package.json"));
 const Options_1 = require("./Options");
 const toCommanderOption_1 = require("./toCommanderOption");
-// TODO: add test
+// TODO: Add test
 const createOptions = (cliOptions) => {
     commander_1.program.version(package_json_1.default.version);
     cliOptions

package/dist/src/options/toCommanderOption.js

@@ -12,6 +12,9 @@ const toCommanderOption = (cliOption) => {
     if (!cliOption.required && cliOption.default !== undefined) {
         option.default(cliOption.default);
     }
+    if (cliOption.type === OptionType_1.OptionType.Number) {
+        option.argParser(Number);
+    }
     return option;
 };
 exports.toCommanderOption = toCommanderOption;
@@ -21,9 +24,11 @@ const createArgumentString = (cliOption) => {
 };
 const createArgumentNameString = (optionType) => {
     switch (optionType) {
+        case OptionType_1.OptionType.Number:
+            return 'number';
         case OptionType_1.OptionType.String:
-            return 'value';
+            return 'string';
         case OptionType_1.OptionType.StringArray:
-            return 'values...';
+            return 'strings...';
     }
 };

package/dist/src/terminal/Terminal.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Terminal = void 0;
 const execa_1 = __importDefault(require("execa"));
-// TODO: add test
+// TODO: Add test
 class Terminal {
     async run(command, ...args) {
         return await (0, execa_1.default)(command, args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.48.4",
+  "version": "0.50.0",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -41,7 +41,7 @@
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
     "@typescript-eslint/eslint-plugin": "5.16.0",
-    "eslint": "8.11.0",
+    "eslint": "8.12.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",
     "eslint-plugin-jest": "26.1.3",
@@ -53,9 +53,9 @@
     "lint-staged": "12.3.7",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
-    "ts-jest": "27.1.3",
+    "ts-jest": "27.1.4",
     "ts-node": "10.7.0",
-    "typescript": "4.6.2",
+    "typescript": "4.6.3",
     "utility-types": "3.10.0"
   },
   "repository": {