npm-update-package 0.30.0 → 0.31.3

package/src/options/toCommanderOption.ts

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

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

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

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

package/src/package-json/parsePackageJson.ts

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

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

@@ -0,0 +1,5 @@
+export interface PackageManager {
+  packageFile: string
+  lockFile: string
+  install: () => Promise<void>
+}

package/src/package-manager/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/package-manager/Yarn.ts

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

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

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

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

package/src/semver/SemVer.test.ts

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

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

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

package/src/semver/compareSemVers.test.ts

@@ -0,0 +1,21 @@
+import { compareSemVers } from './compareSemVers'
+import { SemVer } from './SemVer'
+import { SemVerLevel } from './SemVerLevel'
+
+describe('compareSemVers', () => {
+  it('returns SemVerLevel.Major if major versions are different', () => {
+    expect(compareSemVers(SemVer.of('1.0.0'), SemVer.of('2.1.1'))).toBe(SemVerLevel.Major)
+  })
+
+  it('returns SemVerLevel.Minor if minor versions are different', () => {
+    expect(compareSemVers(SemVer.of('1.0.0'), SemVer.of('1.1.1'))).toBe(SemVerLevel.Minor)
+  })
+
+  it('returns SemVerLevel.Patch if patch versions are different', () => {
+    expect(compareSemVers(SemVer.of('1.0.0'), SemVer.of('1.0.1'))).toBe(SemVerLevel.Patch)
+  })
+
+  it('returns undefined if both versions are same', () => {
+    expect(compareSemVers(SemVer.of('1.0.0'), SemVer.of('1.0.0'))).toBeUndefined()
+  })
+})

package/src/semver/compareSemVers.ts

@@ -0,0 +1,16 @@
+import type { SemVer } from './SemVer'
+import { SemVerLevel } from './SemVerLevel'
+
+export const compareSemVers = (version1: SemVer, version2: SemVer): SemVerLevel | undefined => {
+  if (version1.major !== version2.major) {
+    return SemVerLevel.Major
+  }
+
+  if (version1.minor !== version2.minor) {
+    return SemVerLevel.Minor
+  }
+
+  if (version1.patch !== version2.patch) {
+    return SemVerLevel.Patch
+  }
+}

package/src/semver/index.ts

@@ -0,0 +1,3 @@
+export * from './compareSemVers'
+export * from './SemVer'
+export * from './SemVerLevel'

package/src/terminal/Terminal.ts

@@ -0,0 +1,12 @@
+import execa from 'execa'
+import type { ExecaReturnValue } from 'execa'
+
+// TODO: add test
+export class Terminal {
+  async run (
+    command: string,
+    ...args: string[]
+  ): Promise<ExecaReturnValue<string>> {
+    return await execa(command, args)
+  }
+}

package/src/terminal/index.ts

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

package/tsconfig.base.json

@@ -0,0 +1,7 @@
+{
+  "extends": "@tsconfig/node12/tsconfig.json",
+  "compilerOptions": {
+    "noUncheckedIndexedAccess": true,
+    "resolveJsonModule": true
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "**/*.test.ts"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "types": [
+      "node",
+      "jest"
+    ]
+  }
+}

package/dist/app.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.app = void 0;
-exports.app = {
-    name: 'npm-update-package',
-    version: '0.30.0',
-    web: 'https://github.com/npm-update-package/npm-update-package'
-};