feat: transform command (#7)

* initial draft

* Merge branch 'main' into transform-command

* somoe changes

* add logic files

* write new content

* remove --print

* remove  allowUnknownOption

Author: bjohansebas

commands/transform.ts

@@ -0,0 +1,68 @@
+import { writeFile } from 'node:fs/promises'
+import { bold } from 'picocolors'
+import prompts from 'prompts'
+import { TRANSFORM_OPTIONS } from '../config'
+import { getAllFiles, getContent } from '../utils/file'
+
+export function onCancel() {
+  process.exit(1)
+}
+
+// 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
+
+  let existCodemod = TRANSFORM_OPTIONS.find(({ value }) => value === codemodSelected)
+
+  if (!codemodSelected || (codemodSelected && !existCodemod)) {
+    const res = await prompts(
+      {
+        type: 'select',
+        name: 'transformer',
+        message: 'Which codemod would you like to apply?',
+        choices: TRANSFORM_OPTIONS.map(({ description, value, version }) => {
+          return {
+            title: `(${bold(`v${version}`)}) ${value}`,
+            description,
+            value,
+          }
+        }),
+      },
+      { onCancel },
+    )
+
+    codemodSelected = res.transformer
+    existCodemod = TRANSFORM_OPTIONS.find(({ value }) => value === codemodSelected)
+  }
+
+  if (!sourceSelected) {
+    const res = await prompts(
+      {
+        type: 'text',
+        name: 'path',
+        message: 'Which files or directories should the codemods be applied to?',
+        initial: '.',
+      },
+      { onCancel },
+    )
+
+    sourceSelected = res.path
+  }
+
+  const files = await getAllFiles(sourceSelected)
+
+  for (const file of files) {
+    const content = await getContent(file)
+
+    if (existCodemod) {
+      const newContent = existCodemod.codemod({ path: file.toString(), source: content }, options)
+
+      if (!dry) {
+        await writeFile(file.toString(), newContent)
+      }
+    }
+  }
+}

config.ts

@@ -0,0 +1,18 @@
+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,10 +1,19 @@
 #!/usr/bin/env node
 
 import { Command } from 'commander'
+import { transform } from './commands/transform'
 import packageJson from './package.json'
 
 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.')
-  .usage('[codemod] [source]')
+  .helpOption('-h, --help', 'Display this help message.')
+  .option('-d, --dry', 'Dry run (no changes are made to files)')
+  .usage('[codemod] [source] [options]')
+  .action(transform)
+  // Why this option is necessary is explained here: https://github.com/tj/commander.js/pull/1427
+  .enablePositionalOptions()
+
+program.parse(process.argv)

package.json

@@ -18,17 +18,21 @@
   },
   "dependencies": {
     "commander": "^12.1.0",
-    "jscodeshift": "^17.0.0"
+    "fast-glob": "^3.3.2",
+    "jscodeshift": "^17.0.0",
+    "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.1.6"
+    "typescript": "5.6.3"
   },
   "engines": {
     "node": ">=18"

utils/file.ts

@@ -0,0 +1,36 @@
+import type { PathLike } from 'node:fs'
+import { readFile, stat } from 'node:fs/promises'
+import { join, resolve } from 'node:path'
+import { async as glob } from 'fast-glob'
+
+export async function isDirectory(path: PathLike): Promise<boolean> {
+  try {
+    const metadata = await stat(path)
+    return metadata.isDirectory()
+  } catch (err) {
+    return false
+  }
+}
+
+export async function getAllFiles(path: PathLike, arrayOfFiles: PathLike[] = []): Promise<PathLike[]> {
+  if (await isDirectory(path)) {
+    const files = await glob('**/*.{js,ts}', {
+      cwd: path.toString(),
+      dot: true,
+      ignore: ['node_modules', 'dist', 'build'],
+      markDirectories: true,
+    })
+
+    for (const file of files) {
+      arrayOfFiles.push(resolve(join(path.toString(), file)))
+    }
+  } else {
+    arrayOfFiles.push(resolve(path.toString()))
+  }
+
+  return arrayOfFiles
+}
+
+export async function getContent(path: PathLike): Promise<string> {
+  return readFile(path, 'utf-8')
+}