@mrclrchtr/supi-extras 4.7.0 → 4.8.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 (25) hide show
  1. package/README.md +1 -5
  2. package/node_modules/@mrclrchtr/supi-core/README.md +26 -34
  3. package/node_modules/@mrclrchtr/supi-core/package.json +4 -7
  4. package/node_modules/@mrclrchtr/supi-core/src/api.ts +4 -6
  5. package/node_modules/@mrclrchtr/supi-core/src/config/config.ts +0 -20
  6. package/node_modules/@mrclrchtr/supi-core/src/config/prompt-surface.ts +7 -1
  7. package/node_modules/@mrclrchtr/supi-core/src/config.ts +0 -1
  8. package/node_modules/@mrclrchtr/supi-core/src/context.ts +1 -9
  9. package/node_modules/@mrclrchtr/supi-core/src/index.ts +4 -6
  10. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-registry.ts +54 -28
  11. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-schema.ts +91 -125
  12. package/node_modules/@mrclrchtr/supi-core/src/settings.ts +10 -7
  13. package/package.json +2 -4
  14. package/src/index.ts +0 -2
  15. package/node_modules/@mrclrchtr/supi-core/src/context/context-messages.ts +0 -119
  16. package/node_modules/@mrclrchtr/supi-core/src/progress-widget.ts +0 -189
  17. package/node_modules/@mrclrchtr/supi-core/src/settings/scoped-settings-list.ts +0 -373
  18. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-action-menu.ts +0 -102
  19. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-command.ts +0 -15
  20. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-submenus.ts +0 -141
  21. package/node_modules/@mrclrchtr/supi-core/src/settings/settings-ui.ts +0 -118
  22. package/node_modules/@mrclrchtr/supi-core/src/settings-ui.ts +0 -3
  23. package/node_modules/@mrclrchtr/supi-core/src/tool-framework.ts +0 -192
  24. package/src/api.ts +0 -1
  25. package/src/skill-shortcut.ts +0 -123
package/README.md CHANGED
@@ -24,7 +24,7 @@ pi install ./packages/supi-extras
24
24
 
25
25
  ## What you get
26
26
 
27
- This package mixes a few commands and shortcuts with a few always-on UI tweaks.
27
+ This package mixes a few commands and shortcuts with a few always-on UI tweaks. Skill controls and `$skill-name` shortcuts live in [`@mrclrchtr/supi-skills`](https://github.com/mrclrchtr/supi/tree/main/packages/supi-skills).
28
28
 
29
29
  ## Commands
30
30
 
@@ -38,9 +38,6 @@ This package mixes a few commands and shortcuts with a few always-on UI tweaks.
38
38
 
39
39
  - `Alt+S` — stash the current editor text
40
40
  - `Alt+C` — copy the current editor text to the system clipboard
41
- - `$skill-name` — input shorthand that expands to `/skill:skill-name`
42
-
43
- The `$skill-name` helper also adds skill-only autocomplete while the cursor is inside a `$...` token.
44
41
 
45
42
  ## Prompt stash
46
43
 
@@ -84,7 +81,6 @@ That prevents git subprocesses from hanging while waiting for an interactive edi
84
81
  - `src/aliases.ts` — command aliases
85
82
  - `src/clone-session.ts` — cross-worktree session cloning by ID
86
83
  - `src/prompt-stash.ts` — prompt stash shortcuts, persistence, and overlay
87
- - `src/skill-shortcut.ts` — `$skill-name` expansion and autocomplete
88
84
  - `src/tab-spinner.ts` — terminal tab-title spinner
89
85
  - `src/copy-prompt.ts` and `src/clipboard.ts` — copy-to-clipboard shortcut and helper
90
86
  - `src/supi-footer.ts` — footer replacement
@@ -37,28 +37,13 @@ Config file locations:
37
37
 
38
38
  ### Settings helpers
39
39
 
40
- - `registerDeclarativeSettings(pi, options)` — contribute a config-backed declarative settings section with source-aware scoped persistence
41
- - `registerSettingsCommand(pi)` — register `/supi-settings` (used by `@mrclrchtr/supi-settings`)
42
- - `openSettingsOverlay(pi, ctx)` open the shared settings UI directly
43
- - `createInputSubmenu()` — helper for simple text-entry submenus
44
- - `createModelPickerSubmenu()` — helper for scoped model selection submenus, with optional host-owned choices and `disabled` control
45
-
46
- The built-in settings UI supports:
47
-
48
- - project/global scope toggle
49
- - source badges for project, global, and default values
50
- - Inherit/Reset actions that delete scoped config keys
51
- - grouped extension sections
52
- - searchable setting lists
40
+ - `registerSettings(pi, module)` — register one canonical asynchronous settings module
41
+ - `defineConfigSettings(options)` — adapt a fixed SuPi config section to that module interface
42
+ - settings registry helpers and types for the `@mrclrchtr/supi-settings` configuration surface
53
43
 
54
44
  ### Context helpers
55
45
 
56
46
  - `wrapExtensionContext()` — wrap injected text in SuPi's `<extension-context>` tag
57
- - `findLastUserMessageIndex()`
58
- - `getContextToken()`
59
- - `getPromptContent()`
60
- - `pruneAndReorderContextMessages()`
61
- - `restorePromptContent()`
62
47
 
63
48
  ### Shared registries
64
49
 
@@ -84,25 +69,33 @@ The built-in settings UI supports:
84
69
 
85
70
  ```ts
86
71
  import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
87
- import { loadSupiConfig, registerDeclarativeSettings, wrapExtensionContext } from "@mrclrchtr/supi-core/api";
72
+ import {
73
+ defineConfigSettings,
74
+ loadSupiConfig,
75
+ registerSettings,
76
+ wrapExtensionContext,
77
+ } from "@mrclrchtr/supi-core/api";
88
78
 
89
79
  export default function myExtension(pi: ExtensionAPI) {
90
80
  const defaults = { enabled: true };
91
81
  const config = loadSupiConfig("my-extension", process.cwd(), defaults);
92
82
 
93
- registerDeclarativeSettings(pi, {
94
- id: "my-extension",
95
- label: "My Extension",
96
- section: "my-extension",
97
- defaults,
98
- fields: [
99
- {
100
- kind: "boolean" as const,
101
- key: "enabled",
102
- label: "Enabled",
103
- },
104
- ],
105
- });
83
+ registerSettings(
84
+ pi,
85
+ defineConfigSettings({
86
+ id: "my-extension",
87
+ label: "My Extension",
88
+ section: "my-extension",
89
+ defaults,
90
+ fields: [
91
+ {
92
+ kind: "boolean" as const,
93
+ key: "enabled",
94
+ label: "Enabled",
95
+ },
96
+ ],
97
+ }),
98
+ );
106
99
 
107
100
  const message = wrapExtensionContext("my-extension", "hello", {
108
101
  enabled: config.enabled,
@@ -115,6 +108,5 @@ export default function myExtension(pi: ExtensionAPI) {
115
108
 
116
109
  - `src/api.ts` — exported library surface
117
110
  - `src/config.ts` — shared config loading and writing
118
- - `src/config-settings.ts`config-backed settings registration helper
119
- - `src/settings-ui.ts` — shared settings overlay
111
+ - `src/settings/` — settings registry, schema, scope resolution, and persistence
120
112
  - `src/report.ts` — shared text/report rendering helpers
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mrclrchtr/supi-core",
3
- "version": "4.7.0",
3
+ "version": "4.8.0",
4
4
  "description": "Shared settings, configuration, reporting, and session infrastructure",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -60,16 +60,13 @@
60
60
  "./model-selection": "./src/model-selection.ts",
61
61
  "./package.json": "./package.json",
62
62
  "./path": "./src/path.ts",
63
- "./report": "./src/report.ts",
64
- "./progress-widget": "./src/progress-widget.ts",
65
63
  "./project": "./src/project.ts",
64
+ "./prompt-surface": "./src/prompt-surface.ts",
65
+ "./report": "./src/report.ts",
66
66
  "./session": "./src/session.ts",
67
67
  "./settings": "./src/settings.ts",
68
- "./settings-ui": "./src/settings-ui.ts",
69
68
  "./spinner-frames": "./src/spinner-frames.ts",
70
69
  "./status-spinner": "./src/status-spinner.ts",
71
- "./terminal": "./src/terminal.ts",
72
- "./tool-framework": "./src/tool-framework.ts",
73
- "./prompt-surface": "./src/prompt-surface.ts"
70
+ "./terminal": "./src/terminal.ts"
74
71
  }
75
72
  }
@@ -1,6 +1,6 @@
1
1
  // supi-core — shared infrastructure for SuPi extensions.
2
- // Provides XML context tag wrapping, unified config system, context-message utilities,
3
- // settings registry for supi-wide TUI settings, and a shared tool-spec/registration framework.
2
+ // Provides XML context tag wrapping, unified config, prompt-surface resolution,
3
+ // and shared settings, reporting, and session utilities.
4
4
  //
5
5
  // Convenience barrel — re-exports all domain entry points.
6
6
  // For lighter imports, use one of the domain subpaths directly
@@ -25,18 +25,16 @@ export * from "./path.ts";
25
25
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
26
26
  export * from "./project.ts";
27
27
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
28
+ export * from "./prompt-surface.ts";
29
+ // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
28
30
  export * from "./report.ts";
29
31
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
30
32
  export * from "./session.ts";
31
33
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
32
34
  export * from "./settings.ts";
33
35
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
34
- export * from "./settings-ui.ts";
35
- // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
36
36
  export * from "./spinner-frames.ts";
37
37
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
38
38
  export * from "./status-spinner.ts";
39
39
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
40
40
  export * from "./terminal.ts";
41
- // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
42
- export * from "./tool-framework.ts";
@@ -199,23 +199,3 @@ function extractSection(
199
199
  }
200
200
  return null;
201
201
  }
202
-
203
- /**
204
- * Shorthand for {@link loadSupiConfig} that infers the return type from defaults.
205
- *
206
- * Reduces boilerplate when a package only needs the merged runtime config.
207
- *
208
- * @example
209
- * ```ts
210
- * const config = loadSectionConfig("my-ext", cwd, { enabled: true, timeout: 30 });
211
- * // config is typed as { enabled: boolean; timeout: number }
212
- * ```
213
- */
214
- export function loadSectionConfig<T extends Record<string, unknown>>(
215
- section: string,
216
- cwd: string,
217
- defaults: T,
218
- options?: SupiConfigOptions,
219
- ): T {
220
- return loadSupiConfig(section, cwd, defaults, options);
221
- }
@@ -8,11 +8,17 @@ import {
8
8
  type ExtensionContext,
9
9
  hasTrustRequiringProjectResources,
10
10
  } from "@earendil-works/pi-coding-agent";
11
- import type { SuiPiToolPromptSurface } from "../tool-framework.ts";
12
11
  import { loadSupiConfigSectionForScope, type SupiConfigOptions } from "./config.ts";
13
12
 
14
13
  // ── Public types ───────────────────────────────────────────────────────────
15
14
 
15
+ /** Model-facing text that PI adds to one registered tool's prompt surface. */
16
+ export interface SuiPiToolPromptSurface {
17
+ description: string;
18
+ promptSnippet: string;
19
+ promptGuidelines: string[];
20
+ }
21
+
16
22
  export type ToolPromptSurfaceDiagnosticCode =
17
23
  | "invalidPromptSurfaceConfig"
18
24
  | "invalidPromptSurfaceField"
@@ -1,7 +1,6 @@
1
1
  // supi-core config domain — config loading.
2
2
  export type { SupiConfigLocation, SupiConfigOptions } from "./config/config.ts";
3
3
  export {
4
- loadSectionConfig,
5
4
  loadSupiConfig,
6
5
  loadSupiConfigForScope,
7
6
  loadSupiConfigSectionForScope,
@@ -1,12 +1,4 @@
1
- // supi-core context domain — context messages, providers, and XML tags.
2
- export type { ContextMessageLike } from "./context/context-messages.ts";
3
- export {
4
- findLastUserMessageIndex,
5
- getContextToken,
6
- getPromptContent,
7
- pruneAndReorderContextMessages,
8
- restorePromptContent,
9
- } from "./context/context-messages.ts";
1
+ // supi-core context domain — context providers and XML tags.
10
2
  export type { ContextProvider } from "./context/context-provider-registry.ts";
11
3
  export {
12
4
  clearRegisteredContextProviders,
@@ -1,6 +1,6 @@
1
1
  // supi-core — shared infrastructure for SuPi extensions.
2
- // Provides XML context tag wrapping, unified config system, context-message utilities,
3
- // settings registry for supi-wide TUI settings, and a shared tool-spec/registration framework.
2
+ // Provides XML context tag wrapping, unified config, prompt-surface resolution,
3
+ // and shared settings, reporting, and session utilities.
4
4
  //
5
5
  // Convenience barrel — re-exports all domain entry points.
6
6
  // For lighter imports, use one of the domain subpaths directly
@@ -21,16 +21,14 @@ export * from "./path.ts";
21
21
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
22
22
  export * from "./project.ts";
23
23
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
24
+ export * from "./prompt-surface.ts";
25
+ // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
24
26
  export * from "./report.ts";
25
27
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
26
28
  export * from "./session.ts";
27
29
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
28
30
  export * from "./settings.ts";
29
31
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
30
- export * from "./settings-ui.ts";
31
- // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
32
32
  export * from "./status-spinner.ts";
33
33
  // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
34
34
  export * from "./terminal.ts";
35
- // biome-ignore lint/performance/noReExportAll: intentional convenience barrel
36
- export * from "./tool-framework.ts";
@@ -1,35 +1,53 @@
1
- // Event-backed settings contribution types for SuPi extensions.
2
- //
3
- // Extensions contribute declarative settings sections through PI's shared
4
- // event bus. The public helper is registerDeclarativeSettings(pi, ...); this module
5
- // owns the internal collector protocol used by /supi-settings.
1
+ // Event-backed settings module registration and collection.
6
2
 
7
- import type { ExtensionContext } from "@earendil-works/pi-coding-agent";
8
- import type { ScopedFieldValue, SettingsFieldAction } from "./settings-schema.ts";
3
+ import type { ExtensionAPI, ExtensionContext } from "@earendil-works/pi-coding-agent";
4
+ import type { ScopedFieldValue, SettingsAction } from "./settings-schema.ts";
9
5
 
10
6
  export const SUPI_SETTINGS_COLLECT_EVENT = "supi:settings:collect";
11
7
 
12
8
  export type SettingsScope = "project" | "global";
13
9
 
14
- export interface SettingsSection {
15
- /** Stable contribution identifier — e.g. "lsp", "claude-md". */
10
+ /** Scope and PI runtime state supplied for each settings read. */
11
+ export interface SettingsContext {
12
+ scope: SettingsScope;
13
+ cwd: string;
14
+ ctx?: ExtensionContext;
15
+ }
16
+
17
+ /** A resolved, source-aware settings view. */
18
+ export interface SettingsSnapshot {
19
+ rows: ScopedFieldValue[];
20
+ }
21
+
22
+ /** One user action routed to its owning settings module. */
23
+ export interface SettingsActionRequest extends SettingsContext {
24
+ fieldKey: string;
25
+ action: SettingsAction;
26
+ }
27
+
28
+ /** Optional user-facing result from a successful settings action. */
29
+ export interface SettingsApplyResult {
30
+ notice?: {
31
+ message: string;
32
+ level: "info" | "warning" | "error";
33
+ };
34
+ }
35
+
36
+ /**
37
+ * Canonical settings interface consumed by `/supi-settings`.
38
+ *
39
+ * Reads are always asynchronous. Apply resolves only after durable writes and
40
+ * module-owned refresh work complete. Implementations throw on failed writes.
41
+ */
42
+ export interface SettingsModule {
16
43
  id: string;
17
- /** Human-readable label shown in the UI. */
18
44
  label: string;
19
- /** Load current ScopedFieldValue[] for the given scope. */
20
- loadValues: (scope: SettingsScope, cwd: string, ctx?: ExtensionContext) => ScopedFieldValue[];
21
- /** Handle a user action on a field in the selected scope. */
22
- handleAction: (
23
- scope: SettingsScope,
24
- cwd: string,
25
- fieldKey: string,
26
- action: SettingsFieldAction,
27
- ctx?: ExtensionContext,
28
- ) => void;
45
+ read(context: SettingsContext): Promise<SettingsSnapshot>;
46
+ apply(request: SettingsActionRequest): Promise<SettingsApplyResult>;
29
47
  }
30
48
 
31
49
  export interface SettingsContributionCollector {
32
- add(section: SettingsSection): void;
50
+ add(module: SettingsModule): void;
33
51
  }
34
52
 
35
53
  export interface SettingsCollectionDiagnostic {
@@ -38,7 +56,7 @@ export interface SettingsCollectionDiagnostic {
38
56
  }
39
57
 
40
58
  export interface SettingsCollectionResult {
41
- sections: SettingsSection[];
59
+ modules: SettingsModule[];
42
60
  diagnostics: SettingsCollectionDiagnostic[];
43
61
  }
44
62
 
@@ -56,21 +74,29 @@ export function isSettingsContributionCollector(
56
74
  export function createSettingsContributionCollector(): SettingsContributionCollector & {
57
75
  result(): SettingsCollectionResult;
58
76
  } {
59
- const sections = new Map<string, SettingsSection>();
77
+ const modules = new Map<string, SettingsModule>();
60
78
  const diagnostics: SettingsCollectionDiagnostic[] = [];
61
79
 
62
80
  return {
63
- add(section: SettingsSection): void {
64
- if (sections.has(section.id)) {
81
+ add(module: SettingsModule): void {
82
+ if (modules.has(module.id)) {
65
83
  diagnostics.push({
66
84
  kind: "warning",
67
- message: `Duplicate SuPi settings contribution "${section.id}"; using the last contribution.`,
85
+ message: `Duplicate SuPi settings contribution "${module.id}"; using the last contribution.`,
68
86
  });
69
87
  }
70
- sections.set(section.id, section);
88
+ modules.set(module.id, module);
71
89
  },
72
90
  result(): SettingsCollectionResult {
73
- return { sections: Array.from(sections.values()), diagnostics: [...diagnostics] };
91
+ return { modules: Array.from(modules.values()), diagnostics: [...diagnostics] };
74
92
  },
75
93
  };
76
94
  }
95
+
96
+ /** Register one settings module during extension factory setup. */
97
+ export function registerSettings(pi: ExtensionAPI, module: SettingsModule): void {
98
+ const dispose = pi.events.on(SUPI_SETTINGS_COLLECT_EVENT, (collector) => {
99
+ if (isSettingsContributionCollector(collector)) collector.add(module);
100
+ });
101
+ pi.on("session_shutdown", () => dispose());
102
+ }