npm-update-package 0.31.3 → 0.31.4

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "npm-update-package",
-    "version": "0.31.3",
+    "version": "0.31.4",
     "description": "CLI tool for creating pull requests to update npm packages",
     "scripts": {
         "build": "tsc --project tsconfig.build.json",
@@ -35,8 +35,8 @@
         "@types/node": "12.20.40",
         "@types/parse-github-url": "1.0.0",
         "@types/semver": "7.3.9",
-        "@typescript-eslint/eslint-plugin": "5.10.1",
-        "eslint": "8.7.0",
+        "@typescript-eslint/eslint-plugin": "5.10.2",
+        "eslint": "8.8.0",
         "eslint-config-standard-with-typescript": "21.0.1",
         "eslint-plugin-import": "2.25.4",
         "eslint-plugin-jest": "26.0.0",
@@ -45,7 +45,7 @@
         "eslint-plugin-tsdoc": "0.2.14",
         "husky": "7.0.4",
         "jest": "27.4.7",
-        "lint-staged": "12.3.1",
+        "lint-staged": "12.3.2",
         "npm-run-all": "4.1.5",
         "rimraf": "3.0.2",
         "ts-jest": "27.1.3",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.31.3",
+  "version": "0.31.4",
   "description": "CLI tool for creating pull requests to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -35,8 +35,8 @@
     "@types/node": "12.20.40",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.10.1",
-    "eslint": "8.7.0",
+    "@typescript-eslint/eslint-plugin": "5.10.2",
+    "eslint": "8.8.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.4",
     "eslint-plugin-jest": "26.0.0",
@@ -45,7 +45,7 @@
     "eslint-plugin-tsdoc": "0.2.14",
     "husky": "7.0.4",
     "jest": "27.4.7",
-    "lint-staged": "12.3.1",
+    "lint-staged": "12.3.2",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
     "ts-jest": "27.1.3",

package/.eslintignore

@@ -1,3 +0,0 @@
-/coverage
-/dist
-/node_modules

package/.eslintrc.js

@@ -1,23 +0,0 @@
-module.exports = {
-  extends: [
-    'standard-with-typescript',
-    'plugin:jest/recommended'
-  ],
-  plugins: [
-    'eslint-plugin-tsdoc'
-  ],
-  parserOptions: {
-    project: './tsconfig.json'
-  },
-  rules: {
-    'import/order': ['error', {
-      alphabetize: {
-        order: 'asc',
-        caseInsensitive: true
-      }
-    }],
-    'no-console': 'error',
-    'sort-imports': 'off',
-    'tsdoc/syntax': 'warn'
-  }
-}

package/.github/renovate.json

@@ -1,15 +0,0 @@
-{
-  "extends": [
-    "config:base"
-  ],
-  "packageRules": [
-    {
-      "matchPackageNames": ["@types/node"],
-      "allowedVersions": "<13"
-    },
-    {
-      "matchPackageNames": ["node"],
-      "allowedVersions": "<13"
-    }
-  ]
-}

package/.github/workflows/eslint.yml

@@ -1,14 +0,0 @@
-name: eslint
-on:
-  pull_request:
-    branches: [ master ]
-jobs:
-  eslint:
-    name: runner / eslint
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: eslint
-        uses: reviewdog/action-eslint@v1
-        with:
-          reporter: github-pr-check

package/.github/workflows/test.yml

@@ -1,20 +0,0 @@
-name: test
-on:
-  pull_request:
-    branches: [ master ]
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        # https://nodejs.org/en/about/releases/
-        node-version: ['12', '14', '16']
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx lint-staged

package/.nvmrc

@@ -1 +0,0 @@
-12.20.2

package/jest.config.ts

@@ -1,12 +0,0 @@
-import type { Config } from '@jest/types'
-
-const config: Config.InitialOptions = {
-  preset: 'ts-jest',
-  collectCoverage: true,
-  collectCoverageFrom: [
-    'src/**/*.ts',
-    '!src/**/index.ts'
-  ]
-}
-
-export default config

package/lint-staged.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  '*.js': 'eslint',
-  '*.ts': 'eslint'
-}

package/npm-update-package.code-workspace

@@ -1,10 +0,0 @@
-{
-	"folders": [
-		{
-			"path": "."
-		}
-	],
-	"settings": {
-		"typescript.tsdk": "node_modules/typescript/lib"
-	}
-}

package/src/bin.ts

@@ -1,22 +0,0 @@
-#!/usr/bin/env node
-
-import pkg from '../package.json'
-import { createLogger } from './logger'
-import { main } from './main'
-import { initOptions } from './options'
-
-const options = initOptions()
-const logger = createLogger(options.logLevel)
-logger.info(`Start ${pkg.name} v${pkg.version}`)
-
-main({
-  options,
-  logger
-})
-  .then(() => {
-    logger.info(`End ${pkg.name} v${pkg.version}`)
-  })
-  .catch((error: unknown) => {
-    logger.fatal(error)
-    throw error
-  })

package/src/core/FailedResult.ts

@@ -1,6 +0,0 @@
-import type { OutdatedPackage } from './OutdatedPackage'
-
-export interface FailedResult {
-  outdatedPackage: OutdatedPackage
-  error: unknown
-}

package/src/core/OutdatedPackage.ts

@@ -1,11 +0,0 @@
-import type {
-  SemVer,
-  SemVerLevel
-} from '../semver'
-
-export interface OutdatedPackage {
-  name: string
-  currentVersion: SemVer
-  newVersion: SemVer
-  level: SemVerLevel
-}

package/src/core/OutdatedPackageProcessor.ts

@@ -1,136 +0,0 @@
-import {
-  left,
-  right,
-  type Either
-} from 'fp-ts/lib/Either'
-import {
-  createBranchName,
-  type CommitMessageCreator,
-  type Git
-} from '../git'
-import type {
-  BranchFinder,
-  PullRequestCloser,
-  PullRequestCreator,
-  PullRequestFinder
-} from '../github'
-import type { Logger } from '../logger'
-import type { Ncu } from '../ncu'
-import type { PackageManager } from '../package-manager'
-import type { FailedResult } from './FailedResult'
-import type { OutdatedPackage } from './OutdatedPackage'
-import type { SucceededResult } from './SucceededResult'
-
-// TODO: add test
-export class OutdatedPackageProcessor {
-  private readonly git: Git
-  private readonly ncu: Ncu
-  private readonly packageManager: PackageManager
-  private readonly pullRequestCreator: PullRequestCreator
-  private readonly branchFinder: BranchFinder
-  private readonly logger: Logger
-  private readonly commitMessageCreator: CommitMessageCreator
-  private readonly pullRequestFinder: PullRequestFinder
-  private readonly pullRequestCloser: PullRequestCloser
-
-  constructor ({
-    git,
-    ncu,
-    packageManager,
-    pullRequestCreator,
-    branchFinder,
-    logger,
-    commitMessageCreator,
-    pullRequestFinder,
-    pullRequestCloser
-  }: {
-    git: Git
-    ncu: Ncu
-    packageManager: PackageManager
-    pullRequestCreator: PullRequestCreator
-    branchFinder: BranchFinder
-    logger: Logger
-    commitMessageCreator: CommitMessageCreator
-    pullRequestFinder: PullRequestFinder
-    pullRequestCloser: PullRequestCloser
-  }) {
-    this.git = git
-    this.ncu = ncu
-    this.packageManager = packageManager
-    this.pullRequestCreator = pullRequestCreator
-    this.branchFinder = branchFinder
-    this.logger = logger
-    this.commitMessageCreator = commitMessageCreator
-    this.pullRequestFinder = pullRequestFinder
-    this.pullRequestCloser = pullRequestCloser
-  }
-
-  /**
-   * Don't run in parallel because it includes file operations.
-   */
-  async process (outdatedPackage: OutdatedPackage): Promise<Either<FailedResult, SucceededResult>> {
-    const branchName = createBranchName(outdatedPackage)
-    this.logger.debug(`branchName=${branchName}`)
-
-    if (this.branchFinder.findByName(branchName) !== undefined) {
-      this.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`)
-      return right({
-        outdatedPackage,
-        skipped: true
-      })
-    }
-
-    await this.git.createBranch(branchName)
-    this.logger.info(`${branchName} branch has created.`)
-
-    try {
-      try {
-        const updatedPackages = await this.ncu.update(outdatedPackage)
-
-        if (updatedPackages.length !== 1) {
-          throw new Error(`Failed to update ${outdatedPackage.name}.`)
-        }
-
-        await this.packageManager.install()
-      } catch (error) {
-        this.logger.error(error)
-        return left({
-          outdatedPackage,
-          error
-        })
-      }
-
-      this.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`)
-
-      await this.git.add(this.packageManager.packageFile, this.packageManager.lockFile)
-      const message = this.commitMessageCreator.create(outdatedPackage)
-      this.logger.debug(`message=${message}`)
-
-      await this.git.commit(message)
-      await this.git.push(branchName)
-
-      const pullRequest = await this.pullRequestCreator.create({
-        outdatedPackage,
-        branchName
-      })
-      this.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`)
-
-      const pullRequests = this.pullRequestFinder.findByPackageName(outdatedPackage.name)
-      this.logger.debug(`pullRequests=${JSON.stringify(pullRequests)}`)
-
-      await Promise.all(pullRequests.map(async (pullRequest) => {
-        await this.pullRequestCloser.close(pullRequest)
-        this.logger.info(`Pull request for ${outdatedPackage.name} has closed. ${pullRequest.html_url}`)
-      }))
-      return right({
-        outdatedPackage,
-        created: true
-      })
-    } finally {
-      await this.git.restore(this.packageManager.packageFile, this.packageManager.lockFile)
-      await this.git.switch('-')
-      await this.git.removeBranch(branchName)
-      this.logger.info(`${branchName} branch has removed.`)
-    }
-  }
-}

package/src/core/OutdatedPackagesProcessor.ts

@@ -1,35 +0,0 @@
-import type { Either } from 'fp-ts/lib/Either'
-import type { Logger } from '../logger'
-import type { FailedResult } from './FailedResult'
-import type { OutdatedPackage } from './OutdatedPackage'
-import type { OutdatedPackageProcessor } from './OutdatedPackageProcessor'
-import type { SucceededResult } from './SucceededResult'
-
-// TODO: add test
-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<Array<Either<FailedResult, SucceededResult>>> {
-    const results: Array<Either<FailedResult, SucceededResult>> = []
-
-    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/core/SucceededResult.ts

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

package/src/core/index.ts

@@ -1,5 +0,0 @@
-export * from './FailedResult'
-export * from './OutdatedPackage'
-export * from './OutdatedPackageProcessor'
-export * from './OutdatedPackagesProcessor'
-export * from './SucceededResult'

package/src/file/index.ts

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

package/src/file/readFile.ts

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

package/src/git/CommitMessageCreator.test.ts

@@ -1,17 +0,0 @@
-import { SemVer } from '../semver'
-import { CommitMessageCreator } from './CommitMessageCreator'
-
-describe('CommitMessageCreator', () => {
-  describe('create', () => {
-    it('returns commit message', () => {
-      const commitMessageCreator = new CommitMessageCreator('chore(deps): {{level}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
-      const actual = commitMessageCreator.create({
-        name: '@npm-update-package/example',
-        currentVersion: SemVer.of('1.0.0'),
-        newVersion: SemVer.of('2.0.0'),
-        level: 'major'
-      })
-      expect(actual).toBe('chore(deps): major update @npm-update-package/example from 1.0.0 to v2.0.0')
-    })
-  })
-})

package/src/git/CommitMessageCreator.ts

@@ -1,19 +0,0 @@
-import { render } from 'mustache'
-import type { OutdatedPackage } from '../core'
-
-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 level = outdatedPackage.level
-    return render(this.template, {
-      packageName,
-      currentVersion,
-      newVersion,
-      level
-    })
-  }
-}

package/src/git/Git.ts

@@ -1,59 +0,0 @@
-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 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 restore (...files: string[]): Promise<void> {
-    await this.terminal.run('git', 'checkout', ...files)
-  }
-
-  async setConfig (key: string, value: string): Promise<void> {
-    await this.terminal.run('git', 'config', key, value)
-  }
-
-  async switch (branchName: string): Promise<void> {
-    await this.terminal.run('git', 'checkout', branchName)
-  }
-}

package/src/git/GitRepository.test.ts

@@ -1,82 +0,0 @@
-import { GitRepository } from './GitRepository'
-
-describe('GitRepository', () => {
-  describe('of', () => {
-    describe('returns new GitRepository instance if URL is valid', () => {
-      type TestCase = [
-        string,
-        {
-          host: string
-          owner: string
-          name: string
-          apiEndPoint: string
-          isGitHubDotCom: boolean
-        }
-      ]
-      const cases: TestCase[] = [
-        [
-          'https://github.com/npm-update-package/npm-update-package.git',
-          {
-            host: 'github.com',
-            owner: 'npm-update-package',
-            name: 'npm-update-package',
-            apiEndPoint: 'https://api.github.com',
-            isGitHubDotCom: true
-          }
-        ],
-        [
-          'git@github.com:npm-update-package/npm-update-package.git',
-          {
-            host: 'github.com',
-            owner: 'npm-update-package',
-            name: 'npm-update-package',
-            apiEndPoint: 'https://api.github.com',
-            isGitHubDotCom: true
-          }
-        ],
-        [
-          'https://git.example.com/npm-update-package/npm-update-package.git',
-          {
-            host: 'git.example.com',
-            owner: 'npm-update-package',
-            name: 'npm-update-package',
-            apiEndPoint: 'https://git.example.com/api/v3',
-            isGitHubDotCom: false
-          }
-        ],
-        [
-          'git@git.example.com:npm-update-package/npm-update-package.git',
-          {
-            host: 'git.example.com',
-            owner: 'npm-update-package',
-            name: 'npm-update-package',
-            apiEndPoint: 'https://git.example.com/api/v3',
-            isGitHubDotCom: false
-          }
-        ]
-      ]
-
-      it.each<TestCase>(cases)('url=%p', (url, expected) => {
-        const actual = GitRepository.of(url)
-        expect(actual).toBeInstanceOf(GitRepository)
-        expect(actual.host).toBe(expected.host)
-        expect(actual.owner).toBe(expected.owner)
-        expect(actual.name).toBe(expected.name)
-        expect(actual.apiEndPoint).toBe(expected.apiEndPoint)
-        expect(actual.isGitHubDotCom).toBe(expected.isGitHubDotCom)
-      })
-    })
-
-    describe('throws error if URL is invalid', () => {
-      type TestCase = string
-      const cases: TestCase[] = [
-        '',
-        'https://example.com/'
-      ]
-
-      it.each<TestCase>(cases)('url=%p', (url) => {
-        expect(() => GitRepository.of(url)).toThrow(Error)
-      })
-    })
-  })
-})

package/src/git/GitRepository.ts

@@ -1,57 +0,0 @@
-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/createBranchName.test.ts

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