npm-update-package 0.1.0

package/src/enums/PackageManagerName.ts

@@ -0,0 +1,8 @@
+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/enums/UpdateType.ts

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

package/src/enums/index.ts

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

package/src/git/Committer.ts

@@ -0,0 +1,49 @@
+import type { Git } from './Git'
+
+export interface User {
+  name?: string
+  email?: string
+}
+
+// TODO: add test
+export class Committer {
+  private readonly git: Git
+  private readonly user: User | undefined
+
+  constructor ({
+    git,
+    user
+  }: {
+    git: Git
+    user?: User
+  }) {
+    this.git = git
+    this.user = user
+  }
+
+  async commit (message: string): Promise<void> {
+    let name: string | undefined
+
+    if (this.user?.name !== undefined) {
+      name = await this.git.getConfig('user.name')
+      await this.git.setConfig('user.name', this.user.name)
+    }
+
+    let email: string | undefined
+
+    if (this.user?.email !== undefined) {
+      email = await this.git.getConfig('user.email')
+      await this.git.setConfig('user.email', this.user.email)
+    }
+
+    await this.git.commit(message)
+
+    if (name !== undefined) {
+      await this.git.setConfig('user.name', name)
+    }
+
+    if (email !== undefined) {
+      await this.git.setConfig('user.email', email)
+    }
+  }
+}

package/src/git/Git.ts

@@ -0,0 +1,55 @@
+import type { Terminal } from '../terminal'
+import { GitRepository } from './GitRepository'
+
+// TODO: add test
+export class Git {
+  constructor (private readonly terminal: Terminal) {}
+
+  async add (...files: string[]): Promise<void> {
+    await this.terminal.run('git', 'add', ...files)
+  }
+
+  async checkout (branchName: string): Promise<void> {
+    await this.terminal.run('git', 'checkout', branchName)
+  }
+
+  async commit (message: string): Promise<void> {
+    await this.terminal.run('git', 'commit', '--message', message)
+  }
+
+  async createBranch (branchName: string): Promise<void> {
+    await this.terminal.run('git', 'checkout', '-b', branchName)
+  }
+
+  async getConfig (key: string): Promise<string> {
+    const { stdout } = await this.terminal.run('git', 'config', key)
+    return stdout.trim()
+  }
+
+  async getCurrentBranch (): Promise<string> {
+    const { stdout } = await this.terminal.run('git', 'rev-parse', '--abbrev-ref', 'HEAD')
+    return stdout.trim()
+  }
+
+  async getRemoteUrl (): Promise<string> {
+    const { stdout } = await this.terminal.run('git', 'remote', 'get-url', '--push', 'origin')
+    return stdout.trim()
+  }
+
+  async getRepository (): Promise<GitRepository> {
+    const url = await this.getRemoteUrl()
+    return GitRepository.of(url)
+  }
+
+  async push (branchName: string): Promise<void> {
+    await this.terminal.run('git', 'push', 'origin', branchName)
+  }
+
+  async removeBranch (branchName: string): Promise<void> {
+    await this.terminal.run('git', 'branch', '-D', branchName)
+  }
+
+  async setConfig (key: string, value: string): Promise<void> {
+    await this.terminal.run('git', 'config', key, value)
+  }
+}

package/src/git/GitRepository.test.ts

@@ -0,0 +1,61 @@
+import { GitRepository } from './GitRepository'
+
+describe('GitRepository', () => {
+  describe('of', () => {
+    describe('if URL is HTTPS', () => {
+      describe('if URL is github.com', () => {
+        const url = 'https://github.com/munierujp/npm-update-package.git'
+
+        it('returns new GitRepository instance', () => {
+          const repo = GitRepository.of(url)
+          expect(repo.host).toBe('github.com')
+          expect(repo.owner).toBe('munierujp')
+          expect(repo.name).toBe('npm-update-package')
+          expect(repo.apiEndPoint).toBe('https://api.github.com')
+          expect(repo.isGitHubDotCom).toBe(true)
+        })
+      })
+
+      describe('if URL is not github.com', () => {
+        const url = 'https://git.example.com/munierujp/npm-update-package.git'
+
+        it('returns new GitRepository instance', () => {
+          const repo = GitRepository.of(url)
+          expect(repo.host).toBe('git.example.com')
+          expect(repo.owner).toBe('munierujp')
+          expect(repo.name).toBe('npm-update-package')
+          expect(repo.apiEndPoint).toBe('https://git.example.com/api/v3')
+          expect(repo.isGitHubDotCom).toBe(false)
+        })
+      })
+    })
+
+    describe('if URL is SSH', () => {
+      describe('if URL is github.com', () => {
+        const url = 'git@github.com:munierujp/npm-update-package.git'
+
+        it('returns new GitRepository instance', () => {
+          const repo = GitRepository.of(url)
+          expect(repo.host).toBe('github.com')
+          expect(repo.owner).toBe('munierujp')
+          expect(repo.name).toBe('npm-update-package')
+          expect(repo.apiEndPoint).toBe('https://api.github.com')
+          expect(repo.isGitHubDotCom).toBe(true)
+        })
+      })
+
+      describe('if URL is not github.com', () => {
+        const url = 'git@git.example.com:munierujp/npm-update-package.git'
+
+        it('returns new GitRepository instance', () => {
+          const repo = GitRepository.of(url)
+          expect(repo.host).toBe('git.example.com')
+          expect(repo.owner).toBe('munierujp')
+          expect(repo.name).toBe('npm-update-package')
+          expect(repo.apiEndPoint).toBe('https://git.example.com/api/v3')
+          expect(repo.isGitHubDotCom).toBe(false)
+        })
+      })
+    })
+  })
+})

package/src/git/GitRepository.ts

@@ -0,0 +1,57 @@
+import parse from 'parse-github-url'
+
+export class GitRepository {
+  readonly host: string
+  readonly owner: string
+  readonly name: string
+
+  private constructor ({
+    host,
+    owner,
+    name
+  }: {
+    host: string
+    owner: string
+    name: string
+  }) {
+    this.host = host
+    this.owner = owner
+    this.name = name
+  }
+
+  static of (url: string): GitRepository {
+    const parsed = parse(url)
+
+    if (parsed === null) {
+      throw new Error(`Failed to parse url. url=${url}`)
+    }
+
+    const {
+      host,
+      owner,
+      name
+    } = parsed
+
+    if (host === null || owner === null || name === null) {
+      throw new Error(`Failed to parse url. url=${url}`)
+    }
+
+    return new GitRepository({
+      host,
+      owner,
+      name
+    })
+  }
+
+  get apiEndPoint (): string {
+    if (this.isGitHubDotCom) {
+      return 'https://api.github.com'
+    } else {
+      return `https://${this.host}/api/v3`
+    }
+  }
+
+  get isGitHubDotCom (): boolean {
+    return this.host === 'github.com'
+  }
+}

package/src/git/index.ts

@@ -0,0 +1,3 @@
+export { Committer } from './Committer'
+export { Git } from './Git'
+export type { GitRepository } from './GitRepository'

package/src/github/Branch.ts

@@ -0,0 +1,4 @@
+import type { RestEndpointMethodTypes } from '@octokit/rest'
+import type { ValuesType } from 'utility-types'
+
+export type Branch = ValuesType<RestEndpointMethodTypes['repos']['listBranches']['response']['data']>

package/src/github/GitHub.ts

@@ -0,0 +1,27 @@
+import type {
+  Octokit,
+  RestEndpointMethodTypes
+} from '@octokit/rest'
+import type { Branch } from './Branch'
+import type { PullRequest } from './PullRequest'
+import type { Repository } from './Repository'
+
+// TODO: add test
+export class GitHub {
+  constructor (private readonly octokit: Octokit) {}
+
+  async createPullRequest (params: RestEndpointMethodTypes['pulls']['create']['parameters']): Promise<PullRequest> {
+    const { data } = await this.octokit.pulls.create(params)
+    return data
+  }
+
+  async fetchBranches (params: RestEndpointMethodTypes['repos']['listBranches']['parameters']): Promise<Branch[]> {
+    const { data } = await this.octokit.repos.listBranches(params)
+    return data
+  }
+
+  async fetchRepository (params: RestEndpointMethodTypes['repos']['get']['parameters']): Promise<Repository> {
+    const { data } = await this.octokit.repos.get(params)
+    return data
+  }
+}

package/src/github/PullRequest.ts

@@ -0,0 +1,3 @@
+import type { RestEndpointMethodTypes } from '@octokit/rest'
+
+export type PullRequest = RestEndpointMethodTypes['pulls']['create']['response']['data']

package/src/github/PullRequestCreator.ts

@@ -0,0 +1,57 @@
+import type { GitRepository } from '../git'
+import type { Logger } from '../logger'
+import type { OutdatedPackage } from '../types'
+import { createPullRequestBody } from './createPullRequestBody'
+import { createPullRequestTitle } from './createPullRequestTitle'
+import type { GitHub } from './GitHub'
+import type { Repository as GitHubRepository } from './Repository'
+
+// TODO: add test
+export class PullRequestCreator {
+  private readonly github: GitHub
+  private readonly gitRepo: GitRepository
+  private readonly githubRepo: GitHubRepository
+  private readonly logger: Logger
+
+  constructor ({
+    github,
+    gitRepo,
+    githubRepo,
+    logger
+  }: {
+    github: GitHub
+    gitRepo: GitRepository
+    githubRepo: GitHubRepository
+    logger: Logger
+  }) {
+    this.github = github
+    this.gitRepo = gitRepo
+    this.githubRepo = githubRepo
+    this.logger = logger
+  }
+
+  async create ({
+    outdatedPackage,
+    branchName
+  }: {
+    outdatedPackage: OutdatedPackage
+    branchName: string
+  }): Promise<void> {
+    const title = createPullRequestTitle(outdatedPackage)
+    this.logger.debug(`title=${title}`)
+
+    const body = createPullRequestBody(outdatedPackage)
+    this.logger.debug(`body=${body}`)
+
+    const createdPullRequest = await this.github.createPullRequest({
+      owner: this.gitRepo.owner,
+      repo: this.gitRepo.name,
+      base: this.githubRepo.default_branch,
+      head: branchName,
+      title,
+      body
+    })
+    this.logger.debug(`createdPullRequest=${JSON.stringify(createdPullRequest)}`)
+    this.logger.info(`Pull request for ${outdatedPackage.name} has created. ${createdPullRequest.html_url}`)
+  }
+}

package/src/github/RemoteBranchExistenceChecker.ts

@@ -0,0 +1,15 @@
+import type { Branch } from './Branch'
+
+// TODO: add test
+export class RemoteBranchExistenceChecker {
+  constructor (private readonly remoteBranchNames: string[]) {}
+
+  static of (remoteBranches: Branch[]): RemoteBranchExistenceChecker {
+    const remoteBranchNames = remoteBranches.map(({ name }) => name)
+    return new RemoteBranchExistenceChecker(remoteBranchNames)
+  }
+
+  check (branchName: string): boolean {
+    return this.remoteBranchNames.includes(branchName)
+  }
+}

package/src/github/Repository.ts

@@ -0,0 +1,3 @@
+import type { RestEndpointMethodTypes } from '@octokit/rest'
+
+export type Repository = RestEndpointMethodTypes['repos']['get']['response']['data']

package/src/github/createGitHub.ts

@@ -0,0 +1,18 @@
+import type { GitRepository } from '../git'
+import { createOctokit } from './createOctokit'
+import { GitHub } from './GitHub'
+
+// TODO: add test
+export const createGitHub = ({
+  repository,
+  token
+}: {
+  repository: GitRepository
+  token: string
+}): GitHub => {
+  const octokit = createOctokit({
+    repository,
+    token
+  })
+  return new GitHub(octokit)
+}

package/src/github/createOctokit.ts

@@ -0,0 +1,28 @@
+import { Octokit } from '@octokit/rest'
+import { app } from '../app'
+import type { GitRepository } from '../git'
+
+// TODO: add test
+export const createOctokit = ({
+  repository,
+  token
+}: {
+  repository: GitRepository
+  token: string
+}): Octokit => {
+  const auth = `token ${token}`
+  const userAgent = `${app.name}/${app.version}`
+
+  if (repository.isGitHubDotCom) {
+    return new Octokit({
+      auth,
+      userAgent
+    })
+  } else {
+    return new Octokit({
+      auth,
+      userAgent,
+      baseUrl: repository.apiEndPoint
+    })
+  }
+}

package/src/github/createPullRequestBody.test.ts

@@ -0,0 +1,62 @@
+import { UpdateType } from '../enums'
+import { PackageVersion } from '../values'
+import { createPullRequestBody } from './createPullRequestBody'
+
+describe('createPullRequestBody', () => {
+  describe('if update type is patch', () => {
+    it('returns pull request body', () => {
+      const actual = createPullRequestBody({
+        name: '@typescript-eslint/eslint-plugin',
+        currentVersion: PackageVersion.of('1.0.0'),
+        newVersion: PackageVersion.of('1.0.1'),
+        type: UpdateType.Patch
+      })
+      expect(actual).toBe(`This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|patch|\`1.0.0\`|\`1.0.1\`|
+
+---
+This PR has been generated by [npm-update-package](https://github.com/munierujp/npm-update-package)`)
+    })
+  })
+
+  describe('if update type is minor', () => {
+    it('returns pull request body', () => {
+      const actual = createPullRequestBody({
+        name: '@typescript-eslint/eslint-plugin',
+        currentVersion: PackageVersion.of('1.0.0'),
+        newVersion: PackageVersion.of('1.1.0'),
+        type: UpdateType.Minor
+      })
+      expect(actual).toBe(`This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|minor|\`1.0.0\`|\`1.1.0\`|
+
+---
+This PR has been generated by [npm-update-package](https://github.com/munierujp/npm-update-package)`)
+    })
+  })
+
+  describe('if update type is major', () => {
+    it('returns pull request body', () => {
+      const actual = createPullRequestBody({
+        name: '@typescript-eslint/eslint-plugin',
+        currentVersion: PackageVersion.of('1.0.0'),
+        newVersion: PackageVersion.of('2.0.0'),
+        type: UpdateType.Major
+      })
+      expect(actual).toBe(`This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|major|\`1.0.0\`|\`2.0.0\`|
+
+---
+This PR has been generated by [npm-update-package](https://github.com/munierujp/npm-update-package)`)
+    })
+  })
+})

package/src/github/createPullRequestBody.ts

@@ -0,0 +1,17 @@
+import { app } from '../app'
+import type { OutdatedPackage } from '../types'
+
+export const createPullRequestBody = (outdatedPackage: OutdatedPackage): string => {
+  const packageName = outdatedPackage.name
+  const currentVersion = outdatedPackage.currentVersion.version
+  const newVersion = outdatedPackage.newVersion.version
+  const updateType = outdatedPackage.type
+  return `This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[${packageName}](https://www.npmjs.com/package/${packageName})|${updateType}|\`${currentVersion}\`|\`${newVersion}\`|
+
+---
+This PR has been generated by [${app.name}](${app.web})`
+}

package/src/github/createPullRequestTitle.test.ts

@@ -0,0 +1,43 @@
+import { UpdateType } from '../enums'
+import { PackageVersion } from '../values'
+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

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

package/src/github/index.ts

@@ -0,0 +1,7 @@
+export type { Branch } from './Branch'
+export { createGitHub } from './createGitHub'
+export { GitHub } from './GitHub'
+export type { PullRequest } from './PullRequest'
+export { PullRequestCreator } from './PullRequestCreator'
+export { RemoteBranchExistenceChecker } from './RemoteBranchExistenceChecker'
+export type { Repository } from './Repository'

package/src/logger/Logger.ts

@@ -0,0 +1 @@
+export type { Logger } from 'log4js'

package/src/logger/createLogger.ts

@@ -0,0 +1,10 @@
+import { getLogger } from 'log4js'
+import type { LogLevel } from '../enums'
+import type { Logger } from './Logger'
+
+// TODO: add test
+export const createLogger = (logLevel: LogLevel): Logger => {
+  const logger = getLogger()
+  logger.level = logLevel
+  return logger
+}

package/src/logger/index.ts

@@ -0,0 +1,2 @@
+export { createLogger } from './createLogger'
+export type { Logger } from './Logger'