npm-update-package 0.22.4 → 0.24.0

package/README.md

@@ -22,17 +22,16 @@ Commit message template
 
 - type: string
 - required: false
-- variables:
-  - `currentVersion`
-  - `newVersion`
-  - `packageName`
-  - `updateType`
-- default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`
+- variables
+  - `currentVersion`: current package version
+  - `newVersion`: new package version
+  - `packageName`: package name
+  - `level`: semver level (major/minor/patch)
+- default: `chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}`
 
 ### `--github-token`
 
-GitHub token.  
-See more in [GitHub token](#github-token) section.
+[GitHub token](#github-token).
 
 - type: string
 - required: true
@@ -43,7 +42,7 @@ Log level to show
 
 - type: string
 - required: false
-- allowed values:
+- allowed values
   - `off`: Do not output any logs.
   - `error`: Output error logs.
   - `info`: Output error/info logs.
@@ -56,9 +55,9 @@ Package manager of your project
 
 - type: string
 - required: false
-- allowed values:
+- allowed values
   - `npm`: npm
-  - `yarn`: Yarn
+  - `yarn`: Yarn (**It has not been tested yet.**)
 - default: `npm`
 
 ### `--pull-request-title`
@@ -67,23 +66,33 @@ Pull request title template
 
 - type: string
 - required: false
-- variables:
-  - `currentVersion`
-  - `newVersion`
-  - `packageName`
-  - `updateType`
-- default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`
+- variables
+  - `currentVersion`: current package version
+  - `newVersion`: new package version
+  - `packageName`: package name
+  - `level`: semver level (major/minor/patch)
+- default: `chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}`
 
 ## GitHub token
 
 GitHub token is required to run npm-update-package.  
-For example, the following tokens can be used.
+Available tokens and permissions required for each token are as follows.
 
-|GitHub token|Owner|Author of pull requests|Trigger other actions|
+- [GitHub Actions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
+- [GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps)
+  - Contents: Read-only
+  - Metadata: Read-only
+  - Pull requests: Read & write
+- [Personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
+  - repo
+
+Features of each token are as follows.
+
+||GitHub Actions|GitHub App|Personal access token|
 |---|---|---|---|
-|[GitHub Actions](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)|GitHub|`github-actions`||
-|[GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps)|organization or personal account|app which issued the token|✓|
-|[Personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)|personal account|user who issued the token|✓|
+|Owner of token|GitHub|organization or user|user|
+|Author of pull requests|`github-actions`|app|user|
+|Trigger other actions|-|✓|✓|
 
 We recommend using GitHub App for the following reasons.
 
@@ -93,20 +102,6 @@ We recommend using GitHub App for the following reasons.
 
 Creating a GitHub App may be tedious, but you only have to do it once the first time.
 
-### Token of GitHub App
-
-These permissions are required.
-
-- Contents: Read-only
-- Metadata: Read-only
-- Pull requests: Read & write
-
-### Personal access token
-
-These permissions are required.
-
-- repo
-
 ## Examples
 
 - Use token of GitHub Actions

package/dist/app.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.app = void 0;
 exports.app = {
     name: 'npm-update-package',
-    version: '0.22.4',
+    version: '0.24.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/core/OutdatedPackagesProcessor.js

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

package/dist/git/CommitMessageCreator.js

@@ -10,13 +10,12 @@ class CommitMessageCreator {
         const packageName = outdatedPackage.name;
         const currentVersion = outdatedPackage.currentVersion.version;
         const newVersion = outdatedPackage.newVersion.version;
-        // TODO: rename to level
-        const updateType = outdatedPackage.level;
+        const level = outdatedPackage.level;
         return (0, mustache_1.render)(this.template, {
             packageName,
             currentVersion,
             newVersion,
-            updateType
+            level
         });
     }
 }

package/dist/github/GitHub.js

@@ -20,6 +20,13 @@ class GitHub {
         const { data } = await this.octokit.pulls.create(params);
         return data;
     }
+    async deleteBranch({ owner, repo, branch }) {
+        await this.octokit.git.deleteRef({
+            owner,
+            repo,
+            ref: `heads/${branch}`
+        });
+    }
     // TODO: fetch all branches with page option
     async fetchBranches(params) {
         const { data } = await this.octokit.repos.listBranches({

package/dist/github/createGitHub.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createGitHub = void 0;
 const createOctokit_1 = require("./createOctokit");
 const GitHub_1 = require("./GitHub");
-// TODO: add test
 const createGitHub = ({ repository, token }) => {
     const octokit = (0, createOctokit_1.createOctokit)({
         repository,

package/dist/github/createOctokit.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createOctokit = void 0;
 const rest_1 = require("@octokit/rest");
 const app_1 = require("../app");
-// TODO: add test
 const createOctokit = ({ repository, token }) => {
     const auth = `token ${token}`;
     const userAgent = `${app_1.app.name}/${app_1.app.version}`;

package/dist/github/pull-request/closer/PullRequestCloser.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCloser = void 0;
-// TODO: Add test
 class PullRequestCloser {
     constructor(github) {
         this.github = github;
@@ -12,6 +11,11 @@ class PullRequestCloser {
             repo: pullRequest.base.repo.name,
             pull_number: pullRequest.number
         });
+        await this.github.deleteBranch({
+            owner: pullRequest.base.repo.owner.login,
+            repo: pullRequest.base.repo.name,
+            branch: pullRequest.head.ref
+        });
     }
 }
 exports.PullRequestCloser = PullRequestCloser;

package/dist/github/pull-request/creator/PullRequestTitleCreator.js

@@ -10,13 +10,12 @@ class PullRequestTitleCreator {
         const packageName = outdatedPackage.name;
         const currentVersion = outdatedPackage.currentVersion.version;
         const newVersion = outdatedPackage.newVersion.version;
-        // TODO: rename to level
-        const updateType = outdatedPackage.level;
+        const level = outdatedPackage.level;
         return (0, mustache_1.render)(this.template, {
             packageName,
             currentVersion,
             newVersion,
-            updateType
+            level
         });
     }
 }

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

@@ -13,10 +13,9 @@ const createPullRequestBody = (outdatedPackage) => {
     const packageName = outdatedPackage.name;
     const level = outdatedPackage.level;
     const metadata = (0, json_1.toJSON)((0, metadata_1.createPullRequestMetadata)([outdatedPackage]), { pretty: true });
-    // TODO: rename type to level
     return `This PR updates these packages:
 
-|package|type|current version|new version|
+|Package|Level|Current version|New version|
 |---|---|---|---|
 |[${packageName}](https://www.npmjs.com/package/${packageName})|${level}|\`${currentVersion}\`|\`${newVersion}\`|
 

package/dist/github/pull-request/metadata/PullRequestMetadata.js

@@ -9,8 +9,7 @@ const PullRequestMetadata = (0, io_ts_1.type)({
         name: io_ts_1.string,
         currentVersion: io_ts_1.string,
         newVersion: io_ts_1.string,
-        // TODO: rename to level
-        type: (0, io_ts_1.union)([(0, io_ts_1.literal)(semver_1.SemVerLevel.Major), (0, io_ts_1.literal)(semver_1.SemVerLevel.Minor), (0, io_ts_1.literal)(semver_1.SemVerLevel.Patch)])
+        level: (0, io_ts_1.union)([(0, io_ts_1.literal)(semver_1.SemVerLevel.Major), (0, io_ts_1.literal)(semver_1.SemVerLevel.Minor), (0, io_ts_1.literal)(semver_1.SemVerLevel.Patch)])
     }))
 });
 exports.isPullRequestMetadata = PullRequestMetadata.is;

package/dist/github/pull-request/metadata/createPullRequestMetadata.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPullRequestMetadata = void 0;
 const app_1 = require("../../../app");
-// TODO: Add test
 const createPullRequestMetadata = (outdatedPackages) => {
     return {
         version: app_1.app.version,
@@ -10,7 +9,7 @@ const createPullRequestMetadata = (outdatedPackages) => {
             name,
             currentVersion: currentVersion.version,
             newVersion: newVersion.version,
-            type: level
+            level
         }))
     };
 };

package/dist/json/toJSON.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toJSON = void 0;
-// TODO: Add test
 const toJSON = (value, options) => {
     var _a;
     const pretty = (_a = options === null || options === void 0 ? void 0 : options.pretty) !== null && _a !== void 0 ? _a : false;

package/dist/options/cliOptions.js

@@ -10,7 +10,7 @@ exports.cliOptions = [
         description: 'Commit message template',
         type: OptionType_1.OptionType.String,
         required: false,
-        default: 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}'
+        default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
     },
     {
         name: 'github-token',
@@ -47,6 +47,6 @@ exports.cliOptions = [
         description: 'Pull request title template',
         type: OptionType_1.OptionType.String,
         required: false,
-        default: 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}'
+        default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
     }
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.22.4",
+  "version": "0.24.0",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -20,7 +20,7 @@
     "@octokit/rest": "18.12.0",
     "commander": "8.3.0",
     "execa": "5.1.1",
-    "fp-ts": "2.11.7",
+    "fp-ts": "2.11.8",
     "io-ts": "2.2.16",
     "log4js": "6.3.0",
     "mustache": "4.1.0",
@@ -37,11 +37,11 @@
     "@types/node": "12.20.40",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.9.1",
-    "eslint": "8.6.0",
+    "@typescript-eslint/eslint-plugin": "5.10.0",
+    "eslint": "8.7.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-jest": "25.3.4",
+    "eslint-plugin-jest": "25.7.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-tsdoc": "0.2.14",
@@ -50,7 +50,7 @@
     "lint-staged": "12.1.7",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
-    "ts-jest": "27.1.2",
+    "ts-jest": "27.1.3",
     "ts-node": "10.4.0",
     "typescript": "4.5.4",
     "utility-types": "3.10.0"