npm-update-package 0.4.0 → 0.5.0

package/README.md

@@ -38,6 +38,7 @@ You can customize behavior via command-line options.
 |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|-|
@@ -54,3 +55,8 @@ These variables are available:
   - `currentVersion`
   - `newVersion`
   - `updateType`
+- `--commit-message`
+  - `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.4.0',
+    version: '0.5.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/commit-message-creator/CommitMessageCreator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitMessageCreator = void 0;
+const mustache_1 = require("mustache");
+class CommitMessageCreator {
+    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.CommitMessageCreator = CommitMessageCreator;

package/dist/commit-message-creator/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommitMessageCreator = void 0;
+var CommitMessageCreator_1 = require("./CommitMessageCreator");
+Object.defineProperty(exports, "CommitMessageCreator", { enumerable: true, get: function () { return CommitMessageCreator_1.CommitMessageCreator; } });

package/dist/main.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
 const branch_name_creator_1 = require("./branch-name-creator");
+const commit_message_creator_1 = require("./commit-message-creator");
 const git_1 = require("./git");
 const github_1 = require("./github");
 const ncu_1 = require("./ncu");
@@ -57,6 +58,7 @@ const main = async ({ options, logger }) => {
         logger
     });
     const branchNameCreator = new branch_name_creator_1.BranchNameCreator(options.branchName);
+    const commitMessageCreator = new commit_message_creator_1.CommitMessageCreator(options.commitMessage);
     const outdatedPackageProcessor = new outdated_package_processor_1.OutdatedPackageProcessor({
         committer,
         git,
@@ -65,7 +67,8 @@ const main = async ({ options, logger }) => {
         pullRequestCreator,
         remoteBranchExistenceChecker,
         logger,
-        branchNameCreator
+        branchNameCreator,
+        commitMessageCreator
     });
     const outdatedPackagesProcessor = new outdated_packages_processor_1.OutdatedPackagesProcessor({
         outdatedPackageProcessor,

package/dist/options/Options.js

@@ -5,6 +5,7 @@ const io_ts_1 = require("io-ts");
 exports.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')])

package/dist/options/initOptions.js

@@ -10,6 +10,7 @@ const initOptions = () => {
     commander_1.program
         .version(app_1.app.version)
         .option('--branch-name <value>', 'Branch name template', 'npm-update-package/{{{packageName}}}/v{{newVersion}}')
+        .option('--commit-message <value>', 'Commit message template', 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}')
         .option('--git-user-email <value>', 'User email of commit')
         .option('--git-user-name <value>', 'User name of commit')
         .requiredOption('--github-token <value>', 'GitHub token')

package/dist/outdated-package-processor/OutdatedPackageProcessor.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutdatedPackageProcessor = void 0;
-const createCommitMessage_1 = require("./createCommitMessage");
 // TODO: add test
 class OutdatedPackageProcessor {
-    constructor({ committer, git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger, branchNameCreator }) {
+    constructor({ committer, git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger, branchNameCreator, commitMessageCreator }) {
         this.committer = committer;
         this.git = git;
         this.ncu = ncu;
@@ -13,6 +12,7 @@ class OutdatedPackageProcessor {
         this.remoteBranchExistenceChecker = remoteBranchExistenceChecker;
         this.logger = logger;
         this.branchNameCreator = branchNameCreator;
+        this.commitMessageCreator = commitMessageCreator;
     }
     /**
      * Don't run in parallel because it includes file operations.
@@ -36,7 +36,7 @@ class OutdatedPackageProcessor {
         await this.packageManager.install();
         this.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
         await this.git.add(...this.packageManager.packageFiles);
-        const message = (0, createCommitMessage_1.createCommitMessage)(outdatedPackage);
+        const message = this.commitMessageCreator.create(outdatedPackage);
         this.logger.debug(`message=${message}`);
         await this.committer.commit(message);
         await this.git.push(branchName);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.4.0",
+  "version": "0.5.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.4.0',
+  version: '0.5.0',
   web: 'https://github.com/npm-update-package/npm-update-package'
 } as const

package/src/commit-message-creator/CommitMessageCreator.test.ts

@@ -0,0 +1,17 @@
+import { PackageVersion } from '../values'
+import { CommitMessageCreator } from './CommitMessageCreator'
+
+describe('CommitMessageCreator', () => {
+  describe('create', () => {
+    it('returns commit message', () => {
+      const commitMessageCreator = new CommitMessageCreator('chore(deps): {{updateType}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
+      const actual = commitMessageCreator.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/commit-message-creator/CommitMessageCreator.ts

@@ -0,0 +1,19 @@
+import { render } from 'mustache'
+import type { OutdatedPackage } from '../types'
+
+export class CommitMessageCreator {
+  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/commit-message-creator/index.ts

@@ -0,0 +1 @@
+export { CommitMessageCreator } from './CommitMessageCreator'

package/src/main.ts

@@ -1,4 +1,5 @@
 import { BranchNameCreator } from './branch-name-creator'
+import { CommitMessageCreator } from './commit-message-creator'
 import {
   Committer,
   Git
@@ -77,6 +78,7 @@ export const main = async ({
     logger
   })
   const branchNameCreator = new BranchNameCreator(options.branchName)
+  const commitMessageCreator = new CommitMessageCreator(options.commitMessage)
   const outdatedPackageProcessor = new OutdatedPackageProcessor({
     committer,
     git,
@@ -85,7 +87,8 @@ export const main = async ({
     pullRequestCreator,
     remoteBranchExistenceChecker,
     logger,
-    branchNameCreator
+    branchNameCreator,
+    commitMessageCreator
   })
   const outdatedPackagesProcessor = new OutdatedPackagesProcessor({
     outdatedPackageProcessor,

package/src/options/Options.ts

@@ -11,6 +11,7 @@ import type { TypeOf } from 'io-ts'
 export const Options = intersection([
   type({
     branchName: string,
+    commitMessage: string,
     githubToken: string,
     logLevel: union([literal('info'), literal('debug')]),
     packageManager: union([literal('npm'), literal('yarn')])

package/src/options/initOptions.ts

@@ -15,6 +15,7 @@ export const initOptions = (): Options => {
   program
     .version(app.version)
     .option('--branch-name <value>', 'Branch name template', 'npm-update-package/{{{packageName}}}/v{{newVersion}}')
+    .option('--commit-message <value>', 'Commit message template', 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}')
     .option('--git-user-email <value>', 'User email of commit')
     .option('--git-user-name <value>', 'User name of commit')
     .requiredOption('--github-token <value>', 'GitHub token')

package/src/outdated-package-processor/OutdatedPackageProcessor.ts

@@ -1,4 +1,5 @@
 import type { BranchNameCreator } from '../branch-name-creator'
+import type { CommitMessageCreator } from '../commit-message-creator'
 import type {
   Committer,
   Git
@@ -14,7 +15,6 @@ import type {
   OutdatedPackage,
   Result
 } from '../types'
-import { createCommitMessage } from './createCommitMessage'
 
 // TODO: add test
 export class OutdatedPackageProcessor {
@@ -26,6 +26,7 @@ export class OutdatedPackageProcessor {
   private readonly remoteBranchExistenceChecker: RemoteBranchExistenceChecker
   private readonly logger: Logger
   private readonly branchNameCreator: BranchNameCreator
+  private readonly commitMessageCreator: CommitMessageCreator
 
   constructor ({
     committer,
@@ -35,7 +36,8 @@ export class OutdatedPackageProcessor {
     pullRequestCreator,
     remoteBranchExistenceChecker,
     logger,
-    branchNameCreator
+    branchNameCreator,
+    commitMessageCreator
   }: {
     committer: Committer
     git: Git
@@ -45,6 +47,7 @@ export class OutdatedPackageProcessor {
     remoteBranchExistenceChecker: RemoteBranchExistenceChecker
     logger: Logger
     branchNameCreator: BranchNameCreator
+    commitMessageCreator: CommitMessageCreator
   }) {
     this.committer = committer
     this.git = git
@@ -54,6 +57,7 @@ export class OutdatedPackageProcessor {
     this.remoteBranchExistenceChecker = remoteBranchExistenceChecker
     this.logger = logger
     this.branchNameCreator = branchNameCreator
+    this.commitMessageCreator = commitMessageCreator
   }
 
   /**
@@ -84,7 +88,7 @@ export class OutdatedPackageProcessor {
     this.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`)
 
     await this.git.add(...this.packageManager.packageFiles)
-    const message = createCommitMessage(outdatedPackage)
+    const message = this.commitMessageCreator.create(outdatedPackage)
     this.logger.debug(`message=${message}`)
 
     await this.committer.commit(message)

package/dist/outdated-package-processor/createCommitMessage.js

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

package/src/outdated-package-processor/createCommitMessage.test.ts

@@ -1,43 +0,0 @@
-import { UpdateType } from '../enums'
-import { PackageVersion } from '../values'
-import { createCommitMessage } from './createCommitMessage'
-
-describe('createCommitMessage', () => {
-  const currentVersion = PackageVersion.of('1.0.0')
-
-  describe('if update type is patch', () => {
-    it('returns commit message', () => {
-      const actual = createCommitMessage({
-        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 commit message', () => {
-      const actual = createCommitMessage({
-        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 commit message', () => {
-      const actual = createCommitMessage({
-        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/outdated-package-processor/createCommitMessage.ts

@@ -1,8 +0,0 @@
-import type { OutdatedPackage } from '../types'
-
-export const createCommitMessage = (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}`
-}