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

config-file.ts

80 lines2.3 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' | 'chosenAddOns' | 'framework' | 'starter' | 'targetDir'
11> & {
12 framework: string
13 version: number
14 chosenAddOns: Array<string>
15 starter?: string
17​
18function createPersistedOptions(options: Options): PersistedOptions {
19 /* eslint-disable unused-imports/no-unused-vars */
20 const { chosenAddOns, framework, targetDir, ...rest } = options
21 /* eslint-enable unused-imports/no-unused-vars */
22 return {
23 ...rest,
24 version: 1,
25 framework: options.framework.id,
26 chosenAddOns: options.chosenAddOns.map((addOn) => addOn.id),
27 starter: options.starter?.id ?? undefined,
28 }
30​
31export async function writeConfigFileToEnvironment(
32 environment: Environment,
33 options: Options,
34) {
35 await environment.writeFile(
36 resolve(options.targetDir, CONFIG_FILE),
37 JSON.stringify(createPersistedOptions(options), null, 2),
38 )
40​
41export async function readConfigFileFromEnvironment(
42 environment: Environment,
43 targetDir: string,
44): Promise<PersistedOptions | null> {
45 try {
46 const configFile = resolve(targetDir, CONFIG_FILE)
47 const config = await environment.readFile(configFile)
48​
49 const originalJSON = JSON.parse(config)
50​
51 // 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)
52 if (originalJSON.existingAddOns) {
53 if (originalJSON.framework === 'react-cra') {
54 originalJSON.framework = 'react'
55 }
56 originalJSON.chosenAddOns = originalJSON.existingAddOns
57 delete originalJSON.existingAddOns
58 delete originalJSON.addOns
59 if (originalJSON.toolchain && originalJSON.toolchain !== 'none') {
60 originalJSON.chosenAddOns.push(originalJSON.toolchain)
61 }
62 delete originalJSON.toolchain
63 delete originalJSON.variableValues
64 }
65​
66 if (originalJSON.framework === 'react-cra') {
67 originalJSON.framework = 'react'
68 }
69​
70 return originalJSON
71 } catch {
72 return null
73 }
75​
76export async function readConfigFile(
77 targetDir: string,
78): Promise<PersistedOptions | null> {
79 return readConfigFileFromEnvironment(createDefaultEnvironment(), targetDir)