Skip to content
Source
Sign inSign up
TanStack/cli
Open History to see the last commit

options.ts

224 lines5.4 KB

1import { intro } from '@clack/prompts'
2​
3import {
4 finalizeAddOns,
5 getFrameworkById,
6 getPackageManager,
7 populateAddOnOptionsDefaults,
8 readConfigFile,
9} from '@tanstack/cta-engine'
10​
11import {
12 getProjectName,
13 promptForAddOnOptions,
14 selectAddOns,
15 selectGit,
16 selectDeployment,
17 selectPackageManager,
18 selectRouterType,
19 selectTailwind,
20 selectToolchain,
21 selectTypescript,
22} from './ui-prompts.js'
23​
24import {
25 getCurrentDirectoryName,
26 sanitizePackageName,
27 validateProjectName,
28} from './utils.js'
29import type { Options } from '@tanstack/cta-engine'
30​
31import type { CliOptions } from './types.js'
32​
33export async function promptForCreateOptions(
34 cliOptions: CliOptions,
35 {
36 forcedAddOns = [],
37 forcedMode,
38 showDeploymentOptions = false,
39 }: {
40 forcedAddOns?: Array<string>
41 forcedMode?: string
42 showDeploymentOptions?: boolean
43 },
44): Promise<Required<Options> | undefined> {
45 const options = {} as Required<Options>
46​
47 options.framework = getFrameworkById(cliOptions.framework || 'react-cra')!
48​
49 if (cliOptions.projectName) {
50 // Handle "." as project name - use sanitized current directory name
51 if (cliOptions.projectName === '.') {
52 options.projectName = sanitizePackageName(getCurrentDirectoryName())
53 } else {
54 options.projectName = cliOptions.projectName
55 }
56 const { valid, error } = validateProjectName(options.projectName)
57 if (!valid) {
58 console.error(error)
59 process.exit(1)
60 }
61 } else {
62 options.projectName = await getProjectName()
63 }
64​
65 // Router type selection
66 if (forcedMode) {
67 options.mode = forcedMode
68 } else if (cliOptions.template) {
69 options.mode =
70 cliOptions.template === 'file-router' ? 'file-router' : 'code-router'
71 } else {
72 options.mode = await selectRouterType()
73 }
74​
75 // TypeScript selection (if using Code Router)
76 // TODO: Make this declarative
77 options.typescript =
78 options.mode === 'file-router' || options.framework.id === 'solid'
79 if (
80 forcedMode &&
81 options.framework.supportedModes[forcedMode].forceTypescript
82 ) {
83 options.typescript = true
84 }
85 if (!options.typescript && options.mode === 'code-router') {
86 options.typescript = await selectTypescript()
87 }
88​
89 // Tailwind selection
90 if (!cliOptions.tailwind && options.framework.id === 'react-cra') {
91 options.tailwind = await selectTailwind()
92 } else {
93 options.tailwind = true
94 }
95​
96 // Package manager selection
97 if (cliOptions.packageManager) {
98 options.packageManager = cliOptions.packageManager
99 } else {
100 const detectedPackageManager = await getPackageManager()
101 options.packageManager =
102 detectedPackageManager || (await selectPackageManager())
103 }
104​
105 // Toolchain selection
106 const toolchain = await selectToolchain(
107 options.framework,
108 cliOptions.toolchain,
109 )
110​
111 // Deployment selection
112 const deployment = showDeploymentOptions
113 ? await selectDeployment(options.framework, cliOptions.deployment)
114 : undefined
115​
116 // Add-ons selection
117 const addOns: Set<string> = new Set()
118​
119 if (toolchain) {
120 addOns.add(toolchain)
121 }
122 if (deployment) {
123 addOns.add(deployment)
124 }
125​
126 for (const addOn of forcedAddOns) {
127 addOns.add(addOn)
128 }
129​
130 if (Array.isArray(cliOptions.addOns)) {
131 for (const addOn of cliOptions.addOns) {
132 addOns.add(addOn)
133 }
134 } else {
135 for (const addOn of await selectAddOns(
136 options.framework,
137 options.mode,
138 'add-on',
139 'What add-ons would you like for your project?',
140 forcedAddOns,
141 )) {
142 addOns.add(addOn)
143 }
144​
145 for (const addOn of await selectAddOns(
146 options.framework,
147 options.mode,
148 'example',
149 'Would you like any examples?',
150 forcedAddOns,
151 )) {
152 addOns.add(addOn)
153 }
154 }
155​
156 options.chosenAddOns = Array.from(
157 await finalizeAddOns(options.framework, options.mode, Array.from(addOns)),
158 )
159​
160 if (options.chosenAddOns.length) {
161 options.tailwind = true
162 options.typescript = true
163 }
164​
165 // Prompt for add-on options in interactive mode
166 if (Array.isArray(cliOptions.addOns)) {
167 // Non-interactive mode: use defaults
168 options.addOnOptions = populateAddOnOptionsDefaults(options.chosenAddOns)
169 } else {
170 // Interactive mode: prompt for options
171 const userOptions = await promptForAddOnOptions(
172 options.chosenAddOns.map((a) => a.id),
173 options.framework,
174 )
175 const defaultOptions = populateAddOnOptionsDefaults(options.chosenAddOns)
176 // Merge user options with defaults
177 options.addOnOptions = { ...defaultOptions, ...userOptions }
178 }
179 options.git = cliOptions.git || (await selectGit())
180​
181 return options
183​
184export async function promptForAddOns(): Promise<Array<string>> {
185 const config = await readConfigFile(process.cwd())
186​
187 if (!config) {
188 console.error('No config file found')
189 process.exit(1)
190 }
191​
192 const framework = getFrameworkById(config.framework)
193​
194 if (!framework) {
195 console.error(`Unknown framework: ${config.framework}`)
196 process.exit(1)
197 }
198​
199 intro(`Adding new add-ons to '${config.projectName}'`)
200​
201 const addOns: Set<string> = new Set()
202​
203 for (const addOn of await selectAddOns(
204 framework,
205 config.mode!,
206 'add-on',
207 'What add-ons would you like for your project?',
208 config.chosenAddOns,
209 )) {
210 addOns.add(addOn)
211 }
212​
213 for (const addOn of await selectAddOns(
214 framework,
215 config.mode!,
216 'example',
217 'Would you like any examples?',
218 config.chosenAddOns,
219 )) {
220 addOns.add(addOn)
221 }
222​
223 return Array.from(addOns)