Use jscodeshift executable (#14)

* use jscodeshift executable

* update execa

* fix code style

* remove unused code

* remove unnecesary concat

* remove export

Author: bjohansebas

.gitignore

@@ -21,4 +21,8 @@ yarn-error.log*
 
 # Misc
 .DS_Store
-*.pem
+*.pem
+
+*.d.ts
+*.js
+*.js.map

commands/transform.ts

@@ -1,19 +1,23 @@
-import { writeFile } from 'node:fs/promises'
-import { bold } from 'picocolors'
+import { join } from 'node:path'
+import execa from 'execa'
+import { bold, green } from 'picocolors'
 import prompts from 'prompts'
 import { TRANSFORM_OPTIONS } from '../config'
-import { getAllFiles, getContent } from '../utils/file'
+import { getAllFiles } from '../utils/file'
 
 export function onCancel() {
   process.exit(1)
 }
 
+const jscodeshiftExecutable = require.resolve('.bin/jscodeshift')
+const transformerDirectory = join(__dirname, '../', 'transforms')
+
 // biome-ignore lint/suspicious/noExplicitAny: 'Any' is used because options can be anything.
 export async function transform(codemodName: string, source: string, options: any): Promise<void> {
   let codemodSelected = codemodName
   let sourceSelected = source
 
-  const { dry } = options
+  const { dry, print, verbose } = options
 
   let existCodemod = TRANSFORM_OPTIONS.find(({ value }) => value === codemodSelected)
 
@@ -52,17 +56,37 @@ export async function transform(codemodName: string, source: string, options: an
     sourceSelected = res.path
   }
 
-  const files = await getAllFiles(sourceSelected)
+  const transformerPath = join(transformerDirectory, `${codemodSelected}.js`)
+
+  const args: string[] = []
 
-  for (const file of files) {
-    const content = await getContent(file)
+  if (dry) {
+    args.push('--dry')
+  }
 
-    if (existCodemod) {
-      const newContent = existCodemod.codemod({ path: file.toString(), source: content }, options)
+  if (print) {
+    args.push('--print')
+  }
 
-      if (!dry) {
-        await writeFile(file.toString(), newContent)
-      }
-    }
+  if (verbose) {
+    args.push('--verbose=2')
   }
+
+  args.push('--no-babel')
+  args.push('--ignore-pattern=**/node_modules/**')
+  args.push('--extensions=cts,mts,ts,js,mjs,cjs')
+
+  const files = await getAllFiles(sourceSelected)
+
+  args.push('--transform', transformerPath, ...files.map((file) => file.toString()))
+
+  console.log(`Executing command: ${green('jscodeshift')} ${args.join(' ')}`)
+
+  const jscodeshiftProcess = execa(jscodeshiftExecutable, args, {
+    // include ANSI color codes
+    env: process.stdout.isTTY ? { FORCE_COLOR: 'true' } : {},
+  })
+
+  jscodeshiftProcess.stdout?.pipe(process.stdout)
+  jscodeshiftProcess.stderr?.pipe(process.stderr)
 }

config.ts

@@ -1,18 +1,13 @@
-import magicRedirect from './transforms/magic-redirect'
-import pluralizedMethods from './transforms/pluralized-methods'
-
 export const TRANSFORM_OPTIONS = [
   {
     description: 'Transform the deprecated magic string "back"',
     value: 'magic-redirect',
     version: '5.0.0',
-    codemod: magicRedirect,
   },
   {
     description: 'Transform the methods to their pluralized versions',
     value: 'pluralized-methods',
     version: '5.0.0',
-    codemod: pluralizedMethods,
   },
   //{ description: 'Transform the deprecated signatures in Express v4', value: 'signature-deprecated', version: '5.0.0' },
 ]

index.ts

@@ -1,5 +1,8 @@
 #!/usr/bin/env node
 
+// Based on https://github.com/vercel/next.js/blob/26a2bab6fa0f0bdf9ff88f85d64342bb5a975658/packages/next-codemod/bin/next-codemod.ts
+// @expressjs/codemod optional-name-of-transform optional/path/ [...options]
+
 import { Command } from 'commander'
 import { transform } from './commands/transform'
 import packageJson from './package.json'
@@ -8,9 +11,11 @@ const program = new Command(packageJson.name)
   .version(packageJson.version, '-v, --version', `Output the current version of ${packageJson.name}.`)
   .description(packageJson.description)
   .argument('[codemod]', 'Codemod slug to run')
-  .argument('[source]', 'Path to source files or directory to transform including glob patterns.')
+  .argument('[source]', 'Path to source files or directory to transform.')
   .helpOption('-h, --help', 'Display this help message.')
   .option('-d, --dry', 'Dry run (no changes are made to files)')
+  .option('-p, --print', 'Print transformed files to stdout')
+  .option('--verbose', 'Show more information about the transform process')
   .usage('[codemod] [source] [options]')
   .action(transform)
   // Why this option is necessary is explained here: https://github.com/tj/commander.js/pull/1427

package.json

@@ -6,30 +6,30 @@
   "main": "index.js",
   "author": "Sebastian Beltran <[email protected]>",
   "license": "MIT",
-  "bin": "./dist/index.js",
-  "files": ["dist"],
+  "bin": "./index.js",
+  "files": ["transforms/*.js", "commands/*.js", "utils/*.js", "config.js", "index.js"],
   "scripts": {
-    "dev": "ncc build ./index.ts -w -o dist/",
-    "build": "ncc build ./index.ts -o ./dist/ --minify --no-cache --no-source-map-register",
+    "dev": "tsc -d -w -p tsconfig.json",
+    "build": "tsc -d -p tsconfig.json",
     "lint": "biome check",
     "lint:fix": "biome check --fix",
     "test": "jest",
     "test:ci": "jest --ci"
   },
   "dependencies": {
     "commander": "^12.1.0",
+    "execa": "^5.1.1",
     "fast-glob": "^3.3.2",
-    "jscodeshift": "^17.0.0",
-    "picocolors": "1.1.1",
-    "prompts": "2.4.2"
+    "jscodeshift": "^17.1.1",
+    "picocolors": "^1.1.1",
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
     "@types/jest": "29.5.14",
     "@types/jscodeshift": "^0.12.0",
     "@types/node": "^22.8.1",
     "@types/prompts": "2.4.9",
-    "@vercel/ncc": "0.38.2",
     "jest": "29.7.0",
     "ts-jest": "29.2.5",
     "typescript": "5.6.3"

utils/file.ts

@@ -1,5 +1,5 @@
 import type { PathLike } from 'node:fs'
-import { readFile, stat } from 'node:fs/promises'
+import { stat } from 'node:fs/promises'
 import { join, resolve } from 'node:path'
 import { async as glob } from 'fast-glob'
 
@@ -14,7 +14,7 @@ export async function isDirectory(path: PathLike): Promise<boolean> {
 
 export async function getAllFiles(path: PathLike, arrayOfFiles: PathLike[] = []): Promise<PathLike[]> {
   if (await isDirectory(path)) {
-    const files = await glob('**/*.{js,ts}', {
+    const files = await glob('**/*.{js,ts,cjs,mjs,cts,mts}', {
       cwd: path.toString(),
       dot: true,
       ignore: ['node_modules', 'dist', 'build'],
@@ -30,7 +30,3 @@ export async function getAllFiles(path: PathLike, arrayOfFiles: PathLike[] = [])
 
   return arrayOfFiles
 }
-
-export async function getContent(path: PathLike): Promise<string> {
-  return readFile(path, 'utf-8')
-}