npm-update-package 0.2.1 → 0.5.1

package/src/main.ts

@@ -1,4 +1,6 @@
 import {
+  BranchNameCreator,
+  CommitMessageCreator,
   Committer,
   Git
 } from './git'
@@ -10,9 +12,15 @@ import {
 import type { Logger } from './logger'
 import { Ncu } from './ncu'
 import type { Options } from './options'
-import { OutdatedPackageProcessor } from './outdated-package-processor'
-import { OutdatedPackagesProcessor } from './outdated-packages-processor'
+import {
+  PackageJsonParser,
+  PackageJsonReader
+} from './package-json'
 import { createPackageManager } from './package-manager'
+import {
+  OutdatedPackageProcessor,
+  OutdatedPackagesProcessor
+} from './processors'
 import { Terminal } from './terminal'
 
 // TODO: add test
@@ -25,7 +33,12 @@ export const main = async ({
 }): Promise<void> => {
   logger.debug(`options=${JSON.stringify(options)}`)
 
-  const ncu = new Ncu()
+  const packageJsonParser = new PackageJsonParser(logger)
+  const packageJsonReader = new PackageJsonReader({
+    packageJsonParser,
+    logger
+  })
+  const ncu = new Ncu(packageJsonReader)
   const outdatedPackages = await ncu.check()
   logger.debug(`outdatedPackages=${JSON.stringify(outdatedPackages)}`)
 
@@ -75,6 +88,8 @@ export const main = async ({
     githubRepo,
     logger
   })
+  const branchNameCreator = new BranchNameCreator(options.branchName)
+  const commitMessageCreator = new CommitMessageCreator(options.commitMessage)
   const outdatedPackageProcessor = new OutdatedPackageProcessor({
     committer,
     git,
@@ -82,7 +97,9 @@ export const main = async ({
     packageManager,
     pullRequestCreator,
     remoteBranchExistenceChecker,
-    logger
+    logger,
+    branchNameCreator,
+    commitMessageCreator
   })
   const outdatedPackagesProcessor = new OutdatedPackagesProcessor({
     outdatedPackageProcessor,

package/src/ncu/Ncu.ts

@@ -1,12 +1,14 @@
 import { run } from 'npm-check-updates'
 import type { Options } from 'npm-check-updates/build/src/types'
-import { readPackageJson } from '../read-package-json'
-import type { OutdatedPackage } from '../types'
+import type { OutdatedPackage } from '../ncu'
+import type { PackageJsonReader } from '../package-json'
 import { isNcuOutdatedPackages } from './isNcuOutdatedPackages'
 import { NcuOutdatedPackagesConverter } from './NcuOutdatedPackagesConverter'
 
 // TODO: add test
 export class Ncu {
+  constructor (private readonly packageJsonReader: PackageJsonReader) {}
+
   async check (): Promise<OutdatedPackage[]> {
     return await this.run({
       jsonUpgraded: true
@@ -22,7 +24,7 @@ export class Ncu {
   }
 
   private async run (options: Options): Promise<OutdatedPackage[]> {
-    const pkg = await readPackageJson('./package.json')
+    const pkg = await this.packageJsonReader.read('./package.json')
     const currentDependencies = {
       ...pkg.dependencies,
       ...pkg.devDependencies,

package/src/ncu/NcuOutdatedPackagesConverter.ts

@@ -1,7 +1,7 @@
-import type { PackageDependencies } from '../read-package-json'
-import type { OutdatedPackage } from '../types'
-import { PackageVersion } from '../values'
+import type { PackageDependencies } from '../package-json'
 import type { NcuOutdatedPackages } from './NcuOutdatedPackages'
+import type { OutdatedPackage } from './OutdatedPackage'
+import { PackageVersion } from './PackageVersion'
 import { toUpdateType } from './toUpdateType'
 
 // TODO: add test

package/src/{types → ncu}/OutdatedPackage.ts

@@ -1,5 +1,5 @@
-import type { UpdateType } from '../enums/UpdateType'
-import type { PackageVersion } from '../values'
+import type { PackageVersion } from './PackageVersion'
+import type { UpdateType } from './UpdateType'
 
 export interface OutdatedPackage {
   name: string

package/src/ncu/index.ts

@@ -1 +1,7 @@
 export { Ncu } from './Ncu'
+export type { OutdatedPackage } from './OutdatedPackage'
+export { PackageVersion } from './PackageVersion'
+export {
+  isUpdateType,
+  UpdateType
+} from './UpdateType'

package/src/ncu/toUpdateType.test.ts

@@ -1,6 +1,6 @@
-import { UpdateType } from '../enums'
-import { PackageVersion } from '../values'
+import { PackageVersion } from './PackageVersion'
 import { toUpdateType } from './toUpdateType'
+import { UpdateType } from './UpdateType'
 
 describe('toUpdateType', () => {
   const currentVersion = PackageVersion.of('1.0.0')

package/src/ncu/toUpdateType.ts

@@ -1,5 +1,5 @@
-import { UpdateType } from '../enums'
-import type { PackageVersion } from '../values'
+import type { PackageVersion } from './PackageVersion'
+import { UpdateType } from './UpdateType'
 
 export const toUpdateType = (currentVersion: PackageVersion, newVersion: PackageVersion): UpdateType => {
   if (currentVersion.major !== newVersion.major) {

package/src/options/Options.ts

@@ -8,8 +8,10 @@ import {
 } from 'io-ts'
 import type { TypeOf } from 'io-ts'
 
-export const Options = intersection([
+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

@@ -3,6 +3,8 @@ import {
   program
 } from 'commander'
 import { app } from '../app'
+import { LogLevel } from '../logger'
+import { PackageManagerName } from '../package-manager'
 import { isOptions } from './Options'
 import type { Options } from './Options'
 
@@ -10,18 +12,26 @@ import type { Options } from './Options'
 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')
     .addOption(
       new Option('--log-level <value>', 'Log level to show')
-        .choices(['info', 'debug'])
-        .default('info')
+        .choices([
+          LogLevel.Info,
+          LogLevel.Debug
+        ])
+        .default(LogLevel.Info)
     )
     .addOption(
       new Option('--package-manager <value>', 'Package manager of your project')
-        .choices(['npm', 'yarn'])
-        .default('npm')
+        .choices([
+          PackageManagerName.Npm,
+          PackageManagerName.Yarn
+        ])
+        .default(PackageManagerName.Npm)
     )
   program.parse(process.argv)
   const options = program.opts()

package/src/{read-package-json → package-json}/Package.ts

@@ -7,7 +7,7 @@ import {
 import type { TypeOf } from 'io-ts'
 import { PackageDependencies } from './PackageDependencies'
 
-export const Package = intersection([
+const Package = intersection([
   type({
     name: string,
     version: string

package/src/package-json/PackageJsonParser.ts

@@ -0,0 +1,19 @@
+import type { Logger } from '../logger'
+import { isPackage } from './Package'
+import type { Package } from './Package'
+
+// TODO: add test
+export class PackageJsonParser {
+  constructor (private readonly logger: Logger) {}
+
+  parse (json: string): Package {
+    const parsed: unknown = JSON.parse(json)
+    this.logger.debug(`parsed=${JSON.stringify(parsed)}`)
+
+    if (isPackage(parsed)) {
+      return parsed
+    } else {
+      throw new Error(`Failed to parse package.json. json=${json}`)
+    }
+  }
+}

package/src/package-json/PackageJsonReader.ts

@@ -0,0 +1,27 @@
+import fs from 'fs'
+import type { Logger } from '../logger'
+import type { Package } from './Package'
+import type { PackageJsonParser } from './PackageJsonParser'
+
+// TODO: add test
+export class PackageJsonReader {
+  private readonly packageJsonParser: PackageJsonParser
+  private readonly logger: Logger
+
+  constructor ({
+    packageJsonParser,
+    logger
+  }: {
+    packageJsonParser: PackageJsonParser
+    logger: Logger
+  }) {
+    this.packageJsonParser = packageJsonParser
+    this.logger = logger
+  }
+
+  async read (filePath: string): Promise<Package> {
+    const json = await fs.promises.readFile(filePath, 'utf8')
+    this.logger.debug(`json=${json}`)
+    return this.packageJsonParser.parse(json)
+  }
+}

package/src/package-json/index.ts

@@ -0,0 +1,3 @@
+export { PackageJsonParser } from './PackageJsonParser'
+export { PackageJsonReader } from './PackageJsonReader'
+export type { PackageDependencies } from './PackageDependencies'

package/src/package-manager/createPackageManager.ts

@@ -1,7 +1,7 @@
-import type { PackageManagerName } from '../enums'
 import type { Terminal } from '../terminal'
 import { Npm } from './Npm'
 import type { PackageManager } from './PackageManager'
+import type { PackageManagerName } from './PackageManagerName'
 import { Yarn } from './Yarn'
 
 // TODO: add test

package/src/package-manager/index.ts

@@ -1,4 +1,8 @@
 export { createPackageManager } from './createPackageManager'
 export { Npm } from './Npm'
 export type { PackageManager } from './PackageManager'
+export {
+  isPackageManagerName,
+  PackageManagerName
+} from './PackageManagerName'
 export { Yarn } from './Yarn'

package/src/{outdated-package-processor → processors}/OutdatedPackageProcessor.ts

@@ -1,4 +1,6 @@
 import type {
+  BranchNameCreator,
+  CommitMessageCreator,
   Committer,
   Git
 } from '../git'
@@ -7,14 +9,12 @@ import type {
   RemoteBranchExistenceChecker
 } from '../github'
 import type { Logger } from '../logger'
-import type { Ncu } from '../ncu'
-import type { PackageManager } from '../package-manager'
 import type {
-  OutdatedPackage,
-  Result
-} from '../types'
-import { createBranchName } from './createBranchName'
-import { createCommitMessage } from './createCommitMessage'
+  Ncu,
+  OutdatedPackage
+} from '../ncu'
+import type { PackageManager } from '../package-manager'
+import type { Result } from './Result'
 
 // TODO: add test
 export class OutdatedPackageProcessor {
@@ -25,6 +25,8 @@ export class OutdatedPackageProcessor {
   private readonly pullRequestCreator: PullRequestCreator
   private readonly remoteBranchExistenceChecker: RemoteBranchExistenceChecker
   private readonly logger: Logger
+  private readonly branchNameCreator: BranchNameCreator
+  private readonly commitMessageCreator: CommitMessageCreator
 
   constructor ({
     committer,
@@ -33,7 +35,9 @@ export class OutdatedPackageProcessor {
     packageManager,
     pullRequestCreator,
     remoteBranchExistenceChecker,
-    logger
+    logger,
+    branchNameCreator,
+    commitMessageCreator
   }: {
     committer: Committer
     git: Git
@@ -42,6 +46,8 @@ export class OutdatedPackageProcessor {
     pullRequestCreator: PullRequestCreator
     remoteBranchExistenceChecker: RemoteBranchExistenceChecker
     logger: Logger
+    branchNameCreator: BranchNameCreator
+    commitMessageCreator: CommitMessageCreator
   }) {
     this.committer = committer
     this.git = git
@@ -50,13 +56,15 @@ export class OutdatedPackageProcessor {
     this.pullRequestCreator = pullRequestCreator
     this.remoteBranchExistenceChecker = remoteBranchExistenceChecker
     this.logger = logger
+    this.branchNameCreator = branchNameCreator
+    this.commitMessageCreator = commitMessageCreator
   }
 
   /**
    * Don't run in parallel because it includes file operations.
    */
   async process (outdatedPackage: OutdatedPackage): Promise<Result> {
-    const branchName = createBranchName(outdatedPackage)
+    const branchName = this.branchNameCreator.create(outdatedPackage)
     this.logger.debug(`branchName=${branchName}`)
 
     if (this.remoteBranchExistenceChecker.check(branchName)) {
@@ -80,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/src/{outdated-packages-processor → processors}/OutdatedPackagesProcessor.ts

@@ -1,9 +1,7 @@
 import type { Logger } from '../logger'
-import type { OutdatedPackageProcessor } from '../outdated-package-processor'
-import type {
-  OutdatedPackage,
-  Result
-} from '../types'
+import type { OutdatedPackage } from '../ncu'
+import type { OutdatedPackageProcessor } from './OutdatedPackageProcessor'
+import type { Result } from './Result'
 
 export class OutdatedPackagesProcessor {
   private readonly outdatedPackageProcessor: OutdatedPackageProcessor

package/src/{types → processors}/Result.ts

@@ -1,4 +1,4 @@
-import type { OutdatedPackage } from './OutdatedPackage'
+import type { OutdatedPackage } from '../ncu'
 
 export interface Result {
   outdatedPackage: OutdatedPackage

package/src/{outdated-packages-processor → processors}/index.ts

@@ -1 +1,2 @@
+export { OutdatedPackageProcessor } from './OutdatedPackageProcessor'
 export { OutdatedPackagesProcessor } from './OutdatedPackagesProcessor'

package/dist/enums/index.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UpdateType = exports.isUpdateType = exports.PackageManagerName = exports.isPackageManagerName = exports.LogLevel = exports.isLogLevel = void 0;
-var LogLevel_1 = require("./LogLevel");
-Object.defineProperty(exports, "isLogLevel", { enumerable: true, get: function () { return LogLevel_1.isLogLevel; } });
-Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return LogLevel_1.LogLevel; } });
-var PackageManagerName_1 = require("./PackageManagerName");
-Object.defineProperty(exports, "isPackageManagerName", { enumerable: true, get: function () { return PackageManagerName_1.isPackageManagerName; } });
-Object.defineProperty(exports, "PackageManagerName", { enumerable: true, get: function () { return PackageManagerName_1.PackageManagerName; } });
-var UpdateType_1 = require("./UpdateType");
-Object.defineProperty(exports, "isUpdateType", { enumerable: true, get: function () { return UpdateType_1.isUpdateType; } });
-Object.defineProperty(exports, "UpdateType", { enumerable: true, get: function () { return UpdateType_1.UpdateType; } });

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

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBranchName = void 0;
-const createBranchName = (outdatedPackage) => {
-    const packageName = outdatedPackage.name;
-    const newVersion = outdatedPackage.newVersion.version;
-    return `npm-update-package/${packageName}/v${newVersion}`;
-};
-exports.createBranchName = createBranchName;

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/dist/outdated-package-processor/index.js

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

package/dist/read-package-json/index.js

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

package/dist/read-package-json/parsePackageJson.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parsePackageJson = void 0;
-const Package_1 = require("./Package");
-// TODO: add test
-const parsePackageJson = (json) => {
-    const parsed = JSON.parse(json);
-    if ((0, Package_1.isPackage)(parsed)) {
-        return parsed;
-    }
-    else {
-        throw new Error(`Failed to parse package.json. json=${json}`);
-    }
-};
-exports.parsePackageJson = parsePackageJson;

package/dist/read-package-json/readFile.js

@@ -1,12 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readFile = void 0;
-const fs_1 = __importDefault(require("fs"));
-// TODO: add test
-const readFile = async (filePath) => {
-    return await fs_1.default.promises.readFile(filePath, 'utf8');
-};
-exports.readFile = readFile;

package/dist/read-package-json/readPackageJson.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readPackageJson = void 0;
-const parsePackageJson_1 = require("./parsePackageJson");
-const readFile_1 = require("./readFile");
-// TODO: add test
-const readPackageJson = async (filePath) => {
-    const json = await (0, readFile_1.readFile)(filePath);
-    return (0, parsePackageJson_1.parsePackageJson)(json);
-};
-exports.readPackageJson = readPackageJson;

package/dist/types/index.js

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

package/dist/values/index.js

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

package/src/enums/index.ts

@@ -1,12 +0,0 @@
-export {
-  isLogLevel,
-  LogLevel
-} from './LogLevel'
-export {
-  isPackageManagerName,
-  PackageManagerName
-} from './PackageManagerName'
-export {
-  isUpdateType,
-  UpdateType
-} from './UpdateType'

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

@@ -1,14 +0,0 @@
-import { PackageVersion } from '../values'
-import { createBranchName } from './createBranchName'
-
-describe('createBranchName', () => {
-  it('returns branch name', () => {
-    const actual = createBranchName({
-      name: '@typescript-eslint/eslint-plugin',
-      currentVersion: PackageVersion.of('1.0.0'),
-      newVersion: PackageVersion.of('1.2.3'),
-      type: 'major'
-    })
-    expect(actual).toBe('npm-update-package/@typescript-eslint/eslint-plugin/v1.2.3')
-  })
-})

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

@@ -1,7 +0,0 @@
-import type { OutdatedPackage } from '../types'
-
-export const createBranchName = (outdatedPackage: OutdatedPackage): string => {
-  const packageName = outdatedPackage.name
-  const newVersion = outdatedPackage.newVersion.version
-  return `npm-update-package/${packageName}/v${newVersion}`
-}

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}`
-}

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

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

package/src/read-package-json/index.ts

@@ -1,2 +0,0 @@
-export type { PackageDependencies } from './PackageDependencies'
-export { readPackageJson } from './readPackageJson'

package/src/read-package-json/parsePackageJson.ts

@@ -1,13 +0,0 @@
-import { isPackage } from './Package'
-import type { Package } from './Package'
-
-// TODO: add test
-export const parsePackageJson = (json: string): Package => {
-  const parsed: unknown = JSON.parse(json)
-
-  if (isPackage(parsed)) {
-    return parsed
-  } else {
-    throw new Error(`Failed to parse package.json. json=${json}`)
-  }
-}

package/src/read-package-json/readFile.ts

@@ -1,6 +0,0 @@
-import fs from 'fs'
-
-// TODO: add test
-export const readFile = async (filePath: string): Promise<string> => {
-  return await fs.promises.readFile(filePath, 'utf8')
-}

package/src/read-package-json/readPackageJson.ts

@@ -1,9 +0,0 @@
-import type { Package } from './Package'
-import { parsePackageJson } from './parsePackageJson'
-import { readFile } from './readFile'
-
-// TODO: add test
-export const readPackageJson = async (filePath: string): Promise<Package> => {
-  const json = await readFile(filePath)
-  return parsePackageJson(json)
-}

package/src/types/index.ts

@@ -1,2 +0,0 @@
-export type { OutdatedPackage } from './OutdatedPackage'
-export type { Result } from './Result'

package/src/values/index.ts

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