npm-update-package 0.31.3 → 0.31.4

package/src/main.ts

@@ -1,149 +0,0 @@
-import {
-  isLeft,
-  isRight
-} from 'fp-ts/lib/Either'
-import {
-  OutdatedPackageProcessor,
-  OutdatedPackagesProcessor
-} from './core'
-import {
-  CommitMessageCreator,
-  Git
-} from './git'
-import {
-  BranchFinder,
-  createGitHub,
-  LabelCreator,
-  PullRequestCloser,
-  PullRequestCreator,
-  PullRequestFinder,
-  PullRequestTitleCreator
-} from './github'
-import type { Logger } from './logger'
-import { Ncu } from './ncu'
-import type { Options } from './options'
-import { createPackageManager } from './package-manager'
-import { Terminal } from './terminal'
-
-// TODO: add test
-export const main = async ({
-  options,
-  logger
-}: {
-  options: Options
-  logger: Logger
-}): Promise<void> => {
-  logger.debug(`options=${JSON.stringify({
-    ...options,
-    githubToken: options.githubToken !== '' ? '***' : ''
-  })}`)
-
-  const ncu = new Ncu(logger)
-  const outdatedPackages = await ncu.check()
-  logger.debug(`outdatedPackages=${JSON.stringify(outdatedPackages)}`)
-
-  if (outdatedPackages.length === 0) {
-    logger.info('All packages are up-to-date.')
-    return
-  }
-
-  logger.info(`There are ${outdatedPackages.length} outdated packages.`)
-
-  const terminal = new Terminal()
-  const git = new Git(terminal)
-  const gitRepo = await git.getRepository()
-  logger.debug(`gitRepo=${JSON.stringify(gitRepo)}`)
-
-  const github = createGitHub({
-    repository: gitRepo,
-    token: options.githubToken
-  })
-  const githubRepo = await github.fetchRepository({
-    owner: gitRepo.owner,
-    repo: gitRepo.name
-  })
-  logger.debug(`githubRepo=${JSON.stringify(githubRepo)}`)
-
-  const branches = await github.fetchBranches({
-    owner: gitRepo.owner,
-    repo: gitRepo.name
-  })
-  logger.debug(`branches=${JSON.stringify(branches)}`)
-
-  const pullRequests = await github.fetchPullRequests({
-    owner: gitRepo.owner,
-    repo: gitRepo.name
-  })
-  logger.debug(`pullRequests=${JSON.stringify(pullRequests)}`)
-
-  const labelCreator = new LabelCreator({
-    github,
-    gitRepo,
-    logger
-  })
-  await labelCreator.create({
-    name: 'npm-update-package',
-    description: 'Created by npm-update-package',
-    color: 'A00F21'
-  })
-
-  const branchFinder = new BranchFinder(branches)
-  const packageManager = createPackageManager({
-    terminal,
-    packageManager: options.packageManager
-  })
-  const pullRequestTitleCreator = new PullRequestTitleCreator(options.pullRequestTitle)
-  const pullRequestCreator = new PullRequestCreator({
-    github,
-    gitRepo,
-    githubRepo,
-    pullRequestTitleCreator,
-    logger,
-    reviewers: options.reviewers
-  })
-  const commitMessageCreator = new CommitMessageCreator(options.commitMessage)
-  const pullRequestFinder = new PullRequestFinder(pullRequests)
-  const pullRequestCloser = new PullRequestCloser(github)
-  const outdatedPackageProcessor = new OutdatedPackageProcessor({
-    git,
-    ncu,
-    packageManager,
-    pullRequestCreator,
-    branchFinder,
-    logger,
-    commitMessageCreator,
-    pullRequestFinder,
-    pullRequestCloser
-  })
-  const outdatedPackagesProcessor = new OutdatedPackagesProcessor({
-    outdatedPackageProcessor,
-    logger
-  })
-  const results = await outdatedPackagesProcessor.process(outdatedPackages)
-  logger.debug(`results=${JSON.stringify(results)}`)
-
-  const succeededResults = results.filter(isRight).map(({ right }) => right)
-  logger.debug(`succeededResults=${JSON.stringify(succeededResults)}`)
-
-  const createdPackages = succeededResults
-    .filter(({ created }) => created)
-    .map(({ outdatedPackage }) => outdatedPackage)
-  logger.debug(`createdPackages=${JSON.stringify(createdPackages)}`)
-
-  const skippedPackages = succeededResults
-    .filter(({ skipped }) => skipped)
-    .map(({ outdatedPackage }) => outdatedPackage)
-  logger.debug(`skippedPackages=${JSON.stringify(skippedPackages)}`)
-
-  const failedResults = results.filter(isLeft).map(({ left }) => left)
-  logger.debug(`failedResults=${JSON.stringify(failedResults)}`)
-
-  const failedPackages = failedResults.map(({ outdatedPackage }) => outdatedPackage)
-  logger.debug(`failedPackages=${JSON.stringify(failedPackages)}`)
-
-  // TODO: show as table
-  logger.info(`Processed ${succeededResults.length + failedPackages.length} packages:
-- ${createdPackages.length} packages: created (${createdPackages.map(({ name }) => name).join(',')})
-- ${skippedPackages.length} packages: skipped: (${skippedPackages.map(({ name }) => name).join(',')})
-- ${failedPackages.length} packages: failed: (${failedPackages.map(({ name }) => name).join(',')})`)
-}

package/src/ncu/Ncu.ts

@@ -1,84 +0,0 @@
-import { run } from 'npm-check-updates'
-import type { RunOptions } from 'npm-check-updates/build/src/types'
-import { isNotUndefined } from 'type-guards'
-import type { OutdatedPackage } from '../core'
-import { readFile } from '../file'
-import type { Logger } from '../logger'
-import { parsePackageJson } from '../package-json'
-import {
-  compareSemVers,
-  SemVer
-} from '../semver'
-import { isNcuResult } from './NcuResult'
-
-// TODO: add test
-export class Ncu {
-  constructor (private readonly logger: Logger) {}
-
-  async check (): Promise<OutdatedPackage[]> {
-    return await this.run({
-      jsonUpgraded: true
-    })
-  }
-
-  async update (outdatedPackage: OutdatedPackage): Promise<OutdatedPackage[]> {
-    return await this.run({
-      jsonUpgraded: true,
-      filter: outdatedPackage.name,
-      upgrade: true
-    })
-  }
-
-  private async run (options: RunOptions): Promise<OutdatedPackage[]> {
-    // Read package.json before running ncu
-    const json = await readFile('./package.json')
-    const pkg = parsePackageJson(json)
-    this.logger.debug(`pkg=${JSON.stringify(pkg)}`)
-
-    const result = await run(options)
-    this.logger.debug(`result=${JSON.stringify(result)}`)
-
-    if (!isNcuResult(result)) {
-      throw new Error('Failed to running ncu.')
-    }
-
-    const currentDependencies = {
-      ...pkg.dependencies,
-      ...pkg.devDependencies,
-      ...pkg.peerDependencies,
-      ...pkg.optionalDependencies
-    }
-    const resultEntries = Object.entries(result)
-    const outdatedPackages: OutdatedPackage[] = resultEntries
-      .map(([name, newVersionString]) => {
-        const currentVersionString = currentDependencies[name]
-
-        if (currentVersionString === undefined) {
-          return undefined
-        }
-
-        const currentVersion = SemVer.of(currentVersionString)
-        const newVersion = SemVer.of(newVersionString)
-        const level = compareSemVers(currentVersion, newVersion)
-
-        if (level === undefined) {
-          return undefined
-        }
-
-        const outdatedPackage: OutdatedPackage = {
-          name,
-          currentVersion,
-          newVersion,
-          level
-        }
-        return outdatedPackage
-      })
-      .filter(isNotUndefined)
-
-    if (resultEntries.length !== outdatedPackages.length) {
-      throw new Error('Failed to running ncu.')
-    }
-
-    return outdatedPackages
-  }
-}

package/src/ncu/NcuResult.ts

@@ -1,10 +0,0 @@
-import {
-  record,
-  string,
-  type TypeOf
-} from 'io-ts'
-
-export const NcuResult = record(string, string)
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type NcuResult = TypeOf<typeof NcuResult>
-export const isNcuResult = NcuResult.is

package/src/ncu/index.ts

@@ -1 +0,0 @@
-export * from './Ncu'

package/src/options/CLIOption.ts

@@ -1,19 +0,0 @@
-import type { OptionType } from './OptionType'
-
-interface OptionBase {
-  name: string
-  description: string
-  type: OptionType
-  choices?: string[]
-}
-
-interface RequiredOption extends OptionBase {
-  required: true
-}
-
-interface OptionalOption extends OptionBase {
-  required: false
-  default?: string
-}
-
-export type CLIOption = RequiredOption | OptionalOption

package/src/options/OptionType.ts

@@ -1,8 +0,0 @@
-export const OptionType = {
-  String: 'string',
-  StringArray: 'string[]'
-} as const
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type OptionType = typeof OptionType[keyof typeof OptionType]
-const optionTypes = Object.values(OptionType)
-export const isOptionType = (value: any): value is OptionType => optionTypes.includes(value)

package/src/options/Options.ts

@@ -1,40 +0,0 @@
-import {
-  array,
-  intersection,
-  literal,
-  partial,
-  string,
-  type,
-  union,
-  type TypeOf
-} from 'io-ts'
-import { LogLevel } from '../logger'
-import { PackageManagerName } from '../package-manager'
-
-const Options = intersection([
-  type({
-    commitMessage: string,
-    githubToken: string,
-    logLevel: union([
-      literal(LogLevel.Off),
-      literal(LogLevel.Fatal),
-      literal(LogLevel.Error),
-      literal(LogLevel.Warn),
-      literal(LogLevel.Info),
-      literal(LogLevel.Debug),
-      literal(LogLevel.Trace)
-    ]),
-    packageManager: union([
-      literal(PackageManagerName.Npm),
-      literal(PackageManagerName.Yarn)
-    ]),
-    pullRequestTitle: string
-  }),
-  partial({
-    reviewers: array(string)
-  })
-])
-
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type Options = TypeOf<typeof Options>
-export const isOptions = Options.is

package/src/options/cliOptions.ts

@@ -1,60 +0,0 @@
-import { LogLevel } from '../logger'
-import { PackageManagerName } from '../package-manager'
-import type { CLIOption } from './CLIOption'
-import { OptionType } from './OptionType'
-
-export const cliOptions: CLIOption[] = [
-  {
-    name: 'commit-message',
-    description: 'Commit message template',
-    type: OptionType.String,
-    required: false,
-    default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
-  },
-  {
-    name: 'github-token',
-    description: 'GitHub token',
-    type: OptionType.String,
-    required: true
-  },
-  {
-    name: 'log-level',
-    description: 'Log level to show',
-    type: OptionType.String,
-    required: false,
-    choices: [
-      LogLevel.Off,
-      LogLevel.Fatal,
-      LogLevel.Error,
-      LogLevel.Warn,
-      LogLevel.Info,
-      LogLevel.Debug,
-      LogLevel.Trace
-    ],
-    default: LogLevel.Info
-  },
-  {
-    name: 'package-manager',
-    description: 'Package manager of your project',
-    type: OptionType.String,
-    required: false,
-    choices: [
-      PackageManagerName.Npm,
-      PackageManagerName.Yarn
-    ],
-    default: PackageManagerName.Npm
-  },
-  {
-    name: 'pull-request-title',
-    description: 'Pull request title template',
-    type: OptionType.String,
-    required: false,
-    default: 'chore(deps): {{level}} update {{{packageName}}} to v{{newVersion}}'
-  },
-  {
-    name: 'reviewers',
-    description: 'User names to request reviews',
-    type: OptionType.StringArray,
-    required: false
-  }
-]

package/src/options/index.ts

@@ -1,2 +0,0 @@
-export * from './initOptions'
-export * from './Options'

package/src/options/initOptions.ts

@@ -1,24 +0,0 @@
-import { program } from 'commander'
-import pkg from '../../package.json'
-import { cliOptions } from './cliOptions'
-import {
-  isOptions,
-  type Options
-} from './Options'
-import { toCommanderOption } from './toCommanderOption'
-
-// TODO: add test
-export const initOptions = (): Options => {
-  program.version(pkg.version)
-  cliOptions
-    .map(toCommanderOption)
-    .forEach(option => program.addOption(option))
-  program.parse(process.argv)
-  const options = program.opts()
-
-  if (!isOptions(options)) {
-    throw new Error(`Failed to parse command-line options. options=${JSON.stringify(options)}`)
-  }
-
-  return options
-}

package/src/options/toCommanderOption.ts

@@ -1,35 +0,0 @@
-import { Option } from 'commander'
-import type { CLIOption } from './CLIOption'
-import { OptionType } from './OptionType'
-
-// TODO: add test
-export const toCommanderOption = (cliOption: CLIOption): Option => {
-  const argument = createArgumentString(cliOption)
-  const option = new Option(`--${cliOption.name} ${argument}`, cliOption.description)
-
-  if (cliOption.choices !== undefined) {
-    option.choices(cliOption.choices)
-  }
-
-  if (!cliOption.required && cliOption.default !== undefined) {
-    option.default(cliOption.default)
-  }
-
-  return option
-}
-
-const createArgumentString = (cliOption: CLIOption): string => {
-  const prefix = cliOption.required ? '<' : '['
-  const suffix = cliOption.required ? '>' : ']'
-  const name = createArgumentNameString(cliOption.type)
-  return `${prefix}${name}${suffix}`
-}
-
-const createArgumentNameString = (optionType: OptionType): string => {
-  switch (optionType) {
-    case OptionType.String:
-      return 'value'
-    case OptionType.StringArray:
-      return 'values...'
-  }
-}

package/src/package-json/PackageMetadata.ts

@@ -1,24 +0,0 @@
-import {
-  intersection,
-  partial,
-  string,
-  type,
-  type TypeOf
-} from 'io-ts'
-import { PackageMetadataDependencies } from './PackageMetadataDependencies'
-
-const PackageMetadata = intersection([
-  type({
-    name: string,
-    version: string
-  }),
-  partial({
-    dependencies: PackageMetadataDependencies,
-    devDependencies: PackageMetadataDependencies,
-    peerDependencies: PackageMetadataDependencies,
-    optionalDependencies: PackageMetadataDependencies
-  })
-])
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type PackageMetadata = TypeOf<typeof PackageMetadata>
-export const isPackageMetadata = PackageMetadata.is

package/src/package-json/PackageMetadataDependencies.ts

@@ -1,10 +0,0 @@
-import {
-  record,
-  string,
-  type TypeOf
-} from 'io-ts'
-
-export const PackageMetadataDependencies = record(string, string)
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type PackageMetadataDependencies = TypeOf<typeof PackageMetadataDependencies>
-export const isPackageMetadataDependencies = PackageMetadataDependencies.is

package/src/package-json/index.ts

@@ -1,2 +0,0 @@
-export * from './PackageMetadata'
-export * from './parsePackageJson'

package/src/package-json/parsePackageJson.ts

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

package/src/package-manager/Npm.ts

@@ -1,17 +0,0 @@
-import type { Terminal } from '../terminal'
-import type { PackageManager } from './PackageManager'
-
-// TODO: add test
-export class Npm implements PackageManager {
-  readonly packageFile = 'package.json'
-  readonly lockFile = '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,5 +0,0 @@
-export interface PackageManager {
-  packageFile: string
-  lockFile: 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,17 +0,0 @@
-import type { Terminal } from '../terminal'
-import type { PackageManager } from './PackageManager'
-
-// TODO: add test
-export class Yarn implements PackageManager {
-  readonly packageFile = 'package.json'
-  readonly lockFile = '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.test.ts

@@ -1,27 +0,0 @@
-import { Terminal } from '../terminal'
-import { createPackageManager } from './createPackageManager'
-import { Npm } from './Npm'
-import { PackageManagerName } from './PackageManagerName'
-import { Yarn } from './Yarn'
-
-describe('createPackageManager', () => {
-  const terminal = new Terminal()
-
-  it(`returns new Npm instance if packageManager is ${PackageManagerName.Npm}`, () => {
-    const packageManager = createPackageManager({
-      terminal,
-      packageManager: PackageManagerName.Npm
-    })
-
-    expect(packageManager).toBeInstanceOf(Npm)
-  })
-
-  it(`returns new Yarn instance if packageManager is ${PackageManagerName.Yarn}`, () => {
-    const packageManager = createPackageManager({
-      terminal,
-      packageManager: PackageManagerName.Yarn
-    })
-
-    expect(packageManager).toBeInstanceOf(Yarn)
-  })
-})

package/src/package-manager/createPackageManager.ts

@@ -1,20 +0,0 @@
-import type { Terminal } from '../terminal'
-import { Npm } from './Npm'
-import type { PackageManager } from './PackageManager'
-import { PackageManagerName } from './PackageManagerName'
-import { Yarn } from './Yarn'
-
-export const createPackageManager = ({
-  terminal,
-  packageManager
-}: {
-  terminal: Terminal
-  packageManager: PackageManagerName
-}): PackageManager => {
-  switch (packageManager) {
-    case PackageManagerName.Npm:
-      return new Npm(terminal)
-    case PackageManagerName.Yarn:
-      return new Yarn(terminal)
-  }
-}

package/src/package-manager/index.ts

@@ -1,5 +0,0 @@
-export * from './createPackageManager'
-export * from './Npm'
-export * from './PackageManager'
-export * from './PackageManagerName'
-export * from './Yarn'

package/src/semver/SemVer.test.ts

@@ -1,17 +0,0 @@
-import { SemVer } from './SemVer'
-
-describe('SemVer', () => {
-  describe('of', () => {
-    it('returns new SemVer instance if version is valid', () => {
-      const semver = SemVer.of('^1.2.3')
-      expect(semver.version).toBe('1.2.3')
-      expect(semver.major).toBe(1)
-      expect(semver.minor).toBe(2)
-      expect(semver.patch).toBe(3)
-    })
-
-    it('throws error if version is invalid', () => {
-      expect(() => SemVer.of('')).toThrow(Error)
-    })
-  })
-})

package/src/semver/SemVer.ts

@@ -1,40 +0,0 @@
-import { coerce } from 'semver'
-
-export class SemVer {
-  readonly version: string
-  readonly major: number
-  readonly minor: number
-  readonly patch: number
-
-  private constructor ({
-    version,
-    major,
-    minor,
-    patch
-  }: {
-    version: string
-    major: number
-    minor: number
-    patch: number
-  }) {
-    this.version = version
-    this.major = major
-    this.minor = minor
-    this.patch = patch
-  }
-
-  static of (version: string): SemVer {
-    const semver = coerce(version)
-
-    if (semver === null) {
-      throw new Error(`Failed to parse version. version=${version}`)
-    }
-
-    return new SemVer({
-      version: semver.version,
-      major: semver.major,
-      minor: semver.minor,
-      patch: semver.patch
-    })
-  }
-}

package/src/semver/SemVerLevel.ts

@@ -1,9 +0,0 @@
-export const SemVerLevel = {
-  Major: 'major',
-  Minor: 'minor',
-  Patch: 'patch'
-} as const
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type SemVerLevel = typeof SemVerLevel[keyof typeof SemVerLevel]
-const semVerLevels = Object.values(SemVerLevel)
-export const isSemVerLevel = (value: any): value is SemVerLevel => semVerLevels.includes(value)