feat: replace execa with tinyexec (#195)

Co-authored-by: ziebam <[email protected]>
Co-authored-by: JounQin <[email protected]>

Author: 3 people

.changeset/dull-badgers-sleep.md

@@ -0,0 +1,5 @@
+---
+"pretty-quick": minor
+---
+
+feat: replace `execa` with `tinyexec`

.gitignore

@@ -4,3 +4,5 @@ node_modules
 /.yarn/*
 !/.yarn/plugins
 !/.yarn/releases
+coverage
+.eslintcache

__mocks__/execa.ts

@@ -0,0 +1,6 @@
+export const exec = jest.fn().mockReturnValue({
+  stdout: '',
+  stderr: '',
+  // eslint-disable-next-line @typescript-eslint/no-empty-function
+  kill: () => {},
+})

__mocks__/tinyexec.ts

@@ -57,13 +57,13 @@
     "prettier": "^3.0.0"
   },
   "dependencies": {
-    "execa": "^5.1.1",
     "find-up": "^5.0.0",
     "ignore": "^7.0.3",
     "mri": "^1.2.0",
-    "picocolors": "^1.0.0",
-    "picomatch": "^3.0.1",
-    "tslib": "^2.6.2"
+    "picocolors": "^1.1.1",
+    "picomatch": "^4.0.2",
+    "tinyexec": "^0.3.2",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@1stg/lib-config": "^13.0.0",
@@ -82,14 +82,13 @@
     "lint-staged": "^15.4.3",
     "mock-fs": "^5.5.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^3.2.3",
+    "prettier": "^3.5.3",
     "pretty-quick": "link:.",
-    "simple-git-hooks": "^2.9.0",
-    "size-limit": "^11.0.2",
+    "size-limit": "^11.2.0",
     "size-limit-preset-node-lib": "^0.3.0",
-    "ts-jest": "^29.1.1",
+    "ts-jest": "^29.2.6",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.8.2"
   },
   "resolutions": {
     "prettier": "^3.5.3",

package.json

@@ -35,7 +35,8 @@ export = async (
   }
   const directory = scm.rootDirectory
 
-  const revision = since || scm.getSinceRevision(directory, { staged, branch })
+  const revision =
+    since || (await scm.getSinceRevision(directory, { staged, branch }))
 
   onFoundSinceRevision?.(scm.name, revision)
 
@@ -49,19 +50,23 @@ export = async (
 
   const isFileSupportedExtension = isSupportedExtension(resolveConfig)
 
+  const unfilteredChangedFiles = await scm.getChangedFiles(
+    directory,
+    revision,
+    staged,
+  )
   const changedFiles = await filterAsync(
-    scm
-      .getChangedFiles(directory, revision, staged)
+    unfilteredChangedFiles
       .filter(patternMatcher)
       .filter(rootIgnorer)
       .filter(cwdIgnorer),
     isFileSupportedExtension,
   )
 
+  const unfilteredStagedFiles = await scm.getUnstagedChangedFiles(directory)
   const unstagedFiles = staged
     ? await filterAsync(
-        scm
-          .getUnstagedChangedFiles(directory)
+        unfilteredStagedFiles
           .filter(patternMatcher)
           .filter(rootIgnorer)
           .filter(cwdIgnorer),
@@ -78,14 +83,14 @@ export = async (
   await processFiles(directory, changedFiles, {
     check,
     config,
-    onWriteFile(file: string) {
-      onWriteFile?.(file)
+    onWriteFile: async (file: string) => {
+      await onWriteFile?.(file)
       if (bail) {
         failReasons.add('BAIL_ON_WRITE')
       }
       if (staged && restage) {
         if (wasFullyStaged(file)) {
-          scm.stageFile(directory, file)
+          await scm.stageFile(directory, file)
         } else {
           onPartiallyStagedFile?.(file)
           failReasons.add('PARTIALLY_STAGED_FILE')

src/index.ts

@@ -40,7 +40,7 @@ export default async (
 
     if (output !== input) {
       fs.writeFileSync(file, output)
-      onWriteFile?.(relative)
+      await onWriteFile?.(relative)
     }
   }
 }

src/processFiles.ts

@@ -1,8 +1,8 @@
 import fs from 'fs'
 import path from 'path'
 
-import execa from 'execa'
 import findUp from 'find-up'
+import { Output, exec } from 'tinyexec'
 
 export const name = 'git'
 
@@ -44,26 +44,35 @@ export const detect = (directory: string) => {
 }
 
 const runGit = (directory: string, args: string[]) =>
-  execa.sync('git', args, {
-    cwd: directory,
+  exec('git', args, {
+    nodeOptions: {
+      cwd: directory,
+    },
   })
 
-const getLines = (execaResult: execa.ExecaSyncReturnValue) =>
-  execaResult.stdout.split('\n')
+const getLines = (tinyexecOutput: Output) => tinyexecOutput.stdout.split('\n')
 
-export const getSinceRevision = (
+export const getSinceRevision = async (
   directory: string,
   { staged, branch }: { staged?: boolean; branch?: string },
 ) => {
   try {
-    const revision = staged
-      ? 'HEAD'
-      : runGit(directory, [
-          'merge-base',
-          'HEAD',
-          branch || 'master',
-        ]).stdout.trim()
-    return runGit(directory, ['rev-parse', '--short', revision]).stdout.trim()
+    let revision = 'HEAD'
+    if (!staged) {
+      const revisionOutput = await runGit(directory, [
+        'merge-base',
+        'HEAD',
+        branch || 'master',
+      ])
+      revision = revisionOutput.stdout.trim()
+    }
+
+    const revParseOutput = await runGit(directory, [
+      'rev-parse',
+      '--short',
+      revision,
+    ])
+    return revParseOutput.stdout.trim()
   } catch (err) {
     const error = err as Error
     if (
@@ -76,14 +85,14 @@ export const getSinceRevision = (
   }
 }
 
-export const getChangedFiles = (
+export const getChangedFiles = async (
   directory: string,
   revision: string | null,
   staged?: boolean | undefined,
 ) =>
   [
     ...getLines(
-      runGit(
+      await runGit(
         directory,
         [
           'diff',
@@ -97,14 +106,17 @@ export const getChangedFiles = (
     ...(staged
       ? []
       : getLines(
-          runGit(directory, ['ls-files', '--others', '--exclude-standard']),
+          await runGit(directory, [
+            'ls-files',
+            '--others',
+            '--exclude-standard',
+          ]),
         )),
   ].filter(Boolean)
 
 export const getUnstagedChangedFiles = (directory: string) => {
   return getChangedFiles(directory, null, false)
 }
 
-export const stageFile = (directory: string, file: string) => {
+export const stageFile = (directory: string, file: string) =>
   runGit(directory, ['add', file])
-}

src/scms/git.ts

@@ -1,7 +1,7 @@
 import path from 'path'
 
-import execa from 'execa'
 import findUp from 'find-up'
+import { Output, exec } from 'tinyexec'
 
 export const name = 'hg'
 
@@ -16,33 +16,37 @@ export const detect = (directory: string) => {
 }
 
 const runHg = (directory: string, args: string[]) =>
-  execa.sync('hg', args, {
-    cwd: directory,
+  exec('hg', args, {
+    nodeOptions: {
+      cwd: directory,
+    },
   })
 
-const getLines = (execaResult: execa.ExecaSyncReturnValue) =>
-  execaResult.stdout.split('\n')
+const getLines = (tinyexecOutput: Output) => tinyexecOutput.stdout.split('\n')
 
-export const getSinceRevision = (
+export const getSinceRevision = async (
   directory: string,
   { branch }: { branch?: string },
 ) => {
-  const revision = runHg(directory, [
+  const revisionOutput = await runHg(directory, [
     'debugancestor',
     'tip',
     branch || 'default',
-  ]).stdout.trim()
-  return runHg(directory, ['id', '-i', '-r', revision]).stdout.trim()
+  ])
+  const revision = revisionOutput.stdout.trim()
+
+  const hgOutput = await runHg(directory, ['id', '-i', '-r', revision])
+  return hgOutput.stdout.trim()
 }
 
-export const getChangedFiles = (
+export const getChangedFiles = async (
   directory: string,
   revision: string | null,
   _staged?: boolean,
 ) =>
   [
     ...getLines(
-      runHg(directory, [
+      await runHg(directory, [
         'status',
         '-n',
         '-a',
@@ -54,6 +58,5 @@ export const getChangedFiles = (
 
 export const getUnstagedChangedFiles = () => []
 
-export const stageFile = (directory: string, file: string) => {
+export const stageFile = (directory: string, file: string) =>
   runHg(directory, ['add', file])
-}

src/scms/hg.ts

@@ -15,5 +15,5 @@ export interface PrettyQuickOptions {
   onPartiallyStagedFile(file: string): void
   onExamineFile(relative: string): void
   onCheckFile(relative: string, isFormatted: boolean): void
-  onWriteFile(relative: string): void
+  onWriteFile(relative: string): Promise<void> | void
 }

src/types.ts

@@ -1,10 +1,8 @@
-import execa from 'execa'
 import mock from 'mock-fs'
+import * as tinyexec from 'tinyexec'
 
 import prettyQuick from 'pretty-quick'
 
-jest.mock('execa')
-
 afterEach(() => {
   mock.restore()
   jest.clearAllMocks()
@@ -22,9 +20,8 @@ describe('match pattern', () => {
       '/src/should-not-be-included/hello/zoo.js': "export const zoo = 'zoo'",
     })
 
-    // @ts-expect-error -- Need to find a better way to mock this
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-    execa.sync.mockImplementation((_command: string, args: string[]) => {
+    const execSpy = jest.spyOn(tinyexec, 'exec') as jest.Mock
+    execSpy.mockImplementation((_command: string, args: string[]) => {
       switch (args[0]) {
         case 'ls-files': {
           return { stdout: '' }