-
Notifications
You must be signed in to change notification settings - Fork 148
Expand file tree
/
Copy pathconfig.ts
More file actions
447 lines (406 loc) · 12 KB
/
config.ts
File metadata and controls
447 lines (406 loc) · 12 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
import defu from 'defu';
import fs from 'fs';
import { homedir } from 'os';
import path from 'pathe';
import type { Provider } from './model';
export type McpStdioServerConfig = {
type: 'stdio';
command: string;
args: string[];
env?: Record<string, string>;
disable?: boolean;
};
export type McpSSEServerConfig = {
type: 'sse';
url: string;
disable?: boolean;
headers?: Record<string, string>;
};
export type McpHttpServerConfig = {
type: 'http';
url: string;
disable?: boolean;
headers?: Record<string, string>;
};
export type McpServerConfig =
| McpStdioServerConfig
| McpSSEServerConfig
| McpHttpServerConfig;
export type ApprovalMode = 'default' | 'autoEdit' | 'yolo';
export type AgentConfig = {
model?: string;
// Reserved for future extensions
};
export type CommitConfig = {
language: string;
systemPrompt?: string;
model?: string;
};
export type ProviderConfig = Partial<Omit<Provider, 'createModel'>>;
export type Config = {
model: string;
planModel: string;
smallModel?: string;
visionModel?: string;
language: string;
quiet: boolean;
approvalMode: ApprovalMode;
plugins: string[];
mcpServers: Record<string, McpServerConfig>;
provider?: Record<string, ProviderConfig>;
systemPrompt?: string;
todo?: boolean;
/**
* Controls whether automatic conversation compression is enabled.
* When set to false, conversation history will accumulate and context limit will be exceeded.
*
* @default true
*/
autoCompact?: boolean;
/**
* Controls whether automatic tool output truncation is enabled.
* When enabled, large tool outputs (>2000 lines or >50KB) will be truncated
* and full content saved to a local file.
*
* @default true
*/
truncation?: boolean;
commit?: CommitConfig;
outputStyle?: string;
outputFormat?: 'text' | 'stream-json' | 'json';
autoUpdate?: boolean;
temperature?: number;
httpProxy?: string;
/**
* Extensions configuration for third-party custom agents.
* Allows arbitrary nested configuration without validation.
*/
extensions?: Record<string, any>;
/**
* Tools configuration for enabling/disabling specific tools.
* Key is the tool name, value is boolean (false to disable).
*/
tools?: Record<string, boolean>;
/**
* Agent configuration for customizing agent behavior per agent type.
* Example: { explore: { model: "anthropic/claude-haiku-4" } }
*/
agent?: Record<string, AgentConfig>;
/**
* Extra SKILL.md file paths for user-defined skills.
* Accepts absolute paths to SKILL.md files or directories containing SKILL.md.
* Example: ["/path/to/my-skill/SKILL.md", "/path/to/skill-dir"]
*/
skills?: string[];
/**
* Notification configuration.
* - true: play default sound (Funk/warning)
* - false: disabled
* - string: custom sound name (e.g., "Glass", "Ping")
* - object: extended notification config (reserved for future use, e.g., url)
*/
notification?: boolean | string;
};
const DEFAULT_CONFIG: Partial<Config> = {
language: 'English',
quiet: false,
approvalMode: 'default',
plugins: [],
mcpServers: {},
provider: {},
todo: true,
autoCompact: true,
truncation: true,
outputFormat: 'text',
autoUpdate: true,
extensions: {},
tools: {},
agent: {},
};
const VALID_CONFIG_KEYS = [
...Object.keys(DEFAULT_CONFIG),
'model',
'planModel',
'smallModel',
'visionModel',
'systemPrompt',
'todo',
'autoCompact',
'truncation',
'commit',
'outputStyle',
'autoUpdate',
'provider',
'temperature',
'httpProxy',
'extensions',
'tools',
'agent',
'notification',
'skills',
];
const ARRAY_CONFIG_KEYS = ['plugins', 'skills'];
const OBJECT_CONFIG_KEYS = [
'mcpServers',
'commit',
'provider',
'extensions',
'tools',
'agent',
];
const BOOLEAN_CONFIG_KEYS = [
'quiet',
'todo',
'autoCompact',
'autoUpdate',
'truncation',
];
export const GLOBAL_ONLY_KEYS: string[] = [];
function assertGlobalAllowed(global: boolean, key: string) {
const rootKey = key.split('.')[0];
if (!global && GLOBAL_ONLY_KEYS.includes(rootKey)) {
throw new Error(`Config key '${rootKey}' can only be set globally`);
}
}
export class ConfigManager {
globalConfig: Partial<Config>;
projectConfig: Partial<Config>;
argvConfig: Partial<Config>;
globalConfigPath: string;
projectConfigPath: string;
constructor(cwd: string, productName: string, argvConfig: Partial<Config>) {
const lowerProductName = productName.toLowerCase();
const globalConfigPath = path.join(
homedir(),
`.${lowerProductName}`,
'config.json',
);
const projectConfigPath = path.join(
cwd,
`.${lowerProductName}`,
'config.json',
);
const projectLocalConfigPath = path.join(
cwd,
`.${lowerProductName}`,
'config.local.json',
);
this.globalConfigPath = globalConfigPath;
this.projectConfigPath = projectConfigPath;
this.globalConfig = loadConfig(globalConfigPath);
this.projectConfig = defu(
loadConfig(projectConfigPath),
loadConfig(projectLocalConfigPath),
);
this.argvConfig = argvConfig;
}
get config() {
const config = defu(
this.argvConfig,
defu(this.projectConfig, defu(this.globalConfig, DEFAULT_CONFIG)),
) as Config;
config.planModel = config.planModel || config.model;
config.smallModel = config.smallModel || config.model;
config.visionModel = config.visionModel || config.model;
return config;
}
removeConfig(global: boolean, key: string, values?: string[]) {
assertGlobalAllowed(global, key);
const config = global ? this.globalConfig : this.projectConfig;
const configPath = global ? this.globalConfigPath : this.projectConfigPath;
if (key.includes('.')) {
// Handle dot notation for nested keys
const keys = key.split('.');
const rootKey = keys[0];
if (!VALID_CONFIG_KEYS.includes(rootKey)) {
throw new Error(`Invalid config key: ${rootKey}`);
}
if (!OBJECT_CONFIG_KEYS.includes(rootKey)) {
throw new Error(
`Config key '${rootKey}' does not support nested properties`,
);
}
// Navigate to the nested property
let current: any = config[rootKey as keyof Config];
if (!current) {
return; // Nothing to remove
}
// Navigate to the parent of the target property
for (let i = 1; i < keys.length - 1; i++) {
if (!current[keys[i]]) {
return; // Path doesn't exist, nothing to remove
}
current = current[keys[i]];
}
const lastKey = keys[keys.length - 1];
if (values) {
// Remove specific values from array
if (Array.isArray(current[lastKey])) {
current[lastKey] = current[lastKey].filter(
(v: string) => !values.includes(v),
);
}
} else {
// Delete the property
delete current[lastKey];
}
} else {
// Handle flat keys
if (!VALID_CONFIG_KEYS.includes(key)) {
throw new Error(`Invalid config key: ${key}`);
}
if (values) {
(config[key as keyof Config] as any) = (
config[key as keyof Config] as string[]
).filter((v) => !values.includes(v));
} else {
delete config[key as keyof Config];
}
}
saveConfig(configPath, config, DEFAULT_CONFIG);
}
addConfig(global: boolean, key: string, values: string[]) {
assertGlobalAllowed(global, key);
if (!VALID_CONFIG_KEYS.includes(key)) {
throw new Error(`Invalid config key: ${key}`);
}
const config = global ? this.globalConfig : this.projectConfig;
const configPath = global ? this.globalConfigPath : this.projectConfigPath;
if (ARRAY_CONFIG_KEYS.includes(key)) {
(config[key as keyof Config] as any) = [
...((config[key as keyof Config] as string[]) || []),
...values,
];
} else if (OBJECT_CONFIG_KEYS.includes(key)) {
(config[key as keyof Config] as any) = {
...(config[key as keyof Config] as Record<string, McpServerConfig>),
...values,
};
}
saveConfig(configPath, config, DEFAULT_CONFIG);
}
getConfig(global: boolean, key: string): any {
const config = global ? this.globalConfig : this.projectConfig;
const getValue = (conf: Partial<Config>) => {
if (!key.includes('.')) {
return conf[key as keyof Config];
}
const keys = key.split('.');
const rootKey = keys[0];
if (!VALID_CONFIG_KEYS.includes(rootKey)) {
throw new Error(`Invalid config key: ${rootKey}`);
}
let current: any = conf[rootKey as keyof Config];
for (let i = 1; i < keys.length; i++) {
if (current === undefined || current === null) {
return undefined;
}
current = current[keys[i]];
}
return current;
};
const value = getValue(config);
if (value !== undefined) {
return value;
}
return getValue(DEFAULT_CONFIG);
}
setConfig(global: boolean, key: string, value: string) {
assertGlobalAllowed(global, key);
const config = global ? this.globalConfig : this.projectConfig;
const configPath = global ? this.globalConfigPath : this.projectConfigPath;
if (key.includes('.')) {
// Handle dot notation for nested keys
const keys = key.split('.');
const rootKey = keys[0];
if (!VALID_CONFIG_KEYS.includes(rootKey)) {
throw new Error(`Invalid config key: ${rootKey}`);
}
if (!OBJECT_CONFIG_KEYS.includes(rootKey)) {
throw new Error(
`Config key '${rootKey}' does not support nested properties`,
);
}
// Initialize the root object if it doesn't exist
if (!config[rootKey as keyof Config]) {
(config[rootKey as keyof Config] as any) = {};
}
// Navigate to the nested property and set the value
let current: any = config[rootKey as keyof Config];
for (let i = 1; i < keys.length - 1; i++) {
if (!current[keys[i]]) {
current[keys[i]] = {};
}
current = current[keys[i]];
}
const lastKey = keys[keys.length - 1];
current[lastKey] = value;
} else {
// Handle flat keys
if (!VALID_CONFIG_KEYS.includes(key)) {
throw new Error(`Invalid config key: ${key}`);
}
let newValue: any = value;
if (BOOLEAN_CONFIG_KEYS.includes(key)) {
if (typeof value === 'boolean') {
newValue = value;
} else {
newValue = value === 'true';
}
}
if (ARRAY_CONFIG_KEYS.includes(key)) {
newValue = JSON.parse(value);
}
if (OBJECT_CONFIG_KEYS.includes(key)) {
newValue = JSON.parse(value);
}
(config[key as keyof Config] as any) = newValue;
}
saveConfig(configPath, config, DEFAULT_CONFIG);
}
updateConfig(global: boolean, newConfig: Partial<Config>) {
Object.keys(newConfig).forEach((key) => {
if (!VALID_CONFIG_KEYS.includes(key)) {
throw new Error(`Invalid config key: ${key}`);
}
assertGlobalAllowed(global, key);
});
let config = global ? this.globalConfig : this.projectConfig;
const configPath = global ? this.globalConfigPath : this.projectConfigPath;
config = defu(newConfig, config);
if (global) {
this.globalConfig = config;
} else {
this.projectConfig = config;
}
saveConfig(configPath, config, DEFAULT_CONFIG);
}
}
function loadConfig(file: string) {
if (!fs.existsSync(file)) {
return {};
}
try {
return JSON.parse(fs.readFileSync(file, 'utf-8'));
} catch (error) {
throw new Error(`Unable to read config file ${file}: ${error}`);
}
}
function saveConfig(
file: string,
config: Partial<Config>,
defaultConfig: Partial<Config>,
) {
const filteredConfig = Object.fromEntries(
Object.entries(config).filter(
([key, value]) =>
JSON.stringify(value) !==
JSON.stringify(defaultConfig[key as keyof Config]),
),
);
const dir = path.dirname(file);
if (!fs.existsSync(dir)) {
fs.mkdirSync(dir, { recursive: true });
}
fs.writeFileSync(file, JSON.stringify(filteredConfig, null, 2), 'utf-8');
}