@mrclrchtr/supi-lsp 2.0.6 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/README.md +32 -23
  2. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/package.json +2 -1
  3. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/config/config.ts +22 -8
  4. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/config/prompt-surface.ts +357 -0
  5. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/config.ts +2 -3
  6. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/debug-registry.ts +0 -5
  7. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/prompt-surface.ts +4 -0
  8. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings/scoped-settings-list.ts +372 -0
  9. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings/settings-action-menu.ts +101 -0
  10. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings/settings-command.ts +1 -1
  11. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings/settings-registry.ts +55 -27
  12. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings/settings-schema.ts +464 -0
  13. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings/settings-submenus.ts +124 -0
  14. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings/settings-ui.ts +72 -285
  15. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings-ui.ts +2 -5
  16. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/settings.ts +27 -5
  17. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/tool-framework.ts +10 -0
  18. package/node_modules/@mrclrchtr/supi-code-runtime/package.json +2 -2
  19. package/node_modules/@mrclrchtr/supi-core/README.md +32 -23
  20. package/node_modules/@mrclrchtr/supi-core/package.json +2 -1
  21. package/node_modules/@mrclrchtr/supi-core/src/config/config.ts +22 -8
  22. package/node_modules/@mrclrchtr/supi-core/src/config/prompt-surface.ts +357 -0
  23. package/node_modules/@mrclrchtr/supi-core/src/config.ts +2 -3
  24. package/node_modules/@mrclrchtr/supi-core/src/debug-registry.ts +0 -5
  25. package/node_modules/@mrclrchtr/supi-core/src/prompt-surface.ts +4 -0
  26. package/node_modules/@mrclrchtr/supi-core/src/settings/scoped-settings-list.ts +372 -0
  27. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-action-menu.ts +101 -0
  28. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-command.ts +1 -1
  29. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-registry.ts +55 -27
  30. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-schema.ts +464 -0
  31. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-submenus.ts +124 -0
  32. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-ui.ts +72 -285
  33. package/node_modules/@mrclrchtr/supi-core/src/settings-ui.ts +2 -5
  34. package/node_modules/@mrclrchtr/supi-core/src/settings.ts +27 -5
  35. package/node_modules/@mrclrchtr/supi-core/src/tool-framework.ts +10 -0
  36. package/package.json +3 -3
  37. package/src/config/lsp-settings.ts +1 -1
  38. package/node_modules/@mrclrchtr/supi-code-runtime/node_modules/@mrclrchtr/supi-core/src/config/config-settings.ts +0 -188
  39. package/node_modules/@mrclrchtr/supi-core/src/config/config-settings.ts +0 -188
@@ -1,327 +1,114 @@
1
- // Generic settings overlay for SuPi extensions.
1
+ // Declarative settings overlay for SuPi extensions.
2
2
  //
3
- // Uses pi-tui's SettingsList with scope toggle (Tab), extension grouping,
4
- // and search. Each extension declares its settings via registerSettings().
3
+ // Thin orchestration layer that collects settings contributions and opens the
4
+ // scoped settings list inside a pi-tui custom component overlay.
5
5
 
6
- import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
7
- import { getSettingsListTheme } from "@earendil-works/pi-coding-agent";
6
+ import type { ExtensionAPI, ExtensionContext } from "@earendil-works/pi-coding-agent";
7
+ import { Container, Key, matchesKey, Text } from "@earendil-works/pi-tui";
8
+ import { ScopedSettingsList } from "./scoped-settings-list.ts";
9
+ import type { SettingsCollectionDiagnostic, SettingsScope } from "./settings-registry.ts";
8
10
  import {
9
- Container,
10
- Input,
11
- Key,
12
- matchesKey,
13
- type SelectItem,
14
- SelectList,
15
- type SelectListTheme,
16
- type SettingItem,
17
- SettingsList,
18
- Text,
19
- } from "@earendil-works/pi-tui";
20
- import { getSelectableModels } from "../model-selection.ts";
21
- import {
22
- getRegisteredSettings,
23
- type SettingsScope,
24
- type SettingsSection,
11
+ createSettingsContributionCollector,
12
+ SUPI_SETTINGS_COLLECT_EVENT,
25
13
  } from "./settings-registry.ts";
26
14
 
27
- // ── Input submenu component ──────────────────────────────────
15
+ // Re-export submenu helpers
16
+ export { createInputSubmenu, createModelPickerSubmenu } from "./settings-submenus.ts";
28
17
 
29
- /**
30
- * Creates a pi-tui Input-backed submenu component with enter-to-confirm
31
- * and escape-to-cancel handling.
32
- *
33
- * @param currentValue - Initial value for the text input.
34
- * @param label - Label text displayed above the input.
35
- * @param done - Callback invoked with the confirmed value, or undefined on cancel.
36
- */
37
- export function createInputSubmenu(
38
- currentValue: string,
39
- label: string,
40
- done: (selectedValue?: string) => void,
41
- ): {
42
- render: (width: number) => string[];
43
- invalidate: () => void;
44
- handleInput: (data: string) => boolean;
45
- } {
46
- const input = new Input();
47
- input.setValue(currentValue);
18
+ // ── Overlay ────────────────────────────────────────────────────────────────
48
19
 
49
- return {
50
- render: (_width: number) => {
51
- const lines = [` ${label}`];
52
- lines.push(...input.render(_width));
53
- lines.push(" enter confirm • esc cancel");
54
- return lines;
55
- },
56
- invalidate: () => {
57
- input.invalidate();
58
- },
59
- handleInput: (data: string) => {
60
- if (matchesKey(data, Key.escape)) {
61
- done();
62
- return true;
63
- }
64
- if (matchesKey(data, Key.enter)) {
65
- done(input.getValue());
66
- return true;
67
- }
68
- input.handleInput(data);
69
- return true;
70
- },
71
- };
20
+ interface OverlayStatus {
21
+ kind: "warning" | "error";
22
+ message: string;
72
23
  }
73
24
 
74
- // ── Types ────────────────────────────────────────────────────
75
-
76
25
  interface OverlayState {
77
26
  scope: SettingsScope;
78
27
  cwd: string;
28
+ status?: OverlayStatus;
79
29
  }
80
30
 
81
- // ── Pure helpers ─────────────────────────────────────────────
82
-
83
31
  function getScopeLabel(scope: SettingsScope): string {
84
32
  return scope === "project" ? "Project" : "Global";
85
33
  }
86
34
 
87
- function buildFlatItems(
88
- sections: SettingsSection[],
89
- scope: SettingsScope,
90
- cwd: string,
91
- ctx?: ExtensionContext,
92
- ): SettingItem[] {
93
- const items: SettingItem[] = [];
94
- for (const section of sections) {
95
- const sectionItems = section.loadValues(scope, cwd, ctx);
96
- for (const item of sectionItems) {
97
- items.push({
98
- ...item,
99
- id: `${section.id}.${item.id}`,
100
- label: `${section.label}: ${item.label}`,
101
- });
102
- }
103
- }
104
- return items;
105
- }
106
-
107
- function findSectionAndId(
108
- sections: SettingsSection[],
109
- flatId: string,
110
- ): { section: SettingsSection; itemId: string } | null {
111
- const dotIndex = flatId.indexOf(".");
112
- if (dotIndex === -1) return null;
113
- const sectionId = flatId.slice(0, dotIndex);
114
- const itemId = flatId.slice(dotIndex + 1);
115
- const section = sections.find((s) => s.id === sectionId);
116
- if (!section) return null;
117
- return { section, itemId };
118
- }
119
-
120
- // ── Component ────────────────────────────────────────────────
121
-
122
- interface SettingsOverlayDeps {
123
- ctx: ExtensionContext;
124
- state: OverlayState;
125
- container: Container;
126
- settingsList: SettingsList | null;
127
- tui: Parameters<Parameters<ExtensionContext["ui"]["custom"]>[0]>[0];
128
- theme: Parameters<Parameters<ExtensionContext["ui"]["custom"]>[0]>[1];
129
- done: () => void;
130
- }
131
-
132
- function createSettingsList(deps: SettingsOverlayDeps): SettingsList {
133
- const sections = getRegisteredSettings();
134
- const items = buildFlatItems(sections, deps.state.scope, deps.state.cwd, deps.ctx);
135
- const onChange = (flatId: string, newValue: string) => {
136
- const found = findSectionAndId(sections, flatId);
137
- if (found) {
138
- found.section.persistChange(
139
- deps.state.scope,
140
- deps.state.cwd,
141
- found.itemId,
142
- newValue,
143
- deps.ctx,
144
- );
145
- }
146
- // Re-read all values to reflect persisted changes, but keep the list
147
- // instance (and its selectedIndex) intact.
148
- const updatedItems = buildFlatItems(sections, deps.state.scope, deps.state.cwd, deps.ctx);
149
- for (const updated of updatedItems) {
150
- const existing = items.find((i) => i.id === updated.id);
151
- if (existing && existing.currentValue !== updated.currentValue) {
152
- settingsList.updateValue(updated.id, updated.currentValue);
153
- }
154
- }
155
- deps.tui.requestRender();
156
- };
157
- const settingsList = new SettingsList(
158
- items,
159
- Math.min(items.length + 4, 20),
160
- getSettingsListTheme(),
161
- onChange,
162
- () => deps.done(),
163
- { enableSearch: true },
164
- );
165
- return settingsList;
166
- }
167
-
168
- function rebuildSettingsList(deps: SettingsOverlayDeps): SettingsList {
169
- const settingsList = createSettingsList(deps);
170
- deps.settingsList = settingsList;
171
-
172
- deps.container.clear();
173
- deps.container.addChild(createHeaderComponent(deps));
174
- deps.container.addChild(settingsList);
175
-
176
- return settingsList;
177
- }
178
-
179
- function createHeaderComponent(deps: SettingsOverlayDeps): Text {
180
- const { theme, state } = deps;
181
- const scopeLabel = getScopeLabel(state.scope);
182
- const otherScope = state.scope === "project" ? "Global" : "Project";
183
- const headerText = new Text(
184
- `${theme.fg("accent", theme.bold("SuPi Settings"))} ${theme.fg("text", `Scope: ${scopeLabel}`)} ${theme.fg("dim", `(tab → ${otherScope})`)}`,
185
- 0,
186
- 0,
187
- );
188
- return headerText;
189
- }
190
-
191
- function handleScopeToggle(deps: SettingsOverlayDeps): void {
192
- deps.state.scope = deps.state.scope === "project" ? "global" : "project";
193
- rebuildSettingsList(deps);
194
- deps.tui.requestRender();
195
- }
196
-
197
- /** Minimal SelectList theme — uses identity so the parent SettingsList provides styling context. */
198
- const PASSTHROUGH_THEME: SelectListTheme = {
199
- selectedPrefix: (text) => `› ${text}`,
200
- selectedText: (text) => text,
201
- description: (text) => text,
202
- scrollInfo: (text) => text,
203
- noMatch: (text) => text,
204
- };
205
-
206
- /**
207
- * Create a model picker submenu for settings.
208
- *
209
- * Shows a scrollable list of selectable models from the scoped model set,
210
- * with the current session model annotated `[current]`. The first entry is
211
- * always `"disabled"`.
212
- *
213
- * @param currentValue - Currently configured canonical model id or `"disabled"`.
214
- * @param done - Callback invoked with the selected value, or undefined on cancel.
215
- * @param ctx - Extension context for model listing. When undefined, only
216
- * `"disabled"` is offered.
217
- */
218
- export function createModelPickerSubmenu(
219
- currentValue: string,
220
- done: (selectedValue?: string) => void,
221
- ctx?: ExtensionContext,
222
- ): {
223
- render: (width: number) => string[];
224
- invalidate: () => void;
225
- handleInput: (data: string) => boolean;
226
- } {
227
- const items = buildModelItems(ctx);
228
-
229
- const initialIndex =
230
- currentValue === "disabled"
231
- ? 0
232
- : Math.max(
233
- 0,
234
- items.findIndex((item) => item.value === currentValue),
235
- );
236
-
237
- const container = new Container();
238
- container.addChild(new Text(" Select suggestion model", 1, 0));
239
- container.addChild(new Text("", 1, 0));
240
-
241
- const selectList = new SelectList(items, Math.min(items.length, 15), PASSTHROUGH_THEME);
242
-
243
- if (initialIndex >= 0) {
244
- selectList.setSelectedIndex(initialIndex);
245
- }
246
-
247
- selectList.onSelect = (item) => done(item.value);
248
- selectList.onCancel = () => done();
249
-
250
- container.addChild(selectList);
251
- container.addChild(new Text(" ↑↓ navigate • enter select • esc cancel", 1, 0));
252
-
253
- return {
254
- render: (width: number) => container.render(width),
255
- invalidate: () => container.invalidate(),
256
- handleInput: (data: string) => {
257
- selectList.handleInput(data);
258
- return true;
259
- },
260
- };
35
+ function collectSettingsSections(pi: ExtensionAPI) {
36
+ const collector = createSettingsContributionCollector();
37
+ pi.events.emit(SUPI_SETTINGS_COLLECT_EVENT, collector);
38
+ return collector.result();
261
39
  }
262
40
 
263
- /** Build selectable model items with "disabled" first. */
264
- function buildModelItems(ctx?: ExtensionContext): SelectItem[] {
265
- const items: SelectItem[] = [
266
- {
267
- value: "disabled",
268
- label: "disabled",
269
- description: "No prompt suggestions",
270
- },
271
- ];
272
-
273
- if (!ctx) return items;
274
-
275
- const models = getSelectableModels(ctx);
276
-
277
- for (const model of models) {
278
- const suffix = model.isCurrent ? " [current]" : "";
279
- items.push({
280
- value: model.canonicalId,
281
- label: `${model.canonicalId}${suffix}`,
282
- description: model.label !== model.canonicalId ? model.label : undefined,
283
- });
284
- }
285
-
286
- return items;
41
+ function latestStatus(diagnostics: SettingsCollectionDiagnostic[]): OverlayStatus | undefined {
42
+ const latest = diagnostics.at(-1);
43
+ return latest ? { kind: latest.kind, message: latest.message } : undefined;
287
44
  }
288
45
 
289
- // ── Entry point ──────────────────────────────────────────────
290
-
291
- export function openSettingsOverlay(ctx: ExtensionContext): void {
292
- const sections = getRegisteredSettings();
293
- if (sections.length === 0) {
46
+ export function openSettingsOverlay(pi: ExtensionAPI, ctx: ExtensionContext): void {
47
+ const collection = collectSettingsSections(pi);
48
+ if (collection.sections.length === 0) {
294
49
  ctx.ui.notify("No settings registered by SuPi extensions", "info");
295
50
  return;
296
51
  }
297
52
 
298
53
  void ctx.ui.custom<void>((tui, theme, _kb, done) => {
299
- const state: OverlayState = { scope: "project", cwd: ctx.cwd };
300
- const container = new Container();
54
+ const state: OverlayState = {
55
+ scope: "project",
56
+ cwd: ctx.cwd,
57
+ status: latestStatus(collection.diagnostics),
58
+ };
301
59
 
302
- const deps: SettingsOverlayDeps = {
60
+ const container = new Container();
61
+ const scopedList = new ScopedSettingsList(
62
+ collection.sections,
63
+ state.scope,
64
+ state.cwd,
303
65
  ctx,
304
- state,
305
- container,
306
- settingsList: null,
307
- tui,
308
66
  theme,
67
+ tui,
309
68
  done,
69
+ (message) => {
70
+ state.status = { kind: "error", message };
71
+ rebuildOverlay();
72
+ tui.requestRender();
73
+ },
74
+ );
75
+ scopedList.enableSearch();
76
+
77
+ const rebuildOverlay = () => {
78
+ container.clear();
79
+ const scopeLabel = getScopeLabel(state.scope);
80
+ const otherScope = state.scope === "project" ? "Global" : "Project";
81
+ container.addChild(
82
+ new Text(
83
+ `${theme.fg("accent", theme.bold("SuPi Settings"))} ${theme.fg("text", `Scope: ${scopeLabel}`)} ${theme.fg("dim", `(tab → ${otherScope})`)}`,
84
+ 0,
85
+ 0,
86
+ ),
87
+ );
88
+ if (state.status) {
89
+ container.addChild(new Text(theme.fg(state.status.kind, state.status.message), 0, 0));
90
+ }
310
91
  };
311
92
 
312
- rebuildSettingsList(deps);
93
+ rebuildOverlay();
313
94
 
314
95
  const component = {
315
- render: (width: number) => container.render(width),
316
- invalidate: () => container.invalidate(),
96
+ render: (width: number) => [...container.render(width), ...scopedList.render(width)],
97
+ invalidate: () => {
98
+ container.invalidate();
99
+ scopedList.invalidate();
100
+ },
317
101
  handleInput: (data: string) => {
318
102
  if (matchesKey(data, Key.tab)) {
319
- handleScopeToggle(deps);
103
+ state.scope = state.scope === "project" ? "global" : "project";
104
+ state.status = undefined;
105
+ scopedList.reload(state.scope, state.cwd, ctx);
106
+ rebuildOverlay();
107
+ tui.requestRender();
320
108
  return true;
321
109
  }
322
- // Delegate input to the settings list (always set after rebuildSettingsList)
323
- deps.settingsList?.handleInput?.(data);
324
- deps.tui.requestRender();
110
+ scopedList.handleInput(data);
111
+ tui.requestRender();
325
112
  return true;
326
113
  },
327
114
  };
@@ -1,6 +1,3 @@
1
1
  // supi-core settings-ui domain — settings TUI components (imports pi-tui at runtime, heavy).
2
- export {
3
- createInputSubmenu,
4
- createModelPickerSubmenu,
5
- openSettingsOverlay,
6
- } from "./settings/settings-ui.ts";
2
+ export { createInputSubmenu, createModelPickerSubmenu } from "./settings/settings-submenus.ts";
3
+ export { openSettingsOverlay } from "./settings/settings-ui.ts";
@@ -1,9 +1,31 @@
1
- // supi-core settings domain — settings registry (lightweight, type-only pi-tui import).
1
+ // supi-core settings domain — event-backed declarative settings contributions and command wiring.
2
2
 
3
3
  export { registerSettingsCommand } from "./settings/settings-command.ts";
4
- export type { SettingsScope, SettingsSection } from "./settings/settings-registry.ts";
4
+ export type {
5
+ SettingsCollectionDiagnostic,
6
+ SettingsCollectionResult,
7
+ SettingsContributionCollector,
8
+ SettingsScope,
9
+ SettingsSection,
10
+ } from "./settings/settings-registry.ts";
5
11
  export {
6
- clearRegisteredSettings,
7
- getRegisteredSettings,
8
- registerSettings,
12
+ createSettingsContributionCollector,
13
+ isSettingsContributionCollector,
14
+ SUPI_SETTINGS_COLLECT_EVENT,
9
15
  } from "./settings/settings-registry.ts";
16
+ export type {
17
+ BoolField,
18
+ ConfigHelpers,
19
+ CustomField,
20
+ DeclarativeSettingsOptions,
21
+ EnumField,
22
+ ModelPickerField,
23
+ NumberField,
24
+ ScopedFieldValue,
25
+ SettingsField,
26
+ SettingsFieldAction,
27
+ SettingsPersistedChange,
28
+ StringListField,
29
+ ValueSource,
30
+ } from "./settings/settings-schema.ts";
31
+ export { registerDeclarativeSettings } from "./settings/settings-schema.ts";
@@ -53,6 +53,16 @@ export function derivePromptSurface(spec: SuiPiToolSpec): SuiPiToolPromptSurface
53
53
  };
54
54
  }
55
55
 
56
+ // Re-export prompt-surface types (implemented in config/prompt-surface.ts)
57
+ export {
58
+ notifyToolPromptSurfaceDiagnostics,
59
+ type ResolveToolPromptSurfaceOptions,
60
+ type ResolveToolPromptSurfaceResult,
61
+ resolveToolPromptSurface,
62
+ type ToolPromptSurfaceDiagnostic,
63
+ type ToolPromptSurfaceDiagnosticCode,
64
+ } from "./config/prompt-surface.ts";
65
+
56
66
  // ---------------------------------------------------------------------------
57
67
  // Registration
58
68
  // ---------------------------------------------------------------------------
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mrclrchtr/supi-lsp",
3
- "version": "2.0.6",
3
+ "version": "2.2.0",
4
4
  "description": "SuPi LSP extension — Language Server Protocol integration for pi",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -38,8 +38,8 @@
38
38
  "vscode-jsonrpc": "^9.0.0",
39
39
  "vscode-languageserver-protocol": "^3.17.5",
40
40
  "vscode-languageserver-types": "^3.17.5",
41
- "@mrclrchtr/supi-core": "2.0.6",
42
- "@mrclrchtr/supi-code-runtime": "2.0.6"
41
+ "@mrclrchtr/supi-code-runtime": "2.2.0",
42
+ "@mrclrchtr/supi-core": "2.2.0"
43
43
  },
44
44
  "bundledDependencies": [
45
45
  "@mrclrchtr/supi-code-runtime",
@@ -8,7 +8,7 @@ import { loadSupiConfig, loadSupiConfigForScope } from "@mrclrchtr/supi-core/con
8
8
 
9
9
  // ── Types ────────────────────────────────────────────────────
10
10
 
11
- export interface LspSettings {
11
+ export interface LspSettings extends Record<string, unknown> {
12
12
  enabled: boolean;
13
13
  severity: number;
14
14
  active: string[];
@@ -1,188 +0,0 @@
1
- // Config-aware settings helper for SuPi config-backed settings sections.
2
- // Wraps registerSettings() and centralizes selected-scope loading + scoped persistence.
3
- //
4
- // Setting items can declare a `configType` ("boolean" | "number" | "stringList")
5
- // to enable auto-generated persistChange. When all items have a configType,
6
- // the persistChange callback can be omitted.
7
-
8
- import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
9
- import type { SettingItem } from "@earendil-works/pi-tui";
10
- import type { SettingsScope } from "../settings/settings-registry.ts";
11
- import { registerSettings } from "../settings/settings-registry.ts";
12
- import { loadSupiConfigForScope, removeSupiConfigKey, writeSupiConfig } from "./config.ts";
13
-
14
- // ── Types ──────────────────────────────────────────────────────────────────
15
-
16
- /**
17
- * Supported config value types for declarative persistChange.
18
- *
19
- * - `"boolean"`: maps "on" → true, "off" → false
20
- * - `"number"`: parses integer via Number.parseInt, falls back to unset on invalid
21
- * - `"stringList"`: splits on comma, trims whitespace, unsets on empty
22
- */
23
- export type ConfigSettingType = "boolean" | "number" | "stringList";
24
-
25
- /**
26
- * Extended setting item that can declare its config type for auto-generated
27
- * persistence handling.
28
- */
29
- export interface ConfigSettingItem extends SettingItem {
30
- /**
31
- * When set, persistChange for this item is auto-generated.
32
- * All items must declare a configType for auto-generation to activate.
33
- */
34
- configType?: ConfigSettingType;
35
- }
36
-
37
- /**
38
- * Helpers provided to the persistChange callback for writing or removing
39
- * scoped config values.
40
- */
41
- export interface ConfigSettingsHelpers {
42
- /** Write a key to the selected scope's config section. */
43
- set(key: string, value: unknown): void;
44
- /** Remove a key from the selected scope's config section. */
45
- unset(key: string): void;
46
- }
47
-
48
- export interface ConfigSettingsOptions<T> {
49
- /** Extension identifier — e.g. "lsp", "claude-md" */
50
- id: string;
51
- /** Human-readable label shown in the UI */
52
- label: string;
53
- /** SuPi config section name — e.g. "lsp", "claude-md" */
54
- section: string;
55
- /** Default config values */
56
- defaults: T;
57
- /**
58
- * Build SettingItem[] from scoped config. Called by loadValues.
59
- *
60
- * Items can include a `configType` property for auto-generated
61
- * persistChange handling. When ALL items declare a configType,
62
- * the `persistChange` callback can be omitted.
63
- */
64
- buildItems: (
65
- settings: T,
66
- scope: SettingsScope,
67
- cwd: string,
68
- ctx?: ExtensionContext,
69
- ) => ConfigSettingItem[];
70
- /**
71
- * Handle a settings change with scoped persistence helpers.
72
- *
73
- * Optional when all items returned by `buildItems` declare a `configType`.
74
- * Required when any item lacks a `configType`.
75
- */
76
- persistChange?: (
77
- scope: SettingsScope,
78
- cwd: string,
79
- settingId: string,
80
- value: string,
81
- helpers: ConfigSettingsHelpers,
82
- ) => void;
83
- /** Optional home directory for config resolution (testing). */
84
- homeDir?: string;
85
- }
86
-
87
- // ── Auto-generated persistChange ───────────────────────────────────────────
88
-
89
- function autoPersistChange(
90
- settingId: string,
91
- value: string,
92
- helpers: ConfigSettingsHelpers,
93
- items: ConfigSettingItem[],
94
- ): void {
95
- const item = items.find((i) => i.id === settingId);
96
- if (!item?.configType) return;
97
-
98
- switch (item.configType) {
99
- case "boolean": {
100
- helpers.set(settingId, value === "on");
101
- break;
102
- }
103
- case "number": {
104
- const num = Number.parseInt(value, 10);
105
- if (Number.isFinite(num) && num > 0) {
106
- helpers.set(settingId, num);
107
- } else {
108
- helpers.unset(settingId);
109
- }
110
- break;
111
- }
112
- case "stringList": {
113
- const names = value
114
- .split(",")
115
- .map((s) => s.trim())
116
- .filter((s) => s.length > 0);
117
- if (names.length > 0) {
118
- helpers.set(settingId, names);
119
- } else {
120
- helpers.unset(settingId);
121
- }
122
- break;
123
- }
124
- }
125
- }
126
-
127
- function areAllItemsDeclarative(items: ConfigSettingItem[]): boolean {
128
- return items.length > 0 && items.every((i) => i.configType !== undefined);
129
- }
130
-
131
- // ── Registration ───────────────────────────────────────────────────────────
132
-
133
- /**
134
- * Register a config-backed settings section.
135
- *
136
- * Loads display values from the selected scope only (`defaults <- selected scope`)
137
- * instead of merged effective runtime config. Provides scoped `set` / `unset`
138
- * persistence helpers so extensions don't need to wire `writeSupiConfig` /
139
- * `removeSupiConfigKey` by hand.
140
- *
141
- * When every item returned by `buildItems` declares a `configType`, the
142
- * `persistChange` callback is optional and will be auto-generated.
143
- */
144
- export function registerConfigSettings<T>(options: ConfigSettingsOptions<T>): void {
145
- let cachedItems: ConfigSettingItem[] | undefined;
146
-
147
- registerSettings({
148
- id: options.id,
149
- label: options.label,
150
- loadValues: (scope, cwd, ctx) => {
151
- const settings = loadSupiConfigForScope(options.section, cwd, options.defaults, {
152
- scope,
153
- homeDir: options.homeDir,
154
- });
155
- const items = options.buildItems(settings, scope, cwd, ctx);
156
- cachedItems = items;
157
- return items;
158
- },
159
- persistChange: (scope, cwd, settingId, value) => {
160
- const helpers: ConfigSettingsHelpers = {
161
- set: (key, val) => {
162
- writeSupiConfig(
163
- { section: options.section, scope, cwd },
164
- { [key]: val },
165
- { homeDir: options.homeDir },
166
- );
167
- },
168
- unset: (key) => {
169
- removeSupiConfigKey({ section: options.section, scope, cwd }, key, {
170
- homeDir: options.homeDir,
171
- });
172
- },
173
- };
174
-
175
- // Use manual persistChange when provided
176
- if (options.persistChange) {
177
- options.persistChange(scope, cwd, settingId, value, helpers);
178
- return;
179
- }
180
-
181
- // Auto-generate when all items are declarative
182
- const items = cachedItems ?? options.buildItems(options.defaults, scope, cwd, undefined);
183
- if (areAllItemsDeclarative(items)) {
184
- autoPersistChange(settingId, value, helpers, items);
185
- }
186
- },
187
- });
188
- }