-
-
Notifications
You must be signed in to change notification settings - Fork 168
Expand file tree
/
Copy pathcli.ts
More file actions
636 lines (583 loc) · 19.6 KB
/
cli.ts
File metadata and controls
636 lines (583 loc) · 19.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
import fs from 'node:fs'
import { resolve } from 'node:path'
import { Command, InvalidArgumentError } from 'commander'
import { intro, log } from '@clack/prompts'
import chalk from 'chalk'
import semver from 'semver'
import {
SUPPORTED_PACKAGE_MANAGERS,
addToApp,
compileAddOn,
compileStarter,
createApp,
createSerializedOptions,
getAllAddOns,
getFrameworkByName,
getFrameworks,
initAddOn,
initStarter,
} from '@tanstack/cta-engine'
import { launchUI } from '@tanstack/cta-ui'
import { runMCPServer } from './mcp.js'
import { promptForAddOns, promptForCreateOptions } from './options.js'
import { normalizeOptions, validateDevWatchOptions } from './command-line.js'
import { createUIEnvironment } from './ui-environment.js'
import { convertTemplateToMode } from './utils.js'
import { DevWatchManager } from './dev-watch.js'
import type { CliOptions, TemplateOptions } from './types.js'
import type {
FrameworkDefinition,
Options,
PackageManager,
} from '@tanstack/cta-engine'
// This CLI assumes that all of the registered frameworks have the same set of toolchains, deployments, modes, etc.
export function cli({
name,
appName,
forcedMode,
forcedAddOns = [],
defaultTemplate = 'javascript',
forcedDeployment,
defaultFramework,
craCompatible = false,
webBase,
frameworkDefinitionInitializers,
showDeploymentOptions = false,
}: {
name: string
appName: string
forcedMode?: string
forcedAddOns?: Array<string>
forcedDeployment?: string
defaultTemplate?: TemplateOptions
defaultFramework?: string
craCompatible?: boolean
webBase?: string
frameworkDefinitionInitializers?: Array<() => FrameworkDefinition>
showDeploymentOptions?: boolean
}) {
const environment = createUIEnvironment(appName, false)
const program = new Command()
const availableFrameworks = getFrameworks().map((f) => f.name)
const toolchains = new Set<string>()
for (const framework of getFrameworks()) {
for (const addOn of framework.getAddOns()) {
if (addOn.type === 'toolchain') {
toolchains.add(addOn.id)
}
}
}
const deployments = new Set<string>()
for (const framework of getFrameworks()) {
for (const addOn of framework.getAddOns()) {
if (addOn.type === 'deployment') {
deployments.add(addOn.id)
}
}
}
let defaultMode: string | undefined = forcedMode
const supportedModes = new Set<string>()
for (const framework of getFrameworks()) {
for (const mode of Object.keys(framework.supportedModes)) {
supportedModes.add(mode)
}
}
if (defaultMode && !supportedModes.has(defaultMode)) {
throw new InvalidArgumentError(
`Invalid mode: ${defaultMode}. The following are allowed: ${Array.from(
supportedModes,
).join(', ')}`,
)
}
if (supportedModes.size < 2) {
defaultMode = Array.from(supportedModes)[0]
}
program.name(name).description(`CLI to create a new ${appName} application`)
program
.command('pin-versions')
.description('Pin versions of the TanStack libraries')
.action(async () => {
if (!fs.existsSync('package.json')) {
console.error('package.json not found')
return
}
const packageJson = JSON.parse(fs.readFileSync('package.json', 'utf8'))
const packages: Record<string, string> = {
'@tanstack/react-router': '',
'@tanstack/router-generator': '',
'@tanstack/react-router-devtools': '',
'@tanstack/react-start': '',
'@tanstack/react-start-config': '',
'@tanstack/router-plugin': '',
'@tanstack/react-start-client': '',
'@tanstack/react-start-plugin': '1.115.0',
'@tanstack/react-start-server': '',
'@tanstack/start-server-core': '1.115.0',
}
function sortObject(obj: Record<string, string>): Record<string, string> {
return Object.keys(obj)
.sort()
.reduce<Record<string, string>>((acc, key) => {
acc[key] = obj[key]
return acc
}, {})
}
if (!packageJson.dependencies['@tanstack/react-start']) {
console.error('@tanstack/react-start not found in dependencies')
return
}
let changed = 0
const startVersion = packageJson.dependencies[
'@tanstack/react-start'
].replace(/^\^/, '')
for (const pkg of Object.keys(packages)) {
if (!packageJson.dependencies[pkg]) {
packageJson.dependencies[pkg] = packages[pkg].length
? semver.maxSatisfying(
[startVersion, packages[pkg]],
`^${packages[pkg]}`,
)!
: startVersion
changed++
} else {
if (packageJson.dependencies[pkg].startsWith('^')) {
packageJson.dependencies[pkg] = packageJson.dependencies[
pkg
].replace(/^\^/, '')
changed++
}
}
}
packageJson.dependencies = sortObject(packageJson.dependencies)
if (changed > 0) {
fs.writeFileSync('package.json', JSON.stringify(packageJson, null, 2))
console.log(
`${changed} packages updated.
Remove your node_modules directory and package lock file and re-install.`,
)
} else {
console.log(
'No changes needed. The relevant TanStack packages are already pinned.',
)
}
})
program
.command('add')
.argument(
'[add-on...]',
'Name of the add-ons (or add-ons separated by spaces or commas)',
)
.option('--forced', 'Force the add-on to be added', false)
.option('--ui', 'Add with the UI')
.action(async (addOns: Array<string>) => {
const parsedAddOns: Array<string> = []
for (const addOn of addOns) {
if (addOn.includes(',') || addOn.includes(' ')) {
parsedAddOns.push(
...addOn.split(/[\s,]+/).map((addon) => addon.trim()),
)
} else {
parsedAddOns.push(addOn.trim())
}
}
if (program.opts().ui) {
launchUI({
mode: 'add',
addOns: parsedAddOns,
projectPath: resolve(process.cwd()),
forcedRouterMode: defaultMode,
forcedAddOns,
environmentFactory: () => createUIEnvironment(appName, false),
webBase,
showDeploymentOptions,
})
} else if (parsedAddOns.length < 1) {
const addOns = await promptForAddOns()
if (addOns.length) {
await addToApp(environment, addOns, resolve(process.cwd()), {
forced: program.opts().forced,
})
}
} else {
await addToApp(environment, parsedAddOns, resolve(process.cwd()), {
forced: program.opts().forced,
})
}
})
const addOnCommand = program.command('add-on')
addOnCommand
.command('init')
.description('Initialize an add-on from the current project')
.action(async () => {
await initAddOn(environment)
})
addOnCommand
.command('compile')
.description('Update add-on from the current project')
.action(async () => {
await compileAddOn(environment)
})
const starterCommand = program.command('starter')
starterCommand
.command('init')
.description('Initialize a project starter from the current project')
.action(async () => {
await initStarter(environment)
})
starterCommand
.command('compile')
.description('Compile the starter JSON file for the current project')
.action(async () => {
await compileStarter(environment)
})
program.argument('[project-name]', 'name of the project')
if (!defaultMode && craCompatible) {
program.option<'typescript' | 'javascript' | 'file-router'>(
'--template <type>',
'project template (typescript, javascript, file-router)',
(value) => {
if (
value !== 'typescript' &&
value !== 'javascript' &&
value !== 'file-router'
) {
throw new InvalidArgumentError(
`Invalid template: ${value}. Only the following are allowed: typescript, javascript, file-router`,
)
}
return value
},
)
}
if (!defaultFramework) {
program.option<string>(
'--framework <type>',
`project framework (${availableFrameworks.join(', ')})`,
(value) => {
if (
!availableFrameworks.some(
(f) => f.toLowerCase() === value.toLowerCase(),
)
) {
throw new InvalidArgumentError(
`Invalid framework: ${value}. Only the following are allowed: ${availableFrameworks.join(', ')}`,
)
}
return value
},
defaultFramework || 'React',
)
}
program
.option(
'--starter [url]',
'initialize this project from a starter URL',
false,
)
.option('--no-install', 'skip installing dependencies')
.option<PackageManager>(
`--package-manager <${SUPPORTED_PACKAGE_MANAGERS.join('|')}>`,
`Explicitly tell the CLI to use this package manager`,
(value) => {
if (!SUPPORTED_PACKAGE_MANAGERS.includes(value as PackageManager)) {
throw new InvalidArgumentError(
`Invalid package manager: ${value}. The following are allowed: ${SUPPORTED_PACKAGE_MANAGERS.join(
', ',
)}`,
)
}
return value as PackageManager
},
)
.option(
'--dev-watch <path>',
'Watch a framework directory for changes and auto-rebuild',
)
if (deployments.size > 0) {
program.option<string>(
`--deployment <${Array.from(deployments).join('|')}>`,
`Explicitly tell the CLI to use this deployment adapter`,
(value) => {
if (!deployments.has(value)) {
throw new InvalidArgumentError(
`Invalid adapter: ${value}. The following are allowed: ${Array.from(
deployments,
).join(', ')}`,
)
}
return value
},
)
}
if (toolchains.size > 0) {
program.option<string>(
`--toolchain <${Array.from(toolchains).join('|')}>`,
`Explicitly tell the CLI to use this toolchain`,
(value) => {
if (!toolchains.has(value)) {
throw new InvalidArgumentError(
`Invalid toolchain: ${value}. The following are allowed: ${Array.from(
toolchains,
).join(', ')}`,
)
}
return value
},
)
}
program
.option('--interactive', 'interactive mode', false)
.option('--tailwind', 'add Tailwind CSS', false)
.option<Array<string> | boolean>(
'--add-ons [...add-ons]',
'pick from a list of available add-ons (comma separated list)',
(value: string) => {
let addOns: Array<string> | boolean = !!value
if (typeof value === 'string') {
addOns = value.split(',').map((addon) => addon.trim())
}
return addOns
},
)
.option('--list-add-ons', 'list all available add-ons', false)
.option(
'--addon-details <addon-id>',
'show detailed information about a specific add-on',
)
.option('--no-git', 'do not create a git repository')
.option(
'--target-dir <path>',
'the target directory for the application root',
)
.option('--mcp', 'run the MCP server', false)
.option('--mcp-sse', 'run the MCP server in SSE mode', false)
.option('--ui', 'Add with the UI')
.option(
'--add-on-config <config>',
'JSON string with add-on configuration options',
)
program.action(async (projectName: string, options: CliOptions) => {
if (options.listAddOns) {
const addOns = await getAllAddOns(
getFrameworkByName(options.framework || defaultFramework || 'React')!,
defaultMode ||
convertTemplateToMode(options.template || defaultTemplate),
)
let hasConfigurableAddOns = false
for (const addOn of addOns.filter((a) => !forcedAddOns.includes(a.id))) {
const hasOptions =
addOn.options && Object.keys(addOn.options).length > 0
const optionMarker = hasOptions ? '*' : ' '
if (hasOptions) hasConfigurableAddOns = true
console.log(
`${optionMarker} ${chalk.bold(addOn.id)}: ${addOn.description}`,
)
}
if (hasConfigurableAddOns) {
console.log('\n* = has configuration options')
}
} else if (options.addonDetails) {
const addOns = await getAllAddOns(
getFrameworkByName(options.framework || defaultFramework || 'React')!,
defaultMode ||
convertTemplateToMode(options.template || defaultTemplate),
)
const addOn = addOns.find((a) => a.id === options.addonDetails)
if (!addOn) {
console.error(`Add-on '${options.addonDetails}' not found`)
process.exit(1)
}
console.log(
`${chalk.bold.cyan('Add-on Details:')} ${chalk.bold(addOn.name)}`,
)
console.log(`${chalk.bold('ID:')} ${addOn.id}`)
console.log(`${chalk.bold('Description:')} ${addOn.description}`)
console.log(`${chalk.bold('Type:')} ${addOn.type}`)
console.log(`${chalk.bold('Phase:')} ${addOn.phase}`)
console.log(`${chalk.bold('Supported Modes:')} ${addOn.modes.join(', ')}`)
if (addOn.link) {
console.log(`${chalk.bold('Link:')} ${chalk.blue(addOn.link)}`)
}
if (addOn.dependsOn && addOn.dependsOn.length > 0) {
console.log(
`${chalk.bold('Dependencies:')} ${addOn.dependsOn.join(', ')}`,
)
}
if (addOn.options && Object.keys(addOn.options).length > 0) {
console.log(`\n${chalk.bold.yellow('Configuration Options:')}`)
for (const [optionName, option] of Object.entries(addOn.options)) {
if (option && typeof option === 'object' && 'type' in option) {
const opt = option as any
console.log(` ${chalk.bold(optionName)}:`)
console.log(` Label: ${opt.label}`)
if (opt.description) {
console.log(` Description: ${opt.description}`)
}
console.log(` Type: ${opt.type}`)
console.log(` Default: ${opt.default}`)
if (opt.type === 'select' && opt.options) {
console.log(` Available values:`)
for (const choice of opt.options) {
console.log(` - ${choice.value}: ${choice.label}`)
}
}
}
}
} else {
console.log(`\n${chalk.gray('No configuration options available')}`)
}
if (addOn.routes && addOn.routes.length > 0) {
console.log(`\n${chalk.bold.green('Routes:')}`)
for (const route of addOn.routes) {
console.log(` ${chalk.bold(route.url)} (${route.name})`)
console.log(` File: ${route.path}`)
}
}
} else if (options.mcp || options.mcpSse) {
await runMCPServer(!!options.mcpSse, {
forcedMode: defaultMode,
forcedAddOns,
appName,
})
} else if (options.devWatch) {
// Validate dev watch options
const validation = validateDevWatchOptions({ ...options, projectName })
if (!validation.valid) {
console.error(validation.error)
process.exit(1)
}
// Enter dev watch mode
if (!projectName && !options.targetDir) {
console.error(
'Project name/target directory is required for dev watch mode',
)
process.exit(1)
}
if (!options.framework) {
console.error('Failed to detect framework')
process.exit(1)
}
const framework = getFrameworkByName(options.framework)
if (!framework) {
console.error('Failed to detect framework')
process.exit(1)
}
// First, create the app normally using the standard flow
const normalizedOpts = await normalizeOptions(
{
...options,
projectName,
framework: framework.id,
},
defaultMode,
forcedAddOns,
)
if (!normalizedOpts) {
throw new Error('Failed to normalize options')
}
normalizedOpts.targetDir =
options.targetDir || resolve(process.cwd(), projectName)
// Create the initial app with minimal output for dev watch mode
console.log(chalk.bold('\ndev-watch'))
console.log(chalk.gray('├─') + ' ' + `creating initial ${appName} app...`)
if (normalizedOpts.install !== false) {
console.log(chalk.gray('├─') + ' ' + chalk.yellow('⟳') + ' installing packages...')
}
const silentEnvironment = createUIEnvironment(appName, true)
await createApp(silentEnvironment, normalizedOpts)
console.log(chalk.gray('└─') + ' ' + chalk.green('✓') + ` app created`)
// Now start the dev watch mode
const manager = new DevWatchManager({
watchPath: options.devWatch,
targetDir: normalizedOpts.targetDir,
framework,
cliOptions: normalizedOpts,
packageManager: normalizedOpts.packageManager,
environment,
frameworkDefinitionInitializers,
})
await manager.start()
} else {
try {
const cliOptions = {
projectName,
...options,
} as CliOptions
cliOptions.framework = getFrameworkByName(
options.framework || defaultFramework || 'React',
)!.id
if (defaultMode) {
cliOptions.template = defaultMode as TemplateOptions
}
let finalOptions: Options | undefined
if (cliOptions.interactive) {
cliOptions.addOns = true
} else {
finalOptions = await normalizeOptions(
cliOptions,
defaultMode,
forcedAddOns,
{ forcedDeployment },
)
}
if (options.ui) {
const optionsFromCLI = await normalizeOptions(
cliOptions,
defaultMode,
forcedAddOns,
{ disableNameCheck: true, forcedDeployment },
)
const options = {
...createSerializedOptions(optionsFromCLI!),
projectName: 'my-app',
targetDir: resolve(process.cwd(), 'my-app'),
}
launchUI({
mode: 'setup',
options,
forcedRouterMode: defaultMode,
forcedAddOns,
environmentFactory: () => createUIEnvironment(appName, false),
webBase,
showDeploymentOptions,
})
return
}
if (finalOptions) {
intro(`Creating a new ${appName} app in ${projectName}...`)
} else {
intro(`Let's configure your ${appName} application`)
finalOptions = await promptForCreateOptions(cliOptions, {
forcedMode: defaultMode,
forcedAddOns,
showDeploymentOptions,
})
}
if (!finalOptions) {
throw new Error('No options were provided')
}
// Determine target directory:
// 1. Use --target-dir if provided
// 2. Use targetDir from normalizeOptions if set (handles "." case)
// 3. If original projectName was ".", use current directory
// 4. Otherwise, use project name as subdirectory
if (options.targetDir) {
finalOptions.targetDir = options.targetDir
} else if (finalOptions.targetDir) {
// Keep the targetDir from normalizeOptions (handles "." case)
} else if (projectName === '.') {
finalOptions.targetDir = resolve(process.cwd())
} else {
finalOptions.targetDir = resolve(process.cwd(), finalOptions.projectName)
}
await createApp(environment, finalOptions)
} catch (error) {
log.error(
error instanceof Error ? error.message : 'An unknown error occurred',
)
process.exit(1)
}
}
})
program.parse()
}