feat: implement parallel runner

BREAKING CHANGE: move runTransform/runTransformOnFile to:
import { runTransform, runTransformOnFile } from 'astx/node'

Author: jedwards1211

package.json

@@ -109,7 +109,7 @@
     "@babel/plugin-transform-runtime": "^7.12.10",
     "@babel/preset-env": "^7.18.10",
     "@babel/preset-typescript": "^7.18.6",
-    "@babel/register": "^7.12.10",
+    "@babel/register": "^7.18.9",
     "@commitlint/cli": "^11.0.0",
     "@commitlint/config-conventional": "^11.0.0",
     "@jedwards1211/commitlint-config": "^1.0.2",
@@ -175,9 +175,11 @@
     "inquirer": "^7.3.3",
     "lodash": "^4.17.20",
     "minimatch": "^5.1.0",
+    "p-event": "^4.0.0",
     "recast": "^0.21.2",
     "resolve": "^1.19.0",
     "shallowequal": "^1.1.0",
+    "tiny-typed-emitter": "^2.1.0",
     "typed-validators": "^4.5.1",
     "yargs": "^16.2.0"
   }

pnpm-lock.yaml

@@ -1,10 +1,41 @@
-import { Node, NodePath } from './types'
+import { Expression, Statement, Node, NodePath } from './types'
 import { Backend } from './backend/Backend'
 import find, { Match, convertWithCaptures, createMatch } from './find'
 import replace from './replace'
 import compileMatcher, { MatchResult } from './compileMatcher'
 import CodeFrameError from './util/CodeFrameError'
 import ensureArray from './util/ensureArray'
+import * as AstTypes from 'ast-types'
+
+export type TransformOptions = {
+  /** The absolute path to the current file. */
+  path: string
+  /** The source code of the current file. */
+  source: string
+  astx: Astx
+  expression(strings: TemplateStringsArray, ...quasis: any[]): Expression
+  statement(strings: TemplateStringsArray, ...quasis: any[]): Statement
+  statements(strings: TemplateStringsArray, ...quasis: any[]): Statement[]
+  t: typeof AstTypes
+  report: (msg: string) => void
+}
+
+export type Transform = {
+  astx?: (options: TransformOptions) => string | null | undefined | void
+  find?: string | Node | Node[]
+  replace?: string | Node | Node[] | GetReplacement
+  where?: FindOptions['where']
+}
+
+export type TransformResult = {
+  file: string
+  source?: string
+  transformed?: string
+  reports?: any[]
+  error?: Error
+  matches?: readonly Match[]
+  backend: Backend
+}
 
 export type ParsePattern = (
   strings: string | string[] | TemplateStringsArray,

src/Astx.ts

@@ -1,7 +1,5 @@
 import { Backend } from './backend/Backend'
-import { cosmiconfig } from 'cosmiconfig'
 import * as t from 'typed-validators'
-import { CosmiconfigResult } from 'cosmiconfig/dist/types'
 
 export type AstxConfig = {
   parser?:
@@ -11,6 +9,7 @@ export type AstxConfig = {
     | 'recast/babel/auto'
     | Backend
   parserOptions?: Record<string, any>
+  workers?: number
 }
 
 export const AstxConfigType: t.TypeAlias<AstxConfig> = t.alias(
@@ -26,16 +25,7 @@ export const AstxConfigType: t.TypeAlias<AstxConfig> = t.alias(
       ),
 
       parserOptions: t.record(t.string(), t.any()),
+      workers: t.number(),
     },
   })
 )
-
-export const astxCosmiconfig = cosmiconfig('astx', {
-  transform: (result: CosmiconfigResult): CosmiconfigResult =>
-    result
-      ? {
-          ...result,
-          config: AstxConfigType.assert(result.config || {}),
-        }
-      : null,
-})

src/AstxConfig.ts

@@ -8,10 +8,10 @@ import inquirer from 'inquirer'
 import fs from 'fs-extra'
 import dedent from 'dedent-js'
 import CodeFrameError from '../util/CodeFrameError'
-import runTransform from '../runTransform'
-import Astx from '../Astx'
-import formatMatches from '../util/formatMatches'
-import { Transform } from '../runTransformOnFile'
+import { formatIpcMatches } from '../util/formatMatches'
+import { AstxWorkerPool, astxCosmiconfig } from '../node'
+import { invertIpcError } from '../node/ipc'
+import { Transform } from '../Astx'
 
 /* eslint-disable no-console */
 
@@ -93,15 +93,9 @@ const transform: CommandModule<Options> = {
     let errorCount = 0
     let changedCount = 0
     let unchangedCount = 0
-    for await (const {
-      file,
-      source,
-      transformed,
-      reports,
-      error,
-      matches,
-      backend,
-    } of runTransform({
+    const config = (await astxCosmiconfig.search())?.config
+    const pool = new AstxWorkerPool({ capacity: config?.workers })
+    for await (const event of pool.runTransform({
       transform,
       transformFile,
       paths,
@@ -110,6 +104,18 @@ const transform: CommandModule<Options> = {
         parserOptions: parserOptions ? JSON.parse(parserOptions) : undefined,
       },
     })) {
+      if (event.type === 'progress') {
+        continue
+      }
+      const {
+        file,
+        source,
+        transformed,
+        reports,
+        matches,
+        error: _error,
+      } = event.result
+      const error = _error ? invertIpcError(_error) : undefined
       const relpath = path.relative(process.cwd(), file)
       const logHeader = once((logFn: (value: string) => any) =>
         logFn(
@@ -150,7 +156,7 @@ const transform: CommandModule<Options> = {
         !transform.astx
       ) {
         logHeader(console.log)
-        console.log(formatMatches(backend, source, matches))
+        console.log(formatIpcMatches(source, matches))
       } else {
         unchangedCount++
       }
@@ -165,9 +171,10 @@ const transform: CommandModule<Options> = {
         )
         reports?.forEach((r: any) =>
           console.error(
-            r instanceof Astx && source
-              ? formatMatches(backend, source, r.matches)
-              : r
+            // r instanceof Astx && source
+            //   ? formatIpcMatches(source, r.matches)
+            //   : r
+            r
           )
         )
       }
@@ -220,6 +227,8 @@ const transform: CommandModule<Options> = {
       }
       if (process.send) process.send({ exit: 0 })
     }
+    await pool.end()
+    process.exit(0)
   },
 }
 

src/cli/transform.ts

@@ -1,4 +1,11 @@
-export { default as Astx, ParsePattern, GetReplacement } from './Astx'
+export {
+  default as Astx,
+  Transform,
+  TransformOptions,
+  TransformResult,
+  ParsePattern,
+  GetReplacement,
+} from './Astx'
 export { default as find, Match, FindOptions } from './find'
 export { default as compileMatcher, CompiledMatcher } from './compileMatcher'
 export { default as replace, ReplaceOptions } from './replace'
@@ -13,11 +20,6 @@ export { default as getBabelBackend } from './babel/getBabelBackend'
 export { default as BabelBackend } from './babel/BabelBackend'
 export { default as getRecastBackend } from './recast/getRecastBackend'
 export { default as RecastBackend } from './recast/RecastBackend'
-export { default as runTransform } from './runTransform'
-export {
-  default as runTransformOnFile,
-  Transform,
-  TransformResult,
-} from './runTransformOnFile'
 export { default as CodeFrameError } from './util/CodeFrameError'
 export { default as CompilePathError } from './util/CompilePathError'
+export { AstxConfig } from './AstxConfig'

src/index.ts

@@ -0,0 +1,5 @@
+/* eslint-env commonjs */
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+require('@babel/register')({ extensions: ['.ts'] })
+require('./AstxWorker.ts').workerProcess()