npm-update-package 0.6.1 → 0.7.0

package/README.md

@@ -44,6 +44,7 @@ You can customize behavior via command-line options.
 |`--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}}`|
 
 ### Templates
 
@@ -60,3 +61,8 @@ These variables are available:
   - `currentVersion`
   - `newVersion`
   - `updateType`
+- `--pull-request-title`
+  - `packageName`
+  - `currentVersion`
+  - `newVersion`
+  - `updateType`

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

package/dist/github/PullRequestCreator.js

@@ -2,17 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCreator = void 0;
 const createPullRequestBody_1 = require("./createPullRequestBody");
-const createPullRequestTitle_1 = require("./createPullRequestTitle");
 // TODO: add test
 class PullRequestCreator {
-    constructor({ github, gitRepo, githubRepo, logger }) {
+    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, logger }) {
         this.github = github;
         this.gitRepo = gitRepo;
         this.githubRepo = githubRepo;
+        this.pullRequestTitleCreator = pullRequestTitleCreator;
         this.logger = logger;
     }
     async create({ outdatedPackage, branchName }) {
-        const title = (0, createPullRequestTitle_1.createPullRequestTitle)(outdatedPackage);
+        const title = this.pullRequestTitleCreator.create(outdatedPackage);
         this.logger.debug(`title=${title}`);
         const body = (0, createPullRequestBody_1.createPullRequestBody)(outdatedPackage);
         this.logger.debug(`body=${body}`);

package/dist/github/PullRequestTitleCreator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestTitleCreator = void 0;
+const mustache_1 = require("mustache");
+class PullRequestTitleCreator {
+    constructor(template) {
+        this.template = template;
+    }
+    create(outdatedPackage) {
+        const packageName = outdatedPackage.name;
+        const currentVersion = outdatedPackage.currentVersion.version;
+        const newVersion = outdatedPackage.newVersion.version;
+        const updateType = outdatedPackage.type;
+        return (0, mustache_1.render)(this.template, {
+            packageName,
+            currentVersion,
+            newVersion,
+            updateType
+        });
+    }
+}
+exports.PullRequestTitleCreator = PullRequestTitleCreator;

package/dist/github/index.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteBranchExistenceChecker = exports.PullRequestCreator = exports.GitHub = exports.createGitHub = void 0;
+exports.RemoteBranchExistenceChecker = exports.PullRequestTitleCreator = exports.PullRequestCreator = 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 PullRequestCreator_1 = require("./PullRequestCreator");
 Object.defineProperty(exports, "PullRequestCreator", { enumerable: true, get: function () { return PullRequestCreator_1.PullRequestCreator; } });
+var PullRequestTitleCreator_1 = require("./PullRequestTitleCreator");
+Object.defineProperty(exports, "PullRequestTitleCreator", { enumerable: true, get: function () { return PullRequestTitleCreator_1.PullRequestTitleCreator; } });
 var RemoteBranchExistenceChecker_1 = require("./RemoteBranchExistenceChecker");
 Object.defineProperty(exports, "RemoteBranchExistenceChecker", { enumerable: true, get: function () { return RemoteBranchExistenceChecker_1.RemoteBranchExistenceChecker; } });

package/dist/main.js

@@ -54,10 +54,12 @@ const main = async ({ options, logger }) => {
         terminal,
         packageManager: options.packageManager
     });
+    const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.pullRequestTitle);
     const pullRequestCreator = new github_1.PullRequestCreator({
         github,
         gitRepo,
         githubRepo,
+        pullRequestTitleCreator,
         logger
     });
     const branchNameCreator = new git_1.BranchNameCreator(options.branchName);

package/dist/options/Options.js

@@ -2,13 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isOptions = void 0;
 const io_ts_1 = require("io-ts");
+const logger_1 = require("../logger");
+const package_manager_1 = require("../package-manager");
 const Options = (0, io_ts_1.intersection)([
     (0, io_ts_1.type)({
         branchName: io_ts_1.string,
         commitMessage: io_ts_1.string,
         githubToken: io_ts_1.string,
-        logLevel: (0, io_ts_1.union)([(0, io_ts_1.literal)('info'), (0, io_ts_1.literal)('debug')]),
-        packageManager: (0, io_ts_1.union)([(0, io_ts_1.literal)('npm'), (0, io_ts_1.literal)('yarn')])
+        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)]),
+        pullRequestTitle: io_ts_1.string
     }),
     (0, io_ts_1.partial)({
         gitUserEmail: io_ts_1.string,

package/dist/options/initOptions.js

@@ -26,7 +26,8 @@ const initOptions = () => {
         package_manager_1.PackageManagerName.Npm,
         package_manager_1.PackageManagerName.Yarn
     ])
-        .default(package_manager_1.PackageManagerName.Npm));
+        .default(package_manager_1.PackageManagerName.Npm))
+        .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();
     if (!(0, Options_1.isOptions)(options)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.6.1",
+  "version": "0.7.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.6.1',
+  version: '0.7.0',
   web: 'https://github.com/npm-update-package/npm-update-package'
 } as const

package/src/github/PullRequestCreator.ts

@@ -2,8 +2,8 @@ import type { GitRepository } from '../git'
 import type { Logger } from '../logger'
 import type { OutdatedPackage } from '../ncu'
 import { createPullRequestBody } from './createPullRequestBody'
-import { createPullRequestTitle } from './createPullRequestTitle'
 import type { GitHub } from './GitHub'
+import type { PullRequestTitleCreator } from './PullRequestTitleCreator'
 import type { Repository as GitHubRepository } from './Repository'
 
 // TODO: add test
@@ -11,22 +11,26 @@ export class PullRequestCreator {
   private readonly github: GitHub
   private readonly gitRepo: GitRepository
   private readonly githubRepo: GitHubRepository
+  private readonly pullRequestTitleCreator: PullRequestTitleCreator
   private readonly logger: Logger
 
   constructor ({
     github,
     gitRepo,
     githubRepo,
+    pullRequestTitleCreator,
     logger
   }: {
     github: GitHub
     gitRepo: GitRepository
     githubRepo: GitHubRepository
+    pullRequestTitleCreator: PullRequestTitleCreator
     logger: Logger
   }) {
     this.github = github
     this.gitRepo = gitRepo
     this.githubRepo = githubRepo
+    this.pullRequestTitleCreator = pullRequestTitleCreator
     this.logger = logger
   }
 
@@ -37,7 +41,7 @@ export class PullRequestCreator {
     outdatedPackage: OutdatedPackage
     branchName: string
   }): Promise<void> {
-    const title = createPullRequestTitle(outdatedPackage)
+    const title = this.pullRequestTitleCreator.create(outdatedPackage)
     this.logger.debug(`title=${title}`)
 
     const body = createPullRequestBody(outdatedPackage)

package/src/github/PullRequestTitleCreator.test.ts

@@ -0,0 +1,17 @@
+import { PackageVersion } from '../ncu'
+import { PullRequestTitleCreator } from './PullRequestTitleCreator'
+
+describe('PullRequestTitleCreator', () => {
+  describe('create', () => {
+    it('returns commit message', () => {
+      const pullRequestTitleCreator = new PullRequestTitleCreator('chore(deps): {{updateType}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
+      const actual = pullRequestTitleCreator.create({
+        name: '@typescript-eslint/eslint-plugin',
+        currentVersion: PackageVersion.of('1.0.0'),
+        newVersion: PackageVersion.of('2.0.0'),
+        type: 'major'
+      })
+      expect(actual).toBe('chore(deps): major update @typescript-eslint/eslint-plugin from 1.0.0 to v2.0.0')
+    })
+  })
+})

package/src/github/PullRequestTitleCreator.ts

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

package/src/github/index.ts

@@ -3,5 +3,6 @@ export { createGitHub } from './createGitHub'
 export { GitHub } from './GitHub'
 export type { PullRequest } from './PullRequest'
 export { PullRequestCreator } from './PullRequestCreator'
+export { PullRequestTitleCreator } from './PullRequestTitleCreator'
 export { RemoteBranchExistenceChecker } from './RemoteBranchExistenceChecker'
 export type { Repository } from './Repository'

package/src/main.ts

@@ -7,6 +7,7 @@ import {
 import {
   createGitHub,
   PullRequestCreator,
+  PullRequestTitleCreator,
   RemoteBranchExistenceChecker
 } from './github'
 import type { Logger } from './logger'
@@ -82,10 +83,12 @@ export const main = async ({
     terminal,
     packageManager: options.packageManager
   })
+  const pullRequestTitleCreator = new PullRequestTitleCreator(options.pullRequestTitle)
   const pullRequestCreator = new PullRequestCreator({
     github,
     gitRepo,
     githubRepo,
+    pullRequestTitleCreator,
     logger
   })
   const branchNameCreator = new BranchNameCreator(options.branchName)

package/src/options/Options.ts

@@ -7,14 +7,17 @@ import {
   union
 } from 'io-ts'
 import type { TypeOf } from 'io-ts'
+import { LogLevel } from '../logger'
+import { PackageManagerName } from '../package-manager'
 
 const Options = intersection([
   type({
     branchName: string,
     commitMessage: string,
     githubToken: string,
-    logLevel: union([literal('info'), literal('debug')]),
-    packageManager: union([literal('npm'), literal('yarn')])
+    logLevel: union([literal(LogLevel.Info), literal(LogLevel.Debug)]),
+    packageManager: union([literal(PackageManagerName.Npm), literal(PackageManagerName.Yarn)]),
+    pullRequestTitle: string
   }),
   partial({
     gitUserEmail: string,

package/src/options/initOptions.ts

@@ -33,6 +33,7 @@ export const initOptions = (): Options => {
         ])
         .default(PackageManagerName.Npm)
     )
+    .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/createPullRequestTitle.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPullRequestTitle = void 0;
-const createPullRequestTitle = (outdatedPackage) => {
-    const packageName = outdatedPackage.name;
-    const newVersion = outdatedPackage.newVersion.version;
-    const updateType = outdatedPackage.type;
-    return `chore(deps): ${updateType} update ${packageName} to v${newVersion}`;
-};
-exports.createPullRequestTitle = createPullRequestTitle;

package/src/github/createPullRequestTitle.test.ts

@@ -1,42 +0,0 @@
-import { UpdateType, PackageVersion } from '../ncu'
-import { createPullRequestTitle } from './createPullRequestTitle'
-
-describe('createPullRequestTitle', () => {
-  const currentVersion = PackageVersion.of('1.0.0')
-
-  describe('if update type is patch', () => {
-    it('returns pull request title', () => {
-      const actual = createPullRequestTitle({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion,
-        newVersion: PackageVersion.of('1.0.1'),
-        type: UpdateType.Patch
-      })
-      expect(actual).toBe('chore(deps): patch update @typescript-eslint/eslint-plugin to v1.0.1')
-    })
-  })
-
-  describe('if update type is minor', () => {
-    it('returns pull request title', () => {
-      const actual = createPullRequestTitle({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion,
-        newVersion: PackageVersion.of('1.1.0'),
-        type: UpdateType.Minor
-      })
-      expect(actual).toBe('chore(deps): minor update @typescript-eslint/eslint-plugin to v1.1.0')
-    })
-  })
-
-  describe('if update type is major', () => {
-    it('returns pull request title', () => {
-      const actual = createPullRequestTitle({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion,
-        newVersion: PackageVersion.of('2.0.0'),
-        type: UpdateType.Major
-      })
-      expect(actual).toBe('chore(deps): major update @typescript-eslint/eslint-plugin to v2.0.0')
-    })
-  })
-})

package/src/github/createPullRequestTitle.ts

@@ -1,8 +0,0 @@
-import type { OutdatedPackage } from '../ncu'
-
-export const createPullRequestTitle = (outdatedPackage: OutdatedPackage): string => {
-  const packageName = outdatedPackage.name
-  const newVersion = outdatedPackage.newVersion.version
-  const updateType = outdatedPackage.type
-  return `chore(deps): ${updateType} update ${packageName} to v${newVersion}`
-}