npm-update-package 0.31.3 → 0.33.0

package/src/github/pull-request/creator/PullRequestCreator.ts

@@ -1,84 +0,0 @@
-import type { OutdatedPackage } from '../../../core'
-import type { GitRepository } from '../../../git'
-import type { Logger } from '../../../logger'
-import type {
-  CreatedPullRequest,
-  GitHub,
-  Repository as GitHubRepository
-} from '../../GitHub'
-import { createPullRequestBody } from './createPullRequestBody'
-import type { PullRequestTitleCreator } from './PullRequestTitleCreator'
-
-export class PullRequestCreator {
-  private readonly github: GitHub
-  private readonly gitRepo: GitRepository
-  private readonly githubRepo: GitHubRepository
-  private readonly pullRequestTitleCreator: PullRequestTitleCreator
-  private readonly logger: Logger
-  private readonly reviewers: string[] | undefined
-
-  constructor ({
-    github,
-    gitRepo,
-    githubRepo,
-    pullRequestTitleCreator,
-    logger,
-    reviewers
-  }: {
-    github: GitHub
-    gitRepo: GitRepository
-    githubRepo: GitHubRepository
-    pullRequestTitleCreator: PullRequestTitleCreator
-    logger: Logger
-    reviewers?: string[]
-  }) {
-    this.github = github
-    this.gitRepo = gitRepo
-    this.githubRepo = githubRepo
-    this.pullRequestTitleCreator = pullRequestTitleCreator
-    this.logger = logger
-    this.reviewers = reviewers
-  }
-
-  async create ({
-    outdatedPackage,
-    branchName
-  }: {
-    outdatedPackage: OutdatedPackage
-    branchName: string
-  }): Promise<CreatedPullRequest> {
-    const title = this.pullRequestTitleCreator.create(outdatedPackage)
-    this.logger.debug(`title=${title}`)
-
-    const body = createPullRequestBody(outdatedPackage)
-    this.logger.debug(`body=${body}`)
-
-    const pullRequest = await this.github.createPullRequest({
-      owner: this.gitRepo.owner,
-      repo: this.gitRepo.name,
-      baseBranch: this.githubRepo.default_branch,
-      headBranch: branchName,
-      title,
-      body
-    })
-    this.logger.debug(`pullRequest=${JSON.stringify(pullRequest)}`)
-
-    await this.github.addLabels({
-      owner: this.gitRepo.owner,
-      repo: this.gitRepo.name,
-      issueNumber: pullRequest.number,
-      labels: ['npm-update-package']
-    })
-
-    if (this.reviewers !== undefined) {
-      await this.github.requestReviewers({
-        owner: this.gitRepo.owner,
-        repo: this.gitRepo.name,
-        pullNumber: pullRequest.number,
-        reviewers: this.reviewers
-      })
-    }
-
-    return pullRequest
-  }
-}

package/src/github/pull-request/creator/PullRequestTitleCreator.test.ts

@@ -1,17 +0,0 @@
-import { SemVer } from '../../../semver'
-import { PullRequestTitleCreator } from './PullRequestTitleCreator'
-
-describe('PullRequestTitleCreator', () => {
-  describe('create', () => {
-    it('returns pull request title', () => {
-      const pullRequestTitleCreator = new PullRequestTitleCreator('chore(deps): {{level}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
-      const actual = pullRequestTitleCreator.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/github/pull-request/creator/PullRequestTitleCreator.ts

@@ -1,19 +0,0 @@
-import { render } from 'mustache'
-import type { OutdatedPackage } from '../../../core'
-
-export class PullRequestTitleCreator {
-  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/github/pull-request/creator/createPullRequestBody.test.ts

@@ -1,47 +0,0 @@
-
-import pkg from '../../../../package.json'
-import { SemVer } from '../../../semver'
-import { createPullRequestBody } from './createPullRequestBody'
-
-describe('createPullRequestBody', () => {
-  it('returns pull request body', () => {
-    const actual = createPullRequestBody({
-      name: '@npm-update-package/example',
-      currentVersion: SemVer.of('1.0.0'),
-      newVersion: SemVer.of('2.0.0'),
-      level: 'major'
-    })
-    expect(actual).toBe(`This PR updates these packages:
-
-|Package|Level|Current version|New version|
-|---|---|---|---|
-|[@npm-update-package/example](https://www.npmjs.com/package/@npm-update-package/example)|major|\`1.0.0\`|\`2.0.0\`|
-
-<details>
-<summary>Metadata</summary>
-
-**Don't remove or edit this section because it will be used by npm-update-package.**
-
-<div id="npm-update-package-metadata">
-
-\`\`\`json
-{
-  "version": "${pkg.version}",
-  "packages": [
-    {
-      "name": "@npm-update-package/example",
-      "currentVersion": "1.0.0",
-      "newVersion": "2.0.0",
-      "level": "major"
-    }
-  ]
-}
-\`\`\`
-
-</div>
-</details>
-
----
-This PR has been generated by [${pkg.name}](${pkg.homepage}) v${pkg.version}`)
-  })
-})

package/src/github/pull-request/creator/createPullRequestBody.ts

@@ -1,35 +0,0 @@
-
-import pkg from '../../../../package.json'
-import type { OutdatedPackage } from '../../../core'
-import { toJSON } from '../../../json'
-import { createPullRequestMetadata } from '../metadata'
-
-export const createPullRequestBody = (outdatedPackage: OutdatedPackage): string => {
-  const currentVersion = outdatedPackage.currentVersion.version
-  const newVersion = outdatedPackage.newVersion.version
-  const packageName = outdatedPackage.name
-  const level = outdatedPackage.level
-  const metadata = toJSON(createPullRequestMetadata([outdatedPackage]), { pretty: true })
-  return `This PR updates these packages:
-
-|Package|Level|Current version|New version|
-|---|---|---|---|
-|[${packageName}](https://www.npmjs.com/package/${packageName})|${level}|\`${currentVersion}\`|\`${newVersion}\`|
-
-<details>
-<summary>Metadata</summary>
-
-**Don't remove or edit this section because it will be used by npm-update-package.**
-
-<div id="npm-update-package-metadata">
-
-\`\`\`json
-${metadata}
-\`\`\`
-
-</div>
-</details>
-
----
-This PR has been generated by [${pkg.name}](${pkg.homepage}) v${pkg.version}`
-}

package/src/github/pull-request/creator/index.ts

@@ -1,2 +0,0 @@
-export * from './PullRequestCreator'
-export * from './PullRequestTitleCreator'

package/src/github/pull-request/finder/PullRequestFinder.ts

@@ -1,27 +0,0 @@
-import type { PullRequest } from '../../GitHub'
-import { extractPullRequestMetadata } from '../metadata'
-import { isPullRequestByNpmUpdatePackage } from './isPullRequestByNpmUpdatePackage'
-
-// TODO: Add test
-export class PullRequestFinder {
-  constructor (private readonly pullRequests: PullRequest[]) {}
-
-  findByPackageName (packageName: string): PullRequest[] {
-    return this.pullRequests
-      .filter(isPullRequestByNpmUpdatePackage)
-      .filter(({ body }) => {
-        if (body === null) {
-          return false
-        }
-
-        const metadata = extractPullRequestMetadata(body)
-
-        if (metadata === undefined) {
-          return false
-        }
-
-        const { packages } = metadata
-        return packages.some(({ name }) => name === packageName)
-      })
-  }
-}

package/src/github/pull-request/finder/index.ts

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

package/src/github/pull-request/finder/isPullRequestByNpmUpdatePackage.test.ts

@@ -1,24 +0,0 @@
-import type { PullRequest } from '../../GitHub'
-import { isPullRequestByNpmUpdatePackage } from './isPullRequestByNpmUpdatePackage'
-
-describe('isPullRequestByNpmUpdatePackage', () => {
-  it('returns true if pull request has label `npm-update-package`', () => {
-    const pullRequest = {
-      labels: [
-        {
-          name: 'npm-update-package'
-        }
-      ]
-    } as unknown as PullRequest
-
-    expect(isPullRequestByNpmUpdatePackage(pullRequest)).toBe(true)
-  })
-
-  it('returns false if pull request does not have label `npm-update-package`', () => {
-    const pullRequest = {
-      labels: []
-    } as unknown as PullRequest
-
-    expect(isPullRequestByNpmUpdatePackage(pullRequest)).toBe(false)
-  })
-})

package/src/github/pull-request/finder/isPullRequestByNpmUpdatePackage.ts

@@ -1,5 +0,0 @@
-import type { PullRequest } from '../../GitHub'
-
-export const isPullRequestByNpmUpdatePackage = (pullRequest: PullRequest): boolean => {
-  return pullRequest.labels.some(({ name }) => name === 'npm-update-package')
-}

package/src/github/pull-request/index.ts

@@ -1,3 +0,0 @@
-export * from './closer'
-export * from './creator'
-export * from './finder'

package/src/github/pull-request/metadata/PullRequestMetadata.ts

@@ -1,22 +0,0 @@
-import {
-  array,
-  literal,
-  string,
-  type,
-  union,
-  type TypeOf
-} from 'io-ts'
-import { SemVerLevel } from '../../../semver'
-
-const PullRequestMetadata = type({
-  version: string,
-  packages: array(type({
-    name: string,
-    currentVersion: string,
-    newVersion: string,
-    level: union([literal(SemVerLevel.Major), literal(SemVerLevel.Minor), literal(SemVerLevel.Patch)])
-  }))
-})
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type PullRequestMetadata = TypeOf<typeof PullRequestMetadata>
-export const isPullRequestMetadata = PullRequestMetadata.is

package/src/github/pull-request/metadata/createPullRequestMetadata.test.ts

@@ -1,31 +0,0 @@
-
-import pkg from '../../../../package.json'
-import type { OutdatedPackage } from '../../../core'
-import { SemVer } from '../../../semver'
-import { createPullRequestMetadata } from './createPullRequestMetadata'
-
-describe('createPullRequestMetadata', () => {
-  it('returns PullRequestMetadata', () => {
-    const outdatedPackages: OutdatedPackage[] = [
-      {
-        name: '@npm-update-package/example',
-        currentVersion: SemVer.of('1.0.0'),
-        newVersion: SemVer.of('2.0.0'),
-        level: 'major'
-      }
-    ]
-    const metadata = createPullRequestMetadata(outdatedPackages)
-
-    expect(metadata).toEqual({
-      version: pkg.version,
-      packages: [
-        {
-          name: '@npm-update-package/example',
-          currentVersion: '1.0.0',
-          newVersion: '2.0.0',
-          level: 'major'
-        }
-      ]
-    })
-  })
-})

package/src/github/pull-request/metadata/createPullRequestMetadata.ts

@@ -1,21 +0,0 @@
-
-import pkg from '../../../../package.json'
-import type { OutdatedPackage } from '../../../core'
-import type { PullRequestMetadata } from './PullRequestMetadata'
-
-export const createPullRequestMetadata = (outdatedPackages: OutdatedPackage[]): PullRequestMetadata => {
-  return {
-    version: pkg.version,
-    packages: outdatedPackages.map(({
-      name,
-      currentVersion,
-      newVersion,
-      level
-    }) => ({
-      name,
-      currentVersion: currentVersion.version,
-      newVersion: newVersion.version,
-      level
-    }))
-  }
-}

package/src/github/pull-request/metadata/extractPullRequestMetadata.test.ts

@@ -1,53 +0,0 @@
-import { extractPullRequestMetadata } from './extractPullRequestMetadata'
-
-describe('extractPullRequestMetadata', () => {
-  it('returns PullRequestMetadata if body contains metadata', () => {
-    const body = `<div id="npm-update-package-metadata">
-
-\`\`\`json
-{
-  "version": "1.0.0",
-  "packages": [
-    {
-      "name": "@npm-update-package/example",
-      "level": "major",
-      "currentVersion": "1.0.0",
-      "newVersion": "2.0.0"
-    }
-  ]
-}
-\`\`\`
-
-</div>`
-    const metadata = extractPullRequestMetadata(body)
-    expect(metadata).toEqual({
-      version: '1.0.0',
-      packages: [
-        {
-          name: '@npm-update-package/example',
-          level: 'major',
-          currentVersion: '1.0.0',
-          newVersion: '2.0.0'
-        }
-      ]
-    })
-  })
-
-  it('returns undefined if body does not contain metadata', () => {
-    const body = ''
-    const metadata = extractPullRequestMetadata(body)
-    expect(metadata).toBeUndefined()
-  })
-
-  it('returns undefined if metadata is invalid', () => {
-    const body = `<div id="npm-update-package-metadata">
-
-\`\`\`json
-{}
-\`\`\`
-
-</div>`
-    const metadata = extractPullRequestMetadata(body)
-    expect(metadata).toBeUndefined()
-  })
-})

package/src/github/pull-request/metadata/extractPullRequestMetadata.ts

@@ -1,21 +0,0 @@
-import {
-  isPullRequestMetadata,
-  type PullRequestMetadata
-} from './PullRequestMetadata'
-
-export const extractPullRequestMetadata = (pullRequestBody: string): PullRequestMetadata | undefined => {
-  const matched = pullRequestBody.match(/<div id="npm-update-package-metadata">\s*```json\s*([\s\S]+?)\s*```\s*<\/div>/)
-  const json = matched?.[1]
-
-  if (json === undefined) {
-    return undefined
-  }
-
-  const metadata: unknown = JSON.parse(json)
-
-  if (!isPullRequestMetadata(metadata)) {
-    return undefined
-  }
-
-  return metadata
-}

package/src/github/pull-request/metadata/index.ts

@@ -1,3 +0,0 @@
-export * from './createPullRequestMetadata'
-export * from './extractPullRequestMetadata'
-export * from './PullRequestMetadata'

package/src/json/index.ts

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

package/src/json/toJSON.test.ts

@@ -1,65 +0,0 @@
-import { toJSON } from './toJSON'
-
-type TestCase = [unknown, string]
-
-describe('toJSON', () => {
-  describe('returns not indented JSON string if pretty option is false', () => {
-    const cases: TestCase[] = [
-      [
-        {
-          number: 1,
-          string: 'string'
-        },
-        '{"number":1,"string":"string"}'
-      ],
-      [
-        [
-          {
-            number: 1,
-            string: 'string'
-          }
-        ],
-        '[{"number":1,"string":"string"}]'
-      ]
-    ]
-
-    it.each<TestCase>(cases)('value=%j', (value, expected) => {
-      const json = toJSON(value)
-      expect(json).toBe(expected)
-    })
-  })
-
-  describe('returns indented JSON string if pretty option is true', () => {
-    const cases: TestCase[] = [
-      [
-        {
-          number: 1,
-          string: 'string'
-        },
-`{
-  "number": 1,
-  "string": "string"
-}`
-      ],
-      [
-        [
-          {
-            number: 1,
-            string: 'string'
-          }
-        ],
-`[
-  {
-    "number": 1,
-    "string": "string"
-  }
-]`
-      ]
-    ]
-
-    it.each<TestCase>(cases)('value=%j', (value, expected) => {
-      const json = toJSON(value, { pretty: true })
-      expect(json).toBe(expected)
-    })
-  })
-})

package/src/json/toJSON.ts

@@ -1,13 +0,0 @@
-interface Options {
-  pretty?: boolean
-}
-
-export const toJSON = (value: unknown, options?: Options): string => {
-  const pretty = options?.pretty ?? false
-
-  if (pretty) {
-    return JSON.stringify(value, null, 2)
-  } else {
-    return JSON.stringify(value)
-  }
-}

package/src/logger/LogLevel.ts

@@ -1,13 +0,0 @@
-export const LogLevel = {
-  Debug: 'debug',
-  Error: 'error',
-  Fatal: 'fatal',
-  Info: 'info',
-  Off: 'off',
-  Trace: 'trace',
-  Warn: 'warn'
-} as const
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-export type LogLevel = typeof LogLevel[keyof typeof LogLevel]
-const logLevels = Object.values(LogLevel)
-export const isLogLevel = (value: any): value is LogLevel => logLevels.includes(value)

package/src/logger/Logger.ts

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

package/src/logger/createLogger.ts

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

package/src/logger/index.ts

@@ -1,3 +0,0 @@
-export * from './createLogger'
-export * from './Logger'
-export * from './LogLevel'