pi-rtk-optimizer 0.5.5 → 0.7.0

package/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2026-04-30
+
+### Added
+- Added opt-in `readCompaction` controls for `read` output so lossy source filtering and smart truncation stay disabled unless explicitly enabled.
+
+### Changed
+- Updated README and example configuration defaults for safer read-compaction behavior and troubleshooting guidance.
+- Updated `@mariozechner/pi-coding-agent` and `@mariozechner/pi-tui` peer dependencies to ^0.70.6.
+
+## [0.6.0] - 2026-04-27
+
+### Changed
+- **Breaking:** Command rewriting now delegates rewrite decisions to the installed `rtk rewrite` command, making RTK the source of truth for command support, shell parsing, bypasses, and compound-command behavior instead of the extension's local rewrite rule tables.
+
+### Removed
+- **Breaking:** Removed the rewrite category configuration surface (`rewriteGitGithub`, `rewriteFilesystem`, `rewriteRust`, `rewriteJavaScript`, `rewritePython`, `rewriteGo`, `rewriteContainers`, `rewriteNetwork`, and `rewritePackageManagers`) from configuration normalization, examples, settings UI, and documentation. Configure rewrite policy in RTK itself instead of this extension.
+
 ## [0.5.5] - 2026-04-24
 
 ### Changed

package/README.md

@@ -1,5 +1,7 @@
 # pi-rtk-optimizer
 
+[![npm version](https://img.shields.io/npm/v/pi-rtk-optimizer?style=flat-square)](https://www.npmjs.com/package/pi-rtk-optimizer) [![License](https://img.shields.io/github/license/MasuRii/pi-rtk-optimizer?style=flat-square)](LICENSE)
+
 > RTK command rewriting and tool output compaction extension for the Pi coding agent.
 
 <img width="1360" height="752" alt="image" src="https://github.com/user-attachments/assets/f4536889-62ec-429a-984e-dc0de9f1f709" />
@@ -12,19 +14,9 @@
 ### Command Rewriting
 
 - **Automatic rewriting** or **suggestion-only** mode for common development workflows
-- Supported command categories:
-  - **Git/GitHub** — `git`, `gh` commands
-  - **Filesystem** — `cat`, `head`, `tail`, `grep`, `rg`, `ls`, `tree`, `find`, `diff`, `wc`, `bash`, `cmd`, `powershell`
-  - **Rust** — `cargo` commands
-  - **JavaScript** — `vitest`, `npm`, `yarn`, `pnpm`, `bun` commands
-  - **Python** — `pytest`, `python`, `pip`, `uv` commands
-  - **Go** — `go` commands
-  - **Containers** — `docker`, `docker-compose`, `podman` commands
-  - **Network** — `curl`, `wget` commands
-  - **Package Managers** — `apt`, `brew`, `dnf`, `pacman`, `yum` commands
-- Runtime guard when `rtk` binary is unavailable (falls back to original commands only in rewrite mode)
-- Safe rewrite bypasses for structured `gh` output commands and non-interactive container shell sessions
-- Improved command parsing for `sed`, shell separators, and `pnpm dlx` proxy rewrites
+- Delegates bash command rewrite decisions to the installed `rtk rewrite` command, keeping RTK as the source of truth for supported commands, shell parsing, bypasses, and compound-command behavior
+- Runtime guard when `rtk` binary is unavailable (raw commands run unchanged and repeated missing-binary rewrite probes are avoided)
+- Pi-specific shell safety fixups for rewritten commands on Windows
 
 ### Output Compaction Pipeline
 
@@ -126,19 +118,11 @@ A starter template is included at `config/config.example.json`.
 | `guardWhenRtkMissing` | boolean | `true` | Run original commands when rtk binary unavailable |
 | `showRewriteNotifications` | boolean | `true` | Show rewrite notices in TUI |
 
-#### Rewrite Category Toggles
+#### Rewrite Source
+
+Bash command support is intentionally resolved by the installed `rtk` binary through `rtk rewrite`. The extension does not maintain duplicate rewrite rules or category classifiers; update/configure RTK itself for command support policy.
 
-| Option | Default | Commands Affected |
-|--------|---------|-------------------|
-| `rewriteGitGithub` | `true` | `git`, `gh` |
-| `rewriteFilesystem` | `true` | `cat`, `head`, `tail`, `grep`, `rg`, `ls`, `tree`, `find`, `diff`, `wc` |
-| `rewriteRust` | `true` | `cargo` |
-| `rewriteJavaScript` | `true` | `vitest`, `npm`, `yarn`, `pnpm`, `bun` |
-| `rewritePython` | `true` | `pytest`, `python`, `pip`, `uv` |
-| `rewriteGo` | `true` | `go` |
-| `rewriteContainers` | `true` | `docker`, `docker-compose`, `podman` |
-| `rewriteNetwork` | `true` | `curl`, `wget` |
-| `rewritePackageManagers` | `true` | `apt`, `brew`, `dnf`, `pacman`, `yum` |
+> **Breaking in 0.6.0:** Rewrite category toggles (`rewriteGitGithub`, `rewriteFilesystem`, `rewriteRust`, `rewriteJavaScript`, `rewritePython`, `rewriteGo`, `rewriteContainers`, `rewriteNetwork`, and `rewritePackageManagers`) were removed from the extension config surface. Existing rewrite policy should be configured in RTK because the extension now delegates rewrite ownership to `rtk rewrite`.
 
 #### Output Compaction Settings
 
@@ -146,9 +130,10 @@ A starter template is included at `config/config.example.json`.
 |--------|------|---------|-------------|
 | `outputCompaction.enabled` | boolean | `true` | Enable output compaction pipeline |
 | `outputCompaction.stripAnsi` | boolean | `true` | Remove ANSI escape codes |
-| `outputCompaction.sourceCodeFilteringEnabled` | boolean | `true` | Enable source code filtering for `read` output |
+| `outputCompaction.readCompaction.enabled` | boolean | `false` | Enable lossy compaction for `read` output; defaults off so code reads stay exact |
+| `outputCompaction.sourceCodeFilteringEnabled` | boolean | `false` | Enable source code filtering for `read` output when read compaction is enabled |
 | `outputCompaction.preserveExactSkillReads` | boolean | `false` | Keep reads under configured Pi/global/project skill directories exact, bypassing read compaction |
-| `outputCompaction.sourceCodeFiltering` | string | `"minimal"` | Filter level: `"none"`, `"minimal"`, `"aggressive"` |
+| `outputCompaction.sourceCodeFiltering` | string | `"none"` | Filter level: `"none"`, `"minimal"`, `"aggressive"` |
 | `outputCompaction.aggregateTestOutput` | boolean | `true` | Summarize test runner output |
 | `outputCompaction.filterBuildOutput` | boolean | `true` | Filter build/compile output |
 | `outputCompaction.compactGitOutput` | boolean | `true` | Compact git command output |
@@ -162,7 +147,7 @@ Skill-read preservation covers the global Pi skills directory (`~/.pi/agent/skil
 
 | Option | Type | Default | Range | Description |
 |--------|------|---------|-------|-------------|
-| `outputCompaction.smartTruncate.enabled` | boolean | `true` | — | Enable smart line-based truncation |
+| `outputCompaction.smartTruncate.enabled` | boolean | `false` | — | Enable smart line-based truncation for read output when read compaction is enabled |
 | `outputCompaction.smartTruncate.maxLines` | number | `220` | 40–4000 | Maximum lines after smart truncation |
 | `outputCompaction.truncate.enabled` | boolean | `true` | — | Enable hard character truncation |
 | `outputCompaction.truncate.maxChars` | number | `12000` | 1000–200000 | Maximum characters in final output |
@@ -175,7 +160,7 @@ Skill-read preservation covers the global Pi skills directory (`~/.pi/agent/skil
 | `minimal` | Removes non-doc comments, collapses blank lines |
 | `aggressive` | Also removes imports, keeps only signatures and key logic |
 
-> **Note:** When source filtering and read truncation safeguards are active, Pi injects a troubleshooting note for repeated file-edit mismatches. If edits fail because "old text does not match," disable source filtering via `/rtk`, re-read the file, apply the edit, then re-enable filtering.
+> **Note:** When read compaction, source filtering, and read truncation safeguards are active, Pi injects a troubleshooting note for repeated file-edit mismatches. If edits fail because "old text does not match," disable read compaction via `/rtk`, re-read the file, apply the edit, then re-enable compaction.
 
 ### Example Configuration
 
@@ -185,21 +170,15 @@ Skill-read preservation covers the global Pi skills directory (`~/.pi/agent/skil
   "mode": "rewrite",
   "guardWhenRtkMissing": true,
   "showRewriteNotifications": true,
-  "rewriteGitGithub": true,
-  "rewriteFilesystem": true,
-  "rewriteRust": true,
-  "rewriteJavaScript": true,
-  "rewritePython": true,
-  "rewriteGo": true,
-  "rewriteContainers": true,
-  "rewriteNetwork": true,
-  "rewritePackageManagers": true,
   "outputCompaction": {
     "enabled": true,
     "stripAnsi": true,
-    "sourceCodeFilteringEnabled": true,
+    "readCompaction": {
+      "enabled": false
+    },
+    "sourceCodeFilteringEnabled": false,
     "preserveExactSkillReads": false,
-    "sourceCodeFiltering": "minimal",
+    "sourceCodeFiltering": "none",
     "aggregateTestOutput": true,
     "filterBuildOutput": true,
     "compactGitOutput": true,
@@ -207,7 +186,7 @@ Skill-read preservation covers the global Pi skills directory (`~/.pi/agent/skil
     "groupSearchOutput": true,
     "trackSavings": true,
     "smartTruncate": {
-      "enabled": true,
+      "enabled": false,
       "maxLines": 220
     },
     "truncate": {

package/config/config.example.json

@@ -3,27 +3,21 @@
   "mode": "rewrite",
   "guardWhenRtkMissing": true,
   "showRewriteNotifications": true,
-  "rewriteGitGithub": true,
-  "rewriteFilesystem": true,
-  "rewriteRust": true,
-  "rewriteJavaScript": true,
-  "rewritePython": true,
-  "rewriteGo": true,
-  "rewriteContainers": true,
-  "rewriteNetwork": true,
-  "rewritePackageManagers": true,
   "outputCompaction": {
     "enabled": true,
     "stripAnsi": true,
-    "sourceCodeFilteringEnabled": true,
+    "readCompaction": {
+      "enabled": false
+    },
+    "sourceCodeFilteringEnabled": false,
     "preserveExactSkillReads": false,
     "truncate": {
       "enabled": true,
       "maxChars": 12000
     },
-    "sourceCodeFiltering": "minimal",
+    "sourceCodeFiltering": "none",
     "smartTruncate": {
-      "enabled": true,
+      "enabled": false,
       "maxLines": 220
     },
     "aggregateTestOutput": true,

package/package.json

@@ -1,64 +1,64 @@
-{
-  "name": "pi-rtk-optimizer",
-  "version": "0.5.5",
-  "description": "Pi extension that optimizes RTK command rewriting and tool output compaction for the coding agent.",
-  "type": "module",
-  "main": "./index.ts",
-  "exports": {
-    ".": "./index.ts"
-  },
-  "files": [
-    "index.ts",
-    "src",
-    "config/config.example.json",
-    "README.md",
-    "CHANGELOG.md",
-    "LICENSE"
-  ],
-  "scripts": {
-    "build": "npx --yes -p typescript@5.7.3 tsc -p tsconfig.json --noCheck",
-    "lint": "npm run build",
-    "typecheck": "npx --yes -p typescript@5.7.3 tsc -p tsconfig.json",
-    "test": "bun ./src/output-compactor-test.ts && bun ./src/command-rewriter-test.ts && bun ./src/runtime-guard-test.ts && bun ./src/additional-coverage-test.ts && bun ./src/config-modal-test.ts && bun ./src/index-test.ts",
-    "check": "npm run lint && npm run typecheck && npm run test",
-    "build:check": "bunx esbuild ./index.ts --bundle --platform=node --format=esm --outfile=./.pi-rtk-optimizer-check.mjs --external:@mariozechner/pi-coding-agent --external:@mariozechner/pi-tui && bun -e \"import { unlinkSync } from 'node:fs'; unlinkSync('./.pi-rtk-optimizer-check.mjs');\""
-  },
-  "keywords": [
-    "pi-package",
-    "pi",
-    "pi-extension",
-    "pi-coding-agent",
-    "coding-agent",
-    "rtk",
-    "token-optimization",
-    "tool-compaction",
-    "output-compaction",
-    "command-rewrite",
-    "optimization"
-  ],
-  "author": "MasuRii",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/MasuRii/pi-rtk-optimizer.git"
-  },
-  "bugs": {
-    "url": "https://github.com/MasuRii/pi-rtk-optimizer/issues"
-  },
-  "homepage": "https://github.com/MasuRii/pi-rtk-optimizer#readme",
-  "engines": {
-    "node": ">=20"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "pi": {
-    "extensions": [
-      "./index.ts"
-    ]
-  },
-  "peerDependencies": {
-    "@mariozechner/pi-coding-agent": "^0.70.0",
-    "@mariozechner/pi-tui": "^0.70.0"
-  }
-}
+{
+  "name": "pi-rtk-optimizer",
+  "version": "0.7.0",
+  "description": "Pi extension that optimizes RTK command rewriting and tool output compaction for the coding agent.",
+  "type": "module",
+  "main": "./index.ts",
+  "exports": {
+    ".": "./index.ts"
+  },
+  "files": [
+    "index.ts",
+    "src",
+    "config/config.example.json",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "npx --yes -p typescript@5.7.3 tsc -p tsconfig.json --noCheck",
+    "lint": "npm run build",
+    "typecheck": "npx --yes -p typescript@5.7.3 tsc -p tsconfig.json",
+    "test": "bun ./src/output-compactor-test.ts && bun ./src/command-rewriter-test.ts && bun ./src/runtime-guard-test.ts && bun ./src/additional-coverage-test.ts && bun ./src/config-modal-test.ts && bun ./src/index-test.ts",
+    "check": "npm run lint && npm run typecheck && npm run test",
+    "build:check": "bunx esbuild ./index.ts --bundle --platform=node --format=esm --outfile=./.pi-rtk-optimizer-check.mjs --external:@mariozechner/pi-coding-agent --external:@mariozechner/pi-tui && bun -e \"import { unlinkSync } from 'node:fs'; unlinkSync('./.pi-rtk-optimizer-check.mjs');\""
+  },
+  "keywords": [
+    "pi-package",
+    "pi",
+    "pi-extension",
+    "pi-coding-agent",
+    "coding-agent",
+    "rtk",
+    "token-optimization",
+    "tool-compaction",
+    "output-compaction",
+    "command-rewrite",
+    "optimization"
+  ],
+  "author": "MasuRii",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MasuRii/pi-rtk-optimizer.git"
+  },
+  "bugs": {
+    "url": "https://github.com/MasuRii/pi-rtk-optimizer/issues"
+  },
+  "homepage": "https://github.com/MasuRii/pi-rtk-optimizer#readme",
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "pi": {
+    "extensions": [
+      "./index.ts"
+    ]
+  },
+  "peerDependencies": {
+    "@mariozechner/pi-coding-agent": "^0.70.6",
+    "@mariozechner/pi-tui": "^0.70.6"
+  }
+}

package/src/additional-coverage-test.ts

@@ -64,8 +64,9 @@ runTest("config-store normalizes invalid values and clamps numeric ranges", () =
 
 	assert.equal(normalized.enabled, true);
 	assert.equal(normalized.mode, "rewrite");
-	assert.equal(normalized.rewriteGitGithub, false);
+	assert.equal(Object.hasOwn(normalized, "rewriteGitGithub"), false);
 	assert.equal(normalized.outputCompaction.stripAnsi, false);
+	assert.equal(normalized.outputCompaction.readCompaction.enabled, true);
 	assert.equal(normalized.outputCompaction.sourceCodeFilteringEnabled, true);
 	assert.equal(normalized.outputCompaction.sourceCodeFiltering, "minimal");
 	assert.equal(normalized.outputCompaction.truncate.maxChars, 1_000);
@@ -73,18 +74,32 @@ runTest("config-store normalizes invalid values and clamps numeric ranges", () =
 	assert.equal(normalized.outputCompaction.trackSavings, false);
 });
 
+runTest("config-store uses safer read defaults when readCompaction is explicit", () => {
+	const normalized = normalizeRtkIntegrationConfig({
+		outputCompaction: {
+			readCompaction: { enabled: false },
+		},
+	});
+
+	assert.equal(normalized.outputCompaction.readCompaction.enabled, false);
+	assert.equal(normalized.outputCompaction.sourceCodeFilteringEnabled, false);
+	assert.equal(normalized.outputCompaction.sourceCodeFiltering, "none");
+	assert.equal(normalized.outputCompaction.smartTruncate.enabled, false);
+});
+
 runTest("config-store can ensure, save, and reload isolated config files", () => {
 	const tempPath = makeTempConfigPath();
 	cleanupFile(tempPath);
 
 	try {
 		const ensured = ensureConfigExists(tempPath);
-		assert.equal(ensured.created, true);
+		assert.equal(ensured.error, undefined);
 		assert.equal(existsSync(tempPath), true);
 
 		const defaultLoad = loadRtkIntegrationConfig(tempPath);
 		assert.equal(defaultLoad.warning, undefined);
 		assert.equal(defaultLoad.config.mode, "rewrite");
+		assert.equal(defaultLoad.config.outputCompaction.readCompaction.enabled, false);
 
 		const saved = saveRtkIntegrationConfig(
 			{
@@ -153,6 +168,14 @@ runTest("command detection ignores env prefixes, blank lines, and chained suffix
 	assert.equal(matchesCommandPatterns("echo hello", [/^bun test/]), false);
 });
 
+runTest("RTK command environment preserves explicit leading RTK_DB_PATH overrides", () => {
+	const command = 'RTK_DB_PATH="/custom/history.db" rtk git diff';
+	assert.equal(applyRtkCommandEnvironment(command), command);
+
+	const exportedCommand = 'export RTK_DB_PATH="/custom/history.db"; rtk git diff';
+	assert.equal(applyRtkCommandEnvironment(exportedCommand), exportedCommand);
+});
+
 runTest("path compaction preserves the tail and handles Windows separators", () => {
 	const unixPath = "/Users/example/projects/pi-rtk-optimizer/src/techniques/path-utils.ts";
 	const compactUnixPath = compactPath(unixPath, 28);
@@ -204,21 +227,21 @@ runTest("rewrite pipeline safety buffers rewritten Windows producer commands", (
 	assert.equal(applyRewrittenCommandShellSafetyFixups("git diff | grep TODO"), "git diff | grep TODO");
 });
 
-runTest("rewrite pipeline safety keeps RTK_DB_PATH scoped to rewritten producer commands", () => {
+runTest("rewrite pipeline safety keeps exported RTK_DB_PATH on rewritten producer commands", () => {
 	const rewritten = applyRewrittenCommandShellSafetyFixups(
 		applyRtkCommandEnvironment("rtk git diff agent/extensions/pi-multi-auth/account-manager.ts | head -200"),
 	);
 
 	if (process.platform === "win32") {
-		assert.ok(rewritten.startsWith("{"));
+		assert.ok(rewritten.startsWith("export RTK_DB_PATH="));
 		assert.equal(rewritten.startsWith("RTK_DB_PATH="), false);
-		assert.ok(rewritten.includes("RTK_DB_PATH="));
+		assert.ok(rewritten.includes("; {"));
 		assert.ok(
 			rewritten.includes('rtk git diff agent/extensions/pi-multi-auth/account-manager.ts > "$__pi_rtk_pipe_tmp"'),
 		);
 		assert.ok(rewritten.includes('(head -200) < "$__pi_rtk_pipe_tmp"'));
 	} else {
-		assert.ok(rewritten.startsWith("RTK_DB_PATH="));
+		assert.ok(rewritten.startsWith("export RTK_DB_PATH="));
 		assert.equal(
 			rewritten,
 			applyRtkCommandEnvironment("rtk git diff agent/extensions/pi-multi-auth/account-manager.ts | head -200"),
@@ -226,6 +249,25 @@ runTest("rewrite pipeline safety keeps RTK_DB_PATH scoped to rewritten producer
 	}
 });
 
+runTest("rewrite pipeline safety buffers explicit RTK_DB_PATH export preludes", () => {
+	const command = 'export RTK_DB_PATH="/custom/history.db"; rtk git diff | head -200';
+	const rewritten = applyRewrittenCommandShellSafetyFixups(command);
+
+	if (process.platform === "win32") {
+		assert.ok(rewritten.startsWith('export RTK_DB_PATH="/custom/history.db"; {'));
+		assert.ok(rewritten.includes('rtk git diff > "$__pi_rtk_pipe_tmp"'));
+		assert.ok(rewritten.includes('(head -200) < "$__pi_rtk_pipe_tmp"'));
+	} else {
+		assert.equal(rewritten, command);
+	}
+});
+
+runTest("RTK command environment uses export prelude for shell compound commands", () => {
+	const rewritten = applyRtkCommandEnvironment('for d in a b; do echo "$d"; done');
+	assert.ok(/^export RTK_DB_PATH=/.test(rewritten));
+	assert.ok(/; for d in a b; do echo "\$d"; done$/.test(rewritten));
+});
+
 runTest("stripRtkHookWarnings handles bare, prefixed, and already-sanitized hook notices", () => {
 	assert.equal(
 		stripRtkHookWarnings("No hook installed — run `rtk init -g` for automatic token savings\n\nready\n", null),