pi-rtk-optimizer 0.5.4 → 0.6.0

package/CHANGELOG.md

@@ -7,15 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.5.4] - 2026-04-22
+## [0.6.0] - 2026-04-27
 
-### Fixed
-- Respected `PI_CODING_AGENT_DIR` when resolving the global extension config directory and preserved exact skill reads under the configured global Pi skills path.
+### 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
-- Updated README installation/configuration guidance and the settings modal description to document configurable global Pi paths.
-- Removed session-switch lifecycle reinitialization from the extension runtime.
-- Updated `@mariozechner/pi-coding-agent` and `@mariozechner/pi-tui` peer dependencies to ^0.68.1.
+- Config path resolution now uses Pi's `getAgentDir()` API so `PI_CODING_AGENT_DIR` is respected for extension config paths (thanks to @tynanbe for PR #3).
+- Global skill-read preservation paths now resolve through Pi's agent directory so `PI_CODING_AGENT_DIR` is respected (thanks to @tynanbe for PR #3).
+- Source-filter troubleshooting note injection now only runs when output compaction, source filtering, and read truncation safeguards are active (thanks to @philipbjorge for PR #4).
+- Updated `@mariozechner/pi-coding-agent` and `@mariozechner/pi-tui` peer dependencies to ^0.70.0.
+- Clarified README and settings modal copy for global extension/config paths, skill directory paths, source-filter note behavior, architecture, and event hooks.
+
+### Removed
+- Removed the unused local asset directory.
+- Removed the `session_switch` event refresh handler.
 
 ## [0.5.3] - 2026-04-01
 

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
 
@@ -60,8 +52,9 @@ Multi-stage pipeline to reduce token consumption:
 Place this folder in one of the following locations:
 
 ```text
-~/.pi/agent/extensions/pi-rtk-optimizer     # Global default (when PI_CODING_AGENT_DIR is unset)
-.pi/extensions/pi-rtk-optimizer              # Project-specific
+~/.pi/agent/extensions/pi-rtk-optimizer                 # Global default (when PI_CODING_AGENT_DIR is unset)
+$PI_CODING_AGENT_DIR/extensions/pi-rtk-optimizer        # Global when PI_CODING_AGENT_DIR is set
+.pi/extensions/pi-rtk-optimizer                         # Project-specific
 ```
 
 Pi auto-discovers extensions in these paths on startup.
@@ -125,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,7 +131,7 @@ 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.preserveExactSkillReads` | boolean | `false` | Keep reads under Pi skill directories exact, bypassing read compaction |
+| `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.aggregateTestOutput` | boolean | `true` | Summarize test runner output |
 | `outputCompaction.filterBuildOutput` | boolean | `true` | Filter build/compile output |
@@ -155,6 +140,8 @@ A starter template is included at `config/config.example.json`.
 | `outputCompaction.groupSearchOutput` | boolean | `true` | Group search results by file |
 | `outputCompaction.trackSavings` | boolean | `true` | Track compaction metrics |
 
+Skill-read preservation covers the global Pi skills directory (`~/.pi/agent/skills` by default, or `$PI_CODING_AGENT_DIR/skills` when set), `~/.agents/skills`, project `.pi/skills`, and ancestor `.agents/skills` directories.
+
 #### Truncation Settings
 
 | Option | Type | Default | Range | Description |
@@ -172,7 +159,7 @@ A starter template is included at `config/config.example.json`.
 | `minimal` | Removes non-doc comments, collapses blank lines |
 | `aggressive` | Also removes imports, keeps only signatures and key logic |
 
-> **Note:** If file 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 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.
 
 ### Example Configuration
 
@@ -182,15 +169,6 @@ A starter template is included at `config/config.example.json`.
   "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,
@@ -225,15 +203,19 @@ src/
 ├── index.ts                # Extension bootstrap and event wiring
 ├── config-store.ts         # Config load/save with normalization
 ├── config-modal.ts         # TUI settings modal and /rtk handler
-├── command-rewriter.ts     # Command tokenization and rewrite logic
-├── rewrite-bypass.ts       # Rewrite safety bypass rules for interactive/structured commands
-├── rewrite-rules.ts        # Rewrite rule catalog
-├── runtime-guard.ts        # Runtime availability guard helpers for rewrite mode
-├── output-compactor.ts     # Tool result compaction pipeline
-├── output-metrics.ts       # Savings tracking and reporting
-├── command-completions.ts  # /rtk subcommand completions
+├── command-rewriter.ts         # Command tokenization and rewrite logic
+├── rewrite-bypass.ts           # Rewrite safety bypass rules for interactive/structured commands
+├── rewrite-rules.ts            # Rewrite rule catalog
+├── rewrite-pipeline-safety.ts  # Shell-safety fixups for rewritten commands
+├── rtk-command-environment.ts  # RTK_DB_PATH scoping for rewritten commands
+├── shell-env-prefix.ts         # Environment assignment parsing helpers
+├── runtime-guard.ts            # Runtime availability guard helpers for rewrite mode
+├── output-compactor.ts         # Tool result compaction pipeline
+├── output-metrics.ts           # Savings tracking and reporting
+├── tool-execution-sanitizer.ts # Streaming bash execution output sanitizer
+├── command-completions.ts      # /rtk subcommand completions
 ├── windows-command-helpers.ts  # Windows bash compatibility
-└── techniques/             # Compaction technique implementations
+└── techniques/                 # Compaction technique implementations
     ├── ansi.ts             # ANSI code stripping
     ├── build.ts            # Build output filtering
     ├── test-output.ts      # Test output aggregation
@@ -248,9 +230,12 @@ src/
 
 The extension hooks into Pi's event system:
 
-- **`beforeToolCall`** — Rewrites bash commands to rtk equivalents
-- **`afterToolResult`** — Compacts tool output before context consumption
-- **`command`** — Handles `/rtk` command and subcommands
+- **`tool_call`** — Rewrites bash commands to rtk equivalents or emits suggestions
+- **`tool_result`** — Compacts completed tool output before context consumption
+- **`tool_execution_start` / `tool_execution_update` / `tool_execution_end`** — Tracks and sanitizes streamed bash output
+- **`before_agent_start`** — Conditionally injects source-filter troubleshooting guidance
+- **`session_start` / `agent_end`** — Refreshes config and clears in-session tracking state
+- **Registered `/rtk` command** — Handles settings, status, verification, stats, and reset subcommands
 
 ### Windows Compatibility
 

package/config/config.example.json

@@ -3,15 +3,6 @@
   "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,

package/package.json

@@ -1,64 +1,64 @@
-{
-  "name": "pi-rtk-optimizer",
-  "version": "0.5.4",
-  "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.68.1",
-    "@mariozechner/pi-tui": "^0.68.1"
-  }
-}
+{
+  "name": "pi-rtk-optimizer",
+  "version": "0.6.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.2",
+    "@mariozechner/pi-tui": "^0.70.2"
+  }
+}

package/src/additional-coverage-test.ts

@@ -1,11 +1,20 @@
 import assert from "node:assert/strict";
-import { mock } from "bun:test";
 import { existsSync, readFileSync, unlinkSync, writeFileSync } from "node:fs";
+import { mock } from "bun:test";
 
-const MOCK_AGENT_DIR = "C:/tmp/.pi/agent";
+import { clearOutputMetrics, getOutputMetricsSummary, trackOutputSavings } from "./output-metrics.ts";
+import { runTest } from "./test-helpers.ts";
+import { matchesCommandPatterns, normalizeCommandForDetection } from "./techniques/command-detection.ts";
+import { compactPath } from "./techniques/path-utils.ts";
+import { applyWindowsBashCompatibilityFixes } from "./windows-command-helpers.ts";
+import { applyRewrittenCommandShellSafetyFixups } from "./rewrite-pipeline-safety.ts";
+import { applyRtkCommandEnvironment } from "./rtk-command-environment.ts";
+import { sanitizeStreamingBashExecutionResult } from "./tool-execution-sanitizer.ts";
+import { sanitizeRtkEmojiOutput } from "./techniques/emoji.ts";
+import { stripRtkHookWarnings } from "./techniques/rtk.ts";
 
 mock.module("@mariozechner/pi-coding-agent", () => ({
-	getAgentDir: () => MOCK_AGENT_DIR,
+	getAgentDir: () => "/tmp/.pi/agent",
 }));
 
 const {
@@ -15,16 +24,6 @@ const {
 	normalizeRtkIntegrationConfig,
 	saveRtkIntegrationConfig,
 } = await import("./config-store.ts");
-import { clearOutputMetrics, getOutputMetricsSummary, trackOutputSavings } from "./output-metrics.ts";
-import { runTest } from "./test-helpers.ts";
-import { matchesCommandPatterns, normalizeCommandForDetection } from "./techniques/command-detection.ts";
-import { compactPath } from "./techniques/path-utils.ts";
-import { applyWindowsBashCompatibilityFixes } from "./windows-command-helpers.ts";
-import { applyRewrittenCommandShellSafetyFixups } from "./rewrite-pipeline-safety.ts";
-import { applyRtkCommandEnvironment } from "./rtk-command-environment.ts";
-import { sanitizeStreamingBashExecutionResult } from "./tool-execution-sanitizer.ts";
-import { sanitizeRtkEmojiOutput } from "./techniques/emoji.ts";
-import { stripRtkHookWarnings } from "./techniques/rtk.ts";
 
 function makeTempConfigPath(): string {
 	return `${getRtkIntegrationConfigPath()}.test-${Date.now()}-${Math.random().toString(16).slice(2)}.json`;
@@ -65,7 +64,7 @@ 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.sourceCodeFilteringEnabled, true);
 	assert.equal(normalized.outputCompaction.sourceCodeFiltering, "minimal");