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

config-file.ts

89 lines2.5 KB

1import { resolve } from 'node:path'
2​
3import { CONFIG_FILE } from './constants.js'
4import { createDefaultEnvironment } from './environment.js'
5​
6import type { Environment, Options } from './types.js'
7​
8export type PersistedOptions = Omit<
9 Partial<Options>,
10 | 'addOns'
11 | 'chosenAddOns'
12 | 'envVarValues'
13 | 'framework'
14 | 'starter'
15 | 'targetDir'
16> & {
17 framework: string
18 version: number
19 chosenAddOns: Array<string>
20 starter?: string
22​
23function createPersistedOptions(options: Options): PersistedOptions {
24 /* eslint-disable unused-imports/no-unused-vars */
25 const { chosenAddOns, envVarValues, framework, targetDir, ...rest } = options
26 /* eslint-enable unused-imports/no-unused-vars */
27 return {
28 ...rest,
29 version: 1,
30 framework: options.framework.id,
31 chosenAddOns: options.chosenAddOns.map((addOn) => addOn.id),
32 starter: options.starter?.id ?? undefined,
33 }
35​
36export async function writeConfigFileToEnvironment(
37 environment: Environment,
38 options: Options,
39) {
40 await environment.writeFile(
41 resolve(options.targetDir, CONFIG_FILE),
42 JSON.stringify(createPersistedOptions(options), null, 2),
43 )
45​
46export async function readConfigFileFromEnvironment(
47 environment: Environment,
48 targetDir: string,
49): Promise<PersistedOptions | null> {
50 try {
51 const configFile = resolve(targetDir, CONFIG_FILE)
52 const config = await environment.readFile(configFile)
53​
54 const originalJSON = JSON.parse(config)
55​
56 // Look for markers out outdated config files and upgrade the format on the fly (it will be written in the updated version after we add add-ons)
57 if (originalJSON.existingAddOns) {
58 if (originalJSON.framework === 'react-cra') {
59 originalJSON.framework = 'react'
60 }
61 originalJSON.chosenAddOns = originalJSON.existingAddOns
62 delete originalJSON.existingAddOns
63 delete originalJSON.addOns
64 if (originalJSON.toolchain && originalJSON.toolchain !== 'none') {
65 originalJSON.chosenAddOns.push(originalJSON.toolchain)
66 }
67 delete originalJSON.toolchain
68 delete originalJSON.variableValues
69 }
70​
71 if (originalJSON.framework === 'react-cra') {
72 originalJSON.framework = 'react'
73 }
74​
75 originalJSON.bundler ??= 'vite'
76​
77 delete originalJSON.envVarValues
78​
79 return originalJSON
80 } catch {
81 return null
82 }
84​
85export async function readConfigFile(
86 targetDir: string,
87): Promise<PersistedOptions | null> {
88 return readConfigFileFromEnvironment(createDefaultEnvironment(), targetDir)