pi-readseek 0.1.0 → 0.2.0

package/README.md

@@ -36,6 +36,9 @@ pi install npm:pi-readseek
 `pi-readseek` is licensed under `MIT`. See [LICENSE](LICENSE) for more
 information.
 
+The upstream `@jarkkojs/readseek` packages are licensed separately as
+`Apache-2.0 AND LGPL-2.1-or-later`.
+
 `readseek` is originally derived from the source code of
 [`pi-hashline-readmap`](https://github.com/coctostan/pi-hashline-readmap).
 The relevant copyrights have been retained in [LICENSE](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-readseek",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pi extension for readseek-backed hash-anchored read/edit/grep, structural code maps, structural search, and file exploration",
   "type": "module",
   "exports": {
@@ -39,7 +39,7 @@
     "node": ">=20.0.0"
   },
   "dependencies": {
-    "@jarkkojs/readseek": "0.1.5",
+    "@jarkkojs/readseek": "0.2.2",
     "diff": "^8.0.3",
     "ignore": "^7.0.5",
     "picomatch": "^4.0.4",

package/prompts/sg.md

@@ -3,14 +3,18 @@ AST-aware structural code search. Use when text search is too broad or brittle a
 ## Parameters
 
 - `pattern` — ast-grep-style pattern to match.
-- `lang` — language hint such as `typescript`, `tsx`, `javascript`, `jsx`, `rust`, or `python`; set it when syntax is ambiguous.
+- `lang` — language hint such as `typescript`, `tsx`, `javascript`, `jsx`, `rust`, `python`, `dockerfile`, `lua`, `nix`, `perl`, or `zig`; set it when syntax is ambiguous.
 - `path` — file or directory, default cwd.
+- `cached` — in a Git repository, search tracked/indexed files.
+- `others` — in a Git repository, search untracked files.
+- `ignored` — with `others`, include ignored untracked files.
 
 ## Pattern syntax
 
 - `$NAME` matches one AST node.
 - `$_` matches any one node.
 - `$$$ARGS` matches zero or more nodes; use `$$$` for variable-length args, body statements, object fields, JSX children, etc.
+- Reusing the same metavariable name requires each occurrence to match the same source text.
 
 ## Examples
 
@@ -23,3 +27,5 @@ AST-aware structural code search. Use when text search is too broad or brittle a
 ## Tips
 
 Patterns are parsed as code, not text: formatting is mostly ignored, but syntax must be valid for `lang`. Include semicolons in languages that require them. Use `grep` for plain text and `search` for structure.
+
+When searching a directory inside a Git repository, readseek 0.2.x defaults to tracked/indexed files plus untracked non-ignored files. Use `cached`, `others`, and `ignored` to narrow or expand that Git selection.

package/src/context-hygiene.ts

@@ -48,6 +48,9 @@ export interface ContextHygieneSearchRehydrateInput {
   pattern: string;
   lang?: string;
   path?: string;
+  cached?: true;
+  others?: true;
+  ignored?: true;
 }
 
 export interface ContextHygieneReadRehydrateDescriptor {
@@ -200,6 +203,9 @@ export interface BuildSearchRehydrateDescriptorInput {
   pattern: string;
   lang?: string;
   path?: string;
+  cached?: boolean;
+  others?: boolean;
+  ignored?: boolean;
 }
 
 export function buildSearchRehydrateDescriptor(
@@ -208,6 +214,9 @@ export function buildSearchRehydrateDescriptor(
   const descriptorInput: ContextHygieneSearchRehydrateInput = { pattern: input.pattern };
   if (input.lang !== undefined) descriptorInput.lang = input.lang;
   if (input.path !== undefined) descriptorInput.path = input.path;
+  if (input.cached === true) descriptorInput.cached = true;
+  if (input.others === true) descriptorInput.others = true;
+  if (input.ignored === true) descriptorInput.ignored = true;
   return { tool: "search", input: descriptorInput };
 }
 

package/src/read.ts

@@ -52,6 +52,12 @@ interface ReadToolOptions {
 	onSuccessfulRead?: (absolutePath: string) => void;
 }
 
+function splitReadseekLines(text: string): string[] {
+	if (text.length === 0) return [];
+	const withoutTrailingTerminator = text.endsWith("\n") ? text.slice(0, -1) : text;
+	return withoutTrailingTerminator.split("\n");
+}
+
 const PNG_SIGNATURE = [0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a];
 
 function startsWithBytes(buffer: Buffer, bytes: number[]): boolean {
@@ -386,7 +392,7 @@ export function registerReadTool(pi: ExtensionAPI, options: ReadToolOptions = {}
 			const hasBinaryContent = looksLikeBinary(rawBuffer);
 			throwIfAborted(signal);
 			const normalized = normalizeToLF(stripBom(rawBuffer.toString("utf-8")).text);
-			const allLines = normalized.split("\n");
+			const allLines = splitReadseekLines(normalized);
 			const total = allLines.length;
 			const structuredWarnings: ReadseekWarning[] = [];
 			let startLine = p.offset !== undefined ? p.offset : 1;
@@ -538,7 +544,9 @@ export function registerReadTool(pi: ExtensionAPI, options: ReadToolOptions = {}
 			throwIfAborted(signal);
 			let readseekOutput: Awaited<ReturnType<typeof readseekRead>>;
 			try {
-				readseekOutput = await readseekRead(absolutePath, startLine, endIdx);
+				readseekOutput = total === 0
+					? await readseekRead(absolutePath)
+					: await readseekRead(absolutePath, startLine, endIdx);
 			} catch (err: any) {
 				const detail = err?.message ? ` — ${err.message}` : "";
 				const message = `readseek failed while reading ${rawPath}${detail}`;

package/src/readseek-client.ts

@@ -72,6 +72,14 @@ interface ReadseekSearchOutput {
 	results: ReadseekSearchFileOutput[];
 }
 
+export interface ReadseekSearchOptions {
+	language?: string;
+	cached?: boolean;
+	others?: boolean;
+	ignored?: boolean;
+	signal?: AbortSignal;
+}
+
 function normalizeLanguage(language: string): string {
 	return language === "java" ? "Java" : language;
 }
@@ -293,15 +301,11 @@ function parseSearchOutput(value: unknown): ReadseekSearchOutput {
 	};
 }
 
-export async function readseekRead(filePath: string, startLine: number, endLine: number): Promise<ReadseekReadOutput> {
-	return parseReadOutput(await runReadseek([
-		"read",
-		filePath,
-		"--start",
-		String(startLine),
-		"--end",
-		String(endLine),
-	]));
+export async function readseekRead(filePath: string, startLine?: number, endLine?: number): Promise<ReadseekReadOutput> {
+	const args = ["read", filePath];
+	if (startLine !== undefined) args.push("--start", String(startLine));
+	if (endLine !== undefined) args.push("--end", String(endLine));
+	return parseReadOutput(await runReadseek(args));
 }
 
 export async function readseekMap(filePath: string, totalBytes: number): Promise<FileMap | null> {
@@ -321,12 +325,14 @@ export async function readseekMap(filePath: string, totalBytes: number): Promise
 export async function readseekSearch(
 	target: string,
 	pattern: string,
-	language?: string,
-	signal?: AbortSignal,
+	options: ReadseekSearchOptions = {},
 ): Promise<ReadseekSearchFileOutput[]> {
 	const args = ["search", target, pattern];
-	if (language) args.push("--language", language);
-	return parseSearchOutput(await runReadseek(args, { signal })).results;
+	if (options.language) args.push("--language", options.language);
+	if (options.cached) args.push("--cached");
+	if (options.others) args.push("--others");
+	if (options.ignored) args.push("--ignored");
+	return parseSearchOutput(await runReadseek(args, { signal: options.signal })).results;
 }
 
 export async function readseekMapContent(filePath: string, content: string): Promise<FileMap | null> {

package/src/sg.ts

@@ -12,7 +12,7 @@ import { buildSgOutput } from "./sg-output.js";
 import { buildSearchRehydrateDescriptor } from "./context-hygiene.js";
 import { clampLineToWidth, clampLinesToWidth, isRendererExpanded, renderToolLabel, summaryLine } from "./tui-render-utils.js";
 
-type SgParams = { pattern: string; lang?: string; path?: string };
+type SgParams = { pattern: string; lang?: string; path?: string; cached?: boolean; others?: boolean; ignored?: boolean };
 
 export interface SgRange {
   startLine: number;
@@ -113,15 +113,35 @@ export function registerSgTool(pi: ExtensionAPI, options: SgToolOptions = {}) {
       pattern: Type.String({ description: "AST pattern" }),
       lang: Type.Optional(Type.String({ description: "Language hint" })),
       path: Type.Optional(Type.String({ description: "Search path" })),
+      cached: Type.Optional(Type.Boolean({ description: "In a Git repository, search tracked/indexed files" })),
+      others: Type.Optional(Type.Boolean({ description: "In a Git repository, search untracked files" })),
+      ignored: Type.Optional(Type.Boolean({ description: "With others=true, include ignored untracked files" })),
     }),
     ptc: toolConfig,
     async execute(_toolCallId, params, signal, _onUpdate, ctx) {
       await ensureHashInit();
       const p = params as SgParams;
+      if (p.ignored && !p.others) {
+        const message = "Error: search parameter 'ignored' requires 'others'";
+        return {
+          content: [{ type: "text", text: message }],
+          isError: true,
+          details: {
+            readseekValue: {
+              tool: "search",
+              ok: false,
+              error: buildReadseekError("invalid-parameter", message),
+            },
+          },
+        };
+      }
       const rehydrate = buildSearchRehydrateDescriptor({
         pattern: p.pattern,
         lang: p.lang,
         path: p.path,
+        cached: p.cached,
+        others: p.others,
+        ignored: p.ignored,
       });
 
       const searchPath = resolveToCwd(p.path ?? ".", ctx.cwd);
@@ -178,7 +198,13 @@ export function registerSgTool(pi: ExtensionAPI, options: SgToolOptions = {}) {
 
       try {
         const effectiveLang = readseekLanguageForPath(p.lang, searchPath, searchPathIsFile);
-        const results = await readseekSearch(searchPath, p.pattern, effectiveLang, signal);
+        const results = await readseekSearch(searchPath, p.pattern, {
+          language: effectiveLang,
+          cached: p.cached,
+          others: p.others,
+          ignored: p.ignored,
+          signal,
+        });
         if (results.length === 0) {
           const emptyOutput = buildSgOutput({ pattern: p.pattern, files: [], rehydrate });
           return {
@@ -262,6 +288,8 @@ export function registerSgTool(pi: ExtensionAPI, options: SgToolOptions = {}) {
       let text = `${renderToolLabel(theme, "search")} ${theme.fg("accent", `/${args.pattern}/`)}`;
       text += theme.fg("dim", ` in ${args.path ?? "."}`);
       if (args.lang) text += theme.fg("dim", ` (${args.lang})`);
+      const flags = [args.cached && "cached", args.others && "others", args.ignored && "ignored"].filter(Boolean);
+      if (flags.length > 0) text += theme.fg("dim", ` [${flags.join(",")}]`);
       return new Text(clampLineToWidth(text, context.width), 0, 0);
     },
     renderResult(result: any, options: ToolRenderResultOptions, theme: any, ...rest: any[]) {