@tduyng/pi-outline 0.0.3 → 0.0.4

package/README.md

@@ -1,22 +1,16 @@
 # @tduyng/pi-outline
 
-A map of a source file instead of the file. One `outline` call lists every declaration with its line span, so the read that follows fetches one body rather than a thousand lines.
+A map of a source file instead of the file. One call lists every declaration with its line span, so the read that follows fetches one body.
 
-## What it costs
+A 1,213-line TypeScript file puts 51 KB into the transcript, and every later turn of the session re-reads it. The depth-1 outline of that file is 47 rows, about 3 KB, and it names the lines worth reading.
 
-`outline` is 161 tokens a request, and that is the whole bill.
-
-What it saves is larger and grows with the file. On a 1,213-line, 51 KB TypeScript file the depth-1 outline is 47 rows, 3.4 KB. The whole read would put 51 KB in the transcript and re-bill it on every later turn of the session, which is the cheapest mistake to make in pi and the most expensive to keep.
-
-## The tool
-
-`outline` takes a `path` and an optional `depth` from 0 to 5, default 1. It prints one row per declaration: the span, then the declaration line. Members sit under their class or impl, one indent per level. A row whose declaration has children beyond `depth` ends in `[N nested]`.
+## How it works
 
 ```text
 outline(path: "src/goal.ts", depth: 1)
 ```
 
-Covered:
+Depth runs from 0 to 5 and defaults to 1. Depth 0 lists top-level declarations, each extra level adds members, and a row with children past the depth ends in `[N nested]`.
 
 | Language | Declarations |
 | --- | --- |
@@ -28,17 +22,15 @@ Covered:
 
 Headings inside code fences are ignored.
 
-## Where it fits
-
-A read of a file over 350 lines is blocked by pi-subagent's bulk-read guard, and the block message names `outline` first. The pair is the intended path: outline, pick the span, then a ranged read of the one body you need.
+There is no parser. A parser means a dependency, a language server, and a version of both that disagrees with the repository. The outline is built from single-line rules over the text, and spans come from indentation: a declaration runs until the next line at the same or a lower indent, and includes the closing brace that follows its body.
 
-With no guard installed the tool still works, it just stops being the thing that catches you.
+That covers the languages people actually outline, and a miss is visible. A file the rules do not cover gets a line saying so, with grep and a ranged read as the fallback.
 
-## Limits
+## With the read guard
 
-No parser is used, so the rules are regular expressions over single lines. Spans come from indentation: a span runs to the next line at the same or a lower indent, and includes the closing brace that follows the body.
+pi-subagent's bulk-read guard blocks a read of a file over 350 lines, and its block message names `outline` first. The intended path is outline, then a ranged read of the one body needed.
 
-Expect an occasional missed declaration on unusual formatting, and an object-literal method may show as a member. A file the rules do not cover gets a line saying so, with grep or a ranged read as the fallback. Files over 2 MB are refused.
+Without the guard the tool still works, it just stops being the thing that catches an oversized read.
 
 ## Install
 
@@ -47,3 +39,10 @@ pi install npm:@tduyng/pi-outline
 ```
 
 Local checkout: `pi install /path/to/dotfiles/pi/agent/extensions/pi-outline`
+
+## Limits
+
+- Files over 2 MB are refused, since the map would be bigger than the useful part.
+- At most 200 rows, and a row is cut at 120 characters.
+- Spans come from indentation, so unusual formatting can miss a declaration, and an object-literal method can show up as a member.
+- No types, no imports, no call graph.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tduyng/pi-outline",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Declarations of a source file with line spans, so a read fetches one body instead of the whole file.",
   "keywords": [
     "pi",