chore: adding special steps for specific add-ons

Author: jherr

frameworks/react-cra/add-ons/start/info.json

@@ -26,5 +26,6 @@
     "./index.html",
     "./src/main.tsx",
     "./src/App.css"
-  ]
+  ],
+  "addOnSpecialSteps": ["rimraf-node-modules"]
 }

packages/cta-engine/package.json

@@ -36,6 +36,7 @@
     "memfs": "^4.17.0",
     "parse-gitignore": "^2.0.0",
     "prettier": "^3.5.0",
+    "rimraf": "^6.0.1",
     "zod": "^3.24.2"
   },
   "devDependencies": {

packages/cta-engine/src/add-to-app.ts

@@ -16,6 +16,7 @@ import {
   recursivelyGatherFilesFromEnvironment,
 } from './file-helpers.js'
 import { mergePackageJSON } from './package-json.js'
+import { runSpecialSteps } from './special-steps/index.js'
 
 import type { Environment, Mode, Options } from './types.js'
 import type { PersistedOptions } from './config-file.js'
@@ -226,6 +227,20 @@ export async function addToApp(
     'Application files written',
   )
 
+  // Run any special steps for the new add-ons
+
+  const specialSteps = new Set<string>([])
+  for (const addOn of newOptions.chosenAddOns) {
+    for (const step of addOn.addOnSpecialSteps || []) {
+      if (addOns.includes(addOn.id)) {
+        specialSteps.add(step)
+      }
+    }
+  }
+  if (specialSteps.size) {
+    await runSpecialSteps(environment, newOptions, Array.from(specialSteps))
+  }
+
   // Install dependencies
 
   environment.startStep({

packages/cta-engine/src/create-app.ts

@@ -11,6 +11,7 @@ import { createPackageJSON } from './package-json.js'
 import { createTemplateFile } from './template-file.js'
 import { installShadcnComponents } from './integrations/shadcn.js'
 import { setupGit } from './integrations/git.js'
+import { runSpecialSteps } from './special-steps/index.js'
 
 import type { Environment, FileBundleHandler, Options } from './types.js'
 
@@ -120,6 +121,17 @@ async function runCommandsAndInstallDependencies(
     s.stop(`Initialized git repository`)
   }
 
+  // Run any special steps for the new add-ons
+  const specialSteps = new Set<string>([])
+  for (const addOn of options.chosenAddOns) {
+    for (const step of addOn.createSpecialSteps || []) {
+      specialSteps.add(step)
+    }
+  }
+  if (specialSteps.size) {
+    await runSpecialSteps(environment, options, Array.from(specialSteps))
+  }
+
   // Install dependencies
   s.start(`Installing dependencies via ${options.packageManager}...`)
   environment.startStep({

packages/cta-engine/src/environment.ts

@@ -11,6 +11,7 @@ import { existsSync, statSync } from 'node:fs'
 import { dirname } from 'node:path'
 import { execa } from 'execa'
 import { memfs } from 'memfs'
+import { rimraf } from 'rimraf'
 
 import {
   cleanUpFileArray,
@@ -51,7 +52,7 @@ export function createDefaultEnvironment(): Environment {
           cwd,
         })
         return { stdout: result.stdout }
-      } catch (e) {
+      } catch {
         errors.push(
           `Command "${command} ${args.join(' ')}" did not run successfully. Please run this manually in your project.`,
         )
@@ -70,6 +71,9 @@ export function createDefaultEnvironment(): Environment {
     exists: (path: string) => existsSync(path),
     isDirectory: (path: string) => statSync(path).isDirectory(),
     readdir: async (path: string) => readdir(path),
+    rimraf: async (path: string) => {
+      await rimraf(path)
+    },
 
     appName: 'TanStack',
 
@@ -175,6 +179,7 @@ export function createMemoryEnvironment(returnPathsRelativeTo: string = '') {
   environment.readdir = async (path: string) => {
     return Promise.resolve(fs.readdirSync(path).map((d) => d.toString()))
   }
+  environment.rimraf = async () => {}
 
   return {
     environment,

packages/cta-engine/src/special-steps/index.ts

@@ -0,0 +1,36 @@
+import { rimrafNodeModules } from './rimraf-node-modules.js'
+
+import type { Environment, Options } from '../types.js'
+
+const specialStepsLookup: Record<
+  string,
+  (environment: Environment, options: Options) => Promise<void>
+> = {
+  'rimraf-node-modules': rimrafNodeModules,
+}
+
+export async function runSpecialSteps(
+  environment: Environment,
+  options: Options,
+  specialSteps: Array<string>,
+) {
+  if (specialSteps.length) {
+    environment.startStep({
+      id: 'special-steps',
+      type: 'command',
+      message: 'Removing node_modules...',
+    })
+
+    for (const step of specialSteps) {
+      const stepFunction = specialStepsLookup[step]
+      /* eslint-disable @typescript-eslint/no-unnecessary-condition */
+      if (stepFunction) {
+        await stepFunction(environment, options)
+      } else {
+        environment.error(`Special step ${step} not found`)
+      }
+    }
+
+    environment.finishStep('special-steps', 'Special steps complete')
+  }
+}

packages/cta-engine/src/special-steps/rimraf-node-modules.ts

@@ -0,0 +1,25 @@
+import { resolve } from 'node:path'
+
+import type { Environment, Options } from '../types.js'
+
+const lockFiles = ['package-lock.json', 'yarn.lock', 'pnpm-lock.yaml']
+
+export async function rimrafNodeModules(
+  environment: Environment,
+  options: Options,
+) {
+  environment.startStep({
+    id: 'special-steps',
+    type: 'command',
+    message: 'Removing node_modules...',
+  })
+
+  await environment.rimraf(resolve(options.targetDir, 'node_modules'))
+
+  for (const lockFile of lockFiles) {
+    const lockFilePath = resolve(options.targetDir, lockFile)
+    if (environment.exists(lockFilePath)) {
+      await environment.deleteFile(lockFilePath)
+    }
+  }
+}

packages/cta-engine/src/types.ts

@@ -49,6 +49,8 @@ export const AddOnBaseSchema = z.object({
   dependsOn: z.array(z.string()).optional(),
   smallLogo: z.string().optional(),
   logo: z.string().optional(),
+  addOnSpecialSteps: z.array(z.string()).optional(),
+  createSpecialSteps: z.array(z.string()).optional(),
 })
 
 export const StarterSchema = AddOnBaseSchema.extend({
@@ -171,6 +173,7 @@ type FileEnvironment = {
   isDirectory: (path: string) => boolean
   readFile: (path: string) => Promise<string>
   readdir: (path: string) => Promise<Array<string>>
+  rimraf: (path: string) => Promise<void>
 }
 
 export type StatusEvent = {