pi-compact-tools 0.3.3 → 0.4.0

package/README.md

@@ -12,27 +12,28 @@ The recordings below use the optional [Nerd Font](#nerd-font-preset) preset. **T
 
 Active, successful, and failed tool calls stay compact while preserving useful status and timing information.
 
-![Compact tool workflow with Nerd Font](https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/nerd-font-workflow.gif)
+![Compact tool workflow with Nerd Font](https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/nerd-font-workflow-optimized.gif)
 
 ### Spinner and duration indicators
 
 The spinner animates during execution, then changes to a duration-aware completion icon.
 
-![Spinner and duration indicators](https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/spinner-duration.gif)
+![Spinner and duration indicators](https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/spinner-duration-optimized.gif)
 
-### Expandable edit diffs
+### Initially visible edit diffs
 
-Click a completed `edit` row, or press `Ctrl+O`, to reveal and collapse its diff.
+Completed `edit` rows show their full diff initially by default. The per-tool `auto_compact` setting controls which tools start in their compact summary state without disabling click or `Ctrl+O` interaction.
 
-![Expandable edit diff](https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/edit-diff.gif)
+![Edit diff](https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/edit-diff.gif)
 
 ## Features
 
 - Compact rendering for `read`, `write`, `edit`, `bash`, `powershell`, `grep`, `find`, and `ls`
 - Animated configurable spinner in fullscreen TUI mode
 - Millisecond-precision duration and configurable completion icons
-- Click or `Ctrl+O` to cycle through meaningful detail levels
-- Short previews, full output, and clean edit diffs
+- Per-tool initial compaction with `auto_compact: true` or `false`
+- Click or `Ctrl+O` always cycles through meaningful detail levels
+- Short previews, full output, and initially visible edit diffs by default
 - Dark `│` and `└─` visual grouping
 - Windows, Unix, and classic Mac line-ending support
 - No Nerd Font requirement
@@ -78,6 +79,12 @@ Default configuration:
 {
   "$schema": "https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/schemas/compact-tools.schema.json",
   "tools": ["read", "write", "edit", "bash"],
+  "auto_compact": {
+    "read": true,
+    "write": true,
+    "edit": false,
+    "bash": true
+  },
   "previewLines": 10,
   "spinner": {
     "frames": ["◐", "◓", "◑", "◒"],
@@ -94,6 +101,14 @@ Default configuration:
 
 These defaults use emoji and standard Unicode, so they work without a Nerd Font. Fast tools finish immediately; no artificial spinner delay is added.
 
+`auto_compact` controls each tool's initial state independently:
+
+- `true` starts at the compact summary.
+- `false` starts at the most detailed available level.
+- Click or `Ctrl+O` continues to cycle through available levels in either case.
+
+Unspecified entries inherit the previous configuration layer. By default, `read`, `write`, and `bash` start compact, while `edit` starts expanded so code diffs are immediately visible.
+
 `durationIndicators` must have ascending `underMs` values, with a final fallback entry that omits `underMs`. `color` is optional and accepts a supported theme color or six-digit hex value. Existing icon-only configurations remain compatible.
 
 To enable all Unix-compatible tools:
@@ -138,11 +153,7 @@ The escaped code points remain readable on GitHub and are decoded to Nerd Font i
 summary → arguments → output preview → full output → summary
 ```
 
-For `edit`:
-
-```text
-summary → diff → summary
-```
+The `auto_compact` boolean only chooses where that cycle starts. With the default `edit: false`, the diff starts visible and the next click collapses it.
 
 ## Notes
 

package/examples/compact-tools.json

@@ -1,6 +1,12 @@
 {
   "$schema": "https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/schemas/compact-tools.schema.json",
   "tools": ["read", "write", "edit", "bash", "grep", "find", "ls"],
+  "auto_compact": {
+    "read": true,
+    "write": true,
+    "edit": false,
+    "bash": true
+  },
   "previewLines": 10,
   "spinner": {
     "frames": ["◐", "◓", "◑", "◒"],

package/extensions/compact-tools.ts

@@ -47,6 +47,7 @@ type CompactToolName = (typeof SUPPORTED_TOOLS)[number];
 
 export interface CompactToolsConfig {
 	tools: CompactToolName[];
+	auto_compact: Record<CompactToolName, boolean>;
 	previewLines: number;
 	spinner: {
 		frames: string[];
@@ -57,6 +58,16 @@ export interface CompactToolsConfig {
 
 export const DEFAULT_CONFIG: CompactToolsConfig = {
 	tools: ["read", "write", "edit", "bash"],
+	auto_compact: {
+		read: true,
+		write: true,
+		edit: false,
+		bash: true,
+		powershell: true,
+		grep: true,
+		find: true,
+		ls: true,
+	},
 	previewLines: 10,
 	spinner: {
 		frames: ["◐", "◓", "◑", "◒"],
@@ -122,6 +133,31 @@ function parseTools(value: unknown, path: string): CompactToolName[] | undefined
 	return [...new Set(valid)];
 }
 
+function parseAutoCompact(
+	base: CompactToolsConfig["auto_compact"],
+	value: unknown,
+	path: string,
+): CompactToolsConfig["auto_compact"] {
+	if (value === undefined) return base;
+	if (!isObject(value)) {
+		warnConfig(path, "auto_compact must be an object; using previous values");
+		return base;
+	}
+	const autoCompact = { ...base };
+	for (const [name, enabled] of Object.entries(value)) {
+		if (!SUPPORTED_TOOL_SET.has(name)) {
+			warnConfig(path, `ignoring unsupported auto_compact tool: ${name}`);
+			continue;
+		}
+		if (typeof enabled !== "boolean") {
+			warnConfig(path, `auto_compact.${name} must be true or false; using previous value`);
+			continue;
+		}
+		autoCompact[name as CompactToolName] = enabled;
+	}
+	return autoCompact;
+}
+
 function mergeConfig(base: CompactToolsConfig, value: unknown, path: string): CompactToolsConfig {
 	if (value === undefined) return base;
 	if (!isObject(value)) {
@@ -129,6 +165,7 @@ function mergeConfig(base: CompactToolsConfig, value: unknown, path: string): Co
 		return base;
 	}
 	const tools = value.tools === undefined ? base.tools : (parseTools(value.tools, path) ?? base.tools);
+	const auto_compact = parseAutoCompact(base.auto_compact, value.auto_compact, path);
 	const previewValue = value.previewLines;
 	const validPreviewLines = isIntegerInRange(previewValue, 1, 1_000);
 	const previewLines = validPreviewLines ? previewValue : base.previewLines;
@@ -140,7 +177,7 @@ function mergeConfig(base: CompactToolsConfig, value: unknown, path: string): Co
 	if (value.durationIndicators !== undefined && durationIndicators === base.durationIndicators) {
 		warnConfig(path, "invalid durationIndicators; using previous values");
 	}
-	return { tools, previewLines, spinner, durationIndicators };
+	return { tools, auto_compact, previewLines, spinner, durationIndicators };
 }
 
 function parseSpinnerConfig(
@@ -216,8 +253,8 @@ const executionTimings = globalState[EXECUTION_TIMINGS_KEY] ?? new Map<string, E
 globalState[SPINNING_ROWS_KEY] = spinningRows;
 globalState[EXECUTION_TIMINGS_KEY] = executionTimings;
 
-function advanceLevel(state: RowState, expanded: boolean): number {
-	state.level ??= 0;
+function advanceLevel(state: RowState, expanded: boolean, name: CompactToolName): number {
+	state.level ??= config.auto_compact[name] ? 0 : (state.availableLevels?.at(-1) ?? MAX_LEVEL);
 	if (state.lastExpanded === undefined) {
 		state.lastExpanded = expanded;
 		return state.level;
@@ -231,9 +268,13 @@ function advanceLevel(state: RowState, expanded: boolean): number {
 	return state.level;
 }
 
-function setAvailableLevels(state: RowState, levels: number[]): void {
+function setAvailableLevels(state: RowState, levels: number[], name: CompactToolName): void {
 	state.availableLevels = levels;
-	if (!levels.includes(state.level ?? 0)) state.level = 0;
+	if (state.level === undefined) {
+		state.level = config.auto_compact[name] ? 0 : (levels.at(-1) ?? 0);
+	} else if (!levels.includes(state.level)) {
+		state.level = !config.auto_compact[name] && state.level === MAX_LEVEL ? (levels.at(-1) ?? 0) : 0;
+	}
 }
 
 function getOutputLevels(output: string): number[] {
@@ -509,7 +550,7 @@ function renderFileCall(
 	// syncRow may restore a completed timing after /reload. Recompute from the
 	// synchronized state so a stale local value cannot leave the spinner visible.
 	const status = resolveCallStatus(ctx, state);
-	const level = advanceLevel(state, ctx.expanded);
+	const level = advanceLevel(state, ctx.expanded, definition.name as CompactToolName);
 	const callDetails = getCallDetails(definition.name, args);
 	const argumentDetails = getFileArgumentDetails(definition.name, args);
 	let text = `${renderIndicator(theme, state, status)} `;
@@ -554,8 +595,8 @@ function renderFileResult(
 	const state = syncRow(ctx, options.isPartial, !options.isPartial);
 	const output = getFileOutput(definition.name, ctx.args, result, ctx.isError);
 	const hasArguments = Object.keys(getFileArgumentDetails(definition.name, ctx.args)).length > 0;
-	const levels = definition.name === "edit" ? [0, 2] : [0, ...(hasArguments ? [1] : []), ...getOutputLevels(output)];
-	setAvailableLevels(state, levels);
+	const levels = definition.name === "edit" ? [0, MAX_LEVEL] : [0, ...(hasArguments ? [1] : []), ...getOutputLevels(output)];
+	setAvailableLevels(state, levels, definition.name as CompactToolName);
 
 	const level = state.level ?? 0;
 	callOriginalEditResult(definition, result, options, theme, ctx, state, level);
@@ -614,7 +655,7 @@ function renderShellCall(
 	// A completed timing can be restored inside syncRow. Derive the rendered
 	// status afterward so completion immediately replaces the spinner.
 	const status = resolveCallStatus(ctx, state);
-	const level = advanceLevel(state, ctx.expanded);
+	const level = advanceLevel(state, ctx.expanded, name);
 	const command = normalizeLineEndings(args.command ?? "");
 	const displayedCommand = (level >= 1 ? command : firstLine(command)) || "…";
 	let text = `${renderIndicator(theme, state, status)} `;
@@ -623,6 +664,7 @@ function renderShellCall(
 }
 
 function renderShellResult(
+	name: "bash" | "powershell",
 	result: AgentToolResult<BashToolDetails | undefined>,
 	options: ToolRenderResultOptions,
 	theme: Theme,
@@ -631,7 +673,7 @@ function renderShellResult(
 	const state = syncRow(ctx, options.isPartial, !options.isPartial);
 	const output = getTextResult(result);
 	const hasDetailedCall = /\r\n?|\n/.test(ctx.args.command ?? "");
-	setAvailableLevels(state, [0, ...(hasDetailedCall ? [1] : []), ...getOutputLevels(output)]);
+	setAvailableLevels(state, [0, ...(hasDetailedCall ? [1] : []), ...getOutputLevels(output)], name);
 	const level = state.level ?? 0;
 	if (level < 2) return renderControls(theme, state, options.isPartial, ctx.isError);
 
@@ -667,7 +709,12 @@ function registerShellTool(pi: ExtensionAPI, definition: BuiltInDefinition): voi
 		renderShell: "self",
 		renderCall: (args: BashToolInput, theme: Theme, ctx: RenderContext<BashToolInput>) =>
 			renderShellCall(definition.name as "bash" | "powershell", args, theme, ctx),
-		renderResult: renderShellResult,
+		renderResult: (
+			result: AgentToolResult<BashToolDetails | undefined>,
+			options: ToolRenderResultOptions,
+			theme: Theme,
+			ctx: RenderContext<BashToolInput>,
+		) => renderShellResult(definition.name as "bash" | "powershell", result, options, theme, ctx),
 	} as ToolDefinition<any, BashToolDetails | undefined, RowState>);
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-compact-tools",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "description": "Compact, expandable UI for pi's built-in tools, bundled with a polished GitHub Dark theme.",
   "type": "module",
   "license": "MIT",
@@ -42,7 +42,7 @@
     "themes": [
       "./themes/github-dark-pro.json"
     ],
-    "image": "https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/nerd-font-workflow.gif"
+    "image": "https://raw.githubusercontent.com/nedleeds/pi-compact-tools/main/assets/nerd-font-workflow-optimized.gif"
   },
   "peerDependencies": {
     "@earendil-works/pi-coding-agent": "*",

package/schemas/compact-tools.schema.json

@@ -18,6 +18,27 @@
       },
       "default": ["read", "write", "edit", "bash"]
     },
+    "auto_compact": {
+      "description": "Whether each compact-rendered tool starts in its compact summary state. Click/Ctrl+O remains available regardless of this value.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "read": { "type": "boolean", "default": true },
+        "write": { "type": "boolean", "default": true },
+        "edit": { "type": "boolean", "default": false },
+        "bash": { "type": "boolean", "default": true },
+        "powershell": { "type": "boolean", "default": true },
+        "grep": { "type": "boolean", "default": true },
+        "find": { "type": "boolean", "default": true },
+        "ls": { "type": "boolean", "default": true }
+      },
+      "default": {
+        "read": true,
+        "write": true,
+        "edit": false,
+        "bash": true
+      }
+    },
     "previewLines": {
       "description": "Number of output lines shown before the full-output expansion level.",
       "type": "integer",

package/scripts/check-resources.mjs

@@ -32,6 +32,12 @@ if (!Array.isArray(example.spinner?.frames) || example.spinner.frames.length ===
 if (!Number.isInteger(example.spinner.intervalMs)) {
   throw new Error("example spinner.intervalMs must be an integer");
 }
+if (!example.auto_compact || example.auto_compact.edit !== false) {
+  throw new Error("example auto_compact policy must keep edit diffs visible by default");
+}
+if (Object.values(example.auto_compact).some((enabled) => typeof enabled !== "boolean")) {
+  throw new Error("example auto_compact values must be booleans");
+}
 const indicators = example.durationIndicators;
 if (!Array.isArray(indicators) || indicators.length === 0 || indicators.at(-1)?.underMs !== undefined) {
   throw new Error("example durationIndicators must end with a fallback rule");
@@ -51,5 +57,8 @@ const schema = JSON.parse(
 if (!schema.properties?.durationIndicators?.items?.properties?.color) {
   throw new Error("schema must describe durationIndicators.color");
 }
+if (!schema.properties?.auto_compact?.properties?.edit) {
+  throw new Error("schema must describe per-tool auto_compact policies");
+}
 
 console.log("Resource checks passed");