npm-update-package 0.8.0 → 0.9.0

package/src/package-json/PackageJsonReader.ts

@@ -1,27 +0,0 @@
-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

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

package/src/package-manager/Npm.ts

@@ -1,19 +0,0 @@
-import type { Terminal } from '../terminal'
-import type { PackageManager } from './PackageManager'
-
-// TODO: add test
-export class Npm implements PackageManager {
-   readonly packageFiles = [
-     'package.json',
-     'package-lock.json'
-   ]
-
-   constructor (private readonly terminal: Terminal) {}
-
-   /**
-   * @see https://docs.npmjs.com/cli/v8/commands/npm-install
-   */
-   async install (): Promise<void> {
-     await this.terminal.run('npm', 'install')
-   }
-}

package/src/package-manager/PackageManager.ts

@@ -1,4 +0,0 @@
-export interface PackageManager {
-  packageFiles: string[]
-  install: () => Promise<void>
-}

package/src/package-manager/PackageManagerName.ts

@@ -1,8 +0,0 @@
-export const PackageManagerName = {
-  Npm: 'npm',
-  Yarn: 'yarn'
-} as const
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type PackageManagerName = typeof PackageManagerName[keyof typeof PackageManagerName]
-const packageManagerNames = Object.values(PackageManagerName)
-export const isPackageManagerName = (value: any): value is PackageManagerName => packageManagerNames.includes(value)

package/src/package-manager/Yarn.ts

@@ -1,19 +0,0 @@
-import type { Terminal } from '../terminal'
-import type { PackageManager } from './PackageManager'
-
-// TODO: add test
-export class Yarn implements PackageManager {
-  readonly packageFiles = [
-    'package.json',
-    'yarn.lock'
-  ]
-
-  constructor (private readonly terminal: Terminal) {}
-
-  /**
-   * @see https://classic.yarnpkg.com/en/docs/cli/install
-   */
-  async install (): Promise<void> {
-    await this.terminal.run('yarn', 'install')
-  }
-}

package/src/package-manager/createPackageManager.ts

@@ -1,21 +0,0 @@
-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
-export const createPackageManager = ({
-  terminal,
-  packageManager
-}: {
-  terminal: Terminal
-  packageManager: PackageManagerName
-}): PackageManager => {
-  switch (packageManager) {
-    case 'npm':
-      return new Npm(terminal)
-    case 'yarn':
-      return new Yarn(terminal)
-  }
-}

package/src/package-manager/index.ts

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

package/src/processors/OutdatedPackageProcessor.ts

@@ -1,109 +0,0 @@
-import type {
-  BranchNameCreator,
-  CommitMessageCreator,
-  Committer,
-  Git
-} from '../git'
-import type {
-  PullRequestCreator,
-  RemoteBranchExistenceChecker
-} from '../github'
-import type { Logger } from '../logger'
-import type {
-  Ncu,
-  OutdatedPackage
-} from '../ncu'
-import type { PackageManager } from '../package-manager'
-import type { Result } from './Result'
-
-// TODO: add test
-export class OutdatedPackageProcessor {
-  private readonly committer: Committer
-  private readonly git: Git
-  private readonly ncu: Ncu
-  private readonly packageManager: PackageManager
-  private readonly pullRequestCreator: PullRequestCreator
-  private readonly remoteBranchExistenceChecker: RemoteBranchExistenceChecker
-  private readonly logger: Logger
-  private readonly branchNameCreator: BranchNameCreator
-  private readonly commitMessageCreator: CommitMessageCreator
-
-  constructor ({
-    committer,
-    git,
-    ncu,
-    packageManager,
-    pullRequestCreator,
-    remoteBranchExistenceChecker,
-    logger,
-    branchNameCreator,
-    commitMessageCreator
-  }: {
-    committer: Committer
-    git: Git
-    ncu: Ncu
-    packageManager: PackageManager
-    pullRequestCreator: PullRequestCreator
-    remoteBranchExistenceChecker: RemoteBranchExistenceChecker
-    logger: Logger
-    branchNameCreator: BranchNameCreator
-    commitMessageCreator: CommitMessageCreator
-  }) {
-    this.committer = committer
-    this.git = git
-    this.ncu = ncu
-    this.packageManager = packageManager
-    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 = this.branchNameCreator.create(outdatedPackage)
-    this.logger.debug(`branchName=${branchName}`)
-
-    if (this.remoteBranchExistenceChecker.check(branchName)) {
-      this.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`)
-      return {
-        outdatedPackage,
-        skipped: true
-      }
-    }
-
-    await this.git.createBranch(branchName)
-    this.logger.info(`${branchName} branch has created.`)
-
-    const updatedPackages = await this.ncu.update(outdatedPackage)
-
-    if (updatedPackages.length !== 1) {
-      throw new Error(`Failed to update ${outdatedPackage.name}.`)
-    }
-
-    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 = this.commitMessageCreator.create(outdatedPackage)
-    this.logger.debug(`message=${message}`)
-
-    await this.committer.commit(message)
-    await this.git.push(branchName)
-    await this.pullRequestCreator.create({
-      outdatedPackage,
-      branchName
-    })
-    await this.git.checkout('-')
-    await this.git.removeBranch(branchName)
-    this.logger.info(`${branchName} branch has removed.`)
-
-    return {
-      outdatedPackage,
-      updated: true
-    }
-  }
-}

package/src/processors/OutdatedPackagesProcessor.ts

@@ -1,32 +0,0 @@
-import type { Logger } from '../logger'
-import type { OutdatedPackage } from '../ncu'
-import type { OutdatedPackageProcessor } from './OutdatedPackageProcessor'
-import type { Result } from './Result'
-
-export class OutdatedPackagesProcessor {
-  private readonly outdatedPackageProcessor: OutdatedPackageProcessor
-  private readonly logger: Logger
-
-  constructor ({
-    outdatedPackageProcessor,
-    logger
-  }: {
-    outdatedPackageProcessor: OutdatedPackageProcessor
-    logger: Logger
-  }) {
-    this.outdatedPackageProcessor = outdatedPackageProcessor
-    this.logger = logger
-  }
-
-  async process (outdatedPackages: OutdatedPackage[]): Promise<Result[]> {
-    const results: Result[] = []
-
-    for (const outdatedPackage of outdatedPackages) {
-      this.logger.debug(`outdatedPackage=${JSON.stringify(outdatedPackage)}`)
-      const result = await this.outdatedPackageProcessor.process(outdatedPackage)
-      results.push(result)
-    }
-
-    return results
-  }
-}

package/src/processors/Result.ts

@@ -1,7 +0,0 @@
-import type { OutdatedPackage } from '../ncu'
-
-export interface Result {
-  outdatedPackage: OutdatedPackage
-  updated?: boolean
-  skipped?: boolean
-}

package/src/processors/index.ts

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

package/src/terminal/Terminal.ts

@@ -1,30 +0,0 @@
-import execa from 'execa'
-import type { ExecaReturnValue } from 'execa'
-import { isExecaReturnValue } from './isExecaReturnValue'
-
-// TODO: add test
-export class Terminal {
-  async run (
-    command: string,
-    ...args: string[]
-  ): Promise<ExecaReturnValue<string>> {
-    return await execa(command, args)
-  }
-
-  async runWithErrorHandling (
-    command: string,
-    ...args: string[]
-  ): Promise<ExecaReturnValue<string>> {
-    try {
-      return await this.run(command, ...args)
-    } catch (e) {
-      const value: unknown = e instanceof Error ? JSON.parse(JSON.stringify(e)) : e
-
-      if (isExecaReturnValue(value)) {
-        return value
-      } else {
-        throw e
-      }
-    }
-  }
-}

package/src/terminal/index.ts

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

package/src/terminal/isExecaReturnValue.ts

@@ -1,30 +0,0 @@
-import type { ExecaReturnValue } from 'execa'
-import {
-  boolean,
-  intersection,
-  number,
-  partial,
-  string,
-  type
-} from 'io-ts'
-
-const ExecaReturnValueType = intersection([
-  type({
-    command: string,
-    escapedCommand: string,
-    exitCode: number,
-    failed: boolean,
-    timedOut: boolean,
-    killed: boolean,
-    isCanceled: boolean
-  }),
-  partial({
-    signal: string,
-    signalDescription: string
-  })
-])
-
-// TODO: add test
-export const isExecaReturnValue = (value: unknown): value is ExecaReturnValue => {
-  return ExecaReturnValueType.is(value)
-}

package/tsconfig.base.json

@@ -1,3 +0,0 @@
-{
-  "extends": "@tsconfig/node12/tsconfig.json"
-}

package/tsconfig.build.json

@@ -1,13 +0,0 @@
-{
-  "extends": "./tsconfig.base.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src"
-  },
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "**/*.test.ts"
-  ]
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.base.json",
-  "compilerOptions": {
-    "types": [
-      "node",
-      "jest"
-    ]
-  }
-}