@tanstack/cta-engine 0.14.3 → 0.15.0

package/src/integrations/shadcn.ts

@@ -0,0 +1,54 @@
+import { resolve } from 'node:path'
+import { packageManagerExecute } from '../package-manager.js'
+import type { Environment, Options } from '../types.js'
+
+export async function installShadcnComponents(
+  environment: Environment,
+  targetDir: string,
+  options: Options,
+) {
+  const s = environment.spinner()
+
+  if (options.chosenAddOns.find((a) => a.id === 'shadcn')) {
+    const shadcnComponents = new Set<string>()
+    for (const addOn of options.chosenAddOns) {
+      if (addOn.shadcnComponents) {
+        for (const component of addOn.shadcnComponents) {
+          shadcnComponents.add(component)
+        }
+      }
+    }
+    if (options.starter) {
+      if (options.starter.shadcnComponents) {
+        for (const component of options.starter.shadcnComponents) {
+          shadcnComponents.add(component)
+        }
+      }
+    }
+
+    if (shadcnComponents.size > 0) {
+      s.start(
+        `Installing shadcn components (${Array.from(shadcnComponents).join(', ')})...`,
+      )
+      environment.startStep({
+        id: 'install-shadcn-components',
+        type: 'command',
+        message: `Installing shadcn components (${Array.from(shadcnComponents).join(', ')})...`,
+      })
+
+      await packageManagerExecute(
+        environment,
+        resolve(targetDir),
+        options.packageManager,
+        'shadcn@latest',
+        ['add', '--silent', '--yes', ...Array.from(shadcnComponents)],
+      )
+
+      environment.finishStep(
+        'install-shadcn-components',
+        'Shadcn components installed',
+      )
+      s.stop(`Installed additional shadcn components`)
+    }
+  }
+}

package/src/options.ts

@@ -1,412 +1,11 @@
-import {
-  cancel,
-  confirm,
-  isCancel,
-  multiselect,
-  select,
-  text,
-} from '@clack/prompts'
+import type { Options, SerializedOptions } from './types'
 
-import {
-  DEFAULT_PACKAGE_MANAGER,
-  SUPPORTED_PACKAGE_MANAGERS,
-  getPackageManager,
-} from './package-manager.js'
-import { DEFAULT_TOOLCHAIN, SUPPORTED_TOOLCHAINS } from './toolchain.js'
-import { CODE_ROUTER, DEFAULT_FRAMEWORK, FILE_ROUTER } from './constants.js'
-import { finalizeAddOns, getAllAddOns, loadRemoteAddOn } from './add-ons.js'
-
-import type {
-  AddOn,
-  CliOptions,
-  Mode,
-  Options,
-  Overlay,
-  TemplateOptions,
-  Variable,
-} from './types.js'
-
-// If all CLI options are provided, use them directly
-export async function normalizeOptions(
-  cliOptions: CliOptions,
-  forcedMode?: Mode,
-  forcedAddOns?: Array<string>,
-): Promise<Options | undefined> {
-  // in some cases, if you use windows/powershell, the argument for addons
-  // if sepparated by comma is not really passed as an array, but as a string
-  // with spaces, We need to normalize this edge case.
-  if (Array.isArray(cliOptions.addOns) && cliOptions.addOns.length === 1) {
-    const parseSeparatedArgs = cliOptions.addOns[0].split(' ')
-    if (parseSeparatedArgs.length > 1) {
-      cliOptions.addOns = parseSeparatedArgs
-    }
-  }
-
-  if (cliOptions.projectName) {
-    let typescript =
-      cliOptions.template === 'typescript' ||
-      cliOptions.template === 'file-router' ||
-      cliOptions.framework === 'solid'
-
-    let tailwind = !!cliOptions.tailwind
-    if (cliOptions.framework === 'solid') {
-      tailwind = true
-    }
-
-    let mode: typeof FILE_ROUTER | typeof CODE_ROUTER =
-      cliOptions.template === 'file-router' ? FILE_ROUTER : CODE_ROUTER
-
-    const overlay = cliOptions.overlay
-      ? ((await loadRemoteAddOn(cliOptions.overlay)) as Overlay)
-      : undefined
-
-    if (overlay) {
-      tailwind = overlay.tailwind
-      typescript = overlay.typescript
-      cliOptions.framework = overlay.framework
-      mode = overlay.mode
-    }
-
-    let addOns = false
-    let chosenAddOns: Array<AddOn> = []
-    if (
-      Array.isArray(cliOptions.addOns) ||
-      overlay?.dependsOn ||
-      forcedAddOns
-    ) {
-      addOns = true
-      let finalAddOns = Array.from(
-        new Set([...(overlay?.dependsOn || []), ...(forcedAddOns || [])]),
-      )
-      if (cliOptions.addOns && Array.isArray(cliOptions.addOns)) {
-        finalAddOns = Array.from(
-          new Set([
-            ...(forcedAddOns || []),
-            ...finalAddOns,
-            ...cliOptions.addOns,
-          ]),
-        )
-      }
-      chosenAddOns = await finalizeAddOns(
-        cliOptions.framework || DEFAULT_FRAMEWORK,
-        forcedMode || cliOptions.template === 'file-router'
-          ? FILE_ROUTER
-          : CODE_ROUTER,
-        finalAddOns,
-      )
-      tailwind = true
-      typescript = true
-    }
-
-    return {
-      framework: cliOptions.framework || 'react',
-      projectName: cliOptions.projectName,
-      typescript,
-      tailwind,
-      packageManager:
-        cliOptions.packageManager ||
-        getPackageManager() ||
-        DEFAULT_PACKAGE_MANAGER,
-      toolchain: cliOptions.toolchain || DEFAULT_TOOLCHAIN,
-      mode,
-      git: !!cliOptions.git,
-      addOns,
-      chosenAddOns,
-      variableValues: {},
-      overlay,
-    }
-  }
-}
-
-async function collectVariables(
-  variables: Array<Variable>,
-): Promise<Record<string, string | number | boolean>> {
-  const responses: Record<string, string | number | boolean> = {}
-  for (const variable of variables) {
-    if (variable.type === 'string') {
-      const response = await text({
-        message: variable.description,
-        initialValue: variable.default,
-      })
-      if (isCancel(response)) {
-        cancel('Operation cancelled.')
-        process.exit(0)
-      }
-      responses[variable.name] = response
-    } else if (variable.type === 'number') {
-      const response = await text({
-        message: variable.description,
-        initialValue: variable.default.toString(),
-      })
-      if (isCancel(response)) {
-        cancel('Operation cancelled.')
-        process.exit(0)
-      }
-      responses[variable.name] = Number(response)
-    } else {
-      const response = await confirm({
-        message: variable.description,
-        initialValue: variable.default === true,
-      })
-      if (isCancel(response)) {
-        cancel('Operation cancelled.')
-        process.exit(0)
-      }
-      responses[variable.name] = response
-    }
-  }
-  return responses
-}
-
-export async function promptForOptions(
-  cliOptions: CliOptions,
-  {
-    forcedAddOns = [],
-    forcedMode,
-  }: {
-    forcedAddOns?: Array<string>
-    forcedMode?: TemplateOptions
-  },
-): Promise<Required<Options> | undefined> {
-  const options = {} as Required<Options>
-
-  options.framework = cliOptions.framework || DEFAULT_FRAMEWORK
-  if (options.framework === 'solid') {
-    options.typescript = true
-    options.tailwind = true
-  }
-
-  if (cliOptions.addOns) {
-    options.typescript = true
-  }
-
-  if (!cliOptions.projectName) {
-    const value = await text({
-      message: 'What would you like to name your project?',
-      defaultValue: 'my-app',
-      validate(value) {
-        if (!value) {
-          return 'Please enter a name'
-        }
-      },
-    })
-    if (isCancel(value)) {
-      cancel('Operation cancelled.')
-      process.exit(0)
-    }
-    options.projectName = value
-  } else {
-    options.projectName = cliOptions.projectName
+export const createSerializedOptions = (options: Options) => {
+  const serializedOptions: SerializedOptions = {
+    ...options,
+    chosenAddOns: options.chosenAddOns.map((addOn) => addOn.id),
+    framework: options.framework.id,
+    starter: options.starter?.id,
   }
-
-  // Router type selection
-  if (!cliOptions.template && !forcedMode) {
-    const routerType = await select({
-      message: 'Select the router type:',
-      options: [
-        {
-          value: FILE_ROUTER,
-          label: 'File Router - File-based routing structure',
-        },
-        {
-          value: CODE_ROUTER,
-          label: 'Code Router - Traditional code-based routing',
-        },
-      ],
-      initialValue: FILE_ROUTER,
-    })
-    if (isCancel(routerType)) {
-      cancel('Operation cancelled.')
-      process.exit(0)
-    }
-    options.mode = routerType as typeof CODE_ROUTER | typeof FILE_ROUTER
-  } else if (forcedMode) {
-    options.mode = forcedMode === 'file-router' ? FILE_ROUTER : CODE_ROUTER
-    options.typescript = options.mode === FILE_ROUTER
-  } else {
-    options.mode =
-      cliOptions.template === 'file-router' ? FILE_ROUTER : CODE_ROUTER
-    if (options.mode === FILE_ROUTER) {
-      options.typescript = true
-    }
-  }
-
-  // TypeScript selection (if using Code Router)
-  if (!options.typescript) {
-    if (options.mode === CODE_ROUTER) {
-      const typescriptEnable = await confirm({
-        message: 'Would you like to use TypeScript?',
-        initialValue: true,
-      })
-      if (isCancel(typescriptEnable)) {
-        cancel('Operation cancelled.')
-        process.exit(0)
-      }
-      options.typescript = typescriptEnable
-    } else {
-      options.typescript = true
-    }
-  }
-
-  // Tailwind selection
-  if (!cliOptions.tailwind && options.framework === 'react') {
-    const tailwind = await confirm({
-      message: 'Would you like to use Tailwind CSS?',
-      initialValue: true,
-    })
-    if (isCancel(tailwind)) {
-      cancel('Operation cancelled.')
-      process.exit(0)
-    }
-    options.tailwind = tailwind
-  } else {
-    options.tailwind = options.framework === 'solid' || !!cliOptions.tailwind
-  }
-
-  // Package manager selection
-  if (cliOptions.packageManager === undefined) {
-    const detectedPackageManager = getPackageManager()
-    if (!detectedPackageManager) {
-      const pm = await select({
-        message: 'Select package manager:',
-        options: SUPPORTED_PACKAGE_MANAGERS.map((pm) => ({
-          value: pm,
-          label: pm,
-        })),
-        initialValue: DEFAULT_PACKAGE_MANAGER,
-      })
-      if (isCancel(pm)) {
-        cancel('Operation cancelled.')
-        process.exit(0)
-      }
-      options.packageManager = pm
-    } else {
-      options.packageManager = detectedPackageManager
-    }
-  } else {
-    options.packageManager = cliOptions.packageManager
-  }
-
-  // Toolchain selection
-  if (cliOptions.toolchain === undefined) {
-    const tc = await select({
-      message: 'Select toolchain',
-      options: SUPPORTED_TOOLCHAINS.map((tc) => ({
-        value: tc,
-        label: tc,
-      })),
-      initialValue: DEFAULT_TOOLCHAIN,
-    })
-    if (isCancel(tc)) {
-      cancel('Operation cancelled.')
-      process.exit(0)
-    }
-    options.toolchain = tc
-  } else {
-    options.toolchain = cliOptions.toolchain
-  }
-
-  options.chosenAddOns = []
-  if (Array.isArray(cliOptions.addOns)) {
-    options.chosenAddOns = await finalizeAddOns(
-      options.framework,
-      options.mode,
-      Array.from(new Set([...cliOptions.addOns, ...forcedAddOns])),
-    )
-    options.tailwind = true
-  } else if (cliOptions.addOns) {
-    // Select any add-ons
-    const allAddOns = await getAllAddOns(options.framework, options.mode)
-    const addOns = allAddOns.filter((addOn) => addOn.type === 'add-on')
-    let selectedAddOns: Array<string> = []
-    if (options.typescript && addOns.length > 0) {
-      const value = await multiselect({
-        message: 'What add-ons would you like for your project:',
-        options: addOns
-          .filter((addOn) => !forcedAddOns.includes(addOn.id))
-          .map((addOn) => ({
-            value: addOn.id,
-            label: addOn.name,
-            hint: addOn.description,
-          })),
-        required: false,
-      })
-
-      if (isCancel(value)) {
-        cancel('Operation cancelled.')
-        process.exit(0)
-      }
-      selectedAddOns = value
-    }
-
-    // Select any examples
-    let selectedExamples: Array<string> = []
-    const examples = allAddOns.filter((addOn) => addOn.type === 'example')
-    if (options.typescript && examples.length > 0) {
-      const value = await multiselect({
-        message: 'Would you like any examples?',
-        options: examples
-          .filter((addOn) => !forcedAddOns.includes(addOn.id))
-          .map((addOn) => ({
-            value: addOn.id,
-            label: addOn.name,
-            hint: addOn.description,
-          })),
-        required: false,
-      })
-
-      if (isCancel(value)) {
-        cancel('Operation cancelled.')
-        process.exit(0)
-      }
-      selectedExamples = value
-    }
-
-    if (
-      selectedAddOns.length > 0 ||
-      selectedExamples.length > 0 ||
-      forcedAddOns.length > 0
-    ) {
-      options.chosenAddOns = await finalizeAddOns(
-        options.framework,
-        options.mode,
-        Array.from(
-          new Set([...selectedAddOns, ...selectedExamples, ...forcedAddOns]),
-        ),
-      )
-      options.tailwind = true
-    }
-  } else if (forcedAddOns.length > 0) {
-    options.chosenAddOns = await finalizeAddOns(
-      options.framework,
-      options.mode,
-      forcedAddOns,
-    )
-  }
-
-  // Collect variables
-  const variables: Array<Variable> = []
-  for (const addOn of options.chosenAddOns) {
-    for (const variable of addOn.variables ?? []) {
-      variables.push(variable)
-    }
-  }
-  options.variableValues = await collectVariables(variables)
-
-  // Git selection
-  if (cliOptions.git === undefined) {
-    const git = await confirm({
-      message: 'Would you like to initialize a new git repository?',
-      initialValue: true,
-    })
-    if (isCancel(git)) {
-      cancel('Operation cancelled.')
-      process.exit(0)
-    }
-    options.git = git
-  } else {
-    options.git = !!cliOptions.git
-  }
-
-  return options
+  return serializedOptions
 }

package/src/package-json.ts

@@ -0,0 +1,69 @@
+import { FILE_ROUTER } from './constants.js'
+import { sortObject } from './utils.js'
+
+import type { Options } from './types.js'
+
+export function mergePackageJSON(
+  packageJSON: Record<string, any>,
+  overlayPackageJSON?: Record<string, any>,
+) {
+  return {
+    ...packageJSON,
+    dependencies: {
+      ...packageJSON.dependencies,
+      ...(overlayPackageJSON?.dependencies || {}),
+    },
+    devDependencies: {
+      ...packageJSON.devDependencies,
+      ...(overlayPackageJSON?.devDependencies || {}),
+    },
+    scripts: {
+      ...packageJSON.scripts,
+      ...(overlayPackageJSON?.scripts || {}),
+    },
+  }
+}
+
+export function createPackageJSON(options: Options) {
+  let packageJSON = {
+    ...JSON.parse(JSON.stringify(options.framework.basePackageJSON)),
+    name: options.projectName,
+  }
+
+  const additions: Array<Record<string, any> | undefined> = [
+    options.typescript
+      ? options.framework.optionalPackages.typescript
+      : undefined,
+    options.tailwind
+      ? options.framework.optionalPackages.tailwindcss
+      : undefined,
+    options.mode === FILE_ROUTER
+      ? options.framework.optionalPackages['file-router']
+      : undefined,
+  ]
+  for (const addition of additions.filter(Boolean)) {
+    packageJSON = mergePackageJSON(packageJSON, addition)
+  }
+
+  for (const addOn of options.chosenAddOns.map(
+    (addOn) => addOn.packageAdditions,
+  )) {
+    packageJSON = mergePackageJSON(packageJSON, addOn)
+  }
+
+  if (options.starter) {
+    packageJSON = mergePackageJSON(
+      packageJSON,
+      options.starter.packageAdditions,
+    )
+  }
+
+  packageJSON.dependencies = sortObject(
+    (packageJSON.dependencies ?? {}) as Record<string, string>,
+  )
+  packageJSON.devDependencies = sortObject(
+    (packageJSON.devDependencies ?? {}) as Record<string, string>,
+  )
+
+  return packageJSON
+}

package/src/package-manager.ts

@@ -24,23 +24,94 @@ export function getPackageManager(): PackageManager | undefined {
   return packageManager
 }
 
-export function packageManagerExecute(
-  environment: Environment,
+export function getPackageManagerScriptCommand(
+  packagerManager: PackageManager,
+  args: Array<string> = [],
+) {
+  switch (packagerManager) {
+    case 'yarn':
+      return { command: 'yarn', args: ['run', ...args] }
+    case 'pnpm':
+      return { command: 'pnpm', args: [...args] }
+    case 'bun':
+      return { command: 'bunx', args: ['--bun', 'run', ...args] }
+    case 'deno':
+      return { command: 'deno', args: ['task', ...args] }
+    default:
+      return { command: 'npm', args: ['run', ...args] }
+  }
+}
+
+export function getPackageManagerExecuteCommand(
   packagerManager: PackageManager,
   pkg: string,
-  args: Array<string>,
-  cwd: string,
+  args: Array<string> = [],
 ) {
   switch (packagerManager) {
     case 'yarn':
-      return environment.execute('yarn', ['dlx', pkg, ...args], cwd)
+      return { command: 'yarn', args: ['dlx', pkg, ...args] }
     case 'pnpm':
-      return environment.execute('pnpx', [pkg, ...args], cwd)
+      return { command: 'pnpx', args: [pkg, ...args] }
     case 'bun':
-      return environment.execute('bunx', ['--bun', pkg, ...args], cwd)
+      return { command: 'bunx', args: ['--bun', pkg, ...args] }
     case 'deno':
-      return environment.execute('deno', ['run', `npm:${pkg}`, ...args], cwd)
+      return { command: 'deno', args: ['run', `npm:${pkg}`, ...args] }
     default:
-      return environment.execute('npx', [pkg, ...args], cwd)
+      return { command: 'npx', args: [pkg, ...args] }
   }
 }
+
+export function getPackageManagerInstallCommand(
+  packagerManager: PackageManager,
+  pkg?: string,
+  isDev: boolean = false,
+) {
+  if (pkg) {
+    switch (packagerManager) {
+      case 'yarn':
+      case 'pnpm':
+        return {
+          command: packagerManager,
+          args: ['add', pkg, isDev ? '--dev' : ''],
+        }
+      default:
+        return {
+          command: packagerManager,
+          args: ['install', pkg, isDev ? '-D' : ''],
+        }
+    }
+  } else {
+    return {
+      command: packagerManager,
+      args: ['install'],
+    }
+  }
+}
+
+export function packageManagerInstall(
+  environment: Environment,
+  cwd: string,
+  packagerManager: PackageManager,
+  pkg?: string,
+) {
+  const { command, args: commandArgs } = getPackageManagerInstallCommand(
+    packagerManager,
+    pkg,
+  )
+  return environment.execute(command, commandArgs, cwd)
+}
+
+export function packageManagerExecute(
+  environment: Environment,
+  cwd: string,
+  packagerManager: PackageManager,
+  pkg: string,
+  args: Array<string>,
+) {
+  const { command, args: commandArgs } = getPackageManagerExecuteCommand(
+    packagerManager,
+    pkg,
+    args,
+  )
+  return environment.execute(command, commandArgs, cwd)
+}