npm-update-package 0.8.0 → 0.9.0

package/dist/app.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.app = void 0;
 exports.app = {
     name: 'npm-update-package',
-    version: '0.8.0',
+    version: '0.9.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -11,6 +11,9 @@
     "start": "ts-node src/bin.ts",
     "test": "jest --passWithNoTests"
   },
+  "files": [
+    "dist"
+  ],
   "bin": "dist/bin.js",
   "dependencies": {
     "@octokit/rest": "18.12.0",
@@ -50,12 +53,13 @@
     "typescript": "4.4.4",
     "utility-types": "3.10.0"
   },
-  "homepage": "https://github.com/npm-update-package/npm-update-package",
-  "bugs": {
-    "url": "https://github.com/npm-update-package/npm-update-package/issues"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/npm-update-package/npm-update-package.git"
-  }
+  },
+  "bugs": {
+    "url": "https://github.com/npm-update-package/npm-update-package/issues"
+  },
+  "homepage": "https://github.com/npm-update-package/npm-update-package",
+  "license": "MIT"
 }

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/FUNDING.yml

@@ -1,2 +0,0 @@
-github: munierujp
-custom: ["https://www.paypal.me/munieru"]

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,19 +0,0 @@
-name: test
-on:
-  pull_request:
-    branches: [ master ]
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.20.2]
-    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,11 +0,0 @@
-import type { Config } from '@jest/types'
-
-const config: Config.InitialOptions = {
-  preset: 'ts-jest',
-  collectCoverage: true,
-  collectCoverageFrom: [
-    'src/**/*.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,8 +0,0 @@
-{
-	"folders": [
-		{
-			"path": "."
-		}
-	],
-	"settings": {}
-}

package/src/app.ts

@@ -1,5 +0,0 @@
-export const app = {
-  name: 'npm-update-package',
-  version: '0.8.0',
-  web: 'https://github.com/npm-update-package/npm-update-package'
-} as const

package/src/bin.ts

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-
-import { app } from './app'
-import { createLogger } from './logger'
-import { main } from './main'
-import { initOptions } from './options'
-
-const options = initOptions()
-const logger = createLogger(options.logLevel)
-logger.info(`Start ${app.name} v${app.version}`)
-
-main({
-  options,
-  logger
-})
-  .then(() => logger.info(`End ${app.name} v${app.version}`))
-  .catch((e: unknown) => {
-    // TODO: improve error handling
-    logger.fatal('Unexpected error has occurred.', e)
-  })

package/src/git/BranchNameCreator.test.ts

@@ -1,17 +0,0 @@
-import { PackageVersion } from '../ncu'
-import { BranchNameCreator } from './BranchNameCreator'
-
-describe('BranchNameCreator', () => {
-  describe('create', () => {
-    it('returns branch name', () => {
-      const branchNameCreator = new BranchNameCreator('npm-update-package/{{{packageName}}}/{{updateType}}/{{currentVersion}}/{{newVersion}}')
-      const actual = branchNameCreator.create({
-        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/major/1.0.0/1.2.3')
-    })
-  })
-})

package/src/git/BranchNameCreator.ts

@@ -1,19 +0,0 @@
-import { render } from 'mustache'
-import type { OutdatedPackage } from '../ncu'
-
-export class BranchNameCreator {
-  constructor (private readonly template: string) {}
-
-  create (outdatedPackage: OutdatedPackage): string {
-    const packageName = outdatedPackage.name
-    const currentVersion = outdatedPackage.currentVersion.version
-    const newVersion = outdatedPackage.newVersion.version
-    const updateType = outdatedPackage.type
-    return render(this.template, {
-      packageName,
-      currentVersion,
-      newVersion,
-      updateType
-    })
-  }
-}

package/src/git/CommitMessageCreator.test.ts

@@ -1,17 +0,0 @@
-import { PackageVersion } from '../ncu'
-import { CommitMessageCreator } from './CommitMessageCreator'
-
-describe('CommitMessageCreator', () => {
-  describe('create', () => {
-    it('returns commit message', () => {
-      const commitMessageCreator = new CommitMessageCreator('chore(deps): {{updateType}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
-      const actual = commitMessageCreator.create({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion: PackageVersion.of('1.0.0'),
-        newVersion: PackageVersion.of('2.0.0'),
-        type: 'major'
-      })
-      expect(actual).toBe('chore(deps): major update @typescript-eslint/eslint-plugin 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 '../ncu'
-
-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 updateType = outdatedPackage.type
-    return render(this.template, {
-      packageName,
-      currentVersion,
-      newVersion,
-      updateType
-    })
-  }
-}

package/src/git/Committer.ts

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

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

@@ -1,61 +0,0 @@
-import { GitRepository } from './GitRepository'
-
-describe('GitRepository', () => {
-  describe('of', () => {
-    describe('if URL is HTTPS', () => {
-      describe('if URL is github.com', () => {
-        const url = 'https://github.com/npm-update-package/npm-update-package.git'
-
-        it('returns new GitRepository instance', () => {
-          const repo = GitRepository.of(url)
-          expect(repo.host).toBe('github.com')
-          expect(repo.owner).toBe('npm-update-package')
-          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/npm-update-package/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('npm-update-package')
-          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:npm-update-package/npm-update-package.git'
-
-        it('returns new GitRepository instance', () => {
-          const repo = GitRepository.of(url)
-          expect(repo.host).toBe('github.com')
-          expect(repo.owner).toBe('npm-update-package')
-          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:npm-update-package/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('npm-update-package')
-          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

@@ -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/index.ts

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

package/src/github/Branch.ts

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

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

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

package/src/github/PullRequestBodyCreator.test.ts

@@ -1,32 +0,0 @@
-import { app } from '../app'
-import { PackageVersion } from '../ncu'
-import { PullRequestBodyCreator } from './PullRequestBodyCreator'
-
-describe('PullRequestBodyCreator', () => {
-  describe('create', () => {
-    it('returns pull request body', () => {
-      const pullRequestBodyCreator = new PullRequestBodyCreator(`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 [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`)
-      const actual = pullRequestBodyCreator.create({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion: PackageVersion.of('1.0.0'),
-        newVersion: PackageVersion.of('2.0.0'),
-        type: '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 [${app.name}](${app.web}) v${app.version}`)
-    })
-  })
-})

package/src/github/PullRequestBodyCreator.ts

@@ -1,26 +0,0 @@
-import { render } from 'mustache'
-import { app } from '../app'
-import type { OutdatedPackage } from '../ncu'
-
-export class PullRequestBodyCreator {
-  constructor (private readonly template: string) {}
-
-  create (outdatedPackage: OutdatedPackage): string {
-    const appName = app.name
-    const appVersion = app.version
-    const appWeb = app.web
-    const currentVersion = outdatedPackage.currentVersion.version
-    const newVersion = outdatedPackage.newVersion.version
-    const packageName = outdatedPackage.name
-    const updateType = outdatedPackage.type
-    return render(this.template, {
-      appName,
-      appVersion,
-      appWeb,
-      currentVersion,
-      newVersion,
-      packageName,
-      updateType
-    })
-  }
-}

package/src/github/PullRequestCreator.ts

@@ -1,65 +0,0 @@
-import type { GitRepository } from '../git'
-import type { Logger } from '../logger'
-import type { OutdatedPackage } from '../ncu'
-import type { GitHub } from './GitHub'
-import type { PullRequestBodyCreator } from './PullRequestBodyCreator'
-import type { PullRequestTitleCreator } from './PullRequestTitleCreator'
-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 pullRequestTitleCreator: PullRequestTitleCreator
-  private readonly pullRequestBodyCreator: PullRequestBodyCreator
-  private readonly logger: Logger
-
-  constructor ({
-    github,
-    gitRepo,
-    githubRepo,
-    pullRequestTitleCreator,
-    pullRequestBodyCreator,
-    logger
-  }: {
-    github: GitHub
-    gitRepo: GitRepository
-    githubRepo: GitHubRepository
-    pullRequestTitleCreator: PullRequestTitleCreator
-    pullRequestBodyCreator: PullRequestBodyCreator
-    logger: Logger
-  }) {
-    this.github = github
-    this.gitRepo = gitRepo
-    this.githubRepo = githubRepo
-    this.pullRequestTitleCreator = pullRequestTitleCreator
-    this.pullRequestBodyCreator = pullRequestBodyCreator
-    this.logger = logger
-  }
-
-  async create ({
-    outdatedPackage,
-    branchName
-  }: {
-    outdatedPackage: OutdatedPackage
-    branchName: string
-  }): Promise<void> {
-    const title = this.pullRequestTitleCreator.create(outdatedPackage)
-    this.logger.debug(`title=${title}`)
-
-    const body = this.pullRequestBodyCreator.create(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}`)
-  }
-}