npm-update-package 0.1.0

package/src/terminal/Terminal.ts

@@ -0,0 +1,30 @@
+import execa from 'execa'
+import type { ExecaReturnValue } from 'execa'
+import { isExecaReturnValue } from './isExecaReturnValue'
+
+// TODO: add test
+export class Terminal {
+  async run (
+    command: string,
+    ...args: string[]
+  ): Promise<ExecaReturnValue<string>> {
+    return await execa(command, args)
+  }
+
+  async runWithErrorHandling (
+    command: string,
+    ...args: string[]
+  ): Promise<ExecaReturnValue<string>> {
+    try {
+      return await this.run(command, ...args)
+    } catch (e) {
+      const value: unknown = e instanceof Error ? JSON.parse(JSON.stringify(e)) : e
+
+      if (isExecaReturnValue(value)) {
+        return value
+      } else {
+        throw e
+      }
+    }
+  }
+}

package/src/terminal/index.ts

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

package/src/terminal/isExecaReturnValue.ts

@@ -0,0 +1,30 @@
+import type { ExecaReturnValue } from 'execa'
+import {
+  boolean,
+  intersection,
+  number,
+  partial,
+  string,
+  type
+} from 'io-ts'
+
+const ExecaReturnValueType = intersection([
+  type({
+    command: string,
+    escapedCommand: string,
+    exitCode: number,
+    failed: boolean,
+    timedOut: boolean,
+    killed: boolean,
+    isCanceled: boolean
+  }),
+  partial({
+    signal: string,
+    signalDescription: string
+  })
+])
+
+// TODO: add test
+export const isExecaReturnValue = (value: unknown): value is ExecaReturnValue => {
+  return ExecaReturnValueType.is(value)
+}

package/src/types/OutdatedPackage.ts

@@ -0,0 +1,9 @@
+import type { UpdateType } from '../enums/UpdateType'
+import type { PackageVersion } from '../values'
+
+export interface OutdatedPackage {
+  name: string
+  currentVersion: PackageVersion
+  newVersion: PackageVersion
+  type: UpdateType
+}

package/src/types/Result.ts

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

package/src/types/index.ts

@@ -0,0 +1,2 @@
+export type { OutdatedPackage } from './OutdatedPackage'
+export type { Result } from './Result'

package/src/values/PackageVersion.test.ts

@@ -0,0 +1,25 @@
+import { PackageVersion } from './PackageVersion'
+
+describe('PackageVersion', () => {
+  describe('of', () => {
+    describe('if version is valid', () => {
+      const version = '^1.2.3'
+
+      it('returns new PackageVersion instance', () => {
+        const packageVersion = PackageVersion.of(version)
+        expect(packageVersion.version).toBe('1.2.3')
+        expect(packageVersion.major).toBe(1)
+        expect(packageVersion.minor).toBe(2)
+        expect(packageVersion.patch).toBe(3)
+      })
+    })
+
+    describe('if version is invalid', () => {
+      const version = ''
+
+      it('throws error', () => {
+        expect(() => PackageVersion.of(version)).toThrow(Error)
+      })
+    })
+  })
+})

package/src/values/PackageVersion.ts

@@ -0,0 +1,40 @@
+import { coerce } from 'semver'
+
+export class PackageVersion {
+  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): PackageVersion {
+    const semver = coerce(version)
+
+    if (semver === null) {
+      throw new Error(`Failed to parse package version. version=${version}`)
+    }
+
+    return new PackageVersion({
+      version: semver.version,
+      major: semver.major,
+      minor: semver.minor,
+      patch: semver.patch
+    })
+  }
+}

package/src/values/index.ts

@@ -0,0 +1 @@
+export { PackageVersion } from './PackageVersion'

package/tsconfig.base.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@tsconfig/node12/tsconfig.json"
+}

package/tsconfig.build.json

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

package/tsconfig.json

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