npm-update-package 0.7.0 → 0.8.0

package/README.md

@@ -33,36 +33,112 @@ npm-update-package --github-token $GITHUB_TOKEN
 
 ## Options
 
-You can customize behavior via command-line options.
+You can customize behavior via command-line options.  
+Template strings such as `--branch-name` can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
 
-|Option|Description|Required|Value|Default|
-|---|---|---|---|---|
-|`--branch-name`|Branch name template|-|string|`npm-update-package/{{{packageName}}}/v{{newVersion}}`|
-|`--commit-message`|Commit message template|-|string|`chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`|
-|`--git-user-email`|User email of commit|-|string|-|
-|`--git-user-name`|User name of commit|-|string|-|
-|`--github-token`|GitHub token|✓|string|-|
-|`--log-level`|Log level to show|-|`info`, `debug`|`info`|
-|`--package-manager`|Package manager of your project|-|`npm`, `yarn`|`npm`|
-|`--pull-request-title`|Pull request title template|-|string|`chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`|
+### `--branch-name`
 
-### Templates
+Branch name template
 
-npm-update-package is using [mustache](https://www.npmjs.com/package/mustache) for generating string from templates.
-These variables are available:
-
-- `--branch-name`
-  - `packageName`
+- value: template string
+- embeddable variables:
   - `currentVersion`
   - `newVersion`
-  - `updateType`
-- `--commit-message`
   - `packageName`
+  - `updateType`
+- required: false
+- default: `npm-update-package/{{{packageName}}}/v{{newVersion}}`
+
+### `--commit-message`
+
+Commit message template
+
+- value: template string
+- embeddable variables:
   - `currentVersion`
   - `newVersion`
+  - `packageName`
   - `updateType`
-- `--pull-request-title`
+- required: false
+- default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`
+
+### `--git-user-email`
+
+User email of commit
+
+- value: string
+- required: false
+
+### `--git-user-name`
+
+User name of commit
+
+- value: string
+- required: false
+
+### `--github-token`
+
+GitHub token
+
+- value: string
+- required: true
+
+### `--log-level`
+
+Log level to show
+
+- value: string
+  - `info`
+  - `debug`
+- required: false
+- default: `info`
+
+### `--package-manager`
+
+Package manager of your project
+
+- value: string
+  - `npm`
+  - `yarn`
+- required: false
+- default: `npm`
+
+### `--pull-request-body`
+
+Pull request body template
+
+- value: template string
+- embeddable variables:
+  - `appName`
+  - `appVersion`
+  - `appWeb`
+  - `currentVersion`
+  - `newVersion`
   - `packageName`
+  - `updateType`
+- required: false
+- default:
+
+```
+This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
+
+---
+This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}
+```
+
+### `--pull-request-title`
+
+Pull request title template
+
+- value: template string
+- embeddable variables:
   - `currentVersion`
   - `newVersion`
+  - `packageName`
   - `updateType`
+- required: false
+- default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`

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.7.0',
+    version: '0.8.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/github/PullRequestBodyCreator.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestBodyCreator = void 0;
+const mustache_1 = require("mustache");
+const app_1 = require("../app");
+class PullRequestBodyCreator {
+    constructor(template) {
+        this.template = template;
+    }
+    create(outdatedPackage) {
+        const appName = app_1.app.name;
+        const appVersion = app_1.app.version;
+        const appWeb = app_1.app.web;
+        const currentVersion = outdatedPackage.currentVersion.version;
+        const newVersion = outdatedPackage.newVersion.version;
+        const packageName = outdatedPackage.name;
+        const updateType = outdatedPackage.type;
+        return (0, mustache_1.render)(this.template, {
+            appName,
+            appVersion,
+            appWeb,
+            currentVersion,
+            newVersion,
+            packageName,
+            updateType
+        });
+    }
+}
+exports.PullRequestBodyCreator = PullRequestBodyCreator;

package/dist/github/PullRequestCreator.js

@@ -1,20 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCreator = void 0;
-const createPullRequestBody_1 = require("./createPullRequestBody");
 // TODO: add test
 class PullRequestCreator {
-    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, logger }) {
+    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger }) {
         this.github = github;
         this.gitRepo = gitRepo;
         this.githubRepo = githubRepo;
         this.pullRequestTitleCreator = pullRequestTitleCreator;
+        this.pullRequestBodyCreator = pullRequestBodyCreator;
         this.logger = logger;
     }
     async create({ outdatedPackage, branchName }) {
         const title = this.pullRequestTitleCreator.create(outdatedPackage);
         this.logger.debug(`title=${title}`);
-        const body = (0, createPullRequestBody_1.createPullRequestBody)(outdatedPackage);
+        const body = this.pullRequestBodyCreator.create(outdatedPackage);
         this.logger.debug(`body=${body}`);
         const createdPullRequest = await this.github.createPullRequest({
             owner: this.gitRepo.owner,

package/dist/github/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteBranchExistenceChecker = exports.PullRequestTitleCreator = exports.PullRequestCreator = exports.GitHub = exports.createGitHub = void 0;
+exports.RemoteBranchExistenceChecker = exports.PullRequestTitleCreator = exports.PullRequestCreator = exports.PullRequestBodyCreator = exports.GitHub = exports.createGitHub = void 0;
 var createGitHub_1 = require("./createGitHub");
 Object.defineProperty(exports, "createGitHub", { enumerable: true, get: function () { return createGitHub_1.createGitHub; } });
 var GitHub_1 = require("./GitHub");
 Object.defineProperty(exports, "GitHub", { enumerable: true, get: function () { return GitHub_1.GitHub; } });
+var PullRequestBodyCreator_1 = require("./PullRequestBodyCreator");
+Object.defineProperty(exports, "PullRequestBodyCreator", { enumerable: true, get: function () { return PullRequestBodyCreator_1.PullRequestBodyCreator; } });
 var PullRequestCreator_1 = require("./PullRequestCreator");
 Object.defineProperty(exports, "PullRequestCreator", { enumerable: true, get: function () { return PullRequestCreator_1.PullRequestCreator; } });
 var PullRequestTitleCreator_1 = require("./PullRequestTitleCreator");

package/dist/main.js

@@ -55,11 +55,13 @@ const main = async ({ options, logger }) => {
         packageManager: options.packageManager
     });
     const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.pullRequestTitle);
+    const pullRequestBodyCreator = new github_1.PullRequestBodyCreator(options.pullRequestBody);
     const pullRequestCreator = new github_1.PullRequestCreator({
         github,
         gitRepo,
         githubRepo,
         pullRequestTitleCreator,
+        pullRequestBodyCreator,
         logger
     });
     const branchNameCreator = new git_1.BranchNameCreator(options.branchName);

package/dist/options/Options.js

@@ -11,6 +11,7 @@ const Options = (0, io_ts_1.intersection)([
         githubToken: io_ts_1.string,
         logLevel: (0, io_ts_1.union)([(0, io_ts_1.literal)(logger_1.LogLevel.Info), (0, io_ts_1.literal)(logger_1.LogLevel.Debug)]),
         packageManager: (0, io_ts_1.union)([(0, io_ts_1.literal)(package_manager_1.PackageManagerName.Npm), (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Yarn)]),
+        pullRequestBody: io_ts_1.string,
         pullRequestTitle: io_ts_1.string
     }),
     (0, io_ts_1.partial)({

package/dist/options/initOptions.js

@@ -27,6 +27,14 @@ const initOptions = () => {
         package_manager_1.PackageManagerName.Yarn
     ])
         .default(package_manager_1.PackageManagerName.Npm))
+        .option('--pull-request-body <value>', 'Pull request body template', `This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
+
+---
+This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`)
         .option('--pull-request-title <value>', 'Pull request title template', 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}');
     commander_1.program.parse(process.argv);
     const options = commander_1.program.opts();

package/package.json

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

package/src/app.ts

@@ -1,5 +1,5 @@
 export const app = {
   name: 'npm-update-package',
-  version: '0.7.0',
+  version: '0.8.0',
   web: 'https://github.com/npm-update-package/npm-update-package'
 } as const

package/src/github/PullRequestBodyCreator.test.ts

@@ -0,0 +1,32 @@
+import { app } from '../app'
+import { PackageVersion } from '../ncu'
+import { PullRequestBodyCreator } from './PullRequestBodyCreator'
+
+describe('PullRequestBodyCreator', () => {
+  describe('create', () => {
+    it('returns pull request body', () => {
+      const pullRequestBodyCreator = new PullRequestBodyCreator(`This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
+
+---
+This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`)
+      const actual = pullRequestBodyCreator.create({
+        name: '@typescript-eslint/eslint-plugin',
+        currentVersion: PackageVersion.of('1.0.0'),
+        newVersion: PackageVersion.of('2.0.0'),
+        type: 'major'
+      })
+      expect(actual).toBe(`This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|major|\`1.0.0\`|\`2.0.0\`|
+
+---
+This PR has been generated by [${app.name}](${app.web}) v${app.version}`)
+    })
+  })
+})

package/src/github/PullRequestBodyCreator.ts

@@ -0,0 +1,26 @@
+import { render } from 'mustache'
+import { app } from '../app'
+import type { OutdatedPackage } from '../ncu'
+
+export class PullRequestBodyCreator {
+  constructor (private readonly template: string) {}
+
+  create (outdatedPackage: OutdatedPackage): string {
+    const appName = app.name
+    const appVersion = app.version
+    const appWeb = app.web
+    const currentVersion = outdatedPackage.currentVersion.version
+    const newVersion = outdatedPackage.newVersion.version
+    const packageName = outdatedPackage.name
+    const updateType = outdatedPackage.type
+    return render(this.template, {
+      appName,
+      appVersion,
+      appWeb,
+      currentVersion,
+      newVersion,
+      packageName,
+      updateType
+    })
+  }
+}

package/src/github/PullRequestCreator.ts

@@ -1,8 +1,8 @@
 import type { GitRepository } from '../git'
 import type { Logger } from '../logger'
 import type { OutdatedPackage } from '../ncu'
-import { createPullRequestBody } from './createPullRequestBody'
 import type { GitHub } from './GitHub'
+import type { PullRequestBodyCreator } from './PullRequestBodyCreator'
 import type { PullRequestTitleCreator } from './PullRequestTitleCreator'
 import type { Repository as GitHubRepository } from './Repository'
 
@@ -12,6 +12,7 @@ export class PullRequestCreator {
   private readonly gitRepo: GitRepository
   private readonly githubRepo: GitHubRepository
   private readonly pullRequestTitleCreator: PullRequestTitleCreator
+  private readonly pullRequestBodyCreator: PullRequestBodyCreator
   private readonly logger: Logger
 
   constructor ({
@@ -19,18 +20,21 @@ export class PullRequestCreator {
     gitRepo,
     githubRepo,
     pullRequestTitleCreator,
+    pullRequestBodyCreator,
     logger
   }: {
     github: GitHub
     gitRepo: GitRepository
     githubRepo: GitHubRepository
     pullRequestTitleCreator: PullRequestTitleCreator
+    pullRequestBodyCreator: PullRequestBodyCreator
     logger: Logger
   }) {
     this.github = github
     this.gitRepo = gitRepo
     this.githubRepo = githubRepo
     this.pullRequestTitleCreator = pullRequestTitleCreator
+    this.pullRequestBodyCreator = pullRequestBodyCreator
     this.logger = logger
   }
 
@@ -44,7 +48,7 @@ export class PullRequestCreator {
     const title = this.pullRequestTitleCreator.create(outdatedPackage)
     this.logger.debug(`title=${title}`)
 
-    const body = createPullRequestBody(outdatedPackage)
+    const body = this.pullRequestBodyCreator.create(outdatedPackage)
     this.logger.debug(`body=${body}`)
 
     const createdPullRequest = await this.github.createPullRequest({

package/src/github/PullRequestTitleCreator.test.ts

@@ -3,7 +3,7 @@ import { PullRequestTitleCreator } from './PullRequestTitleCreator'
 
 describe('PullRequestTitleCreator', () => {
   describe('create', () => {
-    it('returns commit message', () => {
+    it('returns pull request title', () => {
       const pullRequestTitleCreator = new PullRequestTitleCreator('chore(deps): {{updateType}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
       const actual = pullRequestTitleCreator.create({
         name: '@typescript-eslint/eslint-plugin',

package/src/github/index.ts

@@ -2,6 +2,7 @@ export type { Branch } from './Branch'
 export { createGitHub } from './createGitHub'
 export { GitHub } from './GitHub'
 export type { PullRequest } from './PullRequest'
+export { PullRequestBodyCreator } from './PullRequestBodyCreator'
 export { PullRequestCreator } from './PullRequestCreator'
 export { PullRequestTitleCreator } from './PullRequestTitleCreator'
 export { RemoteBranchExistenceChecker } from './RemoteBranchExistenceChecker'

package/src/main.ts

@@ -6,6 +6,7 @@ import {
 } from './git'
 import {
   createGitHub,
+  PullRequestBodyCreator,
   PullRequestCreator,
   PullRequestTitleCreator,
   RemoteBranchExistenceChecker
@@ -84,11 +85,13 @@ export const main = async ({
     packageManager: options.packageManager
   })
   const pullRequestTitleCreator = new PullRequestTitleCreator(options.pullRequestTitle)
+  const pullRequestBodyCreator = new PullRequestBodyCreator(options.pullRequestBody)
   const pullRequestCreator = new PullRequestCreator({
     github,
     gitRepo,
     githubRepo,
     pullRequestTitleCreator,
+    pullRequestBodyCreator,
     logger
   })
   const branchNameCreator = new BranchNameCreator(options.branchName)

package/src/options/Options.ts

@@ -17,6 +17,7 @@ const Options = intersection([
     githubToken: string,
     logLevel: union([literal(LogLevel.Info), literal(LogLevel.Debug)]),
     packageManager: union([literal(PackageManagerName.Npm), literal(PackageManagerName.Yarn)]),
+    pullRequestBody: string,
     pullRequestTitle: string
   }),
   partial({

package/src/options/initOptions.ts

@@ -33,6 +33,14 @@ export const initOptions = (): Options => {
         ])
         .default(PackageManagerName.Npm)
     )
+    .option('--pull-request-body <value>', 'Pull request body template', `This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
+
+---
+This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`)
     .option('--pull-request-title <value>', 'Pull request title template', 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}')
   program.parse(process.argv)
   const options = program.opts()

package/dist/github/createPullRequestBody.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPullRequestBody = void 0;
-const app_1 = require("../app");
-const createPullRequestBody = (outdatedPackage) => {
-    const packageName = outdatedPackage.name;
-    const currentVersion = outdatedPackage.currentVersion.version;
-    const newVersion = outdatedPackage.newVersion.version;
-    const updateType = outdatedPackage.type;
-    return `This PR updates these packages:
-
-|package|type|current version|new version|
-|---|---|---|---|
-|[${packageName}](https://www.npmjs.com/package/${packageName})|${updateType}|\`${currentVersion}\`|\`${newVersion}\`|
-
----
-This PR has been generated by [${app_1.app.name}](${app_1.app.web})`;
-};
-exports.createPullRequestBody = createPullRequestBody;

package/src/github/createPullRequestBody.test.ts

@@ -1,64 +0,0 @@
-import {
-  PackageVersion,
-  UpdateType
-} from '../ncu'
-import { createPullRequestBody } from './createPullRequestBody'
-
-describe('createPullRequestBody', () => {
-  describe('if update type is patch', () => {
-    it('returns pull request body', () => {
-      const actual = createPullRequestBody({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion: PackageVersion.of('1.0.0'),
-        newVersion: PackageVersion.of('1.0.1'),
-        type: UpdateType.Patch
-      })
-      expect(actual).toBe(`This PR updates these packages:
-
-|package|type|current version|new version|
-|---|---|---|---|
-|[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|patch|\`1.0.0\`|\`1.0.1\`|
-
----
-This PR has been generated by [npm-update-package](https://github.com/npm-update-package/npm-update-package)`)
-    })
-  })
-
-  describe('if update type is minor', () => {
-    it('returns pull request body', () => {
-      const actual = createPullRequestBody({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion: PackageVersion.of('1.0.0'),
-        newVersion: PackageVersion.of('1.1.0'),
-        type: UpdateType.Minor
-      })
-      expect(actual).toBe(`This PR updates these packages:
-
-|package|type|current version|new version|
-|---|---|---|---|
-|[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|minor|\`1.0.0\`|\`1.1.0\`|
-
----
-This PR has been generated by [npm-update-package](https://github.com/npm-update-package/npm-update-package)`)
-    })
-  })
-
-  describe('if update type is major', () => {
-    it('returns pull request body', () => {
-      const actual = createPullRequestBody({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion: PackageVersion.of('1.0.0'),
-        newVersion: PackageVersion.of('2.0.0'),
-        type: UpdateType.Major
-      })
-      expect(actual).toBe(`This PR updates these packages:
-
-|package|type|current version|new version|
-|---|---|---|---|
-|[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|major|\`1.0.0\`|\`2.0.0\`|
-
----
-This PR has been generated by [npm-update-package](https://github.com/npm-update-package/npm-update-package)`)
-    })
-  })
-})

package/src/github/createPullRequestBody.ts

@@ -1,17 +0,0 @@
-import { app } from '../app'
-import type { OutdatedPackage } from '../ncu'
-
-export const createPullRequestBody = (outdatedPackage: OutdatedPackage): string => {
-  const packageName = outdatedPackage.name
-  const currentVersion = outdatedPackage.currentVersion.version
-  const newVersion = outdatedPackage.newVersion.version
-  const updateType = outdatedPackage.type
-  return `This PR updates these packages:
-
-|package|type|current version|new version|
-|---|---|---|---|
-|[${packageName}](https://www.npmjs.com/package/${packageName})|${updateType}|\`${currentVersion}\`|\`${newVersion}\`|
-
----
-This PR has been generated by [${app.name}](${app.web})`
-}