-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathgenerateSettings.ts
More file actions
303 lines (272 loc) · 9.57 KB
/
generateSettings.ts
File metadata and controls
303 lines (272 loc) · 9.57 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
import {
displayProjectId,
exitSync,
logErrorAndExit,
warnApiKeyInConfig,
} from '../console/logging.js';
import { loadConfig } from '../fs/config/loadConfig.js';
import { FilesOptions, Settings, SupportedFrameworks } from '../types/index.js';
import {
defaultBaseUrl,
libraryDefaultLocale,
} from 'generaltranslation/internal';
import fs from 'node:fs';
import { createOrUpdateConfig } from '../fs/config/setupConfig.js';
import { resolveFiles } from '../fs/config/parseFilesConfig.js';
import { validateSettings } from './validateSettings.js';
import {
DEFAULT_GIT_REMOTE_NAME,
GT_DASHBOARD_URL,
} from '../utils/constants.js';
import { resolveProjectId } from '../fs/utils.js';
import path from 'node:path';
import chalk from 'chalk';
import { resolveConfig } from './resolveConfig.js';
import { gt } from '../utils/gt.js';
import { generatePreset } from './optionPresets.js';
export const DEFAULT_SRC_PATTERNS = [
'src/**/*.{js,jsx,ts,tsx}',
'app/**/*.{js,jsx,ts,tsx}',
'pages/**/*.{js,jsx,ts,tsx}',
'components/**/*.{js,jsx,ts,tsx}',
];
export const DEFAULT_PYTHON_SRC_PATTERNS = ['**/*.py'];
export const DEFAULT_PYTHON_SRC_EXCLUDES = [
'venv/**',
'.venv/**',
'__pycache__/**',
'**/migrations/**',
'**/tests/**',
'**/test_*.py',
'**/*_test.py',
];
/**
* Generates settings from any
* @param flags - The CLI flags to generate settings from
* @param cwd - The current working directory
* @returns The generated settings
*/
export async function generateSettings(
flags: Record<string, any>,
cwd: string = process.cwd()
): Promise<Settings> {
// Load config file
let gtConfig: Record<string, any> = {};
if (flags.config && !flags.config.endsWith('.json')) {
flags.config = `${flags.config}.json`;
}
if (flags.config) {
gtConfig = loadConfig(flags.config);
} else {
const config = resolveConfig(cwd);
if (config) {
gtConfig = config.config;
flags.config = config.path;
} else {
gtConfig = {};
}
}
// Warn if apiKey is present in gt.config.json
if (gtConfig.apiKey) {
warnApiKeyInConfig(flags.config);
exitSync(1);
}
const projectIdEnv = resolveProjectId();
// Resolve mismatched projectIds
if (
gtConfig.projectId &&
flags.projectId &&
gtConfig.projectId !== flags.projectId
) {
logErrorAndExit(
`Project ID mismatch between ${chalk.green(gtConfig.projectId)} and ${chalk.green(flags.projectId)}! Use the same projectId in all configs.`
);
} else if (
gtConfig.projectId &&
projectIdEnv &&
gtConfig.projectId !== projectIdEnv
) {
logErrorAndExit(
`Project ID mismatch between ${chalk.green(gtConfig.projectId)} and ${chalk.green(projectIdEnv)}! Use the same projectId in all configs.`
);
}
if (
flags.options?.docsUrlPattern &&
!flags.options?.docsUrlPattern.includes('[locale]')
) {
logErrorAndExit(
'Failed to localize static urls: URL pattern must include "[locale]" to denote the location of the locale'
);
}
if (
flags.options?.docsImportPattern &&
!flags.options?.docsImportPattern.includes('[locale]')
) {
logErrorAndExit(
'Failed to localize static imports: Import pattern must include "[locale]" to denote the location of the locale'
);
}
if (flags.options?.copyFiles) {
for (const file of flags.options.copyFiles) {
if (!file.includes('[locale]')) {
logErrorAndExit(
'Failed to copy files: File path must include "[locale]" to denote the location of the locale'
);
}
}
}
// merge options
const mergedOptions: Settings = { ...gtConfig, ...flags } as Settings;
// Add defaultLocale if not provided
mergedOptions.defaultLocale =
mergedOptions.defaultLocale || libraryDefaultLocale;
// merge locales
mergedOptions.locales = Array.from(
new Set([...(gtConfig.locales || []), ...(flags.locales || [])])
);
// Separate defaultLocale from locales
mergedOptions.locales = mergedOptions.locales.filter(
(locale) => locale !== mergedOptions.defaultLocale
);
// Add apiKey if not provided
mergedOptions.apiKey = mergedOptions.apiKey || process.env.GT_API_KEY;
// Add projectId if not provided
mergedOptions.projectId = mergedOptions.projectId || resolveProjectId();
// Add baseUrl if not provided
mergedOptions.baseUrl = mergedOptions.baseUrl || defaultBaseUrl;
// Add dashboardUrl if not provided
mergedOptions.dashboardUrl = mergedOptions.dashboardUrl || GT_DASHBOARD_URL;
// Add locales if not provided
mergedOptions.locales = mergedOptions.locales || [];
// Add default config file name if not provided
mergedOptions.config =
mergedOptions.config || path.join(cwd, 'gt.config.json');
// Display projectId if present
if (mergedOptions.projectId) displayProjectId(mergedOptions.projectId);
// Add stageTranslations if not provided
// For human review, always stage the project
mergedOptions.stageTranslations = mergedOptions.stageTranslations ?? false;
// Add publish if not provided
mergedOptions.publish = (gtConfig.publish || flags.publish) ?? false;
// Don't default src here — each pipeline (JS/Python) has its own defaults.
// Only set src if the user explicitly provided it via flags or config.
// Resolve all glob patterns in the files object
const compositePatterns = [
...Object.entries(mergedOptions.options?.jsonSchema || {}),
]
.filter(([, schema]) => schema.composite)
.map(([key]) => key);
mergedOptions.files = mergedOptions.files
? resolveFiles(
mergedOptions.files as FilesOptions,
mergedOptions.defaultLocale,
mergedOptions.locales,
cwd,
compositePatterns
)
: { resolvedPaths: {}, placeholderPaths: {}, transformPaths: {} };
mergedOptions.options = {
...(mergedOptions.options || {}),
mintlify: {
...(mergedOptions.options?.mintlify || {}),
inferTitleFromFilename:
gtConfig.options?.mintlify?.inferTitleFromFilename ||
mergedOptions.options?.mintlify?.inferTitleFromFilename,
},
experimentalLocalizeStaticImports:
gtConfig.options?.experimentalLocalizeStaticImports ||
flags.experimentalLocalizeStaticImports,
experimentalLocalizeStaticUrls:
gtConfig.options?.experimentalLocalizeStaticUrls ||
flags.experimentalLocalizeStaticUrls,
experimentalLocalizeRelativeAssets:
gtConfig.options?.experimentalLocalizeRelativeAssets ||
flags.experimentalLocalizeRelativeAssets,
experimentalHideDefaultLocale:
gtConfig.options?.experimentalHideDefaultLocale ||
flags.experimentalHideDefaultLocale,
experimentalFlattenJsonFiles:
gtConfig.options?.experimentalFlattenJsonFiles ||
flags.experimentalFlattenJsonFiles,
experimentalClearLocaleDirs:
gtConfig.options?.experimentalClearLocaleDirs ||
flags.experimentalClearLocaleDirs,
clearLocaleDirsExclude:
gtConfig.options?.clearLocaleDirsExclude || flags.clearLocaleDirsExclude,
};
// Add additional options if provided
if (mergedOptions.options) {
if (mergedOptions.options.jsonSchema) {
for (const fileGlob of Object.keys(mergedOptions.options.jsonSchema)) {
const jsonSchema = mergedOptions.options.jsonSchema[fileGlob];
if (jsonSchema.preset) {
mergedOptions.options.jsonSchema[fileGlob] = {
...generatePreset(jsonSchema.preset, 'json'),
...jsonSchema,
};
}
}
}
if (mergedOptions.options.yamlSchema) {
for (const fileGlob of Object.keys(mergedOptions.options.yamlSchema)) {
const yamlSchema = mergedOptions.options.yamlSchema[fileGlob];
if (yamlSchema.preset) {
mergedOptions.options.yamlSchema[fileGlob] = {
...generatePreset(yamlSchema.preset, 'yaml'),
...yamlSchema,
};
}
}
}
}
// Add parsing options if not provided
mergedOptions.parsingOptions = mergedOptions.parsingOptions || {};
mergedOptions.parsingOptions.conditionNames = mergedOptions.parsingOptions
.conditionNames || [
'development',
'browser',
'module',
'import',
'require',
'default',
];
// Add branch options if not provided
const branchOptions = mergedOptions.branchOptions || {};
// If --branch is set, enable branching
branchOptions.enabled =
flags.enableBranching ??
gtConfig.branchOptions?.enabled ??
(flags.branch ? true : false);
branchOptions.currentBranch =
flags.branch ?? gtConfig.branchOptions?.currentBranch ?? undefined;
branchOptions.autoDetectBranches = flags.disableBranchDetection
? false
: (gtConfig.branchOptions?.autoDetectBranches ?? true);
branchOptions.remoteName =
flags.remoteName ??
gtConfig.branchOptions?.remoteName ??
DEFAULT_GIT_REMOTE_NAME;
mergedOptions.branchOptions = branchOptions;
// if there's no existing config file, creates one
// does not include the API key to avoid exposing it
if (!fs.existsSync(mergedOptions.config)) {
await createOrUpdateConfig(mergedOptions.config, {
projectId: mergedOptions.projectId as string,
defaultLocale: mergedOptions.defaultLocale as string,
locales:
mergedOptions.locales?.length > 0 ? mergedOptions.locales : undefined,
framework: mergedOptions.framework as SupportedFrameworks,
});
}
mergedOptions.configDirectory = path.join(cwd, '.gt');
validateSettings(mergedOptions);
// Set up GT instance
gt.setConfig({
projectId: mergedOptions.projectId,
apiKey: mergedOptions.apiKey,
baseUrl: mergedOptions.baseUrl,
sourceLocale: mergedOptions.defaultLocale,
customMapping: mergedOptions.customMapping,
});
return mergedOptions;
}