npm-update-package 0.45.5 → 0.45.8

package/README.md

@@ -18,86 +18,174 @@ Some options can embed variables like `{{packageName}}`(HTML-escaped) or `{{{pac
 
 ### `--commit-message`
 
-Commit message template
-
-- type: string
-- required: false
-- variables
-  - `currentVersion`: current package version
-  - `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}}}`
+Commit message template.
+
+|Name|Value|
+|---|---|
+|type|string|
+|required|false|
+|default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
+
+#### Available variables
+
+|Variable|Description|
+|---|---|
+|`currentVersion`|Current package version|
+|`newVersion`|New package version|
+|`packageName`|Package name|
+|`level`|Semver level (`major`/`minor`/`patch`)|
+|`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
+
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --commit-message "chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}"
+```
 
 ### `--github-token`
 
-[GitHub token](#github-token)
+[GitHub token](#github-token).
 
-- type: string
-- required: true
+|Name|Value|
+|---|---|
+|type|string|
+|required|true|
 
 ### `--ignore-packages`
 
-Package names to ignore
+Package names to ignore.
+
+|Name|Value|
+|---|---|
+|type|string[]|
+|required|false|
 
-- type: string[]
-- required: false
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --ignore-packages @types/jest jest
+```
 
 ### `--log-level`
 
-Log level to show
+Log level to show.
+
+|Name|Value|
+|---|---|
+|type|string|
+|required|false|
+|default|`info`|
+
+#### Allowed values
 
-- type: string
-- required: false
-- allowed values
-  - `off`: Do not output any logs.
-  - `fatal`: Output fatal logs.
-  - `error`: Output fatal/error logs.
-  - `warn`: Output fatal/error/warn logs.
-  - `info`: Output fatal/error/warn/info logs.
-  - `debug`: Output fatal/error/warn/info/debug logs.
-  - `trace`: Output fatal/error/warn/info/debug/trace logs.
-- default: `info`
+|Value|Description|
+|---|---|
+|`off`|Do not output any logs.|
+|`fatal`|Output fatal logs.|
+|`error`|Output fatal/error logs.|
+|`warn`|Output fatal/error/warn logs.|
+|`info`|Output fatal/error/warn/info logs.|
+|`debug`|Output fatal/error/warn/info/debug logs.|
+|`trace`|Output fatal/error/warn/info/debug/trace logs.|
+
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --log-level info
+```
 
 ### `--package-manager`
 
-Package manager of your project
+Package manager of your project.
+
+|Name|Value|
+|---|---|
+|type|string|
+|required|false|
+|default|`npm`|
+
+#### Allowed values
 
-- type: string
-- required: false
-- allowed values
-  - `npm`: npm
-  - `yarn`: Yarn
-- default: `npm`
+|Value|Description|
+|---|---|
+|`npm`|npm|
+|`yarn`|Yarn|
+
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --package-manager npm
+```
 
 ### `--pr-body-notes`
 
-Additional notes for Pull request body
+Additional notes for Pull request body.
+
+|Name|Value|
+|---|---|
+|type|string|
+|required|false|
 
-- type: string
-- required: false
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --pr-body-notes "**:warning: Please see diff and release notes before merging.**"
+```
 
 ### `--pr-title`
 
-Pull request title template
+Pull request title template.
+
+|Name|Value|
+|---|---|
+|type|string|
+|required|false|
+|default|`chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`|
 
-- type: string
-- required: false
-- variables
-  - `currentVersion`: current package version
-  - `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}}}`
+#### Available variables
+
+|Variable|Description|
+|---|---|
+|`currentVersion`|Current package version|
+|`newVersion`|New package version|
+|`packageName`|Package name|
+|`level`|Semver level (`major`/`minor`/`patch`)|
+|`dependencyType`|Dependency type (`dependencies`/`devDependencies`/`peerDependencies`/`optionalDependencies`)|
+
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --pr-title "chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}"
+```
 
 ### `--reviewers`
 
-User names to request reviews
+User names to request reviews.
 
-- type: string[]
-- required: false
+|Name|Value|
+|---|---|
+|type|string[]|
+|required|false|
+
+#### Example
+
+```sh
+npx npm-update-package \
+  --github-token $GITHUB_TOKEN \
+  --reviewers npm-update-package npm-update-package-bot
+```
 
 ## GitHub token
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.45.5",
+    "version": "0.45.8",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -23,9 +23,11 @@
         "lodash": "4.14.2",
         "log4js": "6.4.2",
         "mustache": "4.1.0",
-        "npm-check-updates": "12.5.2",
+        "node-fetch": "2.6.7",
+        "npm-check-updates": "12.5.3",
         "parse-github-url": "1.0.2",
         "semver": "7.3.5",
+        "sleep-promise": "9.1.0",
         "type-guards": "0.15.0"
     },
     "devDependencies": {
@@ -35,10 +37,11 @@
         "@types/lodash": "4.14.179",
         "@types/mustache": "4.1.2",
         "@types/node": "12.20.40",
+        "@types/node-fetch": "2.6.1",
         "@types/parse-github-url": "1.0.0",
         "@types/semver": "7.3.9",
         "@typescript-eslint/eslint-plugin": "5.14.0",
-        "eslint": "8.10.0",
+        "eslint": "8.11.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/GitHub.js

@@ -89,22 +89,6 @@ class GitHub {
         }
         return pullRequests;
     }
-    async fetchReleases({ owner, repo }) {
-        const releases = [];
-        for (const page of (0, lodash_1.range)(1, 11)) {
-            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/pull-request/creator/PullRequestBodyCreator.js

@@ -67,13 +67,14 @@ ${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(release => `- [${release.tag_name}](${release.html_url})`);
+        const items = releases.map(({ tag, url }) => `- [${tag}](${url})`);
         return `## Release notes
 
 ${items.join('\n')}`;

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,20 +1,58 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 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");
 class ReleasesFetcher {
-    constructor(github) {
-        this.github = github;
+    constructor({ packageManager }) {
+        this.packageManager = packageManager;
     }
-    async fetch({ gitRepo, from, to }) {
-        const releases = await this.github.fetchReleases({
-            owner: gitRepo.owner,
-            repo: gitRepo.name
+    async fetch({ gitRepo, packageName, from, to }) {
+        const versions = await this.getVersions({
+            packageName,
+            from,
+            to
         });
-        return releases.filter(({ tag_name: version }) => {
-            // TODO: Move these to SemVer
-            return (0, semver_1.valid)(version) !== null && (0, semver_1.gte)(version, from.version) && (0, semver_1.lte)(version, to.version);
+        const tags = versions.map(version => `v${version}`);
+        return await this.fetchReleasesByTags({
+            gitRepo,
+            tags
         });
     }
+    async fetchReleaseByTag({ gitRepo, tag }) {
+        const url = `${gitRepo.url.toString()}/releases/tag/${tag}`;
+        const resp = await (0, node_fetch_1.default)(url);
+        if (resp.ok) {
+            return {
+                tag,
+                url
+            };
+        }
+    }
+    async fetchReleasesByTags({ gitRepo, tags }) {
+        const releases = await Promise.all(tags.map(async (tag, i) => {
+            if (i > 0) {
+                // NOTE: Sleeps for 1 second between fetches.
+                await (0, sleep_promise_1.default)(1000);
+            }
+            return await this.fetchReleaseByTag({
+                gitRepo,
+                tag
+            });
+        }));
+        return releases.filter(type_guards_1.isNotUndefined);
+    }
+    async getVersions({ packageName, from, to }) {
+        const versions = await this.packageManager.getVersions(packageName);
+        // TODO: Move these to SemVer
+        return versions.filter(version => (0, semver_1.valid)(version))
+            .filter(version => (0, semver_1.gte)(version, from.version))
+            .filter(version => (0, semver_1.lte)(version, to.version));
+    }
 }
 exports.ReleasesFetcher = ReleasesFetcher;

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

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./fetcher"), exports);
+__exportStar(require("./Release"), exports);

package/dist/src/main.js

@@ -65,10 +65,7 @@ const main = async ({ options, logger }) => {
         packageManager: options.packageManager
     });
     const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.prTitle);
-    const githubWithoutToken = (0, github_1.createGitHub)({
-        host: 'github.com'
-    });
-    const releasesFetcher = new github_1.ReleasesFetcher(githubWithoutToken);
+    const releasesFetcher = new github_1.ReleasesFetcher({ packageManager });
     const pullRequestBodyCreator = new github_1.PullRequestBodyCreator({
         options,
         releasesFetcher

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

@@ -1,12 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Npm = void 0;
+const Versions_1 = require("./Versions");
 class Npm {
     constructor(terminal) {
         this.terminal = terminal;
         this.packageFile = 'package.json';
         this.lockFile = 'package-lock.json';
     }
+    async getVersions(packageName) {
+        const { stdout } = await this.terminal.run('npm', 'info', packageName, 'versions', '--json');
+        const versions = JSON.parse(stdout);
+        if (!(0, Versions_1.isVersions)(versions)) {
+            throw new Error(`Failed to parse versions. versions=${JSON.stringify(versions)}`);
+        }
+        return versions;
+    }
     /**
      * @see https://docs.npmjs.com/cli/v8/commands/npm-install
      */

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isVersions = exports.Versions = void 0;
+const io_ts_1 = require("io-ts");
+exports.Versions = (0, io_ts_1.array)(io_ts_1.string);
+exports.isVersions = exports.Versions.is;

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

@@ -1,12 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Yarn = void 0;
+const Versions_1 = require("./Versions");
 class Yarn {
     constructor(terminal) {
         this.terminal = terminal;
         this.packageFile = 'package.json';
         this.lockFile = 'yarn.lock';
     }
+    async getVersions(packageName) {
+        const { stdout } = await this.terminal.run('yarn', 'info', packageName, 'versions', '--json');
+        const versions = JSON.parse(stdout);
+        if (!(0, Versions_1.isVersions)(versions)) {
+            throw new Error(`Failed to parse versions. versions=${JSON.stringify(versions)}`);
+        }
+        return versions;
+    }
     /**
      * @see https://classic.yarnpkg.com/en/docs/cli/install
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.45.5",
+  "version": "0.45.8",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -23,9 +23,11 @@
     "lodash": "4.14.2",
     "log4js": "6.4.2",
     "mustache": "4.1.0",
-    "npm-check-updates": "12.5.2",
+    "node-fetch": "2.6.7",
+    "npm-check-updates": "12.5.3",
     "parse-github-url": "1.0.2",
     "semver": "7.3.5",
+    "sleep-promise": "9.1.0",
     "type-guards": "0.15.0"
   },
   "devDependencies": {
@@ -35,10 +37,11 @@
     "@types/lodash": "4.14.179",
     "@types/mustache": "4.1.2",
     "@types/node": "12.20.40",
+    "@types/node-fetch": "2.6.1",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
     "@typescript-eslint/eslint-plugin": "5.14.0",
-    "eslint": "8.10.0",
+    "eslint": "8.11.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",
     "eslint-plugin-jest": "26.1.1",