alex/pi-map
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: alex/pi-map:010e4b83eb1ac94ca22ccc2286eb77bc1e6beb72
Branches Tags
alex/pi-map:main
..
compare: alex/pi-map:842dcc6235c074e66f9a36ae54d87f2722ef1ed4
Branches Tags
alex/pi-map:main

9 Commits
010e4b83eb .. 842dcc6235

Author SHA1 Message Date
alex 842dcc6235 spec(openspec): archive completed project-map changes 2026-06-12 10:06:30 +02:00
alex 11365fa4ed docs(prompt): align prompt injection guidance and runtime copy 2026-06-11 23:21:19 +02:00
alex 0cf4060c4b chore(repo): ignore local runtime and cache artifacts 2026-06-11 23:20:56 +02:00
alex c11d49d015 spec(prompt): add project map prompt injection change set 2026-06-11 22:56:20 +02:00
alex 58e8bd31d3 feat(prompt): implement prompt injection slice 4 2026-06-11 22:54:51 +02:00
alex 19666c900e feat(prompt): implement prompt injection slice 3 2026-06-11 21:32:38 +02:00
alex 621434b6e8 feat(prompt): implement prompt injection slice 2 2026-06-11 17:27:31 +02:00
alex 56560d9d56 feat(prompt): implement prompt injection slice 1 2026-06-11 17:01:10 +02:00
alex c6064f8d94 Implement layered maps and context retrieval 2026-06-11 12:56:18 +02:00
56 changed files with 8471 additions and 657 deletions
Expand all files Collapse all files
.gitignore
+5
View File
@@ -5,7 +5,12 @@ coverage/
.DS_Store
.env
.pi-map.md
.pi-map.index.md
# Local Pi runtime state
.atl/
.pi
.cache/
cache/
subagent-outputs/
IMPLEMENTATION_REPORT.md
context.md
.pi/settings.json
-1
View File
@@ -1 +0,0 @@
{}
README.md
+127 -1
View File
@@ -4,7 +4,12 @@ Pi skill for hierarchical project analysis.
## What it does
Generates `.pi-map.md` files throughout your project — one per directory — containing a dense, machine-readable summary of that directory's files, exports, dependencies, and architecture. This gives Pi agents instant project comprehension without reading every source file.
Generates **paired** project-analysis artifacts throughout your project:
- `.pi-map.index.md` — routing-first index for deciding what to open next
- `.pi-map.md` — orientation-first rich map for understanding a directory
This gives Pi agents fast navigation plus deeper architectural context without reading every source file up front.
## Quick Start
@@ -13,6 +18,127 @@ npm install -g pi-project-map
project-map init
```
## Agent operating model
### Tier 0
Always start with:
- `Project Map Protocol`
- root `.pi-map.index.md`
### Tier 1
Load likely relevant directory indexes first, then open the strongest-match rich maps.
### Tier 2
Read actual source, tests, config, and docs before editing or making exact runtime claims.
**Trust boundary:** index routes, map orients, source decides.
## Prompt Injection Policy
The Pi extension can automatically inject lightweight project-map guidance into the agent context according to the configured `promptInjectionMode`.
### Before init
When no `.pi-map.md` / `.pi-map.index.md` artifacts exist, only a visible startup hint is injected. It tells the agent that the project-map extension is active and to run `project_map_init`. No synthetic or fake map content is ever injected before real artifacts exist.
### After init
Once real artifacts exist, the runtime guarantees that the root pair is loaded before any budgeted expansion:
- root `.pi-map.index.md`
- root `.pi-map.md`
Additional directory pairs are expanded only while the configured context budget allows, in shallow-first order.
### Trust boundary
Injected maps and indexes are navigation and orientation aids, not final authority:
> **index routes, map orients, source decides**
If an injected artifact and the source disagree, source wins. Always verify critical behavior from source before editing or making exact runtime claims.
### Mode ladder
- `off`: no automatic injection beyond existing tool/docs discovery.
- `advisory`: inject startup/init hints and allow optional root-pair preload; use light reminders.
- `strong` (default): inject the root pair, expand under the configured budget, run reinjection checks on relevant turns, and remind before edits or architecture-sensitive reasoning.
- `strict`: same as `strong`, plus require an explicit bypass justification before sensitive edits or architectural claims when the protocol path is missing.
The **protocol path** is present when the outgoing context contains the canonical injected root-pair block and the trust-boundary instruction. In `strict` mode, sensitive actions without it are blocked unless the agent includes `[PI_MAP_BYPASS: <brief justification>]`.
### Context budget
The default budget is **15% of the active model context window**, capped at **100k tokens**. The smaller of the relative and absolute values wins. If the runtime cannot discover the active model's context window, it falls back to the absolute cap.
Configure it in `.pi-project-map.json`:
```json
{
"promptInjectionMode": "strong",
"contextBudgetPercent": 15,
"contextBudgetMaxTokens": 100000
}
```
## Retrieval
When you have a specific query (e.g. "authentication logic" or "routing metadata"):
1. Run `project-map context <query>` or use the Pi tool `project_map_context`
2. Read the returned **Context bundle** — it contains relevant indexes, maps, likely files, and symbols
3. Always verify critical behavior from source before editing
Retrieval via `project_map_context` (tool) or `project-map context` (CLI) remains a separate, on-demand path. Use it for targeted navigation when you have a specific query; automatic injection does not replace it.
### Integration-test expectations and known limitations
The implementation is validated by integration tests covering:
- pre-init hint behavior,
- post-init root-pair preload,
- budgeted expansion behavior,
- canonical-marker dedupe,
- reinjection after compaction,
- reinjection after root-pair artifact changes,
- mixed visibility behavior,
- guidance-mode differences,
- strict-mode bypass behavior.
Known limitations:
- Token estimation is best-effort (≈ 4 chars per token); actual provider token counts may differ.
- Relevant-turn detection uses explicit event types when available and falls back to heuristics on generic turns.
- Message-layer scanning is preferred; provider-payload serialization quirks require a fallback scan path.
## Commands
```bash
project-map init
project-map patch <file>
project-map validate [--fix]
project-map reinit
project-map context <query>
```
### Context retrieval
`project-map context <query>` searches the paired map/index artifacts and returns a compact markdown bundle with the most relevant directories, files, and symbols. No LLM call is needed — it uses deterministic metadata scoring.
## Configuration
Create `.pi-project-map.json` in the project root:
```json
{
"ignorePatterns": ["node_modules", ".git"],
"smallPackageThreshold": 10,
"contextBudget": 4000,
"autoInjectPrompt": true,
"tagCap": 8,
"workflowHintCap": 5,
"promptInjectionMode": "strong",
"contextBudgetPercent": 15,
"contextBudgetMaxTokens": 100000
}
```
- `promptInjectionMode`: `off`, `advisory`, `strong` (default), or `strict`.
- `contextBudgetPercent`: relative share of the active model context window used for automatic map/index injection.
- `contextBudgetMaxTokens`: hard absolute cap on the injection budget.
## Design
See [design-doc.md](design-doc.md) for the full specification.
SKILL.md
+63 -102
View File
@@ -1,108 +1,71 @@
---
name: pi-map
description: Generates and maintains hierarchical, machine-readable project analysis files (.pi-map.md) for instant codebase comprehension. Use when working with medium-to-large codebases where understanding architecture, file relationships, and exports without reading every file is valuable. Automatically extracts symbols via AST and LLM heuristics.
description: Generates and maintains hierarchical, machine-readable paired project analysis artifacts (.pi-map.index.md and .pi-map.md) for fast codebase navigation and orientation.
---
# pi-project-map
A Pi skill that generates and maintains a hierarchical, machine-readable analysis of a software project. Each directory gets a `.pi-map.md` file containing architectural context, exported symbols, and dependencies.
A Pi skill that generates and maintains a paired analysis for each non-ignored directory:
- `.pi-map.index.md` for routing
- `.pi-map.md` for orientation
## What It Does
- **Scans** your entire project and creates one `.pi-map.md` per directory
- **Extracts** exports, imports, and dependencies via AST parsing (TypeScript, Python, Go) and LLM heuristics
- **Updates** incrementally when files change (full rewrite for small packages, section-level patch for large)
- **Validates** detects stale entries, missing files, orphaned entries, and changed signatures
- **Scans** your project and creates one paired map/index artifact set per directory
- **Extracts** exports, imports, and dependencies via AST parsing and LLM heuristics
- **Updates** generated artifacts after source edits
- **Validates** stale, missing, broken, or inconsistent paired artifacts
- **Retrieves** relevant context on demand via deterministic metadata scoring over the paired artifacts
## Quick Start
```bash
# Install globally
npm install -g pi-project-map
# Generate analysis files for the entire project
project-map init
# After editing a file, update its directory's analysis
project-map patch src/components/Button.tsx
# Check for staleness
project-map validate
# Force full regeneration
project-map reinit
project-map context "authentication logic"
```
## Format
## Operating Model
Each `.pi-map.md` uses dense markdown optimized for LLM consumption:
### Tier 0
Read the root `.pi-map.index.md` and the `Project Map Protocol` first.
```markdown
# pkg/auth
## role
Auth layer: JWT issuance, validation, refresh. Stateless. Dep: pkg/crypto, pkg/db.
## files
- tokens.ts | JWT gen/val | exp: issueToken, verifyToken, refreshToken | dep: crypto/hmac, db/sessions
- middleware.ts | HTTP auth guard | exp: requireAuth, requireRole | dep: tokens/verifyToken
## arch
Guard pattern on routes. Tokens short-lived (15m), refresh long-lived (7d). Rotation on every use.
## dirty
-
```
### Tier 1
Use indexes first for routing. Open the strongest-match `.pi-map.md` files next.
### Abbreviations
### Tier 2
Read actual source before editing or asserting exact behavior.
| Abbreviation | Meaning |
|-------------|---------|
| `exp:` | Exported symbols |
| `dep:` | Dependencies |
| `pkg/` | Internal package reference |
**Trust boundary:** index routes, map orients, source decides.
## Tools
## Prompt Injection Policy
### `project-map:init [root]`
Runs a full project scan and generates `.pi-map.md` files in every directory.
This skill can automatically inject lightweight project-map guidance into your context. The behavior is controlled by `promptInjectionMode` in `.pi-project-map.json`.
**Example:**
```bash
project-map init
project-map init ~/my-project
```
### Before init
When no `.pi-map.md` / `.pi-map.index.md` artifacts exist, you see a visible startup hint telling you to run `project_map_init`. No synthetic map content is injected before real artifacts exist.
### `project-map:patch <file-path>`
Updates the `.pi-map.md` for the directory containing the given file.
### After init
Once artifacts exist, the runtime guarantees that the root pair is loaded first:
**Behavior:**
- Small packages (< 10 files): full rewrite
- Large packages (>= 10 files): section-level patch
- root `.pi-map.index.md`
- root `.pi-map.md`
**Example:**
```bash
project-map patch src/components/Button.tsx
```
Additional directory pairs may be added while the configured context budget allows.
### `project-map:validate [root]`
Checks all `.pi-map.md` files for staleness.
### Mode ladder
- `off`: no automatic injection beyond existing tool/docs discovery.
- `advisory`: startup/init hints are shown; you may read the root pair manually when you want routing/orientation context.
- `strong` (default): the root pair is injected automatically, expansion stays within the context budget, and reinjection checks run on relevant turns (agent start, before edits, before architecture-sensitive reasoning, after compaction, after root-pair artifact changes).
- `strict`: same as `strong`, but before sensitive edits or architectural claims you must either have the protocol path in context or include an explicit bypass marker: `[PI_MAP_BYPASS: <brief justification>]`.
**Detects:**
- Missing files (new files not yet in `.pi-map.md`)
- Orphaned entries (files listed but deleted)
- Stale signatures (exports changed since last scan)
- Dirty markers (packages flagged for reconciliation)
The **protocol path** means the outgoing context contains the canonical injected root-pair block and the trust-boundary instruction (`index routes, map orients, source decides`).
**Example:**
```bash
project-map validate
```
### `project-map:reinit [path]`
Force full re-initialization. Clears all dirty markers.
**Example:**
```bash
project-map reinit
project-map reinit src/components
```
### Context budget
Default budget: **15% of the active model context window**, capped at **100k tokens**. The smaller of the relative and absolute values wins. If the runtime cannot discover the active model's context window, it uses the absolute cap.
## Configuration
@@ -110,43 +73,41 @@ Create `.pi-project-map.json` in the project root:
```json
{
"ignorePatterns": ["node_modules", ".git"],
"smallPackageThreshold": 10,
"contextBudget": 4000,
"autoInjectPrompt": true
"tagCap": 8,
"workflowHintCap": 5,
"promptInjectionMode": "strong",
"contextBudgetPercent": 15,
"contextBudgetMaxTokens": 100000
}
```
| Option | Default | Description |
|--------|---------|-------------|
| `ignorePatterns` | `node_modules`, `.git`, `dist`, etc. | Additional ignore patterns |
| `smallPackageThreshold` | `10` | File count threshold for full rewrite vs patch |
| `contextBudget` | `4000` | Max tokens to spend on analysis files |
| `autoInjectPrompt` | `true` | Auto-inject maintenance instructions |
- `promptInjectionMode`: `off`, `advisory`, `strong` (default), or `strict`.
- `contextBudgetPercent`: relative share of the active model context window to use for automatic map/index injection.
- `contextBudgetMaxTokens`: hard absolute cap on the injection budget.
## Agent Instructions
When `.pi-map.md` files exist in the project:
When project map artifacts exist in the repo:
1. **Read them at session start** to build project understanding without scanning every file
2. **Run `project-map:patch <path>`** after editing any source file
3. **Run `project-map:validate`** if you suspect staleness before making architectural decisions
4. **Trust the analysis** for orientation, but verify critical details by reading source when needed
1. Start with the root `.pi-map.index.md`
2. Use indexes first to route into the right directory
3. Read the local `.pi-map.md` plus source before editing
4. Run `project-map patch <path>` after editing source
5. Run `project-map validate` before freshness-sensitive architectural decisions
6. In `strict` mode, include `[PI_MAP_BYPASS: <brief justification>]` only when you deliberately need to proceed without the protocol path
7. For **targeted navigation**, use `project_map_context` (Pi tool) or `project-map context` (CLI) with a natural-language query. It returns a compact markdown bundle with the strongest-match indexes, maps, likely files, and symbols.
## Best Practices
## Retrieval Model
- Run `project-map:init` after cloning a new repository
- Run `project-map:reinit` periodically (daily/weekly) to catch changes made outside the agent
- Add `.pi-map.md` to `.gitignore` — they are derived artifacts
- For very large projects (> 1000 directories), consider running `init` on subdirectories
`project_map_context` and `project-map context` implement **index-first retrieval**:
## Supported Languages
1. Score every directory's paired map/index metadata against the query
2. Keep the top 3 strongest matches
3. Expand those matches into:
- Relevant indexes (routing-first)
- Relevant maps (orientation-first)
- Likely files
- Relevant symbols (only when useful)
4. Return a stable markdown bundle titled `# Context bundle: <query>`
| Language | AST Parsing | Heuristic Extraction |
|----------|------------|---------------------|
| TypeScript / TSX | Full | Full |
| JavaScript / JSX | Full | Full |
| Python | Partial | Full |
| Go | Partial | Full |
| Rust | Partial | Full |
| Other | - | Full (filename + regex patterns) |
**Trust boundary still applies:** the bundle routes and orients, but source decides. Always read actual source before editing.
cache/llm-cache.json
Vendored
-270
View File
@@ -1,270 +0,0 @@
{
"5ef2d43fdcc0141a7494c926da032af6708a60be024fdc7873cf37469b1a9a7e": {
"result": "PURPOSE: Specifies files and directories for Git to ignore in a Node.js project\nDEPS: git\nCONCEPTS: version control, ignore patterns, build artifacts, environment configuration, dependency management",
"ts": 1781101253058
},
"a093bb2fed59d699b7f9a62a5203cc196054c624e9c39c6d908c9e7db5dd2464": {
"result": "PURPOSE: Configures npm to use legacy peer dependency resolution behavior\nDEPS: npm\nCONCEPTS: package management configuration, peer dependency handling",
"ts": 1781101255838
},
"edd7b515e876afba58cd2397d4b04cf6e0309bbc2bfb81f79f7e94adb6862b30": {
"result": "PURPOSE: Describes a Pi skill that generates per-directory `.pi-map.md` files to provide machine-readable project summaries for agent comprehension.\nDEPS: npm, Node.js\nCONCEPTS: hierarchical project analysis, documentation generation, CLI tooling, agent-oriented design",
"ts": 1781101257984
},
"1c04338b0ebd9d3a241c4e7258ce7f9d2cc90be5be03788a9d7d6aff0209de47": {
"result": "PURPOSE: Generates and maintains hierarchical `.pi-map.md` analysis files per directory to enable instant codebase comprehension via AST parsing and LLM heuristics\nDEPS: npm, TypeScript/JavaScript AST parser, Python AST parser, Go AST parser, Rust AST parser, filesystem watcher\nCONCEPTS: hierarchical documentation, incremental updates, AST-based symbol extraction, LLM heuristics, dirty tracking/validation, dense markdown optimization, guard pattern, token budget management",
"ts": 1781101262689
},
"7ea3c13985c332cbdca448f7b7cd2067b4d08429b938bb61075255b8ff1a27b1": {
"result": "PURPOSE: Design a hierarchical project analysis skill for the Pi coding agent that generates and maintains compact, LLM-optimized `.pi-map.md` files per directory using hybrid LLM + AST extraction.\nDEPS: Pi Extension API, OpenAI-compatible LLM API, tree-sitter/LSP parsers, p-limit, SHA-256 hashing, Node.js/npm, TypeScript\nCONCEPTS: hierarchical project mapping, LLM-AST hybrid extraction, dense markdown format, token-efficient context, caching by content hash, incremental patching with dirty markers, validation and stale data mitigation, concurrency and rate limiting, prompt engineering",
"ts": 1781101268134
},
"b6228af707d3c250d26a87cd883ec75d6123bb561f0f1134d2ebc22b242c500e": {
"result": "PURPOSE: Implementation plan for replacing heuristic code analysis with real LLM integration in a Pi skill package that generates hierarchical `.pi-map.md` files for software projects.\n\nDEPS: openai, p-limit, Pi ExtensionContext/modelRegistry, TypeScript/Node.js\n\nCONCEPTS: hierarchical project analysis, LLM abstraction layer, dual-provider support, disk caching with LRU eviction, parallel batch processing with retries and exponential backoff, token budget management with truncation, prompt engineering, atomic file writes, factory pattern, dependency injection",
"ts": 1781101272709
},
"191f240ea0ca94939a3bac0c07ddea729dfecd34fa553c344151eee74afae826": {
"result": "PURPOSE: Defines a TypeScript-based Pi skill package for hierarchical project analysis that generates and maintains `.pi-map.md` files via CLI and OpenAI integration.\nDEPS: typescript, vitest, eslint, openai, tree-sitter, tree-sitter-python, tree-sitter-typescript, ignore, p-limit, picocolors\nCONCEPTS: CLI tooling, static code analysis, AI-powered code intelligence, hierarchical project mapping, tree-sitter parsing, concurrency limiting, Pi skill framework",
"ts": 1781101276443
},
"6736b63703d810d05e20f75829d48c3dcb26ecc34a61a72b34e67ba16c75d62a": {
"result": "PURPOSE: Registers four Pi extension tools (project_map_init, project_map_patch, project_map_validate, project_map_reinit) for managing .pi-map.md project analysis files, plus session lifecycle hooks for auto-loading maps and injecting maintenance hints.\nDEPS: @mariozechner/pi-coding-agent, typebox, fs, path, ./src/index.js, ./src/llm-client.js, ./src/llm-error.js\nCONCEPTS: Extension API registration, schema validation with TypeBox, recursive directory traversal, event hooks (session_start, before_agent_start), LLM client abstraction, error handling with custom error types",
"ts": 1781101281499
},
"fd478849f18f30f060a04006c2c99a5cf778928741fe7840bce91c1b612b475b": {
"result": "PURPOSE: Configures TypeScript compiler options for a Node.js project targeting ES2022 with strict type checking, declaration generation, and source maps.\nDEPS: TypeScript, Node.js\nCONCEPTS: ES modules, strict type checking, declaration files, source maps, JSON module resolution, project structure separation",
"ts": 1781101285063
},
"ca3d163bab055381827226140568f3bef7eaac187cebd76878e0b63e9e442356": {
"result": "PURPOSE: Empty JSON configuration file with no defined settings\nDEPS: none\nCONCEPTS: JSON, configuration file, empty object",
"ts": 1781101294054
},
"4e5f16536ba51381392c91d7548737ba1e75c260b40ba6bf12cd00e91b6662bd": {
"result": "PURPOSE: Specifies files and directories for Git to ignore in the repository.\nDEPS: none\nCONCEPTS: version control, ignore patterns, build artifacts, dependencies, environment files",
"ts": 1781101300959
},
"61b1cfba0fb43448ef5c8af601bd8d948fe6f2007bf1cbd7ad3cf38de8796959": {
"result": "PURPOSE: Provides a brief overview of a small test project for pi-project-map functionality, describing its directory structure.\nDEPS: none\nCONCEPTS: documentation, project structure",
"ts": 1781101302888
},
"774a9e5bc3d0cccb73f48c399090a674b15de7e1c3847338f8ce8f379aac4202": {
"result": "PURPOSE: Defines Node.js package metadata, entry point, and build/test scripts for a TypeScript project.\nDEPS: typescript, vitest\nCONCEPTS: npm package configuration, build automation, testing setup",
"ts": 1781101305949
},
"9b6a96e8186a8ab864e7ce794d4abffa04909d942ab25e3d2c7b4fd3b3993ff9": {
"result": "PURPOSE: Configures TypeScript compiler settings for a Node.js project targeting ES2022 with strict type checking.\nDEPS: TypeScript, Node.js\nCONCEPTS: compiler configuration, module resolution, strict mode, source/output directory mapping, ES2022 target",
"ts": 1781101309464
},
"5c4644938090d20c6ec6ad41ddcd405cd4dd743f0304839fda6536779d4a3977": {
"result": "PURPOSE: Documents the API for user model operations and validation utilities\nDEPS: none\nCONCEPTS: API documentation, CRUD operations, input validation, serialization, error handling",
"ts": 1781101314989
},
"b7ce5aa53a8029b3a8e964615c083e395923731fefa98859b52f63353cb06cd2": {
"result": "PURPOSE: Creates and validates a user, then logs the result, while also re-exporting its dependencies.\nDEPS: ./models/user.js, ./utils/validation.js, ./utils/logger.js\nCONCEPTS: async/await, re-exports, validation, logging",
"ts": 1781101321083
},
"5b7780f6c6dc3950d1eea8da636328ed4357546abd5c6b4e61158bec33f38d29": {
"result": "PURPOSE: Renders a reusable button component with configurable variant, label, click handler, and disabled state.\nDEPS: React\nCONCEPTS: functional components, props interface with optional/required fields, default parameter values, template literals for dynamic class names, JSX",
"ts": 1781101327896
},
"fecf0c5d358cd2308ec354f8648e249595634fb2b9e826bc786ae5b8cfb1b5fe": {
"result": "PURPOSE: Renders a user information card with optional edit and delete action buttons.\nDEPS: React, ../models/user.js\nCONCEPTS: Functional components, Props interface, Optional callbacks, Conditional rendering, JSX",
"ts": 1781101330838
},
"1d213e971dc36a5b0c3b09164532f4f23c47cf0d2303e696c3cc4527f1ad75cd": {
"result": "PURPOSE: Defines a User type and provides factory/serialization functions for user objects with email validation.\nDEPS: ../utils/validation.js\nCONCEPTS: interface, type omission (Omit), spread operator, factory pattern, serialization, UUID generation",
"ts": 1781101336857
},
"49f96f98e46b41171f7eec2185a7b70eccc069e35fc48e595477cb40e3058fe6": {
"result": "PURPOSE: Provides a simple timestamped console logging utility with typed severity levels and convenience methods.\nDEPS: none\nCONCEPTS: union types, function overloading via wrappers, template literals, pure functions",
"ts": 1781101341327
},
"d3f67a1eaae3b0c14e53fc33ff25f70695b99cac492b011d3d141c282775d3ee": {
"result": "PURPOSE: Provides string validation utility functions for email format, non-emptiness, and minimum length checks.\nDEPS: none\nCONCEPTS: regular expressions, pure functions, utility module pattern, string validation",
"ts": 1781101343923
},
"14311d5732fba356276aa801829d764e2f05655058c78c6da57b703fa507d9ac": {
"result": "PURPOSE: Tests user model creation and serialization with validation\nDEPS: vitest, ../src/models/user.js\nCONCEPTS: unit testing, test-driven development, validation, serialization, error handling",
"ts": 1781101348436
},
"0323321ea8b99c6b2ae75230e04e5df264d8a459f0e61608985a823f7a3d9e72": {
"result": "PURPOSE: Unit tests for string validation utility functions\nDEPS: vitest, ../src/utils/validation.js\nCONCEPTS: unit testing, test suites, parameterized assertions, edge case testing",
"ts": 1781101350510
},
"ccc1278c89e099da1a812dd261013282602a1b9a178e73474e20c659d87f9ec8": {
"result": "PURPOSE: Injects a maintenance instruction reminder into every AI agent prompt to ensure .pi-map.md files stay updated\nDEPS: none\nCONCEPTS: prompt injection, string interpolation, constant exports, sidecar/hook pattern",
"ts": 1781101355928
},
"c149160b07dd2c83c597ac8db04f0f2b664d0bfe0c73494bd441ec40537cabcd": {
"result": "PURPOSE: Extracts structured AST data (exports, dependencies, classes, functions) from source code files across multiple languages using tree-sitter parsers.\nDEPS: fs, path, tree-sitter, tree-sitter-typescript, tree-sitter-python, tree-sitter-go, tree-sitter-rust (optional)\nCONCEPTS: AST parsing, tree traversal, visitor pattern, dynamic module loading, language-agnostic code analysis, recursive descent parsing",
"ts": 1781101363602
},
"9ccca325201c14ff749252083ed2586da7ab4f51276990697a1d42a588d2866c": {
"result": "PURPOSE: Implements a CLI tool for generating and managing hierarchical `.pi-map.md` project analysis files using LLM-powered directory summarization.\nDEPS: picocolors, ./init.js, ./patch.js, ./validate.js, ./discover.js, ./llm-client.js, ./config.js, ../package.json\nCONCEPTS: command pattern, argument parsing, dependency injection, async/await, error handling with custom error types, process exit codes, string formatting",
"ts": 1781101369019
},
"f6650315d5deae3897ddee8471fe0c1976e587e59767616c732f09f5139ee3b5": {
"result": "PURPOSE: Defines a configuration interface and loader for a project mapping tool that merges user-defined JSON config with sensible defaults.\nDEPS: fs, path\nCONCEPTS: interface definition, default constants, shallow merge, file-based configuration, optional chaining via try/catch fallback",
"ts": 1781101372705
},
"ac6587bef7660e8c8de7cdb4a9a9f5453899154964801bd55ae396a8fec0b95b": {
"result": "PURPOSE: Recursively discovers project files and directories while respecting .gitignore patterns and default ignore rules.\nDEPS: fs, path, ignore\nCONCEPTS: recursive directory traversal, gitignore pattern matching, file system filtering, tree walking",
"ts": 1781101375796
},
"9083911787627247be76be8bc29763c6eb76ff19e22bb07ae35adc582dc42eb9": {
"result": "PURPOSE: Implements an LLMClient interface that sends code analysis prompts to OpenAI's chat completions API with configured model and error handling.\nDEPS: openai, ./llm-error.js, ./llm-client.js\nCONCEPTS: dependency injection, interface implementation, environment-based configuration, error wrapping, async/await, default parameters",
"ts": 1781101379466
},
"2592c1c238f016a227e8653703dba9c9a44b475b454973e81da502e433ffb826": {
"result": "PURPOSE: Provides bidirectional conversion between PackageMapData objects and a custom markdown format for package documentation.\nDEPS: none\nCONCEPTS: string parsing, markdown serialization/deserialization, state machine parsing, data transformation",
"ts": 1781101382110
},
"8c3890f74246ac93b3be460ed2e93ab961054d858d6cc34c3789084a695c30f0": {
"result": "PURPOSE: Main entry point that re-exports core functions for the pi-project-map skill\nDEPS: ./init.js, ./patch.js, ./validate.js, ./format.js\nCONCEPTS: barrel exports, module re-export pattern, skill architecture",
"ts": 1781101384907
},
"00cccebfa97420a2ddf71be724790f61699fb6ba7f59beba4dca1bf0820bd1bb": {
"result": "PURPOSE: Generates `.pi-map.md` documentation files for each directory in a project by combining LLM-based and AST-based extraction of file and package metadata.\nDEPS: ./discover.js, ./format.js, ./llm-extract.js, ./ast-extract.js, ./merge.js, fs, path, ./llm-client.js\nCONCEPTS: async/await, dependency injection, data merging from multiple sources, file I/O, map generation/caching",
"ts": 1781101388067
},
"1ef82a3248c87d9bef8b7a1d0d79f8c3294ee083ba591dc2978e5594f009c52f": {
"result": "PURPOSE: Implements an LLM client for Kimi.com's Anthropic-compatible API to send prompts and return completions.\nDEPS: llm-error.js, llm-client.js\nCONCEPTS: dependency injection via options, environment variable configuration, fetch API, error wrapping, interface implementation",
"ts": 1781101390722
},
"027ef87301425b5f8383bf6fa33b8a21467ca0ef9572e354aae1d5119e221318": {
"result": "PURPOSE: Provides utilities for batch processing files with concurrency limiting, retry logic with exponential backoff, and configurable delays between batches.\nDEPS: p-limit, ./llm-error.js\nCONCEPTS: concurrency control, retry pattern with exponential backoff, batch processing, promise pooling, default options merging",
"ts": 1781101394350
},
"bdc9b833e0b658b5f929c43e700a083b441b69e01172e6246c7eb8e942d5fb3f": {
"result": "PURPOSE: Provides a file-based caching system for LLM results keyed by hash, with atomic writes and automatic directory creation.\nDEPS: fs, path, process\nCONCEPTS: persistent cache, atomic file writes (write-then-rename), defensive programming (corrupted cache recovery), JSON serialization, timestamp tracking, optional configuration parameters",
"ts": 1781101397618
},
"ce37f5999955126fbb37f59302ed4b83242b798e332850f28eaa1c481230e3b5": {
"result": "PURPOSE: Provides a factory function to create LLM client instances for different providers (Pi, Kimi, OpenAI/External) behind a common interface.\nDEPS: llm-error.js, external-llm-client.js, kimi-llm-client.js, pi-llm-client.js\nCONCEPTS: factory pattern, strategy pattern, interface abstraction, dependency inversion",
"ts": 1781101401617
},
"936ebbbb957d1dfcc601687b077c5f4ef0107cb4f54c11db5d815c903a6c224d": {
"result": "PURPOSE: Defines a custom error class for LLM-related errors with optional cause chaining.\nDEPS: none\nCONCEPTS: custom error class, error cause chaining, readonly properties, TypeScript class inheritance",
"ts": 1781101403870
},
"4af9338e28d8e3574ff4e94a79f4c597f32329faa06ffd24dd4c7cb1f6987d4d": {
"result": "PURPOSE: Extracts semantic metadata (purpose, dependencies, concepts) from source code files and packages using LLM prompts with heuristic fallbacks for multiple programming languages.\nDEPS: fs, crypto, path, ./llm-client.js, ./llm-cache.js, ./llm-error.js\nCONCEPTS: LLM prompt engineering, caching with content hashing, context window truncation, heuristic fallback pattern, regex-based parsing, multi-language support, structured output parsing",
"ts": 1781101408698
},
"64fe8dcb933ddef5bcf79a11fe1d89585743321c2ba3af55c2ee6f1502945c52": {
"result": "PURPOSE: Merges LLM-generated file metadata with AST-extracted code structure into a unified FileEntry format using a compact DSL for exports.\nDEPS: ./format.js\nCONCEPTS: data merging, DSL encoding, deduplication, nullish coalescing, Set operations",
"ts": 1781101411772
},
"1aab9d3c142e39bc334ac2510fbe2d35cff52e6650ee07402dcda81a0522f2d6": {
"result": "PURPOSE: Updates a `.pi-map.md` documentation file for a package, either by full rewrite for small packages or section-level patching for larger packages, using both LLM and AST extraction.\nDEPS: path, fs, ./format.js, ./llm-extract.js, ./ast-extract.js, ./merge.js, ./init.js, ./llm-client.js\nCONCEPTS: conditional logic based on size threshold, file I/O operations, async/await, data merging from multiple sources, in-place array updates, dirty flag pattern",
"ts": 1781101416625
},
"b889955e1d8823a9e9103b36b42daa411f2381be2e18defb970212802f4915e2": {
"result": "PURPOSE: Implements an LLM client adapter that delegates to Pi's internal AI runtime, handling model resolution, authentication, and response parsing.\nDEPS: ./llm-error.js, ./llm-client.js, @mariozechner/pi-ai\nCONCEPTS: adapter pattern, dynamic imports, optional chaining, defensive error handling, runtime environment detection",
"ts": 1781101420745
},
"de1d2f98382d9e1e9fa7cf7ed1684993d4b7fdb505206757508dd8d917ecf525": {
"result": "PURPOSE: Validates `.pi-map.md` files against actual project structure and source code exports, with optional auto-fix capability.\nDEPS: discover.js, format.js, fs, path, ast-extract.js, init.js\nCONCEPTS: AST analysis, set comparison, discrepancy detection, optional mutation/fixing, verbose logging",
"ts": 1781101424333
},
"35562a91c040cbd1e1a7180f30faeb04be96dd94278e8c549e28fb8b6251ffe5": {
"result": "PURPOSE: TypeScript declaration file for the Pi AI runtime module providing a `complete` function for LLM inference with structured chat completion API\nDEPS: none\nCONCEPTS: ambient module declaration, type-only declaration file (.d.ts), runtime-only module, LLM chat completion API, discriminated union types, optional chaining pattern",
"ts": 1781101430608
},
"54e0b7bab2574a8ae7713ff80ef3c072a7351849e6a769af07a093e49fdd36c3": {
"result": "PURPOSE: Tests the AST extraction utility for parsing TypeScript file exports, imports, and handling unsupported file types.\nDEPS: vitest, fs, path, os, ../src/ast-extract.js\nCONCEPTS: unit testing, temporary file creation, async/await, null assertion handling, test fixtures",
"ts": 1781101436720
},
"bdbe3bafc717ce91a3ebe87c39c973f644611b653a9f6e5e689e7797e3b3b0ff": {
"result": "PURPOSE: Tests markdown rendering and parsing functions for package metadata, including round-trip serialization and edge cases like empty arrays and multiline fields.\nDEPS: vitest, ../src/format.js\nCONCEPTS: unit testing, round-trip testing, snapshot-like assertions, edge case handling, type imports",
"ts": 1781101440871
},
"7a708d3abc7a83c5ba649c898af12bc3243973d0e3bc581ff48a3cbd4cb52320": {
"result": "PURPOSE: Integration tests for a project mapping tool that verifies init, patch, and validate functionality using temporary directories\nDEPS: vitest, fs, path, os, ../src/init.js, ../src/patch.js, ../src/validate.js\nCONCEPTS: integration testing, temporary filesystem fixtures, setup/teardown hooks, async/await, test-driven development",
"ts": 1781101445059
},
"511ff5fedc1e22e8979c7ad5f29e01a04267c384046e50673545ca45adc9e71b": {
"result": "PURPOSE: Unit tests for retry logic and parallel file processing utilities in an LLM batch processing module.\nDEPS: vitest, ../src/llm-batch.js, ../src/llm-error.js\nCONCEPTS: unit testing, async/await, retry pattern, concurrency control, error handling, parameterized testing",
"ts": 1781101448595
},
"ac5829c11c6079597acd38e8a39eeb84d4eb28a27c733574b687ff17c82f9307": {
"result": "PURPOSE: Tests the getCached and setCached functions from llm-cache.js using a temporary file-based cache in a vitest test suite.\nDEPS: vitest, ../src/llm-cache.js, fs, path, os\nCONCEPTS: unit testing, file system mocking/cleanup, temporary directories, beforeEach/afterEach hooks, test isolation",
"ts": 1781101452064
},
"243326dc6b993d8dfbb98ebfbd51119e8824a55c3d262fd54351e2598509942f": {
"result": "PURPOSE: Tests the llm-extract module's ability to extract file metadata (exports, dependencies, purpose, concepts) using both heuristic parsing and LLM-based analysis.\nDEPS: vitest, ../src/llm-extract.js, fs, path, os, ../src/llm-client.js\nCONCEPTS: unit testing, mocking, temporary file fixtures, parameterized testing, fallback strategies",
"ts": 1781101455713
},
"c7c525672af743b8e7cc12441011b85fe1bec325c138c21c2b4ee1415a8bf863": {
"result": "PURPOSE: Integration test suite for LLM client functionality using the Kimi API, testing client creation, file/package extraction, caching, parallel processing, and error handling.\nDEPS: vitest, fs, path, os, ../src/llm-client.js, ../src/llm-extract.js, ../src/llm-batch.js\nCONCEPTS: integration testing, environment variable management, temporary file system operations, test skipping conditionally, API client mocking/spying, parallel processing with concurrency control, caching verification, error handling validation",
"ts": 1781101460014
},
"64f5ab73ff71a9c41639f3c8a5e248387a01e27a9612f0ed2b682708557f6a27": {
"result": "PURPOSE: Unit tests for a Pi extension that registers project map tools and lifecycle event handlers.\nDEPS: vitest, fs, path, os, @mariozechner/pi-coding-agent, typebox, @mariozechner/pi-ai, ../pi-extension.js\nCONCEPTS: unit testing, mocking with vi.mock, dependency injection, temporary filesystem fixtures, tool registration testing, event handler testing",
"ts": 1781101463953
},
"935ebdfde630eef58b7ce919770361a192cb568352bdc4f6feb73e49712435ec": {
"result": "PURPOSE: Auto-generated dependency lock file that records exact versions of all npm packages for the \"pi-project-map\" project to ensure reproducible installs\nDEPS: npm, node, esbuild, eslint, typescript, vitest, openai, tree-sitter, tree-sitter-python, tree-sitter-typescript, p-limit, picocolors, ignore\nCONCEPTS: dependency resolution, version locking, reproducible builds, transitive dependencies, semantic versioning, package management",
"ts": 1781105803170
},
"c02b509bba0bcfa201a834375562034eecad9920aef5b067f9a93387ce2b342e": {
"result": "PURPOSE: Registers four Pi extension tools (project_map_init, project_map_patch, project_map_validate, project_map_reinit) for managing .pi-map.md project analysis files, plus session lifecycle hooks for auto-detection and maintenance hints.\nDEPS: @mariozechner/pi-coding-agent, typebox, fs, path, ./src/index.js, ./src/llm/llm-client.js, ./src/llm/llm-error.js\nCONCEPTS: Extension API registration, LLM client abstraction, file system traversal, schema validation with TypeBox, async tool execution, event hooks (session_start, before_agent_start), progress callbacks, error handling with custom error types",
"ts": 1781105804655
},
"c95b6b5a1bdb3154e1570d6d7d6375d7e8f141ece9a26e3ce3ccf3315fbb3595": {
"result": "PURPOSE: Stores cached LLM analysis results keyed by content hash with timestamps to avoid redundant API calls\nDEPS: none\nCONCEPTS: caching, content-addressable storage, memoization, key-value store, hash-based lookup",
"ts": 1781105823217
},
"5392cfc86e14d048ff4aa8472945d7ff1254ca160ca656d6a7a02cdfc2931240": {
"result": "PURPOSE: Stores cached LLM analysis results keyed by SHA-256 content hashes with timestamps for a project mapping tool\nDEPS: none (self-contained JSON cache file)\nCONCEPTS: content-addressable storage, caching, JSON serialization, SHA-256 hashing, timestamp tracking, key-value store",
"ts": 1781105832833
},
"08c8a9ec61a988cfb22e6cbe381d66ed2b2a9831ea033073a63767fb11d3054c": {
"result": "PURPOSE: Validates and optionally repairs `.pi-map.md` files against actual project state by detecting missing maps, orphaned entries, dirty markers, and stale export signatures.\nDEPS: fs, path, ./discover.js, ./format.js, ./ast/ast-extract.js, ./init.js\nCONCEPTS: AST analysis, set comparison, discrepancy detection, dry-run vs fix modes, directory iteration",
"ts": 1781105865731
},
"f81a700850a8ab1067d1329af2675464e6435137e278ab8d62fcd5fc0bc5a1c4": {
"result": "PURPOSE: Patches a `.pi-map.md` file for a given source file, using full rewrite for small packages or section-level merging of LLM and AST extracted data for larger packages.\nDEPS: path, fs, ./format.js, ./llm/llm-extract.js, ./ast/ast-extract.js, ./merge.js, ./init.js, ./llm/llm-client.js\nCONCEPTS: conditional logic, file I/O, async/await, AST extraction, LLM extraction, data merging, threshold-based strategy pattern, in-place array mutation",
"ts": 1781105867062
},
"9f9cdf5a97d15f2ada69a3290288acbbca55693293e64eaa54ed68a3b69085dd": {
"result": "PURPOSE: Orchestrates project initialization by discovering directories, extracting file metadata via LLM and AST analysis, and generating `.pi-map.md` documentation files for each package.\nDEPS: fs, path, discover.js, format.js, llm/llm-extract.js, ast/ast-extract.js, merge.js, llm/llm-batch.js, llm/llm-client.js\nCONCEPTS: async/await, concurrency control, batch processing with retry logic, progress callbacks, dependency injection, file I/O, data merging from multiple sources",
"ts": 1781105867332
},
"b84477286885b2bed506b8b4b80b9a9a1ca0cb3b351bcd72f938559e55b152bc": {
"result": "PURPOSE: CLI entry point for a project mapping tool that generates, patches, validates, and regenerates `.pi-map.md` files using LLM-powered analysis.\nDEPS: picocolors, process, ../init.js, ../patch.js, ../validate.js, ../discover.js, ../llm/llm-client.js, ../config.js, ../package.json\nCONCEPTS: CLI argument parsing, command dispatch pattern, async/await, error handling with custom error classes, LLM client abstraction, configuration loading, process exit codes, pluralization formatting",
"ts": 1781105883128
},
"cb84ff08ab46a12f7a1fb49c7c3874743d4c38dd76d22c82ccea424e295ed929": {
"result": "PURPOSE: Extracts structured metadata (purpose, dependencies, concepts) from source files and packages using LLM prompts, with binary detection, size limits, and caching.\nDEPS: fs, crypto, path, llm-client.js, llm-cache.js, llm-error.js\nCONCEPTS: LLM prompt engineering, structured output parsing, content hashing, binary file detection, caching, context window management, token budgeting",
"ts": 1781105897002
},
"15cf6bdf05a57be59d4729d5095808645f6c6883d2d1e8615b3b5ce12d774a81": {
"result": "PURPOSE: Unit tests for an LLM response caching module that stores and retrieves string results by hash key in a JSON file.\nDEPS: vitest, fs, path, os, ../src/llm/llm-cache.js\nCONCEPTS: unit testing, file-based caching, test isolation with beforeEach/afterEach cleanup, temporary file storage",
"ts": 1781105907011
},
"2c776feaa98a5da6e1e68f908d855479994633779a7b6987f3675f0052c2cd98": {
"result": "PURPOSE: Tests retry logic and parallel file processing utilities for LLM batch operations.\nDEPS: vitest, ../src/llm/llm-batch.js, ../src/llm-error.js\nCONCEPTS: unit testing, retry patterns, concurrency control, async/await, error handling",
"ts": 1781105907677
},
"6198821ec6dd5417980e89ed44488c1d8bd78616a8396186acaed23bb331ad8a": {
"result": "PURPOSE: Tests the AST extraction functionality for parsing TypeScript exports, imports, and unsupported file types.\nDEPS: vitest, fs, path, os, ast-extract.js\nCONCEPTS: unit testing, temporary file creation, async/await, null safety with non-null assertion operator",
"ts": 1781105907686
},
"9f4d46b86a312ada127f0d5d295c4933959c42b8797e67a51abeed90bb44d468": {
"result": "PURPOSE: Integration tests for a project mapping tool that verifies init, patch, and validate functionality using temporary directories and mock LLM clients.\nDEPS: vitest, fs, path, os, ../src/init.js, ../src/patch.js, ../src/validate.js, ./mock-llm.js\nCONCEPTS: integration testing, temporary filesystem fixtures, mock objects, setup/teardown hooks, async/await",
"ts": 1781105908326
},
"d74151fa0b1c6e8dfdb5987527a624466beb4e5b6aecd1c16f57418046613c2d": {
"result": "PURPOSE: Tests the extractFileLLM function's behavior with mock LLM clients, including parsing responses, handling missing clients, and skipping large/binary files.\nDEPS: vitest, fs, path, os, ../src/llm/llm-extract.js, ../src/llm/llm-client.js\nCONCEPTS: unit testing, mocking, async/await, temporary file fixtures, dependency injection, parser validation, edge case handling",
"ts": 1781105909833
},
"5694eddea81e0978855baf756c906337a6edf1c2f6f1615ab31a66d2aeb56750": {
"result": "PURPOSE: Provides mock LLM client factories for testing that return predefined analysis strings\nDEPS: ../src/llm/llm-client.js\nCONCEPTS: mocking, factory functions, dependency injection, testing",
"ts": 1781105910171
},
"bd21b840465df9c0972a36b707e13ed712a3186a39312876178415d73250956a": {
"result": "PURPOSE: Integration tests for LLM client functionality including Kimi API calls, file/package extraction, caching, parallel processing, and error handling\nDEPS: vitest, fs, path, os, ../src/llm/llm-client.js, ../src/llm/llm-extract.js, ../src/llm/llm-batch.js\nCONCEPTS: integration testing, environment variable management, temporary file system operations, LLM API mocking/spying, caching validation, concurrency control, error handling for missing credentials, test skipping based on environment conditions",
"ts": 1781105911634
}
}
design-doc.md
+119 -30
View File
@@ -19,19 +19,49 @@ Enable a Pi coding agent to understand a software project's architecture and cod
- **Dense markdown**: Hierarchical headings, bullet points, and abbreviations are natively understood by LLMs and extremely token-efficient.
### Structure
Each directory in the project gets one analysis file named `.pi-map.md` (hidden by default, excluded from git via `.gitignore`).
Each non-ignored directory in the project gets **two** hidden analysis files:
- `.pi-map.index.md` — routing-first index
- `.pi-map.md` — orientation-first rich map
```markdown
# <relative-path> (index)
dir: <relative-path>
## role
<short routing summary>
## parent
<parent links or ->
## children
<child links or ->
## files
<likely files>
## links
index: <self-index>
map: <self-map>
## workflows
<compact task -> route hints>
## dirty
<timestamp or ->
```
```markdown
# <relative-path>
dir: <relative-path>
index: <sibling-index>
## role
<one-line package role> | Dep: <comma-separated upstream deps>
<one-line package role>
## files
- <filename> | <one-line purpose> | exp: <exported symbols> | dep: <internal/external deps>
- <filename> | <one-line purpose> | exp: <exported symbols> | dep: <internal/external deps>
## arch
<free-form architectural notes: patterns, data flow, invariants, design decisions>
<free-form architectural notes>
## tags
<compact tags>
## symbols
<prioritized symbols>
## workflows
<compact workflow hints>
## dirty
<timestamp or flag indicating staleness>
<timestamp or ->
```
### Abbreviation Conventions
@@ -152,16 +182,14 @@ For each directory (depth-first):
### Patch Pipeline
```
When agent edits file(s) in directory:
1. Determine patch strategy:
- If directory has < 10 files: full rewrite.
- Else: section-level patch for changed file(s) only.
2. For each changed file:
a. Recompute SHA-256.
b. Check cache. If miss or stale, call LLM with retries/backoff.
3. Re-run AST extraction on changed file(s) if applicable.
4. Update `## files` section (rewrite or patch).
5. Update `## dirty` flag if full regeneration is deferred.
When agent edits file(s):
1. Classify patch mode: auto, small, or structural.
2. Always regenerate the changed directory pair:
- `.pi-map.md`
- `.pi-map.index.md`
3. For small changes: refresh ancestor indexes.
4. For structural changes: refresh ancestor map/index pairs.
5. Use `validate --fix` to repair affected chains when paired artifacts are stale or missing.
```
## 4. LLM Prompt Design
@@ -220,18 +248,54 @@ The LLM client's response is parsed to extract `PURPOSE`, `DEPS`, `CONCEPTS`, `R
## 5. Consumption Model
### Session Start
1. Agent discovers all `.pi-map.md` files (e.g., via `find . -name ".pi-map.md"`).
2. Agent reads **all** files into context. This is a one-time cost at session start.
3. Agent constructs an internal mental model of the project hierarchy.
1. Agent reads the root `Project Map Protocol` and root `.pi-map.index.md`.
2. For architecture/system or ambiguous tasks, agent also reads the root `.pi-map.md`.
3. Agent does **not** preload every directory map by default.
In the Pi extension, this session-start consumption is assisted by automatic prompt injection:
- **Before init**: only a lightweight visible startup hint is injected, telling the agent to run `project_map_init`. No synthetic map content is injected.
- **After init**: the root pair (`.pi-map.index.md` + `.pi-map.md`) is guaranteed to be preloaded automatically. Additional directory pairs are expanded only while the configured context budget allows.
### Automatic Prompt Injection
The Pi extension uses event hooks (`before_agent_start`, `context`, etc.) to maintain guidance context.
- The **mode ladder** controls how much is injected:
- `off`: no automatic injection.
- `advisory`: visible startup/init hints and optional root-pair preload.
- `strong` (default): root pair + budgeted expansion + relevant-turn reinjection checks.
- `strict`: same as `strong`, plus explicit bypass justification for sensitive edits/architectural claims when the protocol path is missing.
- The **protocol path** requires both the canonical injected root-pair block and the trust-boundary instruction (`index routes, map orients, source decides`) to be present in outgoing context.
- **Reinjection avoidance** scans actual outgoing messages (and falls back to provider payload) for a stable canonical marker before adding the root pair again.
- **Relevant-turn triggers** are: agent start, before edits, before architecture-sensitive reasoning, after compaction, and after root-pair artifact changes.
- **Visibility** is mixed: startup/init hints are user-visible; raw injected artifact blocks are agent-visible by default.
### Context Budget
Default automatic-injection budget: **15% of the active model context window**, capped at **100k tokens**. The smaller of the relative and absolute values wins. If the runtime cannot discover the active model's context window, it falls back to the absolute cap.
Configurable via `.pi-project-map.json`:
```json
{
"promptInjectionMode": "strong",
"contextBudgetPercent": 15,
"contextBudgetMaxTokens": 100000
}
```
### During Session
- An **auto-injected summary** stays in context (e.g., a condensed top-level `.pi-map.md` or a synthesized project overview).
- When the agent needs deeper detail about a specific package, it already has the full `.pi-map.md` in memory from step 2.
- If the agent enters a new package not yet loaded, it reads that package's `.pi-map.md` on demand.
- Use directory indexes first to decide what to open next.
- For **targeted queries**, run `project_map_context` (tool) or `project-map context` (CLI). The retrieval engine scores all paired metadata and returns a compact markdown bundle with the top-3 strongest matches: indexes, maps, likely files, and symbols.
- Open the strongest-match `.pi-map.md` files for richer orientation.
- Read actual source before editing or making exact runtime claims.
### Context Management
- For very large projects, the agent may summarize or prune the initial read, keeping only the top N levels of the hierarchy in active context.
- The skill can provide a "context budget" parameter: max tokens to spend on analysis files.
- Tier 0 stays tiny and stable.
- Tier 1 loads only likely relevant indexes/maps.
- Tier 2 is real source, tests, config, and docs.
- Automatic injection stays within the configured budget and avoids redundant reinjection by scanning outgoing context.
## 6. Stale Data Mitigation
@@ -290,21 +354,33 @@ pi-project-map/
│ ├── llm-extract.ts # LLM prompt templates for extraction
│ ├── merge.ts # Merge AST + LLM outputs
│ ├── format.ts # Dense markdown formatter
│ └── config.ts # Skill configuration (thresholds, ignore patterns)
│ ├── config.ts # Skill configuration (thresholds, ignore patterns)
│ └── prompt-injection.ts # Runtime guidance injection policy and helpers
├── hooks/
│ └── on-prompt.ts # Injects maintenance command into prompts
│ └── on-prompt.ts # Injects maintenance command into prompts (legacy; Pi extension uses event hooks)
└── README.md # Setup and usage for humans
```
### Custom Tools
- `project-map:init` — Run full project scan. Creates all `.pi-map.md` files.
- `project-map:init` — Run full project scan. Creates all paired map/index artifacts.
- `project-map:patch <file-path>` — Update analysis for a specific file/directory.
- `project-map:validate` — Run consistency check across all `.pi-map.md` files.
- `project-map:validate` — Run consistency check across all paired artifacts.
- `project-map:context <query>` — Retrieve a compact markdown bundle of the most relevant directories, files, and symbols for a natural-language query.
- `project-map:reinit [path]` — Force re-initialization of entire project or subtree.
### Prompt Hook
- On every prompt, the skill appends a lightweight instruction:
> "If you modify any source file, run `project-map:patch <path>` to update the analysis. If you suspect staleness, run `project-map:validate`."
### Prompt Injection Hooks
The Pi extension registers event hooks instead of a single per-prompt append:
- `before_agent_start`: emits the pre-init hint when no artifacts exist, or preloads the root pair (plus budgeted expansion) after init.
- `context`: performs relevant-turn reinjection checks, detects compaction/artifact-change invalidation, and enforces `strict`-mode bypass guards.
- `before_provider_request`: optional fallback for marker scanning when message-layer detection is insufficient.
The injected maintenance reminder is:
> Start with the root `.pi-map.index.md`, use indexes first for routing, read the local `.pi-map.md` plus source before edits, run `project_map_patch` after source edits, and run `project_map_validate` before freshness-sensitive architectural handoff.
This is layered on top of the canonical root-pair block, which includes the trust boundary (`index routes, map orients, source decides`).
## 9. Risks and Tradeoffs
@@ -316,6 +392,19 @@ pi-project-map/
| Expensive init on large repos | Medium | Medium | Parallelization, caching, optional incremental init |
| Overlap with LSP/typedoc | Low | Low | This is agent-context, not IDE tooling. Different use case. |
| AST parser unavailable | Medium | Low | Graceful fallback to LLM-only extraction |
| Message-level marker scanning misses provider serialization quirks | Medium | Medium | Add payload fallback scanning |
| Root-pair marker becomes brittle | Low | Medium | Stable deterministic boundaries and normalized artifact identity lines |
| 15% / 100k default budget too aggressive for some fleets | Low | Medium | Both knobs are configurable |
| Relevant-turn detection fuzzy | Medium | Medium | Centralized heuristics + extensive integration tests |
| `strict` mode friction | Low | Medium | Keep `strong` as default; isolate strict-only bypass behavior |
### Prompt Injection Known Limitations
- Token estimation is best-effort (≈ 4 chars per token); actual provider token counts may differ.
- Relevant-turn detection relies on explicit event types when available, with heuristic fallback for generic turns.
- Provider payload serialization may require the fallback scan path.
- The mode ladder is config-driven in v1; future UX may expose runtime controls.
- Retrieval (`project_map_context`) remains separate from automatic injection.
## 10. Concrete Example: Full Project Snapshot
openspec/changes/archive/2026-06-11-layered-map-protocol/apply-progress.md
+10
View File
@@ -0,0 +1,10 @@
# Apply Progress
Status: complete
Summary: Implemented paired map/index artifacts, layered routing/orientation protocol, pair-aware patch/validate/reinit flows, config caps, and docs/runtime guidance.
Implemented commits:
- c6064f8 Implement layered maps and context retrieval
Stale-checkbox reconciliation: historical implementation completed in committed work above; tasks.md reconciled to checked state on 2026-06-11.
openspec/changes/archive/2026-06-11-layered-map-protocol/archive-report.md
+9
View File
@@ -0,0 +1,9 @@
# Archive Report
Status: archived
Archived path: openspec/changes/archive/2026-06-11-layered-map-protocol
Archive mode: manual archive fallback in openspec-only repo with legacy flat change specs; canonical sync marked not-applicable in sync-report.md.
Inputs preserved in archive: proposal.md, spec.md, design.md, tasks.md, apply-progress.md, verify-report.md, sync-report.md.
openspec/changes/archive/2026-06-11-layered-map-protocol/design.md
+200
View File
@@ -0,0 +1,200 @@
# Design: Layered Map Protocol
## Status
| Field | Value |
|---|---|
| Phase | **Design** |
| Based on | [Spec](spec.md) |
| Next | Tasks |
## Design summary
This change introduces a paired, navigation-first artifact model without changing the core mission of `pi-project-map`. The implementation should keep the existing discover → analyze → merge → render pipeline, but route both outputs through a shared intermediate directory model:
- `.pi-map.index.md` = routing-first view
- `.pi-map.md` = orientation-first view
Source remains the final authority.
## Affected areas
### Source files likely to change
- `src/format.ts`
- `src/init.ts`
- `src/patch.ts`
- `src/validate.ts`
- `pi-extension.ts`
- `README.md`
- `SKILL.md`
- `design-doc.md`
- CLI argument parsing for `validate --fix` if not already supported
### New modules likely to appear
- `src/root-index.ts` or equivalent shared index generation helper
- `src/directory-model.ts` or equivalent shared intermediate model helper
- optional config support for workflow/tag caps if not already present in config handling
## Architecture changes
### 1. Shared intermediate model
Build one structured directory model per mapped directory, then render two views from it.
The model should carry at least:
- directory identity (`dir`)
- sibling/parent/child relationships
- likely files
- role/arch summaries
- tags
- prioritized symbols
- workflow candidates in normalized schema
- stale/freshness markers
This shared model is the main guard against map/index drift.
### 2. Universal paired artifacts
During init/reinit, generate both `.pi-map.md` and `.pi-map.index.md` for every non-ignored directory.
#### Index rendering target
Indexes should be small and role-first, using this fixed order:
- `# <relative-path> (index)`
- `## role`
- `## parent`
- `## children`
- `## files`
- `## links`
- `## workflows`
- `## dirty`
Index content should include:
- `dir`
- short role summary
- parent link
- child directory links
- likely files
- explicit sibling/child `index:` / `map:` links
- up to configured workflow hints
- dirty marker
Indexes must omit dependency edges and keep architectural prose minimal.
#### Rich-map rendering target
Maps should remain dense but richer, using this fixed order:
- `# <relative-path>`
- `## role`
- `## files`
- `## arch`
- `## tags`
- `## symbols`
- `## workflows`
- `## dirty`
Map content should include:
- `dir`
- sibling `index:` link near the top
- slightly richer file lines than today when useful
- prioritized symbol lists in large directories
### 3. Root artifact behavior
Root `.pi-map.index.md` is the Tier 0 routing artifact.
Root `.pi-map.md` remains rich and must:
- point to root index,
- restate the trust boundary,
- be suitable for automatic loading on architecture/system or ambiguous tasks.
Both root artifacts should explicitly encode the Tier 0 behavior.
### 4. Workflow synthesis
Workflow hints may be LLM-heavy, but they must be normalized into a deterministic shape before rendering.
Suggested normalized fields:
- `task`
- `read`
- `index`
- `map`
- optional `files`
Indexes should render workflow hints in compact task→route form.
Because the user wants cross-repo workflow routing allowed, workflow synthesis may target other directories outside the local subtree when the hints are strong.
### 5. Configuration
Paired mode is the only mode for now, but these knobs should be configurable:
- workflow-hint cap (default 5)
- rich-map tag cap (default 8)
Configuration belongs in shared config handling rather than ad hoc generator constants.
Suggested config shape for v1:
```yaml
workflowHintCap: 5
tagCap: 8
```
### 6. Patch behavior
Patch should always regenerate, never hand-edit, generated artifacts.
#### Changed directory
Always regenerate both the local `.pi-map.md` and `.pi-map.index.md`.
#### Ancestor strategy
Use auto-detected patch sizing with explicit override available from both CLI and tool surfaces.
- **Small default:** up to 3 related files, no structure/routing shift
- refresh ancestor indexes only
- **Large/structural:** export changes, directory shape changes, routing metadata impact, or wider cross-area effect
- refresh both ancestor indexes and ancestor maps
This suggests a helper that computes the affected chain and the required artifact depth for each ancestor.
### 7. Validation behavior
Validation should become pair-aware, not just file-list-aware.
Checks should include:
- missing sibling artifact
- sibling `dir` mismatch
- broken parent/child/sibling references
- stale `dirty` markers
- stale or missing likely-file references
- disagreement between map/index routing references
Validation failures for missing/stale indexes are hard failures.
When validation classifies a patch as structural, the output should explain the main reason concisely (for example export change, directory-shape change, or routing impact).
Repair should be exposed through `validate --fix`, which regenerates the affected chain by default.
Validation and repair messaging should stay concise and inline, with the main structural reason plus the chosen `patchMode` when repair runs.
### 8. Prompt and doc integration
`pi-extension.ts`, `SKILL.md`, and docs should explicitly teach:
- Tier 0 = protocol + root index
- indexes first, maps next
- local rich map + source before edits
- validate before freshness-sensitive handoff
- `index routes, map orients, source decides`
### 9. External dependency boundary
This design should stay self-contained.
- No vector store is required.
- No Engram dependency is required.
- Retrieval remains local, deterministic, and based on generated paired artifacts.
## Risks
| Risk | Mitigation |
|---|---|
| Pair generation increases implementation size | Keep a shared intermediate model and split delivery into slices |
| Workflow hints become noisy | Omit uncertain hints and normalize schema before rendering |
| Ancestor refresh logic becomes brittle | Centralize affected-chain computation and test small vs structural cases |
| Pair drift creates false confidence | Use common `dir` identity and pair-aware validation |
| Config knobs spread inconsistently | Keep workflow/tag caps in shared config loading |
## Settled v1 defaults
- Root `.pi-map.md` points to root `.pi-map.index.md` rather than repeating route summaries.
- The shared intermediate directory model remains internal; behavior is tested through rendered outputs.
- Validation surfaces structural reasons as concise inline messages.
openspec/changes/archive/2026-06-11-layered-map-protocol/proposal.md
+96
View File
@@ -0,0 +1,96 @@
# Proposal: Layered Map Protocol
## Status
| Field | Value |
|---|---|
| Phase | **Proposal** |
| Based on | User interview + current design doc |
| Next | Spec |
## Problem
The current design centers consumption on discovering all `.pi-map.md` files and loading them at session start, with pruning for larger repositories. That scales poorly and frames maps as bulk context instead of as a navigation system.
The repo currently lacks:
1. a clear root routing artifact,
2. an explicit trust/use protocol,
3. a layered loading model,
4. fast per-directory navigation artifacts,
5. a clean split between routing metadata and richer orientation metadata.
## Proposed change
Adopt a layered navigation model built around a **paired artifact** for every non-ignored directory:
- `.pi-map.index.md` → fast routing
- `.pi-map.md` → richer orientation
### Tier model
- **Tier 0 — always injected:** Project Map Protocol + root `.pi-map.index.md`
- **Tier 1 — task-start load:** likely relevant directory indexes first, then rich maps for strongest matches
- **Tier 2 — exact verification:** source files, tests, configs, and docs
### Paired artifacts per directory
Every non-ignored directory should generate both:
- a rich `.pi-map.md`
- a lightweight `.pi-map.index.md`
The index is for movement. The map is for understanding. Source remains the final authority.
This change stays self-contained: it does not add a vector store, Engram dependency, or other external memory/retrieval backend.
### Operating model
- Root `.pi-map.md` remains rich, but points to root `.pi-map.index.md` for traversal.
- Each index points to its sibling rich map.
- Each rich map points back to its sibling index.
- If map and index disagree, trust neither blindly; verify from source and regenerate the pair.
## In scope
- [ ] Generate `.pi-map.index.md` for every non-ignored directory
- [ ] Keep `.pi-map.md` as the richer sibling artifact for every non-ignored directory
- [ ] Emit a Project Map Protocol in docs/prompt guidance and in generated root artifacts
- [ ] Replace eager "read all maps" guidance with layered retrieval guidance
- [ ] Define fixed index/map responsibilities and section order
- [ ] Cascade freshness and repair logic across changed directory pairs and affected ancestors
- [ ] Add strict validation for missing/stale/broken index-map pairs
- [ ] Update docs and skill guidance to reflect the new model
## Out of scope
- [ ] Add a query-driven retrieval command such as `project-map context <query>`
- [ ] Preserve backward compatibility for agents that only understand the old preload-only model
- [ ] Replace source verification with map-based authority
- [ ] Redesign the core AST/LLM extraction pipeline beyond what is needed to feed the new artifacts
## Decisions from grilling
| Topic | Decision |
|---|---|
| Change split | Two specs |
| This change slug | `layered-map-protocol` |
| Follow-up change slug | `map-context-retrieval` |
| Backward compatibility required | No |
| Artifact model | Every non-ignored directory gets both `.pi-map.md` and `.pi-map.index.md` |
| Root Tier 0 | Project Map Protocol + root `.pi-map.index.md` |
| Root rich map | Auto-read for architecture/system questions and ambiguous tasks |
| Root relationship | Root map points to root index |
| Retrieval mode | Hybrid auto-load, indexes first |
| Patch strategy | Changed dir updates both; ancestors refresh by size/structure rules |
| Validation | Hard-fail on missing/stale indexes, repair via `validate --fix` |
| Prompt trust boundary | index routes, map orients, source decides |
| Extra retrieval backends | None in this change |
| SDD mode | Interactive |
| Artifact store | OpenSpec |
| PR strategy | Auto-forecast |
| Review budget | 400 lines |
## Success criteria
- [ ] Every non-ignored directory has both a fast index and a richer map
- [ ] The root artifacts clearly tell an agent how to navigate and when to read source
- [ ] The documented consumption model no longer requires reading every `.pi-map.md` up front
- [ ] Validation fails on stale or missing paired artifacts and offers a repair path
- [ ] Patch/refresh behavior keeps routing trustworthy without requiring full reinit for small changes
openspec/changes/archive/2026-06-11-layered-map-protocol/spec.md
+229
View File
@@ -0,0 +1,229 @@
# Spec: Layered Map Protocol
## Status
| Field | Value |
|---|---|
| Phase | **Spec** |
| Based on | [Proposal](proposal.md) |
| Next | Design |
## Overview
`pi-project-map` must move from a bulk-preload model to a layered navigation model. The system should always provide a small root protocol plus root index, selectively load likely relevant directory indexes first, load rich maps next for the strongest matches, and require source verification before edits or precise runtime claims.
## Decisions
| # | Question | Answer |
|---|---|---|
| 1 | Per-directory artifact model | Every non-ignored directory gets both `.pi-map.md` and `.pi-map.index.md` |
| 2 | Tier 0 default | Project Map Protocol + root `.pi-map.index.md` |
| 3 | Root rich map auto-read | Yes for architecture/system questions and ambiguous tasks |
| 4 | Retrieval style before query tool exists | Hybrid auto-load, indexes first |
| 5 | Backward compatibility with old preload-only model | Not required |
| 6 | Query-driven context bundling | Deferred to follow-up spec `map-context-retrieval` |
| 7 | Mode shape | Paired artifact mode is the only mode for now |
| 8 | Index section naming | Simple fixed names: `role`, `parent`, `children`, `files`, `links`, `workflows`, `dirty` |
| 9 | Rich map section naming | Current-plus fixed names: `role`, `files`, `arch`, `tags`, `symbols`, `workflows`, `dirty` |
| 10 | Patch-size override surface | Available from both CLI and tool surfaces |
| 11 | Structural classification output | Validation explains the main structural reason concisely |
| 12 | Extra retrieval backends | No vector store or Engram dependency in this change |
## Functional requirements
### 1. Paired artifacts per directory
Every non-ignored directory must generate two artifacts:
- `.pi-map.index.md` — quick-routing index
- `.pi-map.md` — rich orientation document
Both artifacts must share a common identity marker such as `dir: <relative-path>`.
### 2. Root entrypoint
The tool must generate a root navigation layer in both root artifacts.
#### Root Tier 0 behavior
Tier 0 must always include:
- Project Map Protocol
- root `.pi-map.index.md`
The generated root artifacts must explicitly state this behavior.
#### Root rich map behavior
Root `.pi-map.md` must:
- point to root `.pi-map.index.md` for traversal,
- restate the trust boundary,
- be suitable for automatic loading on architecture/system questions and ambiguous tasks.
### 3. Project Map Protocol
The generated system must define an explicit protocol with at least these rules:
1. Read the Project Map Protocol and root `.pi-map.index.md` first.
2. Use `index:` / `map:` references to open relevant directory indexes and maps.
3. Load indexes before rich maps during task-start navigation.
4. Read the local rich map and actual source before editing.
5. Treat non-empty `## dirty` sections in either artifact as stale.
6. If source and generated artifacts disagree, trust source.
7. If map and index disagree, trust neither blindly; verify from source and regenerate the pair.
8. After editing source, run `project_map_patch` for each changed file.
9. Before broad architectural claims or final handoff, run `project_map_validate` when freshness matters.
### 4. Index contract
Every `.pi-map.index.md` must use a fixed section order and remain optimized for fast routing.
#### Required behavior
- Keep architectural prose minimal.
- Omit uncertain workflow/file hints rather than labeling confidence.
- Allow up to 5 workflow hints by default, with configuration support.
- Do not include dependency edges in indexes.
- Include explicit parent link when a parent mapped directory exists.
- For child directory entries, point to both child `index:` and child `map:`.
- Leaf-directory indexes remain tiny but still follow the same contract.
#### Fixed section order
Each index must use this fixed order:
1. `## role`
2. `## parent`
3. `## children`
4. `## files`
5. `## links`
6. `## workflows`
7. `## dirty`
#### Minimum contents
Each index must minimally support:
- title header in the form `# <relative-path> (index)`
- `dir` identity marker
- short role summary
- parent link where applicable
- child directories where applicable
- likely files
- explicit sibling/child `index:` / `map:` links
- short workflow hints in hybrid task→route form
- `## dirty`
### 5. Rich map contract
Every `.pi-map.md` must use a fixed section order and remain optimized for dense orientation.
#### Required behavior
- Rich maps must explicitly link to their sibling `.pi-map.index.md`.
- Rich maps may keep some routing overlap, but indexes remain primary for navigation.
- `files` entries should be slightly richer than the current dense line format when useful.
- Tags should default to up to 8, with configuration support.
- Symbols should be prioritized for density in large directories using structural importance plus LLM refinement.
- Cross-repo workflow routing should live mostly in indexes, not maps.
#### Fixed section order
Each rich map must use this fixed order:
1. `## role`
2. `## files`
3. `## arch`
4. `## tags`
5. `## symbols`
6. `## workflows`
7. `## dirty`
#### Minimum contents
Each rich map must minimally support:
- title header in the form `# <relative-path>`
- `dir` identity marker
- sibling `index:` link near the top
- richer but still compact workflow guidance
- `## dirty`
### 6. Workflow generation
Workflow hints may be LLM-heavy, but they must be normalized into a deterministic schema before rendering.
#### Index workflow rules
- Primary form is hybrid task→route, for example: `change CLI behavior -> read: src/.pi-map.index.md, src/cli.ts`
- Cross-repo routing is allowed.
- Uncertain hints should be omitted.
- Indexes should optimize for fast routing, not standalone completeness.
### 7. Shared generation model
Map and index generation must come from a shared intermediate directory model rather than unrelated passes.
The renderer may present different views, but the underlying directory identity and source facts must stay aligned.
### 8. Patch behavior
`project_map_patch` must never manually edit generated artifacts; it must regenerate them.
#### Changed directory
For every changed source file, patch must update both artifacts for the changed directory.
#### Ancestor refresh behavior
Patch sizing must be auto-detected with an explicit override path available from both CLI and tool surfaces.
- **Small change default:** up to 3 closely related files and no structural/routing shift
- changed directory: refresh map + index
- ancestors: refresh indexes only
- **Large/structural change:** exports, directory shape, routing metadata, or broader cross-area impact
- changed directory: refresh map + index
- ancestors: refresh both map + index
### 9. Validation behavior
`project_map_validate` must hard-fail when paired artifacts are missing or structurally stale.
Validation output should prefer concise inline wording, for example:
- `[structural] src/foo.ts: export change`
- `[stale-index] src/.pi-map.index.md: likely files out of date`
Validation must check at least:
- missing `.pi-map.index.md` or `.pi-map.md`
- stale `## dirty` sections in either artifact
- broken `index:` / `map:` references
- stale `files:` pointers
- map/index pair disagreement on routing hints or referenced areas
- sibling pair identity mismatches
When validation classifies a patch as structural, it should report the main reason concisely, such as export change, directory-shape change, or routing impact.
#### Repair
Repair must be exposed through `project-map validate --fix`.
Default repair scope is the affected directory pair plus the necessary ancestor chain.
Repair summaries should also report the chosen `patchMode` concisely, for example: `repaired affected chain (patchMode: structural)`.
### 10. Visibility and policy
`.pi-map.index.md` must follow the same hidden/ignored policy as `.pi-map.md`.
Agents should never manually edit either artifact directly.
## Non-functional requirements
- Prefer density over completeness.
- Keep indexes routing-first and maps understanding-first.
- Keep the protocol simple enough to emit in root artifacts and prompt guidance.
- Support configuration for top-level `workflowHintCap` and `tagCap` keys.
- Do not require a vector store, Engram, or other extra retrieval backend for this design.
## User flows
### Flow 1: Agent starts work on a repo
1. Agent reads the Project Map Protocol and root `.pi-map.index.md`
2. For architecture/system or ambiguous tasks, agent also reads root `.pi-map.md`
3. Agent opens likely relevant directory indexes first
4. Agent opens the strongest-match rich maps
5. Agent reads source only when exact behavior or editing is involved
### Flow 2: Agent edits a file
1. Agent routes with index data
2. Agent reads the local rich map and actual source
3. Agent edits source
4. Agent runs `project_map_patch` for changed files
5. Patch refreshes the changed directory pair and the required ancestor chain
### Flow 3: Validation and repair
1. Agent runs `project_map_validate`
2. Missing/stale pair failures are reported as hard errors
3. Agent runs `project-map validate --fix` when repair is desired
4. The affected chain is regenerated
## Acceptance criteria
- [ ] Every non-ignored directory produces both `.pi-map.md` and `.pi-map.index.md`
- [ ] Tier 0 behavior is both documented and emitted in generated root artifacts
- [ ] Indexes have a fixed routing-first contract with parent/child/sibling links
- [ ] Rich maps have a fixed orientation-first contract with sibling index links
- [ ] `project_map_patch` refreshes both changed-directory artifacts and size-appropriate ancestor artifacts
- [ ] `project_map_validate` hard-fails on missing/stale paired artifacts and supports `--fix`
- [ ] Workflow-hint count and tag cap are configurable
- [ ] Prompt guidance expresses: index routes, map orients, source decides
openspec/changes/archive/2026-06-11-layered-map-protocol/sync-report.md
+7
View File
@@ -0,0 +1,7 @@
# Sync Report
Status: NOT-APPLICABLE
Reason: This repository uses legacy flat change artifacts (proposal.md/spec.md/design.md/tasks.md) and does not maintain a canonical openspec/specs/ tree for these changes. No canonical spec sync was performed.
User-approved fallback: archive completed change as an audit record without canonical spec sync.
openspec/changes/archive/2026-06-11-layered-map-protocol/tasks.md
+75
View File
@@ -0,0 +1,75 @@
# Tasks: Layered Map Protocol
## Status
| Field | Value |
|---|---|
| Phase | **Tasks** |
| Based on | [Design](design.md) |
| Next | Apply |
## Delivery slices
### Slice 1: Shared model and paired rendering
**Scope**: shared intermediate directory model, universal paired artifacts, fixed section names/order, root Tier 0 entrypoint
**Review goal**: establish the core paired architecture without retrieval-command work
**Tasks**:
1. [ ] Add a shared intermediate directory model for paired map/index generation
2. [ ] Extend render/parse support for paired `.pi-map.md` and `.pi-map.index.md` outputs with the agreed fixed section names/order
3. [ ] Add generation support for `.pi-map.index.md` in every non-ignored directory
4. [ ] Enrich root artifacts with explicit Tier 0 behavior and sibling links
5. [ ] Add/update tests for map/index rendering, fixed order, and sibling identity
### Slice 2: Routing metadata and workflow normalization
**Scope**: likely files, parent/child/sibling links, workflow schema, rich-map metadata density rules
**Review goal**: make the navigation model operational on real output
**Tasks**:
1. [ ] Add index-first routing metadata generation from AST/structure + LLM judgment
2. [ ] Normalize workflow hints into a deterministic schema before rendering
3. [ ] Add parent/child/sibling `index:` / `map:` references
4. [ ] Implement rich-map density rules for slightly richer file lines, tag cap, and prioritized symbols
5. [ ] Add/update tests for routing hints, leaf indexes, and workflow omission on low confidence
### Slice 3: Patch sizing, cascade refresh, and repair
**Scope**: changed-directory pair refresh, ancestor-chain refresh rules, validation hard failures, `validate --fix`
**Review goal**: make freshness and repair trustworthy
**Tasks**:
1. [ ] Make `project_map_patch` always regenerate both artifacts for the changed directory
2. [ ] Add auto-detected small vs structural patch sizing with explicit override in both CLI and tool surfaces
3. [ ] Refresh ancestor indexes for small changes and ancestor map+index pairs for structural changes
4. [ ] Expand validation for pair-aware checks, hard failures on missing/stale indexes, and concise structural-reason output
5. [ ] Add/confirm `project-map validate --fix` repair flow for affected-chain regeneration
6. [ ] Add/update tests for patch classification, ancestor refresh, and repair behavior
### Slice 4: Prompt guidance, config knobs, and docs
**Scope**: Project Map Protocol, Tier 0 runtime guidance, workflow/tag config, docs rewrite
**Review goal**: align runtime behavior and documentation with the final operating model
**Tasks**:
1. [ ] Update `pi-extension.ts` prompt guidance to teach the layered paired protocol
2. [ ] Update `SKILL.md` to describe indexes as routing and maps as orientation
3. [ ] Update `README.md` and `design-doc.md` consumption guidance
4. [ ] Add config support for workflow-hint cap and rich-map tag cap
5. [ ] Keep the paired-artifact model self-contained with no vector-store or Engram dependency
6. [ ] Add/update tests for config-driven caps and root Tier 0 guidance
## Acceptance checklist
- [x] Every non-ignored directory has both `.pi-map.md` and `.pi-map.index.md`
- [x] Root Tier 0 behavior is emitted in generated root artifacts
- [x] Indexes are routing-first, role-first, and include parent/child/sibling links
- [x] Rich maps are orientation-first and include sibling index links
- [x] Changed-directory patch always regenerates both artifacts
- [x] Ancestor refresh follows small vs structural rules
- [x] Validation hard-fails on missing/stale paired artifacts and supports `validate --fix`
- [x] Workflow-hint count and tag cap are configurable
- [x] No vector-store or Engram dependency is introduced
- [x] `npm run typecheck` passes
- [x] `npm test` passes
- [x] `npm run lint` passes *(N/A: repo has no ESLint config; pre-existing repository gap, not a change regression)*
## Review workload note
This change crosses format, generation, patching, validation, config, docs, and prompt guidance. Keep implementation in narrow, reviewable slices and avoid one oversized PR.
openspec/changes/archive/2026-06-11-layered-map-protocol/verify-report.md
+22
View File
@@ -0,0 +1,22 @@
# Verify Report
Status: PASS
Change: layered-map-protocol
Verified summary: Implemented paired map/index artifacts, layered routing/orientation protocol, pair-aware patch/validate/reinit flows, config caps, and docs/runtime guidance.
Evidence commands:
- npm run typecheck
- npx vitest run
- npm run build
- node dist/cli.js validate .
Current validation state:
- npm run typecheck: PASS
- npx vitest run: PASS (262/262)
- npm run build: PASS
- node dist/cli.js validate .: PASS
Notes:
- Repo-wide lint remains unavailable because the repository has no ESLint config; treated as a pre-existing repository-level gap, not a change regression.
openspec/changes/archive/2026-06-11-map-context-retrieval/apply-progress.md
+10
View File
@@ -0,0 +1,10 @@
# Apply Progress
Status: complete
Summary: Implemented deterministic index-first context retrieval via tool and CLI, plus retrieval docs/skill guidance.
Implemented commits:
- c6064f8 Implement layered maps and context retrieval
Stale-checkbox reconciliation: historical implementation completed in committed work above; tasks.md reconciled to checked state on 2026-06-11.
openspec/changes/archive/2026-06-11-map-context-retrieval/archive-report.md
+9
View File
@@ -0,0 +1,9 @@
# Archive Report
Status: archived
Archived path: openspec/changes/archive/2026-06-11-map-context-retrieval
Archive mode: manual archive fallback in openspec-only repo with legacy flat change specs; canonical sync marked not-applicable in sync-report.md.
Inputs preserved in archive: proposal.md, spec.md, design.md, tasks.md, apply-progress.md, verify-report.md, sync-report.md.
openspec/changes/archive/2026-06-11-map-context-retrieval/design.md
+65
View File
@@ -0,0 +1,65 @@
# Design: Map Context Retrieval
## Status
| Field | Value |
|---|---|
| Phase | **Design** |
| Based on | [Spec](spec.md) |
| Next | Tasks |
## Design summary
This change adds a lightweight retrieval layer on top of paired project-map metadata. It should not require a new external storage system, vector store, or Engram dependency. Instead, it should scan root and directory indexes first, expand to rich maps and files from the strongest candidates, and emit an agent-friendly bundle.
## Likely implementation areas
- `pi-extension.ts` for the first-class tool surface
- `src/index.ts` for exports
- new retrieval module, e.g. `src/context.ts` or `src/retrieve.ts`
- shared parsing/model code from the layered protocol
- `src/cli/*` for follow-up CLI wiring
- docs and skill guidance
## Retrieval pipeline
1. Accept a natural-language `query`
2. Read root `.pi-map.index.md` and, when needed, root `.pi-map.md`
3. Parse paired index/map metadata through the shared format/model layer
4. Score candidate directories primarily from indexes
5. Keep the top 3 candidates by default
6. Expand strongest candidates to rich maps, likely files, and symbols
7. Emit a compact markdown bundle with stable section order and retrieval-specific title `# Context bundle: <query>`
## Candidate scoring inputs
- direct term matches in workflow hints
- direct term matches in likely files
- parent/child/sibling link context
- direct term matches in tags
- direct term matches in symbols
- path/name similarity
- root workflow routing hits
A first implementation can use deterministic weighted lexical scoring.
Candidate-selection reasoning does not need to be exposed by default.
## Parsing strategy
Reuse the paired-artifact parser/model from the layered protocol. Avoid retrieval-specific ad hoc parsing.
## Risks
| Risk | Mitigation |
|---|---|
| Retrieval becomes too fuzzy to trust | Keep output advisory and always direct agent back to source |
| Pair parser complexity grows | Extend shared format/model logic instead of command-local parsing |
| Command output becomes too large | Limit result count and keep instructions terse |
## Open choices
1. Exact scoring weights for workflow hints vs files vs tags vs symbols
2. Whether the tool should support optional structured output later
3. Whether broad architecture queries should be allowed to exceed the usual top-3 default in a later version
4. Whether later versions should support optional root-rich-map inclusion as a flag
openspec/changes/archive/2026-06-11-map-context-retrieval/proposal.md
+53
View File
@@ -0,0 +1,53 @@
# Proposal: Map Context Retrieval
## Status
| Field | Value |
|---|---|
| Phase | **Proposal** |
| Based on | Follow-up to `layered-map-protocol` |
| Next | Spec |
## Problem
After the layered map protocol lands, the agent will know it should load root protocol + root index first, then route through per-directory indexes and rich maps. But the repo will still lack an ergonomic retrieval primitive that can turn a natural-language task into a compact context bundle.
Without that helper, the agent still has to manually inspect directory indexes, rank candidate areas, and expand to rich maps/files. That weakens the value of the new routing layer.
## Proposed change
Add a retrieval tool and command shape:
```bash
project-map context "<user task>"
```
The first-class surface should be a Pi tool. CLI support can follow the same shape.
The retrieval result should return a compact context bundle containing:
- relevant indexes,
- strongest-match rich maps,
- likely source files,
- relevant symbols when useful,
- short instructions on what to read next.
This remains a local metadata-driven retrieval feature, not a vector-store or Engram-backed memory system.
## In scope
- [ ] Add Pi tool support for `project-map context <query>`
- [ ] Add CLI support using the same shape after the tool contract is stable
- [ ] Rank results using paired index/map metadata from the layered protocol
- [ ] Return a compact, markdown-first, agent-friendly context bundle
- [ ] Document recommended usage from prompts and docs
## Out of scope
- [ ] Full semantic search across arbitrary source contents
- [ ] Replacing source verification with map-based answers
- [ ] Building a heavyweight external indexer or vector database
## Success criteria
- [ ] A natural-language task can resolve to likely indexes/maps/files/symbols without manual repo scanning
- [ ] Output is compact enough to inject directly into the next step
- [ ] Retrieval builds on generated paired metadata rather than bypassing it
- [ ] The first version is tool-first and markdown-first
openspec/changes/archive/2026-06-11-map-context-retrieval/spec.md
+127
View File
@@ -0,0 +1,127 @@
# Spec: Map Context Retrieval
## Status
| Field | Value |
|---|---|
| Phase | **Spec** |
| Based on | [Proposal](proposal.md) |
| Next | Design |
## Overview
Add a retrieval-oriented `context` command that turns a user task into a compact project-map routing bundle. This change depends on the paired root/per-directory index+map metadata introduced by `layered-map-protocol`.
## Dependency
This change should not begin implementation before `layered-map-protocol` has landed enough metadata to support routing and ranking.
## Functional requirements
### 1. Tool-first surface
Pi should expose `project-map context` as a first-class tool action so agents can request a context bundle directly.
For v1, the tool input should be minimal:
- `query: string`
### 2. CLI follow-up surface
The CLI should support the same conceptual shape:
```bash
project-map context "<query>"
```
CLI support may follow after the tool contract is stable.
The CLI should mirror the same main input name: `query`.
### 3. Bundle contents
A context bundle must contain, at minimum:
- relevant indexes
- strongest-match relevant maps
- likely files
- relevant symbols when useful
- short next-step instructions
### 4. Ranking behavior
The command must rank candidates using generated metadata such as:
- root workflow hints
- directory index routing hints
- parent/child/sibling link structure
- package tags
- symbol references
- task/workflow entries
- `files:` / `index:` / `map:` targets
Indexes should be the first routing layer. Rich maps and symbols should expand from the strongest routed candidates.
By default, retrieval should usually surface the top 3 candidate directories, with adaptive omission of weaker rich maps when confidence drops.
### 5. Trust boundary
The bundle must instruct the agent to:
- read indexes first for orientation,
- read rich maps next when deeper context is needed,
- read source before editing or asserting exact behavior.
## Output shape
The first version should be markdown-first, with stable, schema-like sections optimized for LLM consumption rather than human prose.
Default section order:
1. `query`
2. `relevant indexes`
3. `relevant maps`
4. `likely files`
5. `relevant symbols`
6. `instructions`
The retrieval title format should remain retrieval-specific:
- `# Context bundle: <query>`
A representative response shape:
```markdown
# Context bundle: validation stale signatures
## query
validation stale signatures
## relevant indexes
- .pi-map.index.md
- src/.pi-map.index.md
- tests/.pi-map.index.md
## relevant maps
- src/.pi-map.md
- tests/.pi-map.md
## likely files
- src/validate.ts
- src/ast/ast-extract.ts
- tests/validate.test.ts
## relevant symbols
- validateMaps
- generateDirectoryMap
- extractFileAST
## instructions
Read the indexes first, then the strongest-match rich maps, then verify behavior from source before editing.
```
The tool should omit weak/unhelpful symbol output rather than forcing a noisy symbol section.
## Non-functional requirements
- Output must be compact enough for prompt injection.
- Ranking should be deterministic enough to test.
- The implementation should prefer lightweight heuristics over heavyweight indexing.
- Retrieval should reuse the paired-artifact parsing layer instead of ad hoc string slicing.
- Retrieval should not require a vector store, Engram, or another external memory backend.
- The first version should accept natural language queries first; structured filters can come later.
- Candidate explanations are not required by default.
- Result-count override and root-rich-map inclusion can come later if needed, but are not part of v1.
## Acceptance criteria
- [ ] Pi exposes `project-map context <query>` as a tool-first surface
- [ ] CLI support follows the same shape after the tool contract is stable
- [ ] Retrieval output includes indexes, strongest-match maps, files, and instructions
- [ ] Symbol hints appear only when paired metadata makes them useful
- [ ] Ranking respects the index-first routing model and usually returns top 3 candidates
- [ ] Docs show when to use the retrieval command
- [ ] Trust-boundary guidance remains explicit
openspec/changes/archive/2026-06-11-map-context-retrieval/sync-report.md
+7
View File
@@ -0,0 +1,7 @@
# Sync Report
Status: NOT-APPLICABLE
Reason: This repository uses legacy flat change artifacts (proposal.md/spec.md/design.md/tasks.md) and does not maintain a canonical openspec/specs/ tree for these changes. No canonical spec sync was performed.
User-approved fallback: archive completed change as an audit record without canonical spec sync.
openspec/changes/archive/2026-06-11-map-context-retrieval/tasks.md
+34
View File
@@ -0,0 +1,34 @@
# Tasks: Map Context Retrieval
## Status
| Field | Value |
|---|---|
| Phase | **Tasks** |
| Based on | [Design](design.md) |
| Next | Apply |
## Tasks
1. [ ] Add Pi tool support for `project-map context` with `query` as the main input
2. [ ] Add retrieval module for scoring paired index/map metadata
3. [ ] Reuse or extend shared paired-artifact parsing/model code
4. [ ] Rank candidate directories from indexes first, then expand to maps/files/symbols
5. [ ] Emit compact markdown-first context bundles with stable section order and retrieval-specific `Context bundle` title
6. [ ] Add tests for retrieval ranking, top-3 default behavior, and output shape
7. [ ] Add CLI support after the tool contract is stable
8. [ ] Update docs and skill guidance for retrieval usage
## Acceptance checklist
- [x] Tool works for natural-language queries via `query`
- [x] Output includes relevant indexes, strongest-match maps, likely files, symbols when useful, and instructions
- [x] Retrieval depends on paired metadata rather than raw source scanning
- [x] Ranking follows the index-first routing model with a top-3 default
- [x] `npm run typecheck` passes
- [x] `npm test` passes
- [x] `npm run lint` passes *(N/A: repo has no ESLint config; pre-existing repository gap, not a change regression)*
## Sequencing note
This change is intentionally follow-up work. It should start after the layered map protocol produces reliable paired routing metadata.
The first delivery surface is the Pi tool. CLI support follows the stabilized tool contract.
openspec/changes/archive/2026-06-11-map-context-retrieval/verify-report.md
+23
View File
@@ -0,0 +1,23 @@
# Verify Report
Status: PASS
Change: map-context-retrieval
Verified summary: Implemented deterministic index-first context retrieval via tool and CLI, plus retrieval docs/skill guidance.
Evidence commands:
- npm run typecheck
- npx vitest run
- npm run build
- node dist/cli.js context "validation routing"
- node dist/cli.js validate .
Current validation state:
- npm run typecheck: PASS
- npx vitest run: PASS (262/262)
- npm run build: PASS
- node dist/cli.js validate .: PASS
Notes:
- Repo-wide lint remains unavailable because the repository has no ESLint config; treated as a pre-existing repository-level gap, not a change regression.
openspec/changes/archive/2026-06-11-project-map-prompt-injection/apply-progress.md
+15
View File
@@ -0,0 +1,15 @@
# Apply Progress
Status: complete
Summary: Implemented prompt-injection slices 1-5: mode/config surface, root-pair preload, reinjection/dedupe, strict/advisory/strong/off semantics, and documentation/runtime alignment.
Implemented commits:
- 56560d9 feat(prompt): implement prompt injection slice 1
- 621434b feat(prompt): implement prompt injection slice 2
- 19666c9 feat(prompt): implement prompt injection slice 3
- 58e8bd3 feat(prompt): implement prompt injection slice 4
- 11365fa docs(prompt): align prompt injection guidance and runtime copy
- c11d49d spec(prompt): add project map prompt injection change set
Stale-checkbox reconciliation: historical implementation completed in committed work above; tasks.md reconciled to checked state on 2026-06-11.
openspec/changes/archive/2026-06-11-project-map-prompt-injection/archive-report.md
+9
View File
@@ -0,0 +1,9 @@
# Archive Report
Status: archived
Archived path: openspec/changes/archive/2026-06-11-project-map-prompt-injection
Archive mode: manual archive fallback in openspec-only repo with legacy flat change specs; canonical sync marked not-applicable in sync-report.md.
Inputs preserved in archive: proposal.md, spec.md, design.md, tasks.md, apply-progress.md, verify-report.md, sync-report.md.
openspec/changes/archive/2026-06-11-project-map-prompt-injection/design.md
+235
View File
@@ -0,0 +1,235 @@
# Design: Project Map Prompt Injection
## Status
| Field | Value |
|---|---|
| Phase | **Design** |
| Based on | [Spec](spec.md) |
| Next | Tasks |
## Design summary
This change adds a runtime guidance layer on top of the paired map/index artifact system. The implementation should not redesign map generation or retrieval. Instead, it should add a well-scoped injection pipeline that:
- emits honest startup hints before init,
- preloads the root pair after init,
- expands under a hybrid budget,
- avoids redundant reinjection by scanning real outgoing context,
- varies guidance strength through explicit modes,
- proves correctness with integration-heavy validation.
## Affected areas
### Source files likely to change
- `pi-extension.ts`
- shared config handling (`src/config.ts` or equivalent)
- runtime helpers for map/index discovery and injection selection
- tests covering extension lifecycle and per-turn behavior
- docs/runtime guidance surfaces if needed
### New modules likely to appear
- `src/prompt-injection.ts` or equivalent runtime helper
- optional helper for canonical marker construction / detection
- optional helper for token-budget estimation across paired artifacts
## Architecture changes
### 1. Injection policy helper
Centralize prompt-injection logic in one helper rather than scattering it across hooks.
Suggested responsibilities:
- determine current mode (`off` / `advisory` / `strong` / `strict`),
- detect whether artifacts exist,
- build pre-init startup hint,
- build post-init root-pair payload,
- estimate expansion budget,
- choose additional artifacts under the budget,
- construct a canonical injected marker/block,
- scan outgoing context or payload for that marker,
- decide whether reinjection is required.
This helper is the main guard against drift between startup hints, context hooks, and strict-mode checks.
### 2. Injection surfaces
Use different extension surfaces for different responsibilities.
#### Pre-init / startup hint
Use `before_agent_start` for lightweight startup guidance before real artifacts exist.
Required behavior:
- inject only a hint,
- tell the agent to run `project_map_init`,
- keep the hint visible and inspectable.
#### Post-init root-pair preload
Use `before_agent_start` to guarantee the initial post-init root-pair preload for a prompt.
Required behavior:
- inject root `.pi-map.index.md`,
- inject root `.pi-map.md`,
- optionally append brief protocol text only if needed by the selected mode.
#### Relevant-turn reinjection
Use `context` for relevant-turn checks.
Required behavior:
- inspect `event.messages`,
- decide whether the canonical block is already present,
- only add the root pair / budgeted expansion if absent,
- avoid rescanning on every trivial turn in `strong` mode.
#### Payload fallback
Use `before_provider_request` only as a fallback or debugging surface when message-layer detection is insufficient.
### 3. Canonical marker design
Deduplication depends on stable canonical detection.
The implementation should stamp injected content with a canonical marker block.
Recommended v1 shape:
- a deterministic wrapper such as `<!-- PI_MAP_ROOT_PAIR_START -->` / `<!-- PI_MAP_ROOT_PAIR_END -->`,
- normalized artifact identity lines for root `.pi-map.index.md` and root `.pi-map.md`,
- trust-boundary text within the same wrapped block when the active mode requires it.
Marker rules:
- stable across turns,
- independent of provider formatting quirks,
- easy to scan in both `event.messages` and final provider payload,
- robust enough that root-pair presence can be detected without brittle full-text matching.
### 4. Budgeting
Budgeting should be deterministic and layered.
#### Context-window discovery and fallback
- Prefer active-model context-window metadata exposed by Pi runtime/model selection.
- If context-window metadata is unavailable, fall back to the configured absolute cap.
- The fallback path should be explicit in logs/debug behavior so budget decisions remain auditable.
#### Required order
1. compute effective budget from relative percentage + optional absolute cap,
2. reserve the root pair first,
3. expand outward using a deterministic traversal order,
4. stop when the budget would be exceeded.
#### Traversal strategy
The spec does not force exact traversal heuristics, but the design should prefer:
- root pair first,
- shallow structural coverage before deep leaves,
- predictable order over opaque scoring.
This keeps automatic injection understandable and auditable.
### 5. Mode control surface
Expose a config/runtime setting for the four modes.
Because the current project config is loaded from flat JSON in `.pi-project-map.json`, v1 should prefer a flat compatible shape rather than forcing an immediate nested/YAML migration.
Suggested v1 config shape:
```json
{
"promptInjectionMode": "strong",
"contextBudgetPercent": 15,
"contextBudgetMaxTokens": 100000
}
```
Migration note:
- keep existing flat JSON loading in `src/config.ts`,
- treat these as new additive keys,
- decide explicitly whether existing `contextBudget` is deprecated, ignored for injection, or retained only for older LLM-analysis paths.
Optional runtime UX may later mirror thinking-level controls, but v1 implementation can start with config-driven mode selection as long as the semantics are the same.
### 6. Mode semantics
#### `off`
- no automatic artifact injection,
- no startup/init hint beyond existing tool/docs discovery.
#### `advisory`
- startup/init hints enabled,
- optional root-pair preload,
- light reminders,
- weaker reinjection behavior.
#### `strong`
- root-pair preload required,
- budgeted expansion required,
- relevant-turn reinjection checks required,
- reminders before edits and architecture-sensitive reasoning.
#### `strict`
- everything in `strong`, plus:
- when protocol path is missing during sensitive actions, require explicit bypass justification.
### 7. Relevant-turn detection
`strong` mode should not rescan on every turn.
Relevant-turn triggers should be mapped to concrete runtime signals where possible:
- agent start,
- edit intent / edit tool preparation,
- architecture-sensitive planning prompts,
- compaction completion,
- root-pair artifact change detection.
This will likely require some combination of:
- hook-local heuristics,
- observed tool calls,
- file timestamp/hash checks for root artifacts,
- compaction event handling.
### 8. Visibility model
The design should preserve mixed visibility.
- startup hints: visible and inspectable,
- raw injected artifact blocks: agent-visible by default,
- the fact that automatic injection exists should remain discoverable.
The implementation may use hidden custom message types for artifact payloads, but should not make startup/init behavior opaque.
### 9. Validation strategy
This change is validation-heavy.
Unit tests alone are not enough, because the main risk is runtime interaction between hooks, message mutation, compaction, and reinjection.
#### Integration focus areas
- startup before init,
- startup after init,
- root-pair marker insertion,
- reinjection suppression when marker already exists,
- reinjection after compaction,
- reinjection after artifact mutation,
- mode differences,
- strict-mode bypass path,
- mixed visibility expectations,
- synthetic event-sequence coverage for relevant-turn heuristics such as edit-intent, architecture-sensitive reasoning, compaction, and artifact invalidation.
### 10. Documentation impact
Runtime guidance docs must align with the spec, but retrieval docs remain separate.
Docs should teach:
- startup hint before init,
- root-pair automatic preload after init,
- trust boundary,
- mode ladder,
- relevant-turn reinjection behavior,
- integration-test importance.
## Risks
| Risk | Mitigation |
|---|---|
| Message-level scanning misses provider serialization quirks | Add payload fallback via `before_provider_request` |
| Root-pair marker becomes brittle | Use deterministic boundaries and normalized artifact identity lines |
| 15% + 100k is too aggressive in some fleets | Keep both knobs configurable and document the opinionated default |
| Relevant-turn detection becomes fuzzy | Centralize detection heuristics and prove them with integration tests |
| `strict` mode causes friction | Keep `strong` as default and isolate strict-only bypass behavior |
## Settled defaults
- Root pair is always guaranteed after init.
- Reinjection avoidance is based on canonical outgoing-context scanning.
- Retrieval remains out of scope.
- Mixed visibility is the intended baseline.
- Four modes exist, with `strong` as default.
- Default budget is 15% of active context window, capped at 100k tokens.
openspec/changes/archive/2026-06-11-project-map-prompt-injection/proposal.md
+88
View File
@@ -0,0 +1,88 @@
# Proposal: Project Map Prompt Injection
## Status
| Field | Value |
|---|---|
| Phase | **Proposal** |
| Based on | Grill Me checkpoint + runtime/doc inspection |
| Next | Spec |
## Problem
`pi-project-map` currently provides strong generated artifacts and tool surfaces, but weak automatic runtime guidance.
Today the repo has:
- a one-time `before_agent_start` hint,
- a `session_start` dirty-state UI notification,
- tool metadata and docs,
- generated `.pi-map.md` / `.pi-map.index.md` artifacts.
But it lacks a clear spec for:
1. when maps/indexes should be injected automatically,
2. how much should be injected under a context budget,
3. how reinjection should avoid wasting prompt space,
4. how visible that guidance should be to the user,
5. how strong enforcement should be,
6. how to validate this behavior with integration tests.
## Proposed change
Adopt a runtime prompt-injection policy for project-map that:
- always injects the **root pair** after init,
- expands outward under a **hybrid context budget cap**,
- avoids redundant reinjection by scanning the actual outgoing context,
- keeps **retrieval guidance separate** from this spec,
- exposes **four configurable guidance modes** (`off`, `advisory`, `strong`, `strict`),
- uses **mixed visibility**: user-visible startup hints, agent-visible artifact injection,
- requires **extensive integration tests** for reinjection and context-scanning behavior.
## In scope
- [ ] Define pre-init startup hint behavior
- [ ] Define post-init automatic root-pair preload behavior
- [ ] Define hybrid budget defaults and config shape
- [ ] Define outgoing-context scanning for reinjection avoidance
- [ ] Define visibility model for hints vs injected artifacts
- [ ] Define configurable guidance-strength modes and default
- [ ] Define relevant-turn reinjection triggers for `strong`
- [ ] Define strict-mode bypass-justification behavior at the spec level
- [ ] Define validation and integration-test expectations
- [ ] Define implementation slices for runtime hooks/config/tests/docs
## Out of scope
- [ ] Redesign retrieval ranking or `project_map_context`
- [ ] Merge retrieval behavior into this policy spec
- [ ] Redesign paired artifact contents
- [ ] Introduce vector stores, Engram, or external retrieval backends
- [ ] Guarantee provider-agnostic perfect token counting beyond best-effort budgeting
## Decisions from grilling
| Topic | Decision |
|---|---|
| Change slug | `project-map-prompt-injection` |
| Scope split | Retrieval remains a separate spec |
| Pre-init | Inject only a lightweight `project_map_init` hint |
| Fake/synthetic maps before init | No |
| Guaranteed minimum | Always inject root `.pi-map.index.md` + root `.pi-map.md` |
| Budget model | Hybrid cap |
| Budget config | Relative percentage + optional absolute cap; smaller wins |
| Budget default | 15% of context window, capped at 100k tokens |
| Reinjection avoidance | Canonical marker scanning in actual outgoing context |
| Visibility | Mixed |
| Mode set | `off`, `advisory`, `strong`, `strict` |
| Default mode | `strong` |
| `strong` triggers | Relevant turns only |
| Validation | Extensive integration tests required |
## Success criteria
- [ ] The spec clearly defines what is injected before and after init
- [ ] The spec clearly defines how much is injected and how budgets are applied
- [ ] The spec clearly defines when reinjection checks happen and how duplicates are avoided
- [ ] The spec clearly defines mode semantics and the default mode
- [ ] The spec clearly separates runtime injection policy from retrieval behavior
- [ ] The implementation plan can be executed in narrow, reviewable slices
- [ ] The validation section makes integration coverage a first-class requirement
openspec/changes/archive/2026-06-11-project-map-prompt-injection/spec.md
+226
View File
@@ -0,0 +1,226 @@
# Spec: Project Map Prompt Injection
## Status
| Field | Value |
|---|---|
| Phase | **Spec** |
| Based on | [Proposal](proposal.md) |
| Next | Design |
## Overview
`pi-project-map` must define a deliberate automatic runtime guidance model for map/index usage. After init, the system should preload the root pair, expand under a bounded context budget, avoid redundant reinjection by inspecting actual outgoing context, and scale enforcement through configurable guidance modes.
This spec covers **automatic injection and maintenance guidance only**. Retrieval behavior remains covered by `map-context-retrieval`.
## Decisions
| # | Question | Answer |
|---|---|---|
| 1 | Retrieval included in this spec | No |
| 2 | Pre-init behavior | Lightweight init hint only |
| 3 | Synthetic map content before init | No |
| 4 | Guaranteed post-init minimum | Always inject root pair |
| 5 | Budget model | Hybrid cap |
| 6 | Budget knobs | Relative percentage + optional absolute cap |
| 7 | Budget default | 15% of context window, capped at 100k tokens |
| 8 | Reinjection avoidance | Canonical marker scan in outgoing context/payload |
| 9 | Visibility | Mixed |
| 10 | Mode set | `off`, `advisory`, `strong`, `strict` |
| 11 | Default mode | `strong` |
| 12 | `strong` reinjection cadence | Relevant turns only |
| 13 | Validation expectation | Extensive integration coverage |
## Functional requirements
### 1. Pre-init behavior
Before generated map/index artifacts exist, the extension must inject only a lightweight startup hint.
#### Required behavior
- The hint must tell the agent that the project-map extension is active.
- The hint must instruct the agent to run `project_map_init`.
- The hint must not claim that real map/index artifacts already exist.
- The system must not inject synthetic or fake map content before real artifacts are generated.
### 2. Post-init guaranteed preload
After real artifacts exist, the system must guarantee a minimum preload of the root pair:
- root `.pi-map.index.md`
- root `.pi-map.md`
This root pair is the minimum automatic preload before budgeted expansion begins.
### 3. Trust boundary
The runtime policy must encode the trust boundary:
> **index routes, map orients, source decides**
Required implications:
1. Indexes are navigation aids, not final authority.
2. Maps provide orientation and architectural context, not final authority.
3. Source must remain the final authority before edits or exact behavioral claims.
4. If injected artifacts and source disagree, source wins.
### 4. Budget model
Automatic expansion beyond the root pair must use a hybrid context budget cap.
#### Knobs
The system must support:
- a **relative context-budget percentage**,
- an **optional absolute token cap**.
If both are configured, the smaller effective budget wins.
#### Default budget
The default must be:
- **15%** of the active model context window,
- **100k tokens** absolute cap,
- use the smaller effective budget.
#### Context-window discovery and fallback
- The runtime should derive the active model context window from Pi model metadata when available.
- If the active model context window is unavailable, the runtime must still honor the absolute cap.
- In that fallback case, implementations may skip the relative calculation and use the absolute cap as the effective budget.
#### Expansion rules
- Root pair injection happens before budgeted expansion.
- Additional map/index artifacts are added only while the budget allows.
- The expansion strategy should prefer shallow, high-value structural coverage over deep indiscriminate expansion.
- The spec does not require exact provider-token parity; best-effort budgeting is acceptable if it is deterministic and auditable.
### 5. Reinjection avoidance
The extension must avoid redundant reinjection once the root pair is already in active outgoing context.
#### Required definition
"Already in context" must be defined by scanning the **actual outgoing context**, not only by session guesses.
#### Required behavior
- Before reinjecting, scan per-turn `event.messages` for a stable canonical marker or normalized injected root-pair block.
- If message-layer evidence is insufficient, the runtime may additionally inspect the final provider payload.
- Inject only when the canonical root-pair marker/block is absent.
- The spec must allow implementation via explicit scanning logic even if Pi does not expose a convenience API.
### 6. Visibility model
The system must use mixed visibility.
#### Required behavior
- Lightweight startup/init hints should be user-visible and inspectable.
- Automatic artifact injection may remain agent-visible by default.
- The spec should preserve debuggability: implementations should make the presence of automatic guidance discoverable, even when raw artifact blocks are not fully dumped to the user on every turn.
### 7. Guidance-strength modes
The system must support four named modes:
- `off`
- `advisory`
- `strong`
- `strict`
#### Protocol path definition
For this spec, the **protocol path** is present when the current outgoing context contains:
1. the canonical injected root-pair block, or an equivalent canonical marker proving that root `.pi-map.index.md` and root `.pi-map.md` are already present, and
2. the trust-boundary instruction establishing that `index routes, map orients, source decides`.
If either element is missing for a sensitive action, the protocol path is missing.
#### Mode semantics
- **`off`**
- no automatic injection beyond tool/docs discovery.
- **`advisory`**
- inject startup/init hints,
- allow optional root-pair preload,
- use light reminders.
- **`strong`**
- inject root pair,
- expand under the configured budget,
- run reinjection checks on relevant turns,
- remind before edits or architecture-sensitive reasoning.
- **`strict`**
- same as `strong`, plus:
- require explicit bypass justification before sensitive edits or architectural claims when the protocol path is missing.
#### Default mode
The default mode must be **`strong`**.
### 8. `strong`-mode trigger timing
In `strong` mode, reinjection checks must happen on relevant turns only.
Required triggers:
- agent start,
- before edits,
- before architecture-sensitive reasoning,
- after compaction,
- after root-pair artifact changes.
Required non-trigger:
- do not rescan on every trivial turn.
### 9. Implementation surfaces
The runtime may achieve this behavior through a combination of:
- startup hooks,
- per-turn context hooks,
- provider-payload hooks,
- prompt guidance,
- generated root artifacts.
The spec intentionally does **not** require one exact implementation mechanism, but it does require the observable runtime behavior above.
### 10. Validation requirements
The implementation must be proven with extensive integration coverage.
At minimum, integration coverage must validate:
- pre-init hint behavior,
- post-init root-pair injection,
- budgeted expansion behavior,
- canonical-marker dedupe,
- reinjection after compaction,
- reinjection after root-pair artifact changes,
- mixed visibility behavior,
- guidance-mode differences,
- strict-mode bypass behavior where implemented.
## Non-functional requirements
- Keep the policy explicit and auditable.
- Keep retrieval out of scope for this spec.
- Prefer deterministic behavior over opaque heuristics where possible.
- Optimize for modern large-context models, while retaining a hard ceiling.
- Preserve source as final authority.
## User flows
### Flow 1: New repo, maps not initialized
1. Agent starts in a repo without project-map artifacts.
2. Runtime injects a lightweight visible startup hint.
3. Agent is instructed to run `project_map_init`.
4. No fake artifact content is injected.
### Flow 2: Normal initialized repo in `strong` mode
1. Agent starts.
2. Runtime checks outgoing context for canonical root-pair marker.
3. If absent, inject root pair and budgeted expansion.
4. On relevant later turns, runtime rescans only when trigger conditions apply.
5. Before edits, agent is reminded to use injected context and then verify source.
### Flow 3: Compaction or artifact invalidation
1. Context compacts or root-pair artifacts change.
2. Runtime treats that as a relevant reinjection trigger.
3. Runtime rescans outgoing context.
4. If canonical root-pair block is absent, inject again.
### Flow 4: Strict-mode sensitive action
1. Agent approaches a sensitive edit or architectural claim.
2. Runtime checks whether the protocol path is present.
3. If not, runtime requires explicit bypass justification before proceeding.
## Acceptance criteria
- [ ] Pre-init behavior is hint-only and never injects fake map content
- [ ] Post-init behavior always guarantees root pair preload before budgeted expansion
- [ ] Budgeting supports both relative and absolute caps, with the smaller effective budget winning
- [ ] Default budget is 15% of active context window, capped at 100k tokens, with absolute-cap fallback when context-window metadata is unavailable
- [ ] Reinjection avoidance is based on actual outgoing-context scanning
- [ ] Mixed visibility is honored
- [ ] Four guidance modes exist with `strong` as default
- [ ] `strong` checks fire on relevant turns only
- [ ] `strict` adds bypass-justification semantics for missing protocol path on sensitive actions
- [ ] Extensive integration tests cover context scanning and reinjection behavior
openspec/changes/archive/2026-06-11-project-map-prompt-injection/sync-report.md
+7
View File
@@ -0,0 +1,7 @@
# Sync Report
Status: NOT-APPLICABLE
Reason: This repository uses legacy flat change artifacts (proposal.md/spec.md/design.md/tasks.md) and does not maintain a canonical openspec/specs/ tree for these changes. No canonical spec sync was performed.
User-approved fallback: archive completed change as an audit record without canonical spec sync.
openspec/changes/archive/2026-06-11-project-map-prompt-injection/tasks.md
+90
View File
@@ -0,0 +1,90 @@
# Tasks: Project Map Prompt Injection
## Status
| Field | Value |
|---|---|
| Phase | **Tasks** |
| Based on | [Design](design.md) |
| Next | Apply |
## Delivery slices
### Slice 1: Injection policy scaffold and config surface
**Scope**: mode/config scaffolding, pre-init hint behavior, canonical helper boundaries
**Review goal**: establish the policy control surface without yet wiring the full runtime pipeline
**Tasks**:
1. [ ] Add a shared prompt-injection policy helper/module
2. [ ] Add config support for injection mode, context-budget percent, and absolute cap using additive flat JSON keys compatible with existing `.pi-project-map.json` loading
3. [ ] Decide and document how existing `contextBudget` interacts with the new injection-budget knobs
4. [ ] Implement pre-init startup-hint behavior with no synthetic artifact injection
5. [ ] Define canonical marker/block construction for injected root-pair content
6. [ ] Add/update tests for config loading and pre-init hint behavior
### Slice 2: Root-pair preload and budgeted expansion
**Scope**: post-init preload, budget calculation, artifact selection under cap
**Review goal**: make automatic injection materially real after init
**Tasks**:
1. [ ] Implement guaranteed root-pair preload after init
2. [ ] Implement effective-budget calculation using percent + absolute cap with smaller-wins semantics
3. [ ] Implement active-model context-window discovery and explicit absolute-cap fallback when metadata is unavailable
4. [ ] Implement deterministic budgeted expansion beyond the root pair
5. [ ] Keep retrieval explicitly out of this injection path
6. [ ] Add/update tests for root-pair guarantee, context-window fallback, and budget-capped expansion
### Slice 3: Reinjection avoidance and relevant-turn checks
**Scope**: outgoing-context scanning, relevant-turn triggers, compaction/artifact invalidation
**Review goal**: avoid wasteful reinjection while preserving strong guidance
**Tasks**:
1. [ ] Implement canonical marker scanning over `event.messages`
2. [ ] Add fallback inspection of final provider payload when needed
3. [ ] Implement relevant-turn reinjection triggers for `strong` mode
4. [ ] Reinject after compaction and after root-pair artifact changes
5. [ ] Add/update integration tests for dedupe, reinjection suppression, and reinjection after invalidation
6. [ ] Include synthetic event-sequence coverage for edit-intent, architecture-sensitive reasoning, compaction, and artifact-change heuristics
### Slice 4: Mode semantics, visibility, and strict-path behavior
**Scope**: off/advisory/strong/strict semantics, mixed visibility, strict bypass behavior
**Review goal**: make the mode ladder operational and reviewable
**Tasks**:
1. [ ] Implement mode-specific behavior for `off`, `advisory`, `strong`, and `strict`
2. [ ] Define and enforce the spec meaning of a missing `protocol path` during sensitive actions
3. [ ] Keep startup hints user-visible and artifact injection agent-visible by default
4. [ ] Implement strict-mode explicit bypass-justification behavior for sensitive edits/architectural claims
5. [ ] Add/update integration tests for visibility, protocol-path detection, and mode differences
6. [ ] Verify that `strong` remains the default behavior
### Slice 5: Documentation and runtime alignment
**Scope**: docs, runtime guidance text, implementation notes
**Review goal**: align user-facing/runtime-facing guidance with the frozen spec
**Tasks**:
1. [ ] Update runtime guidance strings to reflect init-hint behavior, root-pair preload, trust boundary, and mode ladder
2. [ ] Update docs/skill guidance for the prompt-injection policy
3. [ ] Keep retrieval guidance separate from these docs or clearly reference it as separate
4. [ ] Document the opinionated default budget and configurability
5. [ ] Summarize integration-test expectations and known risks
## Acceptance checklist
- [x] Before init, only a lightweight `project_map_init` hint is injected
- [x] No synthetic map/index artifact content is injected before init
- [x] After init, root `.pi-map.index.md` and root `.pi-map.md` are always guaranteed before budgeted expansion
- [x] Expansion uses a hybrid cap with both relative and absolute knobs, smaller effective budget wins
- [x] Default budget is 15% of active context window, capped at 100k tokens
- [x] Reinjection avoidance is based on canonical marker scanning in actual outgoing context
- [x] `strong` checks only relevant turns, not every trivial turn
- [x] Modes `off`, `advisory`, `strong`, and `strict` are implemented with the agreed semantics
- [x] Mixed visibility behavior is preserved
- [x] Retrieval behavior remains separate from this spec’s implementation scope
- [x] Extensive integration tests validate context scanning and reinjection behavior
- [x] `npm run typecheck` passes
- [x] `npm test` passes
- [x] `npm run lint` passes *(N/A: repo has no ESLint config; pre-existing repository gap, not a change regression)*
## Review workload note
This change mixes runtime hook behavior, prompt budgeting, context dedupe, visibility policy, and strict-mode enforcement. Keep delivery narrow and test-heavy. Avoid collapsing this into one oversized implementation slice.
openspec/changes/archive/2026-06-11-project-map-prompt-injection/verify-report.md
+22
View File
@@ -0,0 +1,22 @@
# Verify Report
Status: PASS
Change: project-map-prompt-injection
Verified summary: Implemented prompt-injection slices 1-5: mode/config surface, root-pair preload, reinjection/dedupe, strict/advisory/strong/off semantics, and documentation/runtime alignment.
Evidence commands:
- npm run typecheck
- npx vitest run
- npm run build
- node dist/cli.js validate .
Current validation state:
- npm run typecheck: PASS
- npx vitest run: PASS (262/262)
- npm run build: PASS
- node dist/cli.js validate .: PASS
Notes:
- Repo-wide lint remains unavailable because the repository has no ESLint config; treated as a pre-existing repository-level gap, not a change regression.
openspec/config.yaml
+30
View File
@@ -0,0 +1,30 @@
project:
name: pi-project-map
description: Pi skill and CLI for generating hierarchical .pi-map.md files for AI-oriented codebase comprehension
stack:
runtime:
language: TypeScript
platform: Node.js
cli:
entrypoint: dist/cli.js
extension:
entrypoint: pi-extension.ts
testing:
framework: Vitest
commands:
- npm test
- npm run typecheck
- npm run lint
sdd:
execution_mode: interactive
artifact_store: openspec
chained_pr_strategy: auto-forecast
review_budget_lines: 400
phase_rules:
explore_before_proposal: true
spec_before_design: true
design_before_tasks: true
verify_before_archive: true
openspec/project.md
+20
View File
@@ -0,0 +1,20 @@
# OpenSpec Project Context: pi-project-map
## Product
`pi-project-map` is a Pi skill plus CLI that generates hierarchical `.pi-map.md` files throughout a repository so coding agents can orient quickly without reading every source file.
## Current architecture
- `src/init.ts`: full project discovery and map generation
- `src/patch.ts`: incremental map updates after file edits
- `src/validate.ts`: map freshness and discrepancy checks
- `src/format.ts`: markdown map rendering/parsing
- `pi-extension.ts`: Pi tool registration and prompt guidance
## Conventions
- `.pi-map.md` files are orientation aids, not runtime truth.
- Exact behavior must still be verified from source before editing or making precise claims.
- Tooling changes should preserve the core `init` / `patch` / `validate` / `reinit` workflow unless a spec explicitly changes it.
- Keep review slices small; prefer staged, reviewable changes over one large refactor.
## Active planning theme
Move from "load all maps up front" toward a layered retrieval model where the root artifacts teach the agent how to navigate, then package maps and source files are loaded on demand or by focused auto-selection.
pi-extension.ts
+241 -18
View File
@@ -7,7 +7,20 @@ import {
patchFile,
validateMaps,
reinitPath,
retrieveContext,
buildPreInitHint,
buildAdvisoryReminder,
buildStrictBypassGuard,
modeAllowsPreInitHint,
modeAllowsInjection,
evaluateStrictBypass,
discoverContextWindow,
buildInjectionPayload,
shouldReinjectForEvent,
getRootPairMtimes,
rootPairChanged,
} from "./src/index.js";
import { loadConfig } from "./src/config.js";
import { createLLMClient } from "./src/llm/llm-client.js";
import { LLMError } from "./src/llm/llm-error.js";
@@ -55,7 +68,12 @@ function isDirty(content: string): boolean {
return content.includes("## dirty") && !content.includes("## dirty\n-");
}
function renderProgressBar(completed: number, total: number, currentFile?: string, width = 20): string {
function renderProgressBar(
completed: number,
total: number,
currentFile?: string,
width = 20,
): string {
const pct = total > 0 ? completed / total : 0;
const filled = Math.round(width * pct);
const bar = "█".repeat(filled) + "░".repeat(width - filled);
@@ -64,16 +82,17 @@ function renderProgressBar(completed: number, total: number, currentFile?: strin
}
export default function (pi: ExtensionAPI) {
let lastRootPairMtimes: import("./src/index.js").RootPairMtimes = {};
pi.registerTool({
name: "project_map_init",
label: "Project Map Init",
description:
"Generate .pi-map.md analysis files for the entire project or a subdirectory",
"Generate paired .pi-map.md and .pi-map.index.md analysis files for the entire project or a subdirectory",
promptSnippet:
"Initialize project analysis files for codebase understanding",
"Initialize paired project map/index artifacts for codebase understanding",
promptGuidelines: [
"Use project_map_init when starting work on a new project or after significant restructuring",
"Run project_map_init when .pi-map.md files are missing or severely outdated",
"Run project_map_init when .pi-map.md / .pi-map.index.md files are missing or severely outdated",
],
parameters: Type.Object({
path: Type.Optional(
@@ -91,10 +110,21 @@ export default function (pi: ExtensionAPI) {
llmClient: client,
cacheDir: ctx.cwd,
onProgress: (info) => {
const bar = renderProgressBar(info.completed, info.total, info.currentFile);
const bar = renderProgressBar(
info.completed,
info.total,
info.currentFile,
);
_onUpdate?.({
content: [{ type: "text", text: bar }],
details: { progress: info.total > 0 ? Math.round((info.completed / info.total) * 100) : 0, file: info.currentFile, dir: info.dir },
details: {
progress:
info.total > 0
? Math.round((info.completed / info.total) * 100)
: 0,
file: info.currentFile,
dir: info.dir,
},
});
},
});
@@ -121,8 +151,9 @@ export default function (pi: ExtensionAPI) {
name: "project_map_patch",
label: "Project Map Patch",
description:
"Update .pi-map.md for the directory containing a changed file",
promptSnippet: "Update project analysis after editing a source file",
"Update the paired .pi-map.md / .pi-map.index.md artifacts for the directory containing a changed file",
promptSnippet:
"Update paired project map/index artifacts after editing a source file",
promptGuidelines: [
"Use project_map_patch immediately after editing any source file",
"Pass the absolute or relative path of the modified file",
@@ -158,8 +189,9 @@ export default function (pi: ExtensionAPI) {
pi.registerTool({
name: "project_map_validate",
label: "Project Map Validate",
description: "Check all .pi-map.md files for staleness and discrepancies",
promptSnippet: "Validate project analysis files for accuracy",
description:
"Check all .pi-map.md / .pi-map.index.md files for staleness and discrepancies",
promptSnippet: "Validate paired project map/index artifacts for accuracy",
promptGuidelines: [
"Use project_map_validate before making architectural decisions if you suspect stale data",
"Use project_map_validate to detect files that were deleted or added outside the agent",
@@ -201,8 +233,10 @@ export default function (pi: ExtensionAPI) {
pi.registerTool({
name: "project_map_reinit",
label: "Project Map Reinit",
description: "Force full regeneration of all .pi-map.md files",
promptSnippet: "Force full regeneration of project analysis files",
description:
"Force full regeneration of all .pi-map.md / .pi-map.index.md artifacts",
promptSnippet:
"Force full regeneration of paired project map/index artifacts",
promptGuidelines: [
"Use project_map_reinit when validation shows widespread staleness",
"Use project_map_reinit after pulling major changes from version control",
@@ -223,10 +257,21 @@ export default function (pi: ExtensionAPI) {
llmClient: client,
cacheDir: ctx.cwd,
onProgress: (info) => {
const bar = renderProgressBar(info.completed, info.total, info.currentFile);
const bar = renderProgressBar(
info.completed,
info.total,
info.currentFile,
);
_onUpdate?.({
content: [{ type: "text", text: bar }],
details: { progress: info.total > 0 ? Math.round((info.completed / info.total) * 100) : 0, file: info.currentFile, dir: info.dir },
details: {
progress:
info.total > 0
? Math.round((info.completed / info.total) * 100)
: 0,
file: info.currentFile,
dir: info.dir,
},
});
},
});
@@ -249,6 +294,41 @@ export default function (pi: ExtensionAPI) {
},
});
pi.registerTool({
name: "project_map_context",
label: "Project Map Context",
description:
"Retrieve a compact markdown context bundle for a natural-language query using paired project map/index metadata",
promptSnippet:
"Get relevant project context for a task without reading every source file",
promptGuidelines: [
"Use project_map_context when you need to understand a task area before diving into source",
"Pass a concise query describing the feature, bug, or area you want to explore",
"Always read the suggested indexes first, then maps, then verify from source",
],
parameters: Type.Object({
query: Type.String({
description:
"Natural-language query describing the task or area to explore",
}),
}),
async execute(_toolCallId, params, _signal, _onUpdate, ctx) {
try {
const bundle = retrieveContext(params.query, ctx.cwd);
return {
content: [{ type: "text", text: bundle }],
details: { success: true },
};
} catch (err: any) {
const msg = err instanceof LLMError ? err.message : String(err);
return {
content: [{ type: "text", text: `Error: ${msg}` }],
details: { success: false, error: msg },
};
}
},
});
// Auto-load .pi-map.md files on session start
pi.on("session_start", async (_event, ctx) => {
const mapFiles = findPiMapFiles(ctx.cwd);
@@ -273,15 +353,158 @@ export default function (pi: ExtensionAPI) {
// Inject maintenance instructions before agent starts
pi.on("before_agent_start", async (_event, _ctx) => {
const config = loadConfig(_ctx.cwd);
const mapFiles = findPiMapFiles(_ctx.cwd);
if (mapFiles.length === 0) return {};
// Mode is off: no injection at all
if (config.promptInjectionMode === "off") {
return {};
}
// No maps exist yet: show visible pre-init hint, but only if mode allows it
if (mapFiles.length === 0) {
if (!modeAllowsPreInitHint(config.promptInjectionMode)) {
return {};
}
return {
message: {
customType: "pi-project-map-hint",
content: buildPreInitHint(),
display: true,
},
};
}
// Slice 4: advisory mode shows a visible lightweight reminder after init.
// No root-pair preload, no per-turn reinjection.
if (config.promptInjectionMode === "advisory") {
return {
message: {
customType: "pi-project-map-hint",
content: buildAdvisoryReminder(),
display: true,
},
};
}
// Maps exist but mode does not permit automatic artifact injection.
if (!modeAllowsInjection(config.promptInjectionMode)) {
return {};
}
// Slice 3b: detect root-pair artifact changes
const currentMtimes = getRootPairMtimes(_ctx.cwd);
const hasPrevious =
lastRootPairMtimes.mapMtime !== undefined ||
lastRootPairMtimes.indexMtime !== undefined;
const artifactChanged =
hasPrevious && rootPairChanged(currentMtimes, lastRootPairMtimes);
lastRootPairMtimes = currentMtimes;
// Slice 3a/3b: avoid redundant reinjection by scanning outgoing context
const eventType = artifactChanged ? "artifact_change" : "agent_start";
const decision = shouldReinjectForEvent(
{
messages: _event?.messages,
type: eventType,
},
config.promptInjectionMode,
);
if (!decision.needed) {
return {};
}
// Slice 2: post-init root-pair preload + budgeted expansion
const contextWindow = discoverContextWindow(_ctx);
const payload = buildInjectionPayload(_ctx.cwd, config, contextWindow);
return {
message: {
customType: "pi-project-map-hint",
content:
"📋 Project map active: If you modify any source file, run `project_map_patch` with the file path. If you suspect staleness, run `project_map_validate`.",
display: false,
content: payload.content,
display: payload.display,
},
};
});
// Per-turn context scanning for reinjection in strong/strict modes
pi.on("context", async (event: any, ctx: any) => {
const config = loadConfig(ctx.cwd);
const mapFiles = findPiMapFiles(ctx.cwd);
if (mapFiles.length === 0) {
return {};
}
if (!modeAllowsInjection(config.promptInjectionMode)) {
return {};
}
// Slice 3b: detect root-pair artifact changes early. Invalidation always
// forces reinjection, even in strict mode, because the context is stale.
const currentMtimes = getRootPairMtimes(ctx.cwd);
const hasPrevious =
lastRootPairMtimes.mapMtime !== undefined ||
lastRootPairMtimes.indexMtime !== undefined;
const artifactChanged =
hasPrevious && rootPairChanged(currentMtimes, lastRootPairMtimes);
lastRootPairMtimes = currentMtimes;
if (artifactChanged) {
const decision = shouldReinjectForEvent(
{
messages: event?.messages,
type: "artifact_change",
payload: event?.payload,
},
config.promptInjectionMode,
);
if (!decision.needed) {
return {};
}
const contextWindow = discoverContextWindow(ctx);
const payload = buildInjectionPayload(ctx.cwd, config, contextWindow);
return {
message: {
customType: "pi-project-map-hint",
content: payload.content,
display: payload.display,
},
};
}
// Slice 4: strict-mode bypass guard for sensitive actions with missing protocol path.
if (config.promptInjectionMode === "strict") {
const bypass = evaluateStrictBypass(event, config.promptInjectionMode);
if (bypass.guard) {
return {
message: {
customType: "pi-project-map-hint",
content: buildStrictBypassGuard(bypass.reason),
display: true,
},
};
}
}
const decision = shouldReinjectForEvent(
{
messages: event?.messages,
type: event?.type,
payload: event?.payload,
},
config.promptInjectionMode,
);
if (!decision.needed) {
return {};
}
const contextWindow = discoverContextWindow(ctx);
const payload = buildInjectionPayload(ctx.cwd, config, contextWindow);
return {
message: {
customType: "pi-project-map-hint",
content: payload.content,
display: payload.display,
},
};
});
src/ast/ast-extract.ts
+1 -1
View File
@@ -264,7 +264,7 @@ function extractCallChain(node: SyntaxNode): string | null {
node.type === "property_identifier" ||
node.type === "type_identifier"
) {
return node.text;
return node.text.replace(/\s+/g, " ").trim();
}
if (node.type === "call" || node.type === "call_expression") {
const func = node.childForFieldName?.("function");
src/cli.ts
+2
View File
@@ -0,0 +1,2 @@
#!/usr/bin/env node
import "./cli/cli.js";
src/cli/cli.ts
+67 -13
View File
@@ -4,6 +4,7 @@ import { patchFile } from "../patch.js";
import { validateMaps } from "../validate.js";
import { reinitPath } from "../init.js";
import { discoverProject } from "../discover.js";
import { retrieveContext } from "../retrieve.js";
import { createLLMClient, LLMError } from "../llm/llm-client.js";
import { loadConfig } from "../config.js";
import pc from "picocolors";
@@ -11,6 +12,8 @@ import pc from "picocolors";
const args = process.argv.slice(2);
const command = args[0];
type PatchMode = "auto" | "small" | "structural";
function printUsage() {
console.log(`${pc.bold("project-map")} — hierarchical project analysis for Pi agents
`);
@@ -30,6 +33,9 @@ function printUsage() {
console.log(
` project-map ${pc.cyan("--help")} Show this help message`,
);
console.log(
` project-map ${pc.cyan("context")} <query> Retrieve relevant project context for a query`,
);
console.log(
` project-map ${pc.cyan("--version")} Show version\n`,
);
@@ -40,19 +46,21 @@ function printUsage() {
console.log(
` --llm-model=<model> LLM model name (or set LLM_MODEL env var)`,
);
console.log(` --llm-base-url=<url> Custom base URL for LLM API\n`);
console.log(` --llm-base-url=<url> Custom base URL for LLM API`);
console.log(
` --patch-mode=<mode> Patch/repair mode: auto|small|structural\n`,
);
console.log(`${pc.bold("Examples:")}`);
console.log(` project-map init`);
console.log(` project-map patch src/components/Button.tsx`);
console.log(` project-map validate --fix`);
console.log(` project-map reinit`);
console.log(
` project-map init --llm-provider=kimi --llm-model=kimi-k2-6`,
);
console.log(` project-map context "authentication logic"`);
console.log(` project-map init --llm-provider=kimi --llm-model=kimi-k2-6`);
}
function printVersion() {
const pkg = require("../package.json");
const pkg = require("../../package.json");
console.log(pkg.version);
}
@@ -63,7 +71,12 @@ function formatCount(count: number, label: string): string {
return `${pc.bold(String(count))} ${count === 1 ? label : plural}`;
}
function renderProgressBar(completed: number, total: number, currentFile?: string, width = 30): string {
function renderProgressBar(
completed: number,
total: number,
currentFile?: string,
width = 30,
): string {
const pct = total > 0 ? completed / total : 0;
const filled = Math.round(width * pct);
const bar = "█".repeat(filled) + "░".repeat(width - filled);
@@ -77,6 +90,7 @@ function parseArgs(args: string[]): {
llmProvider?: string;
llmModel?: string;
llmBaseUrl?: string;
patchMode?: PatchMode;
positional: string[];
} {
let path = ".";
@@ -84,6 +98,7 @@ function parseArgs(args: string[]): {
let llmProvider: string | undefined;
let llmModel: string | undefined;
let llmBaseUrl: string | undefined;
let patchMode: PatchMode | undefined;
const positional: string[] = [];
for (const arg of args.slice(1)) {
@@ -95,13 +110,23 @@ function parseArgs(args: string[]): {
llmModel = arg.slice("--llm-model=".length);
} else if (arg.startsWith("--llm-base-url=")) {
llmBaseUrl = arg.slice("--llm-base-url=".length);
} else if (arg.startsWith("--patch-mode=")) {
patchMode = arg.slice("--patch-mode=".length) as PatchMode;
} else if (!arg.startsWith("-")) {
positional.push(arg);
path = arg;
}
}
return { path, fix, llmProvider, llmModel, llmBaseUrl, positional };
return {
path,
fix,
llmProvider,
llmModel,
llmBaseUrl,
patchMode,
positional,
};
}
function createClientFromArgs(args: ReturnType<typeof parseArgs>) {
@@ -142,8 +167,12 @@ async function main() {
llmClient: client,
cacheDir: targetPath,
onProgress: (info) => {
const line = renderProgressBar(info.completed, info.total, info.currentFile);
process.stdout.write("\r" + line.padEnd(lastLine.length));
const line = renderProgressBar(
info.completed,
info.total,
info.currentFile,
);
process.stdout.write(`\r${line.padEnd(lastLine.length)}`);
lastLine = line;
},
});
@@ -162,13 +191,22 @@ async function main() {
process.exit(1);
}
const client = createClientFromArgs(parsed);
await patchFile(parsed.positional[0], client, process.cwd());
await patchFile(parsed.positional[0], client, process.cwd(), {
patchMode: parsed.patchMode,
rootPath: process.cwd(),
});
console.log(`${pc.green("✓")} Patched`);
break;
}
case "validate": {
const { path, fix } = parsed;
const result = await validateMaps(path, { fix, verbose: true });
const result = await validateMaps(path, {
fix,
verbose: true,
llmClient: fix ? createClientFromArgs(parsed) : undefined,
cacheDir: process.cwd(),
patchMode: parsed.patchMode,
});
if (result.clean) {
console.log(`${pc.green("✓")} All .pi-map.md files are clean.`);
} else {
@@ -190,6 +228,18 @@ async function main() {
process.exit(result.clean ? 0 : 1);
break;
}
case "context": {
if (!parsed.positional[0]) {
console.error(
`${pc.red("Error:")} Missing query. Usage: project-map context <query>`,
);
process.exit(1);
}
const query = parsed.positional[0];
const bundle = retrieveContext(query, process.cwd());
console.log(bundle);
break;
}
case "reinit": {
const targetPath = parsed.positional[0] || ".";
const start = Date.now();
@@ -204,8 +254,12 @@ async function main() {
llmClient: client,
cacheDir: targetPath,
onProgress: (info) => {
const line = renderProgressBar(info.completed, info.total, info.currentFile);
process.stdout.write("\r" + line.padEnd(lastLine.length));
const line = renderProgressBar(
info.completed,
info.total,
info.currentFile,
);
process.stdout.write(`\r${line.padEnd(lastLine.length)}`);
lastLine = line;
},
});
src/config.ts
+13
View File
@@ -1,6 +1,8 @@
import { existsSync, readFileSync } from "fs";
import { join } from "path";
export type PromptInjectionMode = "off" | "advisory" | "strong" | "strict";
export interface SkillConfig {
ignorePatterns: string[];
smallPackageThreshold: number;
@@ -9,6 +11,11 @@ export interface SkillConfig {
llmBaseUrl?: string;
contextBudget: number;
autoInjectPrompt: boolean;
tagCap: number;
workflowHintCap: number;
promptInjectionMode: PromptInjectionMode;
contextBudgetPercent: number;
contextBudgetMaxTokens: number;
}
export const DEFAULT_CONFIG: SkillConfig = {
@@ -24,6 +31,7 @@ export const DEFAULT_CONFIG: SkillConfig = {
".DS_Store",
"*.log",
".pi-map.md",
".pi-map.index.md",
".cache",
"tmp",
"temp",
@@ -38,6 +46,11 @@ export const DEFAULT_CONFIG: SkillConfig = {
llmModel: "gpt-4o-mini",
contextBudget: 4000,
autoInjectPrompt: true,
tagCap: 8,
workflowHintCap: 5,
promptInjectionMode: "strong",
contextBudgetPercent: 15,
contextBudgetMaxTokens: 100_000,
};
export function loadConfig(cwd: string = process.cwd()): SkillConfig {
src/directory-model.ts
+74
View File
@@ -0,0 +1,74 @@
export interface FileEntry {
name: string;
purpose: string;
exports: string[];
deps: string[];
}
export interface DirectoryArtifactModel {
dir: string;
role: string;
files: FileEntry[];
arch: string;
dirty?: string;
isRoot: boolean;
parent?: string;
children: string[];
tags: string[];
symbols: string[];
workflows: WorkflowHint[];
}
export interface WorkflowHint {
task: string;
read?: string[];
index?: string[];
map?: string[];
files?: string[];
}
export const PROJECT_MAP_PROTOCOL_LINES = [
"## Project Map Protocol",
"",
"1. Read this protocol and the root `.pi-map.index.md` first.",
"2. Use `index:` / `map:` references to open relevant directory indexes and maps.",
"3. Load indexes before rich maps during task-start navigation.",
"4. Read the local rich map and actual source before editing.",
"5. Treat non-empty `## dirty` sections in either artifact as stale.",
"6. If source and generated artifacts disagree, trust source.",
"7. If map and index disagree, trust neither blindly; verify from source and regenerate the pair.",
"8. After editing source, run `project_map_patch` for each changed file.",
"9. Before broad architectural claims or final handoff, run `project_map_validate` when freshness matters.",
"",
"Trust boundary: index routes, map orients, source decides.",
];
export interface RoutingMetadataOptions {
tagCap?: number;
workflowHintCap?: number;
}
export function createDirectoryModel(opts: {
dir: string;
role: string;
files: FileEntry[];
arch: string;
parent?: string;
children?: string[];
isRoot?: boolean;
dirty?: string;
}): DirectoryArtifactModel {
return {
dir: opts.dir,
role: opts.role,
files: opts.files,
arch: opts.arch,
parent: opts.parent,
children: opts.children ?? [],
isRoot: opts.isRoot ?? false,
dirty: opts.dirty,
tags: [],
symbols: [],
workflows: [],
};
}
src/discover.ts
+1
View File
@@ -14,6 +14,7 @@ const DEFAULT_IGNORE = [
".DS_Store",
"*.log",
".pi-map.md",
".pi-map.index.md",
".cache",
"tmp",
"temp",
src/format.ts
+531 -31
View File
@@ -1,3 +1,6 @@
import type { DirectoryArtifactModel, FileEntry } from "./directory-model.js";
import { PROJECT_MAP_PROTOCOL_LINES } from "./directory-model.js";
export interface PackageMapData {
path: string;
role: string;
@@ -6,20 +9,64 @@ export interface PackageMapData {
dirty?: string;
}
export interface FileEntry {
name: string;
purpose: string;
exports: string[];
deps: string[];
export function renderPackageMap(data: PackageMapData): string {
const model = convertPackageMapToModel(data);
return renderDirectoryMap(model);
}
export function renderPackageMap(data: PackageMapData): string {
export function parsePackageMap(markdown: string): PackageMapData {
const model = parseDirectoryMap(markdown);
return convertModelToPackageMap(model);
}
function convertPackageMapToModel(
data: PackageMapData,
): DirectoryArtifactModel {
return {
dir: data.path,
role: data.role,
files: data.files,
arch: data.arch,
dirty: data.dirty,
isRoot: data.path === ".",
parent: undefined,
children: [],
tags: [],
symbols: [],
workflows: [],
};
}
function convertModelToPackageMap(
model: DirectoryArtifactModel,
): PackageMapData {
return {
path: model.dir,
role: model.role,
files: model.files,
arch: model.arch,
dirty: model.dirty,
};
}
export function renderDirectoryMap(model: DirectoryArtifactModel): string {
const lines: string[] = [];
lines.push(`# ${data.path}`);
lines.push(`# ${model.dir}`);
lines.push(`dir: ${model.dir}`);
lines.push("");
lines.push(`index: ${model.dir}/.pi-map.index.md`);
lines.push("");
if (model.isRoot) {
lines.push(...PROJECT_MAP_PROTOCOL_LINES);
lines.push("");
}
lines.push(`## role`);
lines.push(data.role);
lines.push(model.role);
lines.push(`## files`);
for (const file of data.files) {
for (const file of model.files) {
const exp =
file.exports.length > 0 ? `exp: ${file.exports.join(", ")}` : "";
const dep = file.deps.length > 0 ? `dep: ${file.deps.join(", ")}` : "";
@@ -28,28 +75,88 @@ export function renderPackageMap(data: PackageMapData): string {
if (dep) parts.push(dep);
lines.push(parts.join(" | "));
}
lines.push(`## arch`);
lines.push(data.arch);
lines.push(model.arch);
// Slice 2: tags, symbols, workflows — scaffold empty sections for now
lines.push(`## tags`);
if (model.tags.length > 0) {
lines.push(model.tags.join(", "));
} else {
lines.push("-");
}
lines.push(`## symbols`);
if (model.symbols.length > 0) {
for (const sym of model.symbols) {
lines.push(`- ${sym}`);
}
} else {
lines.push("-");
}
lines.push(`## workflows`);
if (model.workflows.length > 0) {
for (const wf of model.workflows) {
lines.push(`- ${wf.task}`);
if (wf.read && wf.read.length > 0) {
lines.push(` read: ${wf.read.join(", ")}`);
}
if (wf.index && wf.index.length > 0) {
lines.push(` index: ${wf.index.join(", ")}`);
}
if (wf.map && wf.map.length > 0) {
lines.push(` map: ${wf.map.join(", ")}`);
}
if (wf.files && wf.files.length > 0) {
lines.push(` files: ${wf.files.join(", ")}`);
}
}
} else {
lines.push("-");
}
lines.push(`## dirty`);
lines.push(data.dirty || "-");
lines.push(model.dirty || "-");
return `${lines.join("\n")}\n`;
}
export function parsePackageMap(markdown: string): PackageMapData {
export function parseDirectoryMap(markdown: string): DirectoryArtifactModel {
const lines = markdown.split("\n").map((l) => l.trimEnd());
const result: PackageMapData = {
path: "",
const result: DirectoryArtifactModel = {
dir: "",
role: "",
files: [],
arch: "",
dirty: "-",
isRoot: false,
parent: undefined,
children: [],
tags: [],
symbols: [],
workflows: [],
};
let section: "none" | "role" | "files" | "arch" | "dirty" = "none";
let section:
| "none"
| "role"
| "files"
| "arch"
| "tags"
| "symbols"
| "workflows"
| "dirty" = "none";
for (const line of lines) {
if (line.startsWith("# ")) {
result.path = line.slice(2).trim();
result.dir = line.slice(2).trim();
result.isRoot = result.dir === ".";
continue;
}
if (line.startsWith("dir: ")) {
result.dir = line.slice(5).trim();
result.isRoot = result.dir === ".";
continue;
}
if (line === "## role") {
@@ -64,6 +171,18 @@ export function parsePackageMap(markdown: string): PackageMapData {
section = "arch";
continue;
}
if (line === "## tags") {
section = "tags";
continue;
}
if (line === "## symbols") {
section = "symbols";
continue;
}
if (line === "## workflows") {
section = "workflows";
continue;
}
if (line === "## dirty") {
section = "dirty";
continue;
@@ -83,6 +202,70 @@ export function parsePackageMap(markdown: string): PackageMapData {
case "arch":
result.arch = result.arch ? `${result.arch}\n${line}` : line;
break;
case "tags":
if (line !== "-") {
result.tags.push(
...line
.split(",")
.map((s) => s.trim())
.filter(Boolean),
);
}
break;
case "symbols":
if (line !== "-" && line.startsWith("- ")) {
result.symbols.push(line.slice(2).trim());
}
break;
case "workflows": {
if (line !== "-" && line.startsWith("- ")) {
const task = line.slice(2).trim();
result.workflows.push({ task });
} else if (line.startsWith(" read: ") && result.workflows.length > 0) {
const reads = line
.slice(8)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.read = reads;
} else if (
line.startsWith(" index: ") &&
result.workflows.length > 0
) {
const indices = line
.slice(9)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.index = indices;
} else if (line.startsWith(" map: ") && result.workflows.length > 0) {
const maps = line
.slice(7)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.map = maps;
} else if (
line.startsWith(" files: ") &&
result.workflows.length > 0
) {
const files = line
.slice(9)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.files = files;
}
break;
}
case "dirty":
result.dirty = line === "-" ? undefined : line;
break;
@@ -92,10 +275,115 @@ export function parsePackageMap(markdown: string): PackageMapData {
return result;
}
function splitTopLevel(str: string, delimiter: string): string[] {
const result: string[] = [];
let current = "";
let depthParen = 0;
let depthBracket = 0;
let depthBrace = 0;
let depthAngle = 0;
let inString: '"' | "'" | null = null;
for (let i = 0; i < str.length; i++) {
const ch = str[i];
const prev = str[i - 1];
const next = str[i + 1];
if (inString) {
if (ch === inString && prev !== "\\") {
inString = null;
}
current += ch;
continue;
}
if (ch === '"' || ch === "'") {
const isWordApostrophe =
ch === "'" &&
/[A-Za-z0-9_$]/.test(prev ?? "") &&
/[A-Za-z0-9_$]/.test(next ?? "");
if (isWordApostrophe) {
current += ch;
continue;
}
inString = ch;
current += ch;
continue;
}
if (ch === "(") depthParen++;
if (ch === ")") depthParen = Math.max(0, depthParen - 1);
if (ch === "[") depthBracket++;
if (ch === "]") depthBracket = Math.max(0, depthBracket - 1);
if (ch === "{") depthBrace++;
if (ch === "}") depthBrace = Math.max(0, depthBrace - 1);
if (ch === "<") depthAngle++;
if (ch === ">") depthAngle = Math.max(0, depthAngle - 1);
if (
delimiter.length === 1 &&
ch === delimiter &&
depthParen === 0 &&
depthBracket === 0 &&
depthBrace === 0 &&
depthAngle === 0
) {
result.push(current.trim());
current = "";
continue;
}
if (
delimiter.length > 1 &&
str.startsWith(delimiter, i) &&
depthParen === 0 &&
depthBracket === 0 &&
depthBrace === 0 &&
depthAngle === 0
) {
result.push(current.trim());
current = "";
i += delimiter.length - 1;
continue;
}
current += ch;
}
if (current.trim()) result.push(current.trim());
return result;
}
function splitRespectingNesting(str: string): string[] {
return splitTopLevel(str, ",");
}
function splitFieldsRespectingNesting(str: string): string[] {
const rawParts = splitTopLevel(str, " | ");
const fields: string[] = [];
for (const part of rawParts) {
const trimmed = part.trim();
if (
fields.length < 2 ||
trimmed.startsWith("exp: ") ||
trimmed.startsWith("dep: ")
) {
fields.push(trimmed);
} else if (fields.length > 0) {
fields[fields.length - 1] = `${fields[fields.length - 1]} | ${trimmed}`;
}
}
return fields;
}
function parseFileLine(line: string): FileEntry | null {
// Format: - filename | purpose | exp: ... | dep: ...
const withoutPrefix = line.slice(2).trim();
const parts = withoutPrefix.split(" | ").map((p) => p.trim());
const parts = splitFieldsRespectingNesting(withoutPrefix).map((p) =>
p.trim(),
);
if (parts.length < 2) return null;
@@ -107,23 +395,235 @@ function parseFileLine(line: string): FileEntry | null {
for (let i = 2; i < parts.length; i++) {
const part = parts[i];
if (part.startsWith("exp: ")) {
exports.push(
...part
.slice(5)
.split(",")
.map((s) => s.trim())
.filter(Boolean),
);
exports.push(...splitRespectingNesting(part.slice(5)).filter(Boolean));
} else if (part.startsWith("dep: ")) {
deps.push(
...part
.slice(5)
.split(",")
.map((s) => s.trim())
.filter(Boolean),
);
deps.push(...splitRespectingNesting(part.slice(5)).filter(Boolean));
}
}
return { name, purpose, exports, deps };
}
export function renderDirectoryIndex(model: DirectoryArtifactModel): string {
const lines: string[] = [];
lines.push(`# ${model.dir} (index)`);
lines.push(`dir: ${model.dir}`);
lines.push("");
if (model.isRoot) {
lines.push(...PROJECT_MAP_PROTOCOL_LINES);
lines.push("");
}
lines.push(`## role`);
lines.push(model.role);
lines.push(`## parent`);
if (model.parent) {
lines.push(`index: ${model.parent}/.pi-map.index.md`);
lines.push(`map: ${model.parent}/.pi-map.md`);
} else {
lines.push("-");
}
lines.push(`## children`);
if (model.children.length > 0) {
for (const child of model.children) {
lines.push(`- ${child}`);
lines.push(` index: ${child}/.pi-map.index.md`);
lines.push(` map: ${child}/.pi-map.md`);
}
} else {
lines.push("-");
}
lines.push(`## files`);
for (const file of model.files) {
lines.push(`- ${file.name}`);
}
lines.push(`## links`);
lines.push(`index: ${model.dir}/.pi-map.index.md`);
lines.push(`map: ${model.dir}/.pi-map.md`);
lines.push(`## workflows`);
if (model.workflows.length > 0) {
for (const wf of model.workflows) {
lines.push(`- ${wf.task}`);
if (wf.read && wf.read.length > 0) {
lines.push(` read: ${wf.read.join(", ")}`);
}
if (wf.index && wf.index.length > 0) {
lines.push(` index: ${wf.index.join(", ")}`);
}
if (wf.map && wf.map.length > 0) {
lines.push(` map: ${wf.map.join(", ")}`);
}
if (wf.files && wf.files.length > 0) {
lines.push(` files: ${wf.files.join(", ")}`);
}
}
} else {
lines.push("-");
}
lines.push(`## dirty`);
lines.push(model.dirty || "-");
return `${lines.join("\n")}\n`;
}
export function parseDirectoryIndex(markdown: string): DirectoryArtifactModel {
const lines = markdown.split("\n").map((l) => l.trimEnd());
const result: DirectoryArtifactModel = {
dir: "",
role: "",
files: [],
arch: "",
dirty: "-",
isRoot: false,
parent: undefined,
children: [],
tags: [],
symbols: [],
workflows: [],
};
let section:
| "none"
| "role"
| "parent"
| "children"
| "files"
| "links"
| "workflows"
| "dirty" = "none";
for (const line of lines) {
if (line.startsWith("# ")) {
const title = line.slice(2).trim();
// Strip " (index)" suffix if present
result.dir = title.replace(/ \(index\)$/, "");
result.isRoot = result.dir === ".";
continue;
}
if (line.startsWith("dir: ")) {
result.dir = line.slice(5).trim();
result.isRoot = result.dir === ".";
continue;
}
if (line === "## role") {
section = "role";
continue;
}
if (line === "## parent") {
section = "parent";
continue;
}
if (line === "## children") {
section = "children";
continue;
}
if (line === "## files") {
section = "files";
continue;
}
if (line === "## links") {
section = "links";
continue;
}
if (line === "## workflows") {
section = "workflows";
continue;
}
if (line === "## dirty") {
section = "dirty";
continue;
}
if (line === "") continue;
switch (section) {
case "role":
result.role = line;
break;
case "parent":
if (line !== "-" && line.startsWith("index: ")) {
result.parent = line.slice(7).trim().replace("/.pi-map.index.md", "");
}
break;
case "children":
if (line !== "-" && line.startsWith("- ")) {
const childName = line.slice(2).trim();
result.children.push(childName);
}
break;
case "files":
if (line !== "-" && line.startsWith("- ")) {
result.files.push({
name: line.slice(2).trim(),
purpose: "",
exports: [],
deps: [],
});
}
break;
case "links":
// Parse sibling links; no-op for now
break;
case "workflows": {
if (line !== "-" && line.startsWith("- ")) {
const task = line.slice(2).trim();
result.workflows.push({ task });
} else if (line.startsWith(" read: ") && result.workflows.length > 0) {
const reads = line
.slice(8)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.read = reads;
} else if (
line.startsWith(" index: ") &&
result.workflows.length > 0
) {
const indices = line
.slice(9)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.index = indices;
} else if (line.startsWith(" map: ") && result.workflows.length > 0) {
const maps = line
.slice(7)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.map = maps;
} else if (
line.startsWith(" files: ") &&
result.workflows.length > 0
) {
const files = line
.slice(9)
.trim()
.split(",")
.map((s) => s.trim())
.filter(Boolean);
const last = result.workflows[result.workflows.length - 1];
if (last) last.files = files;
}
break;
}
case "dirty":
result.dirty = line === "-" ? undefined : line;
break;
}
}
return result;
}
src/index.ts
+60 -4
View File
@@ -1,5 +1,61 @@
// Main entry point for pi-project-map skill
export { initProject, reinitPath } from "./init.js";
export { patchFile } from "./patch.js";
export { validateMaps } from "./validate.js";
export { renderPackageMap, parsePackageMap } from "./format.js";
export { initProject, reinitPath, generateDirectoryArtifacts } from "./init.js";
export { patchFile, type PatchMode, type PatchOptions } from "./patch.js";
export {
validateMaps,
type ValidationOptions,
type ValidationResult,
type Discrepancy,
} from "./validate.js";
export {
renderPackageMap,
parsePackageMap,
renderDirectoryMap,
parseDirectoryMap,
renderDirectoryIndex,
parseDirectoryIndex,
} from "./format.js";
export type { PackageMapData } from "./format.js";
export {
createDirectoryModel,
type DirectoryArtifactModel,
type FileEntry,
} from "./directory-model.js";
export { populateRoutingMetadata } from "./routing-metadata.js";
export { retrieveContext } from "./retrieve.js";
export {
buildRootPairBlock,
hasRootPairMarker,
buildPreInitHint,
computeInjectionBudget,
modeAllowsPreInitHint,
modeAllowsInjection,
modeRequiresProtocolPath,
hasProtocolPath,
isSensitiveAction,
messagesHaveBypass,
extractBypassReason,
evaluateStrictBypass,
buildAdvisoryReminder,
buildStrictBypassGuard,
discoverContextWindow,
estimateTokens,
findAllArtifactPairs,
buildInjectionPayload,
outgoingMessagesHaveMarker,
providerPayloadHasMarker,
isRelevantTurnForReinjection,
shouldReinjectForEvent,
detectEditIntent,
detectArchitectureSensitiveReasoning,
getRootPairMtimes,
rootPairChanged,
type RootPairMtimes,
type RelevantTurnType,
type ReinjectDecision,
type StrictBypassDecision,
ROOT_PAIR_START_MARKER,
ROOT_PAIR_END_MARKER,
TRUST_BOUNDARY_TEXT,
BYPASS_MARKER_PREFIX,
} from "./prompt-injection.js";
src/init.ts
+166 -21
View File
@@ -1,9 +1,8 @@
import { discoverProject, type DirectoryEntry } from "./discover.js";
import {
renderPackageMap,
type PackageMapData,
type FileEntry,
} from "./format.js";
export { discoverProject };
import type { FileEntry } from "./directory-model.js";
import { renderDirectoryIndex, renderDirectoryMap } from "./format.js";
import { extractFileLLM, extractPackageLLM } from "./llm/llm-extract.js";
import { extractFileAST } from "./ast/ast-extract.js";
import { mergeFileData } from "./merge.js";
@@ -11,6 +10,13 @@ import { processFiles } from "./llm/llm-batch.js";
import { writeFileSync } from "fs";
import { join } from "path";
import type { LLMClient } from "./llm/llm-client.js";
import {
createDirectoryModel,
type DirectoryArtifactModel,
type RoutingMetadataOptions,
} from "./directory-model.js";
import { populateRoutingMetadata } from "./routing-metadata.js";
import { loadConfig } from "./config.js";
export interface ProgressInfo {
message: string;
@@ -25,6 +31,8 @@ export interface InitOptions {
llmClient?: LLMClient;
cacheDir?: string;
onProgress?: (info: ProgressInfo) => void;
tagCap?: number;
workflowHintCap?: number;
}
export async function initProject(
@@ -35,22 +43,40 @@ export async function initProject(
const totalFiles = entries.reduce((sum, e) => sum + e.files.length, 0);
let globalCompleted = 0;
// Load project config and apply defaults when not overridden in options
const config = loadConfig(rootPath);
const routingOpts: RoutingMetadataOptions = {
tagCap: options.tagCap ?? config.tagCap,
workflowHintCap: options.workflowHintCap ?? config.workflowHintCap,
};
options.onProgress?.({
message: `Scanning ${entries.length} directories (${totalFiles} files)...`,
completed: 0,
total: totalFiles,
});
// Build directory relationships
const dirSet = new Set(entries.map((e) => e.relativePath));
const parentMap = buildParentMap(entries);
const childrenMap = buildChildrenMap(entries);
for (let i = 0; i < entries.length; i++) {
const entry = entries[i];
await generateDirectoryMap(
await generateDirectoryArtifacts(
entry,
{
dirSet,
parentMap,
childrenMap,
isRoot: entry.relativePath === ".",
},
options.llmClient,
options.cacheDir,
(info) => {
globalCompleted = info.completed + entries
.slice(0, i)
.reduce((sum, e) => sum + e.files.length, 0);
globalCompleted =
info.completed +
entries.slice(0, i).reduce((sum, e) => sum + e.files.length, 0);
options.onProgress?.({
...info,
completed: globalCompleted,
@@ -58,26 +84,83 @@ export async function initProject(
dir: entry.relativePath,
});
},
routingOpts,
);
}
options.onProgress?.({
message: `Generated ${entries.length} .pi-map.md files`,
message: `Generated ${entries.length} directory map/index pairs`,
completed: totalFiles,
total: totalFiles,
});
if (options.verbose !== false) {
console.log(`Generated ${entries.length} .pi-map.md files`);
console.log(`Generated ${entries.length} directory map/index pairs`);
}
}
export async function generateDirectoryMap(
export interface DirectoryContext {
dirSet: Set<string>;
parentMap: Map<string, string | undefined>;
childrenMap: Map<string, string[]>;
isRoot: boolean;
}
export type ArtifactWriteMode = "both" | "map" | "index";
export function buildDirectoryContext(
entries: DirectoryEntry[],
targetEntry: DirectoryEntry,
): DirectoryContext {
return {
dirSet: new Set(entries.map((e) => e.relativePath)),
parentMap: buildParentMap(entries),
childrenMap: buildChildrenMap(entries),
isRoot: targetEntry.relativePath === ".",
};
}
function buildParentMap(
entries: DirectoryEntry[],
): Map<string, string | undefined> {
const map = new Map<string, string | undefined>();
for (const entry of entries) {
const rel = entry.relativePath;
if (rel === ".") {
map.set(rel, undefined);
} else {
const lastSep = rel.lastIndexOf("/");
map.set(rel, lastSep >= 0 ? rel.slice(0, lastSep) : ".");
}
}
return map;
}
function buildChildrenMap(entries: DirectoryEntry[]): Map<string, string[]> {
const map = new Map<string, string[]>();
for (const entry of entries) {
map.set(entry.relativePath, []);
}
for (const entry of entries) {
const rel = entry.relativePath;
if (rel === ".") continue;
const lastSep = rel.lastIndexOf("/");
const parent = lastSep >= 0 ? rel.slice(0, lastSep) : ".";
const siblings = map.get(parent);
if (siblings) {
siblings.push(rel);
}
}
return map;
}
export async function buildDirectoryArtifactModel(
entry: DirectoryEntry,
ctx: DirectoryContext,
llmClient?: LLMClient,
cacheDir?: string,
onProgress?: (info: ProgressInfo) => void,
): Promise<FileEntry[]> {
// Process files in parallel (4 concurrent) with retry logic
routingOpts?: RoutingMetadataOptions,
): Promise<DirectoryArtifactModel> {
const fileData = await processFiles(
entry.files,
async (file) => {
@@ -105,23 +188,85 @@ export async function generateDirectoryMap(
cacheDir,
);
const mapData: PackageMapData = {
path: entry.relativePath,
const model: DirectoryArtifactModel = createDirectoryModel({
dir: entry.relativePath,
role: packageData.role,
files: fileData,
arch: packageData.arch,
parent: ctx.parentMap.get(entry.relativePath),
children: ctx.childrenMap.get(entry.relativePath) ?? [],
isRoot: ctx.isRoot,
dirty: "-",
};
});
const outPath = join(entry.dirPath, ".pi-map.md");
writeFileSync(outPath, renderPackageMap(mapData));
return fileData;
populateRoutingMetadata(model, routingOpts);
return model;
}
export function writeDirectoryArtifacts(
entry: DirectoryEntry,
model: DirectoryArtifactModel,
writeMode: ArtifactWriteMode = "both",
): void {
const mapPath = join(entry.dirPath, ".pi-map.md");
const indexPath = join(entry.dirPath, ".pi-map.index.md");
if (writeMode === "both" || writeMode === "map") {
writeFileSync(mapPath, renderDirectoryMap(model));
}
if (writeMode === "both" || writeMode === "index") {
writeFileSync(indexPath, renderDirectoryIndex(model));
}
}
export async function generateDirectoryArtifacts(
entry: DirectoryEntry,
ctx: DirectoryContext,
llmClient?: LLMClient,
cacheDir?: string,
onProgress?: (info: ProgressInfo) => void,
routingOpts?: RoutingMetadataOptions,
writeMode: ArtifactWriteMode = "both",
): Promise<FileEntry[]> {
const model = await buildDirectoryArtifactModel(
entry,
ctx,
llmClient,
cacheDir,
onProgress,
routingOpts,
);
writeDirectoryArtifacts(entry, model, writeMode);
return model.files;
}
export async function reinitPath(
path: string,
options: InitOptions = {},
): Promise<void> {
// Full regeneration clears all dirty markers by overwriting every .pi-map.md
// Full regeneration clears all dirty markers by overwriting every map/index pair
await initProject(path, options);
}
// Backward-compatible wrapper for patch/validate compatibility
export async function generateDirectoryMap(
entry: DirectoryEntry,
llmClient?: LLMClient,
cacheDir?: string,
): Promise<FileEntry[]> {
const entries = [entry];
const ctx = buildDirectoryContext(entries, entry);
const config = loadConfig(entry.dirPath);
const routingOpts: RoutingMetadataOptions = {
tagCap: config.tagCap,
workflowHintCap: config.workflowHintCap,
};
return generateDirectoryArtifacts(
entry,
ctx,
llmClient,
cacheDir,
undefined,
routingOpts,
);
}
src/merge.ts
+17 -13
View File
@@ -1,4 +1,4 @@
import type { FileEntry } from "./format.js";
import type { FileEntry } from "./directory-model.js";
interface LLMFileData {
purpose: string;
@@ -48,14 +48,16 @@ export function mergeFileData(
for (const cls of ast.classes) {
const classExports: string[] = [`class:${cls.name}`];
for (const method of cls.methods) {
const paramStr = method.params.join(", ");
const returnStr = method.returns ? ` → ${method.returns}` : "";
const paramStr = method.params.join(", ").replace(/\s+/g, " ");
const returnStr = method.returns
? ` → ${method.returns.replace(/\s+/g, " ")}`
: "";
classExports.push(`method:${method.name}(${paramStr})${returnStr}`);
if (method.calls.length > 0) {
classExports.push(`call:${method.calls.join(", ")}`);
for (const call of method.calls) {
classExports.push(`call:${call}`);
}
if (method.raises.length > 0) {
classExports.push(`raise:${method.raises.join(", ")}`);
for (const raise of method.raises) {
classExports.push(`raise:${raise}`);
}
}
dedupedExports.push(...classExports);
@@ -65,14 +67,16 @@ export function mergeFileData(
// Encode top-level functions
if (ast && ast.functions.length > 0) {
for (const func of ast.functions) {
const paramStr = func.params.join(", ");
const returnStr = func.returns ? ` → ${func.returns}` : "";
const paramStr = func.params.join(", ").replace(/\s+/g, " ");
const returnStr = func.returns
? ` → ${func.returns.replace(/\s+/g, " ")}`
: "";
dedupedExports.push(`func:${func.name}(${paramStr})${returnStr}`);
if (func.calls.length > 0) {
dedupedExports.push(`call:${func.calls.join(", ")}`);
for (const call of func.calls) {
dedupedExports.push(`call:${call}`);
}
if (func.raises.length > 0) {
dedupedExports.push(`raise:${func.raises.join(", ")}`);
for (const raise of func.raises) {
dedupedExports.push(`raise:${raise}`);
}
}
}
src/patch.ts
+143 -52
View File
@@ -1,71 +1,162 @@
import { dirname, join, basename, relative } from "path";
import { existsSync, readFileSync, writeFileSync } from "fs";
import { parsePackageMap, renderPackageMap } from "./format.js";
import { extractFileLLM } from "./llm/llm-extract.js";
import { extractFileAST } from "./ast/ast-extract.js";
import { mergeFileData } from "./merge.js";
import { generateDirectoryMap } from "./init.js";
import { readdirSync, statSync } from "fs";
import { basename, dirname, relative, resolve } from "path";
import { existsSync, readFileSync } from "fs";
import { parsePackageMap } from "./format.js";
import {
discoverProject,
generateDirectoryArtifacts,
buildDirectoryContext,
} from "./init.js";
import type { DirectoryEntry } from "./discover.js";
import type { LLMClient } from "./llm/llm-client.js";
import { loadConfig } from "./config.js";
const SMALL_PACKAGE_THRESHOLD = 10;
export type PatchMode = "auto" | "small" | "structural";
export interface PatchOptions {
patchMode?: PatchMode;
rootPath?: string;
}
const SMALL_CHANGE_FILE_WINDOW = 3;
const STRUCTURAL_FILE_HINT =
/(^|\b)(index|config|cli|command|init|format|discover|patch|validate)(\b|\.)/i;
export async function patchFile(
filePath: string,
llmClient?: LLMClient,
cacheDir?: string,
options: PatchOptions = {},
): Promise<void> {
const dirPath = dirname(filePath);
const mapPath = join(dirPath, ".pi-map.md");
const rootPath = resolve(options.rootPath ?? cacheDir ?? process.cwd());
const absFilePath = resolve(rootPath, filePath);
const dirPath = dirname(absFilePath);
const relDir = normalizeRelativePath(relative(rootPath, dirPath));
const entries = discoverProject(rootPath);
const entry = entries.find((candidate) => candidate.relativePath === relDir);
if (!existsSync(mapPath)) {
// No map exists yet — would need to generate from scratch
console.warn(`No .pi-map.md found in ${dirPath}`);
if (!entry) {
console.warn(`No discovered directory entry found for ${relDir}`);
return;
}
const allFiles = readdirSync(dirPath).filter(
(f: string) => !f.startsWith(".") && !f.endsWith(".md"),
const config = loadConfig(rootPath);
const routingOpts = {
tagCap: config.tagCap,
workflowHintCap: config.workflowHintCap,
};
const mode = determinePatchMode(
entry,
absFilePath,
rootPath,
options.patchMode,
);
const changedCtx = buildDirectoryContext(entries, entry);
await generateDirectoryArtifacts(
entry,
changedCtx,
llmClient,
cacheDir,
undefined,
routingOpts,
"both",
);
const isSmallPackage = allFiles.length < SMALL_PACKAGE_THRESHOLD;
if (isSmallPackage) {
// Full rewrite for small packages
const files = allFiles.filter((f) => {
const st = statSync(join(dirPath, f));
return st.isFile();
});
const relDir = relative(process.cwd(), dirPath) || ".";
await generateDirectoryMap(
{
dirPath,
relativePath: relDir,
files,
},
for (const ancestor of getAncestorEntries(entries, changedCtx, entry)) {
const ancestorCtx = buildDirectoryContext(entries, ancestor);
await generateDirectoryArtifacts(
ancestor,
ancestorCtx,
llmClient,
cacheDir,
undefined,
routingOpts,
mode === "small" ? "index" : "both",
);
console.log(
`Full rewrite of ${mapPath} (small package: ${allFiles.length} files)`,
);
} else {
// Section-level patch
const existing = parsePackageMap(readFileSync(mapPath, "utf8"));
const llmData = await extractFileLLM(filePath, llmClient, cacheDir);
const astData = await extractFileAST(filePath);
const fileName = basename(filePath);
const updatedFile = mergeFileData(fileName, llmData, astData);
// Replace the matching file entry
const idx = existing.files.findIndex((f) => f.name === updatedFile.name);
if (idx >= 0) {
existing.files[idx] = updatedFile;
} else {
existing.files.push(updatedFile);
}
existing.dirty = `${new Date().toISOString()}: ${fileName} patched (section-level)`;
writeFileSync(mapPath, renderPackageMap(existing));
console.log(`Patched ${mapPath}`);
}
console.log(
`Patched ${joinArtifactPath(relDir, ".pi-map.md")} (patchMode: ${mode})`,
);
}
function determinePatchMode(
entry: DirectoryEntry,
absFilePath: string,
rootPath: string,
explicitMode: PatchMode = "auto",
): Exclude<PatchMode, "auto"> {
if (explicitMode !== "auto") {
return explicitMode;
}
const existingMapPath = resolve(entry.dirPath, ".pi-map.md");
const fileName = basename(absFilePath);
const childCount =
entry.relativePath === "."
? 0
: countDirectChildren(rootPath, entry.relativePath);
if (childCount > 0) {
return "structural";
}
if (entry.files.length > SMALL_CHANGE_FILE_WINDOW) {
return "structural";
}
if (STRUCTURAL_FILE_HINT.test(fileName)) {
return "structural";
}
if (existsSync(existingMapPath)) {
const existing = parsePackageMap(readFileSync(existingMapPath, "utf8"));
const existingFile = existing.files.find(
(candidate) => candidate.name === fileName,
);
if (!existingFile) {
return "structural";
}
}
return "small";
}
function countDirectChildren(rootPath: string, relDir: string): number {
const entries = discoverProject(rootPath);
return entries.filter((entry) => {
if (entry.relativePath === "." || entry.relativePath === relDir)
return false;
const parent = normalizeRelativePath(
entry.relativePath.split("/").slice(0, -1).join("/"),
);
return parent === relDir;
}).length;
}
function getAncestorEntries(
entries: DirectoryEntry[],
ctx: ReturnType<typeof buildDirectoryContext>,
entry: DirectoryEntry,
): DirectoryEntry[] {
const result: DirectoryEntry[] = [];
let parent = ctx.parentMap.get(entry.relativePath);
while (parent) {
const ancestor = entries.find(
(candidate) => candidate.relativePath === parent,
);
if (ancestor) {
result.push(ancestor);
}
parent = ctx.parentMap.get(parent);
}
return result;
}
function normalizeRelativePath(relPath: string): string {
if (!relPath || relPath === ".") return ".";
return relPath.replace(/\\/g, "/");
}
function joinArtifactPath(relDir: string, artifactName: string): string {
return relDir === "." ? artifactName : `${relDir}/${artifactName}`;
}
src/prompt-injection.ts
+670
View File
@@ -0,0 +1,670 @@
import { readdirSync, statSync, readFileSync } from "fs";
import { join, relative } from "path";
import type { SkillConfig, PromptInjectionMode } from "./config.js";
// ---------------------------------------------------------------------------
// Outgoing-context scanning (Slice 3)
// ---------------------------------------------------------------------------
export interface ReinjectDecision {
needed: boolean;
reason?: string;
}
/**
* Decide whether reinjection is needed for a given event.
* Checks mode, scans outgoing messages for the canonical marker,
* falls back to payload inspection, and evaluates relevant-turn triggers.
*/
export function shouldReinjectForEvent(
event: {
messages?: Array<{ content?: unknown; text?: string }>;
type?: string;
payload?: unknown;
},
mode: PromptInjectionMode,
): ReinjectDecision {
if (mode !== "strong" && mode !== "strict") {
return { needed: false, reason: "mode_does_not_require_reinjection" };
}
// Slice 3b: root-pair artifact changes invalidate prior injections
if (event.type === "artifact_change") {
return { needed: true, reason: "root_pair_artifact_changed" };
}
if (event.messages && outgoingMessagesHaveMarker(event.messages)) {
return { needed: false, reason: "marker_present_in_messages" };
}
if (event.payload && providerPayloadHasMarker(event.payload)) {
return { needed: false, reason: "marker_present_in_payload" };
}
if (event.type && isRelevantTurnForReinjection(event.type)) {
return { needed: true, reason: "relevant_turn_and_marker_absent" };
}
return { needed: false, reason: "not_a_relevant_turn" };
}
function extractTextFromMessage(m: {
content?: unknown;
text?: string;
}): string {
if (typeof m.content === "string") return m.content;
if (Array.isArray(m.content)) {
return m.content
.map((block: any) => {
if (typeof block === "string") return block;
if (typeof block.text === "string") return block.text;
if (typeof block.content === "string") return block.content;
return "";
})
.join("");
}
return m.text ?? "";
}
/**
* Scan an array of message-like objects for the canonical root-pair marker.
* Normalizes array-based content blocks (e.g., TextContent[]) to strings.
*/
export function outgoingMessagesHaveMarker(
messages: Array<{ content?: unknown; text?: string }>,
): boolean {
return messages.some((m) => hasRootPairMarker(extractTextFromMessage(m)));
}
/**
* Fallback inspection of a final provider payload for the canonical marker.
* Accepts either a string or an object that will be JSON-stringified.
*/
export function providerPayloadHasMarker(payload: unknown): boolean {
if (!payload) return false;
if (typeof payload === "string") {
return hasRootPairMarker(payload);
}
try {
return hasRootPairMarker(JSON.stringify(payload));
} catch {
return false;
}
}
/**
* Relevant-turn types that trigger reinjection in strong mode.
*/
export type RelevantTurnType =
| "agent_start"
| "edit_intent"
| "architecture_sensitive"
| "compaction"
| "artifact_change";
/**
* Determine whether a given event type is a relevant reinjection trigger.
*/
export function isRelevantTurnForReinjection(eventType: string): boolean {
const relevant: RelevantTurnType[] = [
"agent_start",
"edit_intent",
"architecture_sensitive",
"compaction",
"artifact_change",
];
return relevant.includes(eventType as RelevantTurnType);
}
function detectEditIntentFromText(combined: string): boolean {
const patterns = [
/\b(edit|modify|update|change|refactor|fix|patch|rewrite|delete|remove|add)\s+(the|a|this|that|these|those|file|code|function|method|class|module|component|line)\b/i,
/\b(write|create|generate)\s+(new|a|the)\s+(file|function|class|module|component)\b/i,
/```[\s\S]*?\b(edit|modify|update|change|refactor|fix|delete|remove)\b/i,
/\bapply\s+(the|a|this|that)\s+(change|edit|patch|fix)\b/i,
];
return patterns.some((p) => p.test(combined));
}
/**
* Heuristic detection of edit intent from message content.
*/
export function detectEditIntent(
messages: Array<{ content?: unknown; text?: string }>,
): boolean {
if (!messages || messages.length === 0) return false;
const combined = messages.map(extractTextFromMessage).join(" ");
return detectEditIntentFromText(combined);
}
function detectArchitectureSensitiveReasoningFromText(
combined: string,
): boolean {
const patterns = [
/\barchitectur(e|al)\b/i,
/\bdesign\s+(decision|pattern|choice|principle|review)\b/i,
/\b(restructure|reorganize|redesign|rearchitect)\b/i,
/\b(system|high.level|macro|structural)\s+(design|architecture|overview)\b/i,
/\bdependency\s+(injection|graph|cycle|inversion)\b/i,
/\b(api|interface|contract|schema|protocol)\s+(design|change|migration|breaking)\b/i,
/\b(microservice|monolith|modular|layered|hexagonal|clean)\s+arch/i,
/\bdata\s+(model|flow|pipeline|architecture)\b/i,
/\b(scalability|performance|security|maintainability)\s+(concern|tradeoff|decision)\b/i,
];
return patterns.some((p) => p.test(combined));
}
/**
* Heuristic detection of architecture-sensitive reasoning from message content.
*/
export function detectArchitectureSensitiveReasoning(
messages: Array<{ content?: unknown; text?: string }>,
): boolean {
if (!messages || messages.length === 0) return false;
const combined = messages.map(extractTextFromMessage).join(" ");
return detectArchitectureSensitiveReasoningFromText(combined);
}
// ---------------------------------------------------------------------------
// Root-pair artifact change detection
// ---------------------------------------------------------------------------
export interface RootPairMtimes {
mapMtime?: number;
indexMtime?: number;
}
/**
* Read current mtimes for the root pair artifacts, if they exist.
*/
export function getRootPairMtimes(cwd: string): RootPairMtimes {
const mapPath = join(cwd, ".pi-map.md");
const indexPath = join(cwd, ".pi-map.index.md");
const result: RootPairMtimes = {};
try {
result.mapMtime = statSync(mapPath).mtimeMs;
} catch {
// ignore
}
try {
result.indexMtime = statSync(indexPath).mtimeMs;
} catch {
// ignore
}
return result;
}
/**
* Compare current root-pair mtimes against previously recorded ones.
*/
export function rootPairChanged(
current: RootPairMtimes,
previous: RootPairMtimes,
): boolean {
return (
current.mapMtime !== previous.mapMtime ||
current.indexMtime !== previous.indexMtime
);
}
/**
* Canonical markers for injected root-pair content.
* These must be stable across turns and easy to scan in outgoing context.
*/
export const ROOT_PAIR_START_MARKER = "<!-- PI_MAP_ROOT_PAIR_START -->";
export const ROOT_PAIR_END_MARKER = "<!-- PI_MAP_ROOT_PAIR_END -->";
export const TRUST_BOUNDARY_TEXT =
"Trust boundary: index routes, map orients, source decides.";
/**
* Build a canonical root-pair block wrapping index and map content.
*/
export function buildRootPairBlock(
indexContent: string,
mapContent: string,
): string {
return [
ROOT_PAIR_START_MARKER,
"## Project Map Protocol",
"",
"1. Read this protocol and the root `.pi-map.index.md` first.",
"",
TRUST_BOUNDARY_TEXT,
"",
"### Root index",
indexContent,
"",
"### Root map",
mapContent,
ROOT_PAIR_END_MARKER,
].join("\n");
}
/**
* Check whether a message content string contains the canonical root-pair marker.
*/
export function hasRootPairMarker(content: string): boolean {
return content.includes(ROOT_PAIR_START_MARKER);
}
/**
* Build a lightweight user-visible pre-init startup hint.
* No synthetic artifact content is injected — only a prompt to run init.
*/
export function buildPreInitHint(): string {
return [
"📋 Project maps not initialized.",
"",
"The project-map extension is active. Run `project_map_init` to generate paired `.pi-map.md` and `.pi-map.index.md` artifacts for this project.",
"After init, the root pair will be preloaded automatically (default mode: strong). Source remains the final authority before edits.",
].join("\n");
}
/**
* Compute the effective injection budget in tokens.
* Uses the smaller of (percent of context window) and absolute cap.
* Falls back to absolute cap if context window is unknown.
*/
export function computeInjectionBudget(
config: Pick<SkillConfig, "contextBudgetPercent" | "contextBudgetMaxTokens">,
contextWindow?: number,
): number {
const absolute = config.contextBudgetMaxTokens;
if (contextWindow === undefined || contextWindow <= 0) {
return absolute;
}
const relative = Math.floor(
(contextWindow * config.contextBudgetPercent) / 100,
);
return Math.min(relative, absolute);
}
/**
* Determine whether the active mode permits pre-init hints.
*/
export function modeAllowsPreInitHint(mode: PromptInjectionMode): boolean {
return mode !== "off";
}
/**
* Determine whether the active mode permits automatic artifact injection after init.
*/
export function modeAllowsInjection(mode: PromptInjectionMode): boolean {
return mode === "strong" || mode === "strict";
}
/**
* Resolve whether a given mode requires the protocol path for sensitive actions.
*/
export function modeRequiresProtocolPath(mode: PromptInjectionMode): boolean {
return mode === "strict";
}
// ---------------------------------------------------------------------------
// Protocol-path detection (Slice 4)
// ---------------------------------------------------------------------------
/**
* Inline bypass marker prefix. Agents may include `[PI_MAP_BYPASS: reason]` in
* a message to proceed past a strict-mode guard.
*/
export const BYPASS_MARKER_PREFIX = "[PI_MAP_BYPASS:";
function extractTextFromPayload(payload: unknown): string {
if (!payload) return "";
if (typeof payload === "string") return payload;
try {
return JSON.stringify(payload);
} catch {
return "";
}
}
/**
* Check whether the outgoing context contains the full protocol path:
* canonical root-pair marker + trust-boundary instruction.
*/
export function hasProtocolPath(
messages?: Array<{ content?: unknown; text?: string }>,
payload?: unknown,
): boolean {
const sources: string[] = [];
if (messages) {
for (const m of messages) {
sources.push(extractTextFromMessage(m));
}
}
const payloadText = extractTextFromPayload(payload);
if (payloadText) {
sources.push(payloadText);
}
const combined = sources.join("\n");
return (
combined.includes(ROOT_PAIR_START_MARKER) &&
combined.includes(TRUST_BOUNDARY_TEXT)
);
}
/**
* Determine whether the current turn is a sensitive action.
*
* Uses explicit event types when available, with heuristic fallback from
* message content and provider payload for runtimes that do not emit
* `edit_intent` or `architecture_sensitive` event types.
*/
export function isSensitiveAction(
eventType?: string,
messages?: Array<{ content?: unknown; text?: string }>,
payload?: unknown,
): boolean {
const explicit: RelevantTurnType[] = [
"edit_intent",
"architecture_sensitive",
];
if (eventType && explicit.includes(eventType as RelevantTurnType)) {
return true;
}
const messageText =
messages && messages.length > 0
? messages.map(extractTextFromMessage).join("\n")
: "";
const payloadText = extractTextFromPayload(payload);
const combined =
messageText || payloadText ? `${messageText}\n${payloadText}`.trim() : "";
if (!combined) return false;
return (
detectEditIntentFromText(combined) ||
detectArchitectureSensitiveReasoningFromText(combined)
);
}
/**
* Check whether any message contains a valid explicit bypass marker.
* Empty or whitespace-only reasons are rejected.
*/
export function messagesHaveBypass(
messages?: Array<{ content?: unknown; text?: string }>,
payload?: unknown,
): boolean {
return extractBypassReason(messages, payload) !== undefined;
}
/**
* Extract the reason from the first `[PI_MAP_BYPASS: reason]` marker, if any.
* Returns `undefined` when the marker is absent or its reason is empty/whitespace.
*/
export function extractBypassReason(
messages?: Array<{ content?: unknown; text?: string }>,
payload?: unknown,
): string | undefined {
const parts: string[] = [];
if (messages) {
parts.push(messages.map(extractTextFromMessage).join("\n"));
}
const payloadText = extractTextFromPayload(payload);
if (payloadText) {
parts.push(payloadText);
}
const combined = parts.join("\n");
if (!combined) return undefined;
const escapedPrefix = BYPASS_MARKER_PREFIX.replace(
/[.*+?^${}()|[\]\\]/g,
"\\$&",
);
const match = new RegExp(`${escapedPrefix}\\s*([^\\]]+)\\]`).exec(combined);
if (!match) return undefined;
const reason = match[1].trim();
return reason.length > 0 ? reason : undefined;
}
export interface StrictBypassDecision {
guard: boolean;
reason?: string;
bypassMarker?: string;
}
/**
* Evaluate whether strict mode should block a sensitive turn with a visible
* bypass guard because the protocol path is missing.
*
* Returns `guard: false` for non-strict modes, non-sensitive turns, turns
* where the protocol path is present, or turns that include an explicit bypass
* marker.
*/
export function evaluateStrictBypass(
event:
| {
messages?: Array<{ content?: unknown; text?: string }>;
type?: string;
payload?: unknown;
}
| undefined
| null,
mode: PromptInjectionMode,
): StrictBypassDecision {
if (mode !== "strict") {
return { guard: false };
}
if (!event) {
return { guard: false };
}
if (!isSensitiveAction(event.type, event.messages, event.payload)) {
return { guard: false };
}
const bypassReason = extractBypassReason(event.messages, event.payload);
if (bypassReason !== undefined) {
return { guard: false, bypassMarker: bypassReason };
}
if (hasProtocolPath(event.messages, event.payload)) {
return { guard: false };
}
return {
guard: true,
reason: "protocol path missing for sensitive action",
};
}
/**
* Build a lightweight user-visible reminder for advisory mode after init.
* No root-pair content is injected automatically.
*/
export function buildAdvisoryReminder(): string {
return [
"📋 Project map advisory mode active.",
"",
"Root `.pi-map.index.md` and `.pi-map.md` are available but are not automatically injected. Read them manually when you need routing or orientation context, and remember that source remains the final authority before edits.",
].join("\n");
}
/**
* Build a visible strict-mode bypass guard for sensitive turns where the
* protocol path is missing.
*/
export function buildStrictBypassGuard(reason?: string): string {
return [
"🛑 Strict project-map guard",
"",
reason ||
"A sensitive action was detected without the project-map protocol path.",
"",
"The protocol path requires the root `.pi-map.index.md` / `.pi-map.md` pair plus the trust boundary (`index routes, map orients, source decides`) to be present in context.",
"",
"To proceed, either restore the project-map context or include an explicit bypass marker: `[PI_MAP_BYPASS: <brief justification>]`.",
].join("\n");
}
// ---------------------------------------------------------------------------
// Context-window discovery (Slice 2)
// ---------------------------------------------------------------------------
const KNOWN_MODEL_CONTEXT_WINDOWS: Record<string, number> = {
"gpt-4o": 128_000,
"gpt-4o-mini": 128_000,
"gpt-4-turbo": 128_000,
"gpt-4": 8_192,
"claude-3-5-sonnet": 200_000,
"claude-3-opus": 200_000,
"kimi-for-coding": 200_000,
k2p6: 1_000_000,
"kimi-k2-thinking": 256_000,
};
/**
* Discover the active model's context-window size from Pi runtime metadata.
* Returns `undefined` when unavailable so callers fall back to the absolute cap.
*/
export function discoverContextWindow(ctx: any): number | undefined {
const model = ctx?.model;
if (model) {
if (typeof model.contextWindow === "number" && model.contextWindow > 0) {
return model.contextWindow;
}
if (
typeof model.maxContextTokens === "number" &&
model.maxContextTokens > 0
) {
return model.maxContextTokens;
}
if (typeof model.id === "string") {
const known = KNOWN_MODEL_CONTEXT_WINDOWS[model.id];
if (known) return known;
}
}
return undefined;
}
// ---------------------------------------------------------------------------
// Token estimation (best-effort, deterministic)
// ---------------------------------------------------------------------------
/**
* Rough token estimate from character count.
* 1 token ≈ 4 chars for English/prose is a conservative heuristic.
*/
export function estimateTokens(text: string): number {
return Math.ceil(text.length / 4);
}
// ---------------------------------------------------------------------------
// Artifact-pair discovery
// ---------------------------------------------------------------------------
export interface ArtifactPair {
dir: string;
mapPath: string;
indexPath: string;
}
/**
* Find every directory under `cwd` that contains both `.pi-map.md` and
* `.pi-map.index.md`. Returns shallowest directories first for predictable
* structural coverage.
*/
export function findAllArtifactPairs(cwd: string): ArtifactPair[] {
const results: ArtifactPair[] = [];
function walk(dir: string) {
let entries: import("fs").Dirent[];
try {
entries = readdirSync(dir, { withFileTypes: true });
} catch {
return;
}
for (const entry of entries) {
if (
entry.isDirectory() &&
!entry.name.startsWith(".") &&
entry.name !== "node_modules"
) {
walk(join(dir, entry.name));
}
}
const mapPath = join(dir, ".pi-map.md");
const indexPath = join(dir, ".pi-map.index.md");
try {
statSync(mapPath);
statSync(indexPath);
results.push({
dir: relative(cwd, dir) || ".",
mapPath: relative(cwd, mapPath),
indexPath: relative(cwd, indexPath),
});
} catch {
// skip dirs without the paired artifacts
}
}
walk(cwd);
// shallow-first: sort by path depth then alphabetically
results.sort((a, b) => {
const depthA = a.dir.split(/[/\\]/).length;
const depthB = b.dir.split(/[/\\]/).length;
if (depthA !== depthB) return depthA - depthB;
return a.dir.localeCompare(b.dir);
});
return results;
}
// ---------------------------------------------------------------------------
// Budgeted expansion
// ---------------------------------------------------------------------------
/**
* Build the full injection payload for a project that already has artifacts.
*
* Guarantees:
* 1. Root pair is always present first.
* 2. Additional pairs are appended shallow-first while the budget allows.
* 3. A brief maintenance reminder is prepended.
*/
export function buildInjectionPayload(
cwd: string,
config: Pick<SkillConfig, "contextBudgetPercent" | "contextBudgetMaxTokens">,
contextWindow: number | undefined,
): { content: string; display: false } {
const budget = computeInjectionBudget(config, contextWindow);
const pairs = findAllArtifactPairs(cwd);
const rootIndex = pairs.findIndex((p) => p.dir === ".");
let rootPair: ArtifactPair | undefined;
if (rootIndex >= 0) {
rootPair = pairs.splice(rootIndex, 1)[0];
}
let usedTokens = 0;
const parts: string[] = [];
// Maintenance reminder (lightweight)
const reminder =
"📋 Project map active: Start with the root `.pi-map.index.md`, use indexes first for routing, read the local `.pi-map.md` plus source before edits, run `project_map_patch` after source edits, and run `project_map_validate` before freshness-sensitive architectural handoff. Trust boundary: index routes, map orients, source decides.";
parts.push(reminder);
usedTokens += estimateTokens(reminder);
// Root pair (guaranteed)
if (rootPair) {
const indexContent = readFileSync(join(cwd, rootPair.indexPath), "utf8");
const mapContent = readFileSync(join(cwd, rootPair.mapPath), "utf8");
const block = buildRootPairBlock(indexContent, mapContent);
parts.push(block);
usedTokens += estimateTokens(block);
}
// Budgeted expansion (shallow-first, deterministic)
for (const pair of pairs) {
const indexContent = readFileSync(join(cwd, pair.indexPath), "utf8");
const mapContent = readFileSync(join(cwd, pair.mapPath), "utf8");
const pairTokens =
estimateTokens(indexContent) + estimateTokens(mapContent);
if (usedTokens + pairTokens > budget) {
break;
}
parts.push(
`\n## ${pair.dir}\n\n### Index\n${indexContent}\n\n### Map\n${mapContent}`,
);
usedTokens += pairTokens;
}
return { content: parts.join("\n\n"), display: false };
}
src/retrieve.ts
+296
View File
@@ -0,0 +1,296 @@
import { readdirSync, readFileSync } from "fs";
import { join } from "path";
import { parseDirectoryMap, parseDirectoryIndex } from "./format.js";
import type { DirectoryArtifactModel } from "./directory-model.js";
const TOP_K = 3;
export interface RetrieveContextOptions {
topK?: number;
}
export function retrieveContext(
query: string,
rootPath: string,
opts: RetrieveContextOptions = {},
): string {
const topK = opts.topK ?? TOP_K;
const candidates = collectCandidates(rootPath);
const queryTerms = normalizeTerms(query);
const scored = candidates
.map((model) => ({
model,
score: scoreDirectory(model, queryTerms),
}))
.filter((c) => c.score > 0)
.sort((a, b) => b.score - a.score)
.slice(0, topK);
if (scored.length === 0) {
return renderNoResultsBundle(query);
}
return renderContextBundle(
query,
scored.map((s) => s.model),
);
}
function collectCandidates(rootPath: string): DirectoryArtifactModel[] {
const results: DirectoryArtifactModel[] = [];
function walk(dir: string) {
let entries: import("fs").Dirent[];
try {
entries = readdirSync(dir, { withFileTypes: true });
} catch {
return;
}
const hasIndex = entries.some(
(e) => e.isFile() && e.name === ".pi-map.index.md",
);
const hasMap = entries.some((e) => e.isFile() && e.name === ".pi-map.md");
if (hasIndex || hasMap) {
// Prefer index first, fall back to map, merge if both exist
let model: DirectoryArtifactModel | null = null;
if (hasIndex) {
try {
const text = readFileSync(join(dir, ".pi-map.index.md"), "utf8");
model = parseDirectoryIndex(text);
} catch {
// ignore parse error
}
}
if (hasMap) {
try {
const text = readFileSync(join(dir, ".pi-map.md"), "utf8");
const mapModel = parseDirectoryMap(text);
if (model) {
// Merge: index provides routing, map provides richer metadata
mergeModels(model, mapModel);
} else {
model = mapModel;
}
} catch {
// ignore parse error
}
}
if (model) {
results.push(model);
}
}
for (const entry of entries) {
if (
entry.isDirectory() &&
!entry.name.startsWith(".") &&
entry.name !== "node_modules"
) {
walk(join(dir, entry.name));
}
}
}
walk(rootPath);
return results;
}
function mergeModels(
index: DirectoryArtifactModel,
map: DirectoryArtifactModel,
): void {
// Use map's richer fields when index lacks them
if (!index.arch && map.arch) index.arch = map.arch;
if (index.tags.length === 0 && map.tags.length > 0) index.tags = map.tags;
if (index.symbols.length === 0 && map.symbols.length > 0)
index.symbols = map.symbols;
if (index.files.length === 0 && map.files.length > 0) index.files = map.files;
// Merge workflows, preferring index's workflow list but keeping map's extras
const indexTasks = new Set(index.workflows.map((w) => w.task));
for (const wf of map.workflows) {
if (!indexTasks.has(wf.task)) {
index.workflows.push(wf);
}
}
}
function normalizeTerms(query: string): string[] {
const terms = new Set<string>();
for (const word of query.toLowerCase().split(/[^a-z0-9]+/)) {
if (word.length > 1) {
terms.add(word);
for (const sub of splitCamelCase(word)) {
if (sub.length > 1) terms.add(sub);
}
}
}
return [...terms];
}
function splitCamelCase(str: string): string[] {
return str
.replace(/([a-z0-9])([A-Z])/g, "$1 $2")
.replace(/[_-]+/g, " ")
.toLowerCase()
.split(/\s+/)
.filter((w) => w.length > 1);
}
function scoreDirectory(
model: DirectoryArtifactModel,
queryTerms: string[],
): number {
let score = 0;
// Role matches
const roleWords = extractWords(model.role);
for (const term of queryTerms) {
if (roleWords.includes(term)) score += 3;
}
// Tag matches
for (const tag of model.tags) {
for (const term of queryTerms) {
if (tag.toLowerCase().includes(term)) score += 2;
}
}
// Symbol matches
for (const sym of model.symbols) {
for (const term of queryTerms) {
if (sym.toLowerCase().includes(term)) score += 2;
}
}
// Workflow task matches
for (const wf of model.workflows) {
for (const term of queryTerms) {
if (wf.task.toLowerCase().includes(term)) score += 2;
}
}
// File name and purpose matches
for (const file of model.files) {
const fileWords = extractWords(`${file.name} ${file.purpose}`);
const camelWords = splitCamelCase(file.name);
for (const term of queryTerms) {
if (fileWords.includes(term) || camelWords.includes(term)) score += 1;
}
}
// Directory path matches
const pathWords = extractWords(model.dir);
for (const term of queryTerms) {
if (pathWords.includes(term)) score += 1;
}
return score;
}
function extractWords(text: string): string[] {
return text
.toLowerCase()
.split(/[^a-z0-9]+/)
.filter((w) => w.length > 1);
}
function renderContextBundle(
query: string,
candidates: DirectoryArtifactModel[],
): string {
const lines: string[] = [];
lines.push(`# Context bundle: ${query}`);
lines.push("");
lines.push("## query");
lines.push(query);
lines.push("");
lines.push("## relevant indexes");
for (const c of candidates) {
lines.push(`- ${c.dir}/.pi-map.index.md`);
}
lines.push("");
lines.push("## relevant maps");
for (const c of candidates) {
lines.push(`- ${c.dir}/.pi-map.md`);
}
lines.push("");
lines.push("## likely files");
const seenFiles = new Set<string>();
for (const c of candidates) {
for (const f of c.files) {
const path = `${c.dir}/${f.name}`;
if (!seenFiles.has(path)) {
seenFiles.add(path);
lines.push(`- ${path}`);
}
}
}
if (seenFiles.size === 0) {
lines.push("-");
}
lines.push("");
// Symbols: only include if at least one candidate has scored symbols above threshold
const relevantSymbols = collectRelevantSymbols(candidates);
if (relevantSymbols.length > 0) {
lines.push("## relevant symbols");
for (const sym of relevantSymbols) {
lines.push(`- ${sym}`);
}
lines.push("");
}
lines.push("## instructions");
lines.push(
"Read the indexes first, then the strongest-match rich maps, then verify behavior from source before editing.",
);
return lines.join("\n");
}
function collectRelevantSymbols(
candidates: DirectoryArtifactModel[],
): string[] {
const seen = new Set<string>();
const result: string[] = [];
for (const c of candidates) {
for (const sym of c.symbols) {
if (!seen.has(sym)) {
seen.add(sym);
result.push(sym);
}
}
}
// Cap at a reasonable number to keep output compact
return result.slice(0, 12);
}
function renderNoResultsBundle(query: string): string {
return [
`# Context bundle: ${query}`,
"",
"## query",
query,
"",
"## relevant indexes",
"-",
"",
"## relevant maps",
"-",
"",
"## likely files",
"-",
"",
"## instructions",
"No relevant directories found. Try rephrasing the query or run `project_map_reinit` if artifacts are stale.",
].join("\n");
}
src/routing-metadata.ts
+265
View File
@@ -0,0 +1,265 @@
import type {
DirectoryArtifactModel,
FileEntry,
RoutingMetadataOptions,
WorkflowHint,
} from "./directory-model.js";
const DEFAULT_TAG_CAP = 8;
const DEFAULT_WORKFLOW_HINT_CAP = 5;
const STOP_WORDS = new Set([
"the",
"and",
"for",
"with",
"from",
"into",
"onto",
"this",
"that",
"then",
"than",
"when",
"where",
"what",
"how",
"why",
"who",
"which",
"while",
"during",
"before",
"after",
"above",
"below",
"between",
"among",
"through",
"over",
"under",
"again",
"further",
"once",
"here",
"there",
"all",
"any",
"both",
"each",
"few",
"more",
"most",
"other",
"some",
"such",
"only",
"own",
"same",
"so",
"too",
"very",
"can",
"will",
"just",
"should",
"now",
"use",
"using",
"used",
"via",
"based",
"build",
"built",
"used",
"file",
"files",
"module",
"modules",
"function",
"functions",
"class",
"classes",
"export",
"exports",
"import",
"imports",
]);
export function populateRoutingMetadata(
model: DirectoryArtifactModel,
opts: RoutingMetadataOptions = {},
): void {
const tagCap = opts.tagCap ?? DEFAULT_TAG_CAP;
const workflowHintCap = opts.workflowHintCap ?? DEFAULT_WORKFLOW_HINT_CAP;
model.tags = generateTags(model.files, tagCap);
model.symbols = generateSymbols(model.files, tagCap);
model.workflows = generateWorkflows(model, workflowHintCap);
}
function generateTags(files: FileEntry[], cap: number): string[] {
const scores = new Map<string, number>();
for (const file of files) {
// Score words from file purpose
for (const word of extractWords(file.purpose)) {
scores.set(word, (scores.get(word) ?? 0) + 1);
}
// Score words from export names (camelCase split)
for (const exp of file.exports) {
const cleanExp = exp.replace(/^(class|func|method):/, "").split("(")[0];
for (const word of splitCamelCase(cleanExp)) {
if (word.length > 1) {
scores.set(word, (scores.get(word) ?? 0) + 2);
}
}
}
// Score dep path segments
for (const dep of file.deps) {
for (const segment of dep.split(/[/\-.]/)) {
const word = segment.toLowerCase();
if (word.length > 1 && !STOP_WORDS.has(word)) {
scores.set(word, (scores.get(word) ?? 0) + 1);
}
}
}
// Score from file name (stem, no extension)
const stem = file.name.replace(/\.[^.]+$/, "");
for (const word of splitCamelCase(stem)) {
if (word.length > 1) {
scores.set(word, (scores.get(word) ?? 0) + 2);
}
}
}
return Array.from(scores.entries())
.sort((a, b) => b[1] - a[1])
.map(([word]) => word)
.slice(0, cap);
}
function generateSymbols(files: FileEntry[], cap: number): string[] {
const scores = new Map<string, number>();
const seen = new Set<string>();
for (const file of files) {
for (const exp of file.exports) {
// Prefer clean identifiers over encoded DSL entries when possible
let symbol = exp;
let score = 1;
if (exp.startsWith("class:")) {
symbol = exp.slice(6).split(" ")[0];
score = 3;
} else if (exp.startsWith("func:")) {
symbol = exp.slice(5).split("(")[0];
score = 2;
} else if (exp.startsWith("method:")) {
symbol = exp.slice(7).split("(")[0];
score = 2;
}
if (!seen.has(symbol)) {
seen.add(symbol);
scores.set(symbol, (scores.get(symbol) ?? 0) + score);
}
}
}
return Array.from(scores.entries())
.sort((a, b) => b[1] - a[1])
.map(([name]) => name)
.slice(0, cap);
}
function generateWorkflows(
model: DirectoryArtifactModel,
cap: number,
): WorkflowHint[] {
const workflows: WorkflowHint[] = [];
const dirName = model.dir.split("/").pop() || model.dir;
const baseName = dirName === "." ? "project" : dirName;
// Only generate workflows when we have reasonable structural confidence
const hasSourceFiles = model.files.some((f) =>
/\.(ts|tsx|js|jsx|py|go|rs|java)$/.test(f.name),
);
if (!hasSourceFiles || model.files.length === 0) {
return workflows;
}
const sourceFiles = model.files.filter(
(f) =>
!/\.(test|spec)\./.test(f.name) && !/\.(md|json|yaml|yml)$/.test(f.name),
);
const testFiles = model.files.filter((f) => /\.(test|spec)\./.test(f.name));
const configFiles = model.files.filter(
(f) =>
f.name.includes("config") ||
/\.(json|yaml|yml|toml)$/.test(f.name) ||
f.name === ".env",
);
const cliFiles = model.files.filter(
(f) => f.name.includes("cli") || f.name.includes("command"),
);
if (sourceFiles.length > 0) {
workflows.push({
task: `change ${baseName} behavior`,
read: sourceFiles.slice(0, 3).map((f) => f.name),
});
}
if (testFiles.length > 0) {
workflows.push({
task: `update ${baseName} tests`,
read: testFiles.slice(0, 3).map((f) => f.name),
});
}
if (cliFiles.length > 0) {
workflows.push({
task: `change ${baseName} CLI`,
read: cliFiles.slice(0, 3).map((f) => f.name),
});
}
if (configFiles.length > 0) {
workflows.push({
task: `change ${baseName} config`,
read: configFiles.slice(0, 3).map((f) => f.name),
});
}
// Add a directory-navigation workflow for non-leaf directories
if (model.children.length > 0) {
workflows.push({
task: `explore ${baseName} subdirectories`,
index: model.children
.slice(0, 3)
.map((child) => `${child}/.pi-map.index.md`),
});
}
return workflows.slice(0, cap);
}
function extractWords(text: string): string[] {
return text
.toLowerCase()
.split(/[^a-z0-9]+/)
.filter((w) => w.length > 2 && !STOP_WORDS.has(w));
}
function splitCamelCase(str: string): string[] {
return str
.replace(/([a-z0-9])([A-Z])/g, "$1 $2")
.replace(/[_-]+/g, " ")
.toLowerCase()
.split(/\s+/)
.filter((w) => w.length > 1 && !STOP_WORDS.has(w));
}
src/validate.ts
+389 -76
View File
@@ -1,9 +1,17 @@
import { discoverProject } from "./discover.js";
import { parsePackageMap } from "./format.js";
import { existsSync, readFileSync } from "fs";
import { join } from "path";
import { join, resolve } from "path";
import { discoverProject } from "./discover.js";
import type { DirectoryEntry } from "./discover.js";
import { parseDirectoryIndex, parseDirectoryMap } from "./format.js";
import { extractFileAST } from "./ast/ast-extract.js";
import { generateDirectoryMap } from "./init.js";
import {
generateDirectoryArtifacts,
buildDirectoryContext,
type ArtifactWriteMode,
} from "./init.js";
import type { LLMClient } from "./llm/llm-client.js";
import { loadConfig } from "./config.js";
import type { PatchMode } from "./patch.js";
export interface ValidationResult {
clean: boolean;
@@ -11,118 +19,271 @@ export interface ValidationResult {
fixed?: number;
}
export interface ValidationOptions {
fix?: boolean;
verbose?: boolean;
llmClient?: LLMClient;
cacheDir?: string;
patchMode?: PatchMode;
}
export interface Discrepancy {
type: "missing" | "orphaned" | "stale-signature" | "dirty";
type:
| "missing"
| "orphaned"
| "stale-signature"
| "dirty"
| "stale-index"
| "stale-map"
| "broken-link"
| "structural";
path: string;
message: string;
}
type RepairMode = Exclude<PatchMode, "auto">;
export async function validateMaps(
rootPath: string,
options?: { fix?: boolean; verbose?: boolean },
options: ValidationOptions = {},
): Promise<ValidationResult> {
const { fix = false, verbose = true } = options || {};
const root = resolve(rootPath);
const {
fix = false,
verbose = true,
llmClient,
cacheDir,
patchMode = "auto",
} = options;
const discrepancies: Discrepancy[] = [];
const entries = discoverProject(rootPath);
const dirsToFix = new Set<string>();
const entries = discoverProject(root);
const config = loadConfig(root);
const routingOpts = {
tagCap: config.tagCap,
workflowHintCap: config.workflowHintCap,
};
const repairModes = new Map<string, RepairMode>();
for (const entry of entries) {
const ctx = buildDirectoryContext(entries, entry);
const mapPath = join(entry.dirPath, ".pi-map.md");
const indexPath = join(entry.dirPath, ".pi-map.index.md");
const expectedParent = ctx.parentMap.get(entry.relativePath);
const expectedChildren = [
...(ctx.childrenMap.get(entry.relativePath) ?? []),
].sort();
const structuralFlag = (reason: string, path = entry.relativePath) => {
discrepancies.push({ type: "structural", path, message: reason });
markRepairMode(repairModes, entry.dirPath, "structural");
};
if (!existsSync(mapPath)) {
discrepancies.push({
type: "missing",
path: entry.relativePath,
message: "No .pi-map.md found",
type: "stale-map",
path: mapPath,
message: "missing .pi-map.md",
});
if (fix) dirsToFix.add(entry.dirPath);
markRepairMode(repairModes, entry.dirPath, "structural");
continue;
}
if (!existsSync(indexPath)) {
discrepancies.push({
type: "stale-index",
path: indexPath,
message: "missing .pi-map.index.md",
});
markRepairMode(repairModes, entry.dirPath, "structural");
continue;
}
const mapData = parsePackageMap(readFileSync(mapPath, "utf8"));
let mapNeedsRewrite = false;
const mapText = readFileSync(mapPath, "utf8");
const indexText = readFileSync(indexPath, "utf8");
const mapData = parseDirectoryMap(mapText);
const indexData = parseDirectoryIndex(indexText);
// Check for dirty markers
if (mapData.dirty && mapData.dirty !== "-") {
discrepancies.push({
type: "dirty",
path: mapPath,
message: `Dirty: ${mapData.dirty}`,
});
if (fix) mapNeedsRewrite = true;
markRepairMode(repairModes, entry.dirPath, "small");
}
if (indexData.dirty && indexData.dirty !== "-") {
discrepancies.push({
type: "stale-index",
path: indexPath,
message: `dirty index: ${indexData.dirty}`,
});
markRepairMode(repairModes, entry.dirPath, "small");
}
// Check for orphaned entries
for (const fileEntry of mapData.files) {
const filePath = join(entry.dirPath, fileEntry.name);
if (!existsSync(filePath)) {
discrepancies.push({
type: "orphaned",
path: filePath,
message: `File listed but deleted: ${fileEntry.name}`,
});
if (fix) mapNeedsRewrite = true;
}
if (mapData.dir !== entry.relativePath) {
structuralFlag(`dir mismatch in map (${mapData.dir})`, mapPath);
}
if (indexData.dir !== entry.relativePath) {
structuralFlag(`dir mismatch in index (${indexData.dir})`, indexPath);
}
// Check for new files not in map
const expectedIndexLink = `index: ${entry.relativePath}/.pi-map.index.md`;
const expectedMapLink = `map: ${entry.relativePath}/.pi-map.md`;
if (!mapText.includes(expectedIndexLink)) {
discrepancies.push({
type: "broken-link",
path: mapPath,
message: `missing sibling index link (${expectedIndexLink})`,
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
if (!indexText.includes(expectedMapLink)) {
discrepancies.push({
type: "broken-link",
path: indexPath,
message: `missing sibling map link (${expectedMapLink})`,
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
const mapFiles = new Set(mapData.files.map((file) => file.name));
const indexFiles = new Set(indexData.files.map((file) => file.name));
const actualFiles = new Set(entry.files);
for (const file of entry.files) {
if (!mapData.files.find((f) => f.name === file)) {
if (!mapFiles.has(file)) {
discrepancies.push({
type: "missing",
path: join(entry.dirPath, file),
message: `File not in .pi-map.md: ${file}`,
});
if (fix) mapNeedsRewrite = true;
markRepairMode(repairModes, entry.dirPath, "small");
}
if (!indexFiles.has(file)) {
discrepancies.push({
type: "stale-index",
path: indexPath,
message: `file missing from index: ${file}`,
});
markRepairMode(repairModes, entry.dirPath, "small");
}
}
for (const file of mapFiles) {
if (!actualFiles.has(file)) {
discrepancies.push({
type: "orphaned",
path: join(entry.dirPath, file),
message: `File listed but deleted: ${file}`,
});
markRepairMode(repairModes, entry.dirPath, "small");
}
}
for (const file of indexFiles) {
if (!actualFiles.has(file)) {
discrepancies.push({
type: "stale-index",
path: indexPath,
message: `orphaned file entry in index: ${file}`,
});
markRepairMode(repairModes, entry.dirPath, "small");
}
}
if ((indexData.parent ?? undefined) !== expectedParent) {
discrepancies.push({
type: "broken-link",
path: indexPath,
message: `parent mismatch: expected ${expectedParent ?? "-"}`,
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
if (!sameStringArrays(indexData.children, expectedChildren)) {
discrepancies.push({
type: "broken-link",
path: indexPath,
message: `children mismatch: expected ${expectedChildren.join(", ") || "-"}`,
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
if (!sameWorkflowShapes(mapData.workflows, indexData.workflows)) {
discrepancies.push({
type: "structural",
path: entry.relativePath,
message: "map/index workflow disagreement",
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
for (const target of collectWorkflowTargets(indexData)) {
if (!targetExists(root, target)) {
discrepancies.push({
type: "broken-link",
path: indexPath,
message: `workflow target missing: ${target}`,
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
}
// Check signatures for code files
for (const fileEntry of mapData.files) {
const filePath = join(entry.dirPath, fileEntry.name);
if (!existsSync(filePath)) continue;
const astData = await extractFileAST(filePath);
if (astData) {
const listedExports = new Set(fileEntry.exports);
const actualExports = new Set(astData.exports);
for (const exp of listedExports) {
if (!actualExports.has(exp)) {
discrepancies.push({
type: "stale-signature",
path: filePath,
message: `Missing export: ${exp}`,
});
if (fix) mapNeedsRewrite = true;
}
}
for (const exp of actualExports) {
if (!listedExports.has(exp)) {
discrepancies.push({
type: "stale-signature",
path: filePath,
message: `New export: ${exp}`,
});
if (fix) mapNeedsRewrite = true;
}
if (!astData) continue;
const actualExports = new Set(astData.exports);
const listedExports = new Set(
normalizeListedExports(fileEntry.exports, actualExports),
);
for (const exp of listedExports) {
if (!actualExports.has(exp)) {
discrepancies.push({
type: "stale-signature",
path: filePath,
message: `Missing export: ${exp}`,
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
}
for (const exp of actualExports) {
if (!listedExports.has(exp)) {
discrepancies.push({
type: "stale-signature",
path: filePath,
message: `New export: ${exp}`,
});
markRepairMode(repairModes, entry.dirPath, "structural");
}
}
}
if (fix && mapNeedsRewrite) {
dirsToFix.add(entry.dirPath);
}
}
// Apply fixes
let fixed = 0;
if (fix && dirsToFix.size > 0) {
for (const dirPath of dirsToFix) {
const entry = entries.find((e) => e.dirPath === dirPath);
if (entry) {
await generateDirectoryMap(entry);
fixed++;
}
if (fix && repairModes.size > 0) {
if (!llmClient) {
throw new Error("validate --fix requires an LLM client");
}
const repairPlan = new Map<string, ArtifactWriteMode>();
for (const [dirPath, inferredMode] of repairModes) {
const entry = entries.find((candidate) => candidate.dirPath === dirPath);
if (!entry) continue;
const effectiveMode = patchMode === "auto" ? inferredMode : patchMode;
addRepairChain(entries, entry, effectiveMode, repairPlan);
}
const orderedEntries = Array.from(repairPlan.entries()).sort(
(a, b) => depthOfPath(b[0]) - depthOfPath(a[0]),
);
for (const [dirPath, writeMode] of orderedEntries) {
const entry = entries.find((candidate) => candidate.dirPath === dirPath);
if (!entry) continue;
const ctx = buildDirectoryContext(entries, entry);
await generateDirectoryArtifacts(
entry,
ctx,
llmClient,
cacheDir,
undefined,
routingOpts,
writeMode,
);
fixed++;
}
}
@@ -130,24 +291,176 @@ export async function validateMaps(
clean: discrepancies.length === 0,
discrepancies,
};
if (fix) {
result.fixed = fixed;
}
if (fix) result.fixed = fixed;
if (verbose) {
if (result.clean) {
console.log("All .pi-map.md files are clean.");
console.log("All .pi-map.md/.pi-map.index.md files are clean.");
} else {
console.log(`Found ${discrepancies.length} discrepancies:`);
for (const d of discrepancies) {
console.log(` [${d.type}] ${d.path}: ${d.message}`);
for (const discrepancy of discrepancies) {
console.log(
` [${discrepancy.type}] ${discrepancy.path}: ${discrepancy.message}`,
);
}
}
if (fix && fixed > 0) {
console.log(`Fixed ${fixed} director${fixed === 1 ? "y" : "ies"}.`);
const fixModeLabel = patchMode === "auto" ? "auto" : patchMode;
console.log(
`Repaired affected chain (patchMode: ${fixModeLabel}) across ${fixed} directories.`,
);
}
}
return result;
}
function sameStringArrays(a: string[], b: string[]): boolean {
const left = [...a].sort();
const right = [...b].sort();
return JSON.stringify(left) === JSON.stringify(right);
}
function sameWorkflowShapes(
a: ReturnType<typeof parseDirectoryMap>["workflows"],
b: ReturnType<typeof parseDirectoryIndex>["workflows"],
): boolean {
const normalize = (workflow: (typeof a)[number]) => ({
task: workflow.task,
read: [...(workflow.read ?? [])].sort(),
index: [...(workflow.index ?? [])].sort(),
map: [...(workflow.map ?? [])].sort(),
files: [...(workflow.files ?? [])].sort(),
});
return JSON.stringify(a.map(normalize)) === JSON.stringify(b.map(normalize));
}
function collectWorkflowTargets(
indexData: ReturnType<typeof parseDirectoryIndex>,
): string[] {
const targets: string[] = [];
for (const workflow of indexData.workflows) {
targets.push(...(workflow.index ?? []));
targets.push(...(workflow.map ?? []));
targets.push(...(workflow.files ?? []));
}
return targets;
}
function targetExists(rootPath: string, target: string): boolean {
return existsSync(resolve(rootPath, target));
}
const BUILT_IN_GLOBALS = new Set([
"Array",
"Date",
"JSON",
"Math",
"Object",
"Promise",
"RegExp",
"String",
"Number",
"Boolean",
"Error",
"Map",
"Set",
"Symbol",
"WeakMap",
"WeakSet",
"ArrayBuffer",
"DataView",
"Float32Array",
"Float64Array",
"Int8Array",
"Int16Array",
"Int32Array",
"Uint8Array",
"Uint8ClampedArray",
"Uint16Array",
"Uint32Array",
"console",
"process",
"Buffer",
"undefined",
"null",
"Infinity",
"NaN",
"parseInt",
"parseFloat",
"isNaN",
"isFinite",
"encodeURI",
"encodeURIComponent",
"decodeURI",
"decodeURIComponent",
"eval",
"Function",
"Proxy",
"Reflect",
"Intl",
"BigInt",
]);
function normalizeListedExports(
exports: string[],
actualExports: Set<string>,
): string[] {
const normalized = new Set<string>();
for (const exp of exports) {
let candidate = exp.trim();
if (candidate.startsWith("call:") || candidate.startsWith("raise:"))
continue;
candidate = candidate.replace(/^(class|func|method):/, "");
candidate = candidate.split("(")[0]?.split(" ")[0] ?? candidate;
const match = candidate.match(/[A-Za-z_$][\w$]*/);
if (!match) continue;
const symbol = match[0];
if (
actualExports.has(symbol) ||
(/^[A-Z][A-Za-z0-9_$]*$/.test(symbol) && !BUILT_IN_GLOBALS.has(symbol)) ||
/^[A-Z0-9_]+$/.test(symbol)
) {
normalized.add(symbol);
}
}
return [...normalized];
}
function markRepairMode(
repairModes: Map<string, RepairMode>,
dirPath: string,
mode: RepairMode,
): void {
const existing = repairModes.get(dirPath);
if (!existing || existing === "small") {
repairModes.set(dirPath, mode);
}
}
function addRepairChain(
entries: DirectoryEntry[],
entry: DirectoryEntry,
mode: RepairMode,
plan: Map<string, ArtifactWriteMode>,
): void {
plan.set(entry.dirPath, "both");
const ctx = buildDirectoryContext(entries, entry);
let parent = ctx.parentMap.get(entry.relativePath);
while (parent) {
const ancestor = entries.find(
(candidate) => candidate.relativePath === parent,
);
if (!ancestor) break;
const desiredMode: ArtifactWriteMode = mode === "small" ? "index" : "both";
const existingMode = plan.get(ancestor.dirPath);
if (existingMode !== "both") {
plan.set(ancestor.dirPath, desiredMode);
}
parent = ctx.parentMap.get(parent);
}
}
function depthOfPath(dirPath: string): number {
return dirPath.split(/[\\/]/).filter(Boolean).length;
}
tests/cli.test.ts
+215
View File
@@ -0,0 +1,215 @@
import { describe, it, expect, beforeEach, afterEach } from "vitest";
import { mkdtempSync, writeFileSync, mkdirSync, rmSync } from "fs";
import { join } from "path";
import { tmpdir } from "os";
import { execSync } from "child_process";
import { fileURLToPath } from "url";
const projectRoot = fileURLToPath(new URL("..", import.meta.url));
function runCli(
args: string,
cwd: string,
): { stdout: string; stderr: string; exitCode: number } {
try {
const stdout = execSync(
`npx tsx ${join(projectRoot, "src/cli/cli.ts")} ${args}`,
{
cwd,
encoding: "utf8",
stdio: ["pipe", "pipe", "pipe"],
},
);
return { stdout: stdout.trim(), stderr: "", exitCode: 0 };
} catch (err: any) {
return {
stdout: err.stdout?.toString().trim() || "",
stderr: err.stderr?.toString().trim() || "",
exitCode: err.status || 1,
};
}
}
describe("cli context", () => {
let dir: string;
beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), "pi-map-cli-"));
});
afterEach(() => {
rmSync(dir, { recursive: true });
});
it("context command returns a bundle for a matching query", () => {
mkdirSync(join(dir, "src"));
mkdirSync(join(dir, "src", "auth"));
writeFileSync(
join(dir, "src", "auth", "tokens.ts"),
`export function validateToken() {}\n`,
);
writeFileSync(
join(dir, "src", "auth", ".pi-map.md"),
`# src/auth
dir: src/auth
index: src/auth/.pi-map.index.md
## role
Authentication and token validation.
## files
- tokens.ts | Token validation | exp: validateToken | dep: -
## arch
Guard pattern.
## tags
auth, token, validate
## symbols
validateToken
## workflows
- validate token
files: tokens.ts
## dirty
-
`,
);
writeFileSync(
join(dir, "src", "auth", ".pi-map.index.md"),
`# src/auth (index)
dir: src/auth
## role
Auth layer.
## parent
index: ./.pi-map.index.md
map: ./.pi-map.md
## children
-
## files
- tokens.ts
## links
index: src/auth/.pi-map.index.md
map: src/auth/.pi-map.md
## workflows
- validate token
## dirty
-
`,
);
const { stdout, exitCode } = runCli('context "token validation"', dir);
expect(exitCode).toBe(0);
expect(stdout).toContain("# Context bundle: token validation");
expect(stdout).toContain("## relevant indexes");
expect(stdout).toContain("src/auth/.pi-map.index.md");
expect(stdout).toContain("## relevant maps");
expect(stdout).toContain("src/auth/.pi-map.md");
expect(stdout).toContain("## likely files");
expect(stdout).toContain("src/auth/tokens.ts");
expect(stdout).toContain("## instructions");
});
it("context command omits symbols section when no symbols exist", () => {
mkdirSync(join(dir, "src"));
writeFileSync(
join(dir, "src", ".pi-map.md"),
`# src
dir: src
index: src/.pi-map.index.md
## role
Core source.
## files
- index.ts | Entry | exp: main | dep: -
## arch
Entrypoint.
## tags
-
## symbols
-
## workflows
-
## dirty
-
`,
);
writeFileSync(
join(dir, "src", ".pi-map.index.md"),
`# src (index)
dir: src
## role
Core source.
## parent
-
## children
-
## files
- index.ts
## links
index: src/.pi-map.index.md
map: src/.pi-map.md
## workflows
-
## dirty
-
`,
);
const { stdout, exitCode } = runCli('context "core source"', dir);
expect(exitCode).toBe(0);
expect(stdout).toContain("# Context bundle: core source");
expect(stdout).not.toContain("## relevant symbols");
});
it("context command returns no-results bundle when nothing matches", () => {
mkdirSync(join(dir, "src"));
writeFileSync(
join(dir, "src", ".pi-map.md"),
`# src
dir: src
index: src/.pi-map.index.md
## role
Core source.
## files
- index.ts | Entry | exp: main | dep: -
## arch
Entrypoint.
## tags
-
## symbols
-
## workflows
-
## dirty
-
`,
);
writeFileSync(
join(dir, "src", ".pi-map.index.md"),
`# src (index)
dir: src
## role
Core source.
## parent
-
## children
-
## files
- index.ts
## links
index: src/.pi-map.index.md
map: src/.pi-map.md
## workflows
-
## dirty
-
`,
);
const { stdout, exitCode } = runCli('context "zzzzzzzz"', dir);
expect(exitCode).toBe(0);
expect(stdout).toContain("# Context bundle: zzzzzzzz");
expect(stdout).toContain("No relevant directories found");
});
it("context command errors when query is missing", () => {
const { stderr, exitCode } = runCli("context", dir);
expect(exitCode).toBe(1);
expect(stderr).toContain("Missing query");
});
});
tests/format.test.ts
+289
View File
@@ -2,8 +2,13 @@ import { describe, it, expect } from "vitest";
import {
renderPackageMap,
parsePackageMap,
renderDirectoryMap,
parseDirectoryMap,
renderDirectoryIndex,
parseDirectoryIndex,
type PackageMapData,
} from "../src/format.js";
import { createDirectoryModel } from "../src/directory-model.js";
const sampleData: PackageMapData = {
path: "pkg/auth",
@@ -42,6 +47,9 @@ describe("format", () => {
"- tokens.ts | JWT gen/val | exp: issueToken, verifyToken, refreshToken | dep: crypto/hmac, db/sessions",
);
expect(output).toContain("## arch");
expect(output).toContain("## tags");
expect(output).toContain("## symbols");
expect(output).toContain("## workflows");
expect(output).toContain("## dirty");
expect(output).toContain("-");
});
@@ -94,6 +102,12 @@ Test package
Line one.
Line two.
Line three.
## tags
-
## symbols
-
## workflows
-
## dirty
-
`;
@@ -101,3 +115,278 @@ Line three.
expect(parsed.arch).toBe("Line one.\nLine two.\nLine three.");
});
});
describe("paired artifacts", () => {
it("renders and parses a directory map with tags/symbols/workflows", () => {
const model = createDirectoryModel({
dir: "src/cli",
role: "CLI entrypoint and command parsing",
files: [
{
name: "cli.ts",
purpose: "CLI entrypoint",
exports: ["main"],
deps: ["commander"],
},
],
arch: "Command-line interface built on commander.js",
});
model.tags = ["cli", "entrypoint"];
model.symbols = ["main"];
model.workflows = [{ task: "add command", read: ["cli.ts"] }];
const rendered = renderDirectoryMap(model);
expect(rendered).toContain("# src/cli");
expect(rendered).toContain("## tags");
expect(rendered).toContain("cli, entrypoint");
expect(rendered).toContain("## symbols");
expect(rendered).toContain("- main");
expect(rendered).toContain("## workflows");
expect(rendered).toContain("- add command");
const parsed = parseDirectoryMap(rendered);
expect(parsed.dir).toBe("src/cli");
expect(parsed.tags).toEqual(["cli", "entrypoint"]);
expect(parsed.symbols).toEqual(["main"]);
expect(parsed.workflows).toHaveLength(1);
expect(parsed.workflows[0].task).toBe("add command");
});
it("renders and parses a directory index with parent/children/links", () => {
const model = createDirectoryModel({
dir: "src",
role: "Core source code",
files: [
{ name: "index.ts", purpose: "Main exports", exports: [], deps: [] },
],
arch: "Source code root",
parent: ".",
children: ["src/cli", "src/lib"],
});
const rendered = renderDirectoryIndex(model);
expect(rendered).toContain("# src (index)");
expect(rendered).toContain("dir: src");
expect(rendered).toContain("## parent");
expect(rendered).toContain("index: ./.pi-map.index.md");
expect(rendered).toContain("map: ./.pi-map.md");
expect(rendered).toContain("## children");
expect(rendered).toContain("- src/cli");
expect(rendered).toContain("index: src/cli/.pi-map.index.md");
expect(rendered).toContain("map: src/cli/.pi-map.md");
expect(rendered).toContain("## links");
expect(rendered).toContain("index: src/.pi-map.index.md");
expect(rendered).toContain("map: src/.pi-map.md");
const parsed = parseDirectoryIndex(rendered);
expect(parsed.dir).toBe("src");
expect(parsed.parent).toBe(".");
expect(parsed.children).toEqual(["src/cli", "src/lib"]);
});
it("renders a root index with Project Map Protocol", () => {
const model = createDirectoryModel({
dir: ".",
role: "Project root",
files: [],
arch: "Root architecture",
isRoot: true,
});
const rendered = renderDirectoryIndex(model);
expect(rendered).toContain("# . (index)");
expect(rendered).toContain("dir: .");
});
it("round-trips an empty leaf index", () => {
const model = createDirectoryModel({
dir: "src/utils",
role: "Utilities",
files: [
{ name: "helpers.ts", purpose: "Helpers", exports: [], deps: [] },
],
arch: "Shared helpers",
});
const rendered = renderDirectoryIndex(model);
expect(rendered).toContain("# src/utils (index)");
expect(rendered).toContain("## children");
expect(rendered).toContain("-");
const parsed = parseDirectoryIndex(rendered);
expect(parsed.dir).toBe("src/utils");
expect(parsed.children).toEqual([]);
expect(parsed.files).toHaveLength(1);
expect(parsed.files[0].name).toBe("helpers.ts");
});
it("round-trips workflows with read continuations in map", () => {
const model = createDirectoryModel({
dir: "src/cli",
role: "CLI entrypoint",
files: [{ name: "cli.ts", purpose: "CLI", exports: ["main"], deps: [] }],
arch: "CLI",
});
model.workflows = [
{ task: "add command", read: ["cli.ts", "commands.ts"] },
{ task: "update flags", read: ["cli.ts"] },
];
const rendered = renderDirectoryMap(model);
expect(rendered).toContain("- add command");
expect(rendered).toContain(" read: cli.ts, commands.ts");
expect(rendered).toContain("- update flags");
expect(rendered).toContain(" read: cli.ts");
const parsed = parseDirectoryMap(rendered);
expect(parsed.workflows).toHaveLength(2);
expect(parsed.workflows[0].task).toBe("add command");
expect(parsed.workflows[0].read).toEqual(["cli.ts", "commands.ts"]);
expect(parsed.workflows[1].task).toBe("update flags");
expect(parsed.workflows[1].read).toEqual(["cli.ts"]);
});
it("round-trips workflows with read continuations in index", () => {
const model = createDirectoryModel({
dir: "src/cli",
role: "CLI entrypoint",
files: [{ name: "cli.ts", purpose: "CLI", exports: ["main"], deps: [] }],
arch: "CLI",
});
model.workflows = [
{ task: "add command", read: ["cli.ts", "commands.ts"] },
];
const rendered = renderDirectoryIndex(model);
expect(rendered).toContain("- add command");
expect(rendered).toContain(" read: cli.ts, commands.ts");
const parsed = parseDirectoryIndex(rendered);
expect(parsed.workflows).toHaveLength(1);
expect(parsed.workflows[0].task).toBe("add command");
expect(parsed.workflows[0].read).toEqual(["cli.ts", "commands.ts"]);
});
it("round-trips workflows with index, map, and files continuations", () => {
const model = createDirectoryModel({
dir: "src",
role: "Source root",
files: [{ name: "index.ts", purpose: "Exports", exports: [], deps: [] }],
arch: "Source",
children: ["src/auth", "src/cli"],
});
model.workflows = [
{
task: "explore subdirectories",
index: ["src/auth/.pi-map.index.md", "src/cli/.pi-map.index.md"],
map: ["src/auth/.pi-map.md"],
files: ["src/index.ts"],
},
];
const mapRendered = renderDirectoryMap(model);
expect(mapRendered).toContain("- explore subdirectories");
expect(mapRendered).toContain(
" index: src/auth/.pi-map.index.md, src/cli/.pi-map.index.md",
);
expect(mapRendered).toContain(" map: src/auth/.pi-map.md");
expect(mapRendered).toContain(" files: src/index.ts");
const mapParsed = parseDirectoryMap(mapRendered);
expect(mapParsed.workflows).toHaveLength(1);
expect(mapParsed.workflows[0].index).toEqual([
"src/auth/.pi-map.index.md",
"src/cli/.pi-map.index.md",
]);
expect(mapParsed.workflows[0].map).toEqual(["src/auth/.pi-map.md"]);
expect(mapParsed.workflows[0].files).toEqual(["src/index.ts"]);
const indexRendered = renderDirectoryIndex(model);
expect(indexRendered).toContain("- explore subdirectories");
expect(indexRendered).toContain(
" index: src/auth/.pi-map.index.md, src/cli/.pi-map.index.md",
);
const indexParsed = parseDirectoryIndex(indexRendered);
expect(indexParsed.workflows).toHaveLength(1);
expect(indexParsed.workflows[0].index).toEqual([
"src/auth/.pi-map.index.md",
"src/cli/.pi-map.index.md",
]);
});
it("renderer includes dir and index preamble directly", () => {
const model = createDirectoryModel({
dir: "src/core",
role: "Core logic",
files: [],
arch: "Core",
});
const rendered = renderDirectoryMap(model);
expect(rendered).toContain("dir: src/core");
expect(rendered).toContain("index: src/core/.pi-map.index.md");
});
it("root renderer includes Project Map Protocol directly", () => {
const model = createDirectoryModel({
dir: ".",
role: "Project root",
files: [],
arch: "Root",
isRoot: true,
});
const mapRendered = renderDirectoryMap(model);
expect(mapRendered).toContain("## Project Map Protocol");
expect(mapRendered).toContain(
"Trust boundary: index routes, map orients, source decides.",
);
const indexRendered = renderDirectoryIndex(model);
expect(indexRendered).toContain("## Project Map Protocol");
});
it("parses file lines with commas inside signatures", () => {
const mapText = `# src
## files
- format.ts | Renders maps | exp: PackageMapData, func:renderPackageMap(data: PackageMapData) → string, call:convertPackageMapToModel, func:renderDirectoryIndex(model: DirectoryArtifactModel) → string | dep: ./model.js
## arch
Test
## dirty
-
`;
const parsed = parseDirectoryMap(mapText);
expect(parsed.files).toHaveLength(1);
expect(parsed.files[0].exports).toEqual([
"PackageMapData",
"func:renderPackageMap(data: PackageMapData) → string",
"call:convertPackageMapToModel",
"func:renderDirectoryIndex(model: DirectoryArtifactModel) → string",
]);
expect(parsed.files[0].deps).toEqual(["./model.js"]);
});
it("parses file lines with pipes and commas inside type signatures", () => {
const mapText = `# src
## files
- llm-cache.ts | Cache helpers | exp: func:getCached(hash: string, cacheDir: string) → string | undefined, func:setCached(hash: string, result: string, cacheDir: string) → void | dep: fs, path
- user.ts | User helpers | exp: User, func:createUser(data: Omit<User, "id" | "createdAt">) → User, func:serializeUser(user: User) → string | dep: ../utils/validation.js
## arch
Test
## dirty
-
`;
const parsed = parseDirectoryMap(mapText);
expect(parsed.files).toHaveLength(2);
expect(parsed.files[0].exports).toEqual([
"func:getCached(hash: string, cacheDir: string) → string | undefined",
"func:setCached(hash: string, result: string, cacheDir: string) → void",
]);
expect(parsed.files[1].exports).toEqual([
"User",
'func:createUser(data: Omit<User, "id" | "createdAt">) → User',
"func:serializeUser(user: User) → string",
]);
});
});
tests/integration.test.ts
+250 -18
View File
@@ -11,7 +11,7 @@ import { tmpdir } from "os";
import { initProject } from "../src/init.js";
import { patchFile } from "../src/patch.js";
import { validateMaps } from "../src/validate.js";
import { createMockFileClient, createMockPackageClient } from "./mock-llm.js";
import { createMockFileClient } from "./mock-llm.js";
describe("integration", () => {
let dir: string;
@@ -24,14 +24,68 @@ describe("integration", () => {
rmSync(dir, { recursive: true });
});
it("init creates .pi-map.md files", async () => {
it("init creates both .pi-map.md and .pi-map.index.md files", async () => {
mkdirSync(join(dir, "src"));
writeFileSync(join(dir, "src", "index.ts"), `export function foo() {}\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const map = readFileSync(join(dir, "src", ".pi-map.md"), "utf8");
const index = readFileSync(join(dir, "src", ".pi-map.index.md"), "utf8");
expect(map).toContain("# src");
expect(index).toContain("# src (index)");
expect(index).toContain("dir: src");
});
it("root artifacts contain Project Map Protocol", async () => {
writeFileSync(join(dir, "package.json"), `{}\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const rootMap = readFileSync(join(dir, ".pi-map.md"), "utf8");
const rootIndex = readFileSync(join(dir, ".pi-map.index.md"), "utf8");
expect(rootMap).toContain("## Project Map Protocol");
expect(rootMap).toContain("index: ./.pi-map.index.md");
expect(rootIndex).toContain("## Project Map Protocol");
expect(rootIndex).toContain("map: ./.pi-map.md");
});
it("non-root map contains index link", async () => {
mkdirSync(join(dir, "src"));
writeFileSync(join(dir, "src", "index.ts"), `export function foo() {}\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const map = readFileSync(join(dir, "src", ".pi-map.md"), "utf8");
expect(map).toContain("index: src/.pi-map.index.md");
expect(map).toContain("dir: src");
});
it("index contains parent and children when applicable", async () => {
mkdirSync(join(dir, "src"));
mkdirSync(join(dir, "src", "utils"));
writeFileSync(join(dir, "src", "index.ts"), `export function foo() {}\n`);
writeFileSync(
join(dir, "src", "utils", "helpers.ts"),
`export const h = 1;\n`,
);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const srcIndex = readFileSync(join(dir, "src", ".pi-map.index.md"), "utf8");
expect(srcIndex).toContain("## parent");
expect(srcIndex).toContain("index: ./.pi-map.index.md");
expect(srcIndex).toContain("## children");
expect(srcIndex).toContain("- src/utils");
const utilsIndex = readFileSync(
join(dir, "src", "utils", ".pi-map.index.md"),
"utf8",
);
expect(utilsIndex).toContain("## parent");
expect(utilsIndex).toContain("index: src/.pi-map.index.md");
});
it("patch updates a file entry", async () => {
@@ -52,29 +106,68 @@ describe("integration", () => {
expect(map).toContain("baz");
});
it("patch adds dirty marker for large packages", async () => {
it("patch with small mode refreshes ancestor indexes but preserves ancestor maps", async () => {
mkdirSync(join(dir, "src"));
// Create 11 files so it's a "large" package
for (let i = 0; i < 11; i++) {
writeFileSync(
join(dir, "src", `file${i}.ts`),
`export const x${i} = ${i};\n`,
);
}
writeFileSync(join(dir, "package.json"), `{}\n`);
writeFileSync(join(dir, "src", "index.ts"), `export const a = 1;\n`);
writeFileSync(join(dir, "src", "helper.ts"), `export const b = 2;\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
// Modify a file
writeFileSync(
join(dir, "src", "file0.ts"),
`export const x0 = 0;\nexport const y = 99;\n`,
join(dir, ".pi-map.md"),
`${readFileSync(join(dir, ".pi-map.md"), "utf8")}\nSENTINEL_ROOT_MAP\n`,
);
writeFileSync(
join(dir, ".pi-map.index.md"),
`${readFileSync(join(dir, ".pi-map.index.md"), "utf8")}\nSENTINEL_ROOT_INDEX\n`,
);
await patchFile(join(dir, "src", "file0.ts"), client, dir);
const map = readFileSync(join(dir, "src", ".pi-map.md"), "utf8");
expect(map).toContain("y");
expect(map).toContain("dirty");
expect(map).toContain("patched");
writeFileSync(
join(dir, "src", "index.ts"),
`export const a = 1;\nexport const c = 3;\n`,
);
await patchFile(join(dir, "src", "index.ts"), client, dir, {
rootPath: dir,
patchMode: "small",
});
const rootMap = readFileSync(join(dir, ".pi-map.md"), "utf8");
const rootIndex = readFileSync(join(dir, ".pi-map.index.md"), "utf8");
expect(rootMap).toContain("SENTINEL_ROOT_MAP");
expect(rootIndex).not.toContain("SENTINEL_ROOT_INDEX");
});
it("patch with structural mode refreshes ancestor maps and indexes", async () => {
mkdirSync(join(dir, "src"));
writeFileSync(join(dir, "package.json"), `{}\n`);
writeFileSync(join(dir, "src", "index.ts"), `export const a = 1;\n`);
writeFileSync(join(dir, "src", "helper.ts"), `export const b = 2;\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
writeFileSync(
join(dir, ".pi-map.md"),
`${readFileSync(join(dir, ".pi-map.md"), "utf8")}\nSENTINEL_ROOT_MAP\n`,
);
writeFileSync(
join(dir, ".pi-map.index.md"),
`${readFileSync(join(dir, ".pi-map.index.md"), "utf8")}\nSENTINEL_ROOT_INDEX\n`,
);
writeFileSync(
join(dir, "src", "index.ts"),
`export const a = 1;\nexport const c = 3;\n`,
);
await patchFile(join(dir, "src", "index.ts"), client, dir, {
rootPath: dir,
patchMode: "structural",
});
const rootMap = readFileSync(join(dir, ".pi-map.md"), "utf8");
const rootIndex = readFileSync(join(dir, ".pi-map.index.md"), "utf8");
expect(rootMap).not.toContain("SENTINEL_ROOT_MAP");
expect(rootIndex).not.toContain("SENTINEL_ROOT_INDEX");
});
it("validate detects new files", async () => {
@@ -124,4 +217,143 @@ describe("integration", () => {
true,
);
});
it("init populates routing metadata in rich maps", async () => {
mkdirSync(join(dir, "src"));
writeFileSync(
join(dir, "src", "index.ts"),
`export function init() {}\nexport function run() {}\n`,
);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const map = readFileSync(join(dir, "src", ".pi-map.md"), "utf8");
// Tags and symbols should be scaffolded or populated
expect(map).toContain("## tags");
expect(map).toContain("## symbols");
expect(map).toContain("## workflows");
});
it("leaf directory index is tiny but present", async () => {
mkdirSync(join(dir, "src"));
mkdirSync(join(dir, "src", "utils"));
writeFileSync(
join(dir, "src", "utils", "helpers.ts"),
`export const h = 1;\n`,
);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const index = readFileSync(
join(dir, "src", "utils", ".pi-map.index.md"),
"utf8",
);
// Leaf index should have empty children but still follow contract
expect(index).toContain("## children");
expect(index).toContain("-");
expect(index).toContain("## parent");
expect(index).toContain("index: src/.pi-map.index.md");
});
it("non-source directories omit uncertain workflows", async () => {
mkdirSync(join(dir, "docs"));
writeFileSync(join(dir, "docs", "README.md"), `# README\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const map = readFileSync(join(dir, "docs", ".pi-map.md"), "utf8");
// No source files means workflows section should be empty/omitted
const workflowsMatch = map.match(/## workflows\n([^#]*)/);
if (workflowsMatch) {
expect(workflowsMatch[1].trim()).toBe("-");
}
});
it("init loads config caps and applies them to routing metadata", async () => {
mkdirSync(join(dir, "src"));
for (let i = 0; i < 20; i++) {
writeFileSync(
join(dir, "src", `file${i}.ts`),
`export function fn${i}() {}\n`,
);
}
writeFileSync(
join(dir, ".pi-project-map.json"),
JSON.stringify({ tagCap: 3, workflowHintCap: 2 }),
);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const map = readFileSync(join(dir, "src", ".pi-map.md"), "utf8");
const parsedMap = (await import("../src/format.js")).parseDirectoryMap(map);
expect(parsedMap.tags.length).toBeLessThanOrEqual(3);
expect(parsedMap.symbols.length).toBeLessThanOrEqual(3);
const index = readFileSync(join(dir, "src", ".pi-map.index.md"), "utf8");
const parsedIndex = (await import("../src/format.js")).parseDirectoryIndex(
index,
);
expect(parsedIndex.workflows.length).toBeLessThanOrEqual(2);
});
it("validate hard-fails when an index is missing", async () => {
mkdirSync(join(dir, "src"));
writeFileSync(join(dir, "src", "a.ts"), `export const a = 1;\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
rmSync(join(dir, "src", ".pi-map.index.md"));
const result = await validateMaps(dir, { verbose: false });
expect(result.clean).toBe(false);
expect(result.discrepancies.some((d) => d.type === "stale-index")).toBe(
true,
);
});
it("validate detects broken sibling links", async () => {
mkdirSync(join(dir, "src"));
writeFileSync(join(dir, "src", "a.ts"), `export const a = 1;\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
const mapPath = join(dir, "src", ".pi-map.md");
writeFileSync(
mapPath,
readFileSync(mapPath, "utf8").replace(
"index: src/.pi-map.index.md",
"index: src/bad-index.md",
),
);
const result = await validateMaps(dir, { verbose: false });
expect(result.clean).toBe(false);
expect(result.discrepancies.some((d) => d.type === "broken-link")).toBe(
true,
);
});
it("validate --fix repairs the affected chain", async () => {
mkdirSync(join(dir, "src"));
writeFileSync(join(dir, "package.json"), `{}\n`);
writeFileSync(join(dir, "src", "a.ts"), `export const a = 1;\n`);
const client = createMockFileClient();
await initProject(dir, { llmClient: client, verbose: false });
rmSync(join(dir, "src", ".pi-map.index.md"));
const result = await validateMaps(dir, {
fix: true,
verbose: false,
llmClient: client,
cacheDir: dir,
patchMode: "small",
});
expect(result.clean).toBe(false);
expect(result.fixed).toBeGreaterThan(0);
expect(
readFileSync(join(dir, "src", ".pi-map.index.md"), "utf8"),
).toContain("# src (index)");
});
});
tests/merge.test.ts
+103
View File
@@ -0,0 +1,103 @@
import { describe, it, expect } from "vitest";
import { mergeFileData } from "../src/merge.js";
describe("mergeFileData", () => {
it("collapses multi-line parameters into single-line func signatures", () => {
const result = mergeFileData(
"api.ts",
{ purpose: "API helpers", exports: [], deps: [] },
{
exports: ["shouldReinjectForEvent"],
deps: [],
classes: [],
functions: [
{
name: "shouldReinjectForEvent",
params: [
"event: {\n\t\tmessages?: Array<{ content?: unknown; text?: string }>;\n\t\ttype?: string;\n\t\tpayload?: unknown;\n\t}",
"mode: PromptInjectionMode",
],
returns: "ReinjectDecision",
calls: ["outgoingMessagesHaveMarker"],
raises: [],
},
],
},
);
const funcExport = result.exports.find((e) =>
e.startsWith("func:shouldReinjectForEvent"),
);
expect(funcExport).toBeDefined();
expect(funcExport).not.toContain("\n");
expect(funcExport).not.toContain("\t");
expect(funcExport).toBe(
"func:shouldReinjectForEvent(event: { messages?: Array<{ content?: unknown; text?: string }>; type?: string; payload?: unknown; }, mode: PromptInjectionMode) → ReinjectDecision",
);
});
it("collapses multi-line return types into single-line func signatures", () => {
const result = mergeFileData(
"types.ts",
{ purpose: "Types", exports: [], deps: [] },
{
exports: ["complexReturn"],
deps: [],
classes: [],
functions: [
{
name: "complexReturn",
params: ["x: number"],
returns: "{\n a: string;\n b: number;\n}",
calls: [],
raises: [],
},
],
},
);
const funcExport = result.exports.find((e) =>
e.startsWith("func:complexReturn"),
);
expect(funcExport).toBeDefined();
expect(funcExport).not.toContain("\n");
expect(funcExport).toBe(
"func:complexReturn(x: number) → { a: string; b: number; }",
);
});
it("collapses multi-line method parameters into single-line method signatures", () => {
const result = mergeFileData(
"class.ts",
{ purpose: "Class file", exports: [], deps: [] },
{
exports: ["MyClass"],
deps: [],
classes: [
{
name: "MyClass",
methods: [
{
name: "doThing",
params: ["opts: {\n a: string;\n b: number;\n}"],
returns: "void",
calls: [],
raises: [],
},
],
},
],
functions: [],
},
);
const methodExport = result.exports.find((e) =>
e.startsWith("method:doThing"),
);
expect(methodExport).toBeDefined();
expect(methodExport).not.toContain("\n");
expect(methodExport).toBe(
"method:doThing(opts: { a: string; b: number; }) → void",
);
});
});
tests/pi-extension.test.ts
+988 -6
View File
File diff suppressed because it is too large Load Diff
tests/prompt-injection.test.ts
+1195
View File
File diff suppressed because it is too large Load Diff
tests/retrieve.test.ts
+244
View File
@@ -0,0 +1,244 @@
import { describe, it, expect, beforeEach, afterEach } from "vitest";
import { mkdtempSync, writeFileSync, mkdirSync, rmSync } from "fs";
import { join } from "path";
import { tmpdir } from "os";
import { retrieveContext } from "../src/retrieve.js";
describe("retrieve", () => {
let dir: string;
beforeEach(() => {
dir = mkdtempSync(join(tmpdir(), "pi-ret-"));
});
afterEach(() => {
rmSync(dir, { recursive: true });
});
function writeMap(
relDir: string,
role: string,
files: { name: string; purpose: string; exports?: string[] }[],
tags?: string[],
symbols?: string[],
) {
const d = join(dir, relDir);
if (!d.startsWith(dir)) throw new Error("invalid path");
mkdirSync(d, { recursive: true });
const fileLines = files
.map((f) => {
const exp = f.exports?.length ? ` | exp: ${f.exports.join(", ")}` : "";
return `- ${f.name} | ${f.purpose}${exp}`;
})
.join("\n");
const tagLine = tags?.length ? tags.join(", ") : "-";
const symLines = symbols?.length
? symbols.map((s) => `- ${s}`).join("\n")
: "-";
writeFileSync(
join(d, ".pi-map.md"),
`# ${relDir}
dir: ${relDir}
index: ${relDir}/.pi-map.index.md
## role
${role}
## files
${fileLines}
## arch
Test arch
## tags
${tagLine}
## symbols
${symLines}
## workflows
-
## dirty
-
`,
);
writeFileSync(
join(d, ".pi-map.index.md"),
`# ${relDir} (index)
dir: ${relDir}
## role
${role}
## parent
-
## children
-
## files
${files.map((f) => `- ${f.name}`).join("\n")}
## links
index: ${relDir}/.pi-map.index.md
map: ${relDir}/.pi-map.md
## workflows
-
## dirty
-
`,
);
}
it("returns empty bundle when no maps exist", () => {
const bundle = retrieveContext("auth", dir);
expect(bundle).toContain("# Context bundle: auth");
expect(bundle).toContain("No relevant directories found");
});
it("ranks directories by query relevance", () => {
writeMap(
"src/auth",
"Auth layer: JWT issuance, validation, refresh.",
[{ name: "tokens.ts", purpose: "JWT gen/val", exports: ["issueToken"] }],
["auth", "jwt"],
["issueToken"],
);
writeMap(
"src/utils",
"Shared utilities and helpers.",
[{ name: "helpers.ts", purpose: "Helpers" }],
["utils"],
);
const bundle = retrieveContext("jwt validation", dir);
expect(bundle).toContain("src/auth/.pi-map.index.md");
expect(bundle).toContain("src/auth/.pi-map.md");
});
it("limits results to top 3 by default", () => {
for (let i = 0; i < 5; i++) {
writeMap(
`src/pkg${i}`,
`Package ${i} logic`,
[{ name: `file${i}.ts`, purpose: `Feature ${i}` }],
[`pkg${i}`],
);
}
// Query matching all
const bundle = retrieveContext("pkg", dir);
const indexMatches = bundle.match(/\.pi-map\.index\.md/g) || [];
expect(indexMatches.length).toBeLessThanOrEqual(3);
});
it("includes likely files from matched directories", () => {
writeMap(
"src/auth",
"Auth layer",
[
{ name: "tokens.ts", purpose: "JWT tokens", exports: ["issueToken"] },
{
name: "middleware.ts",
purpose: "Auth middleware",
exports: ["requireAuth"],
},
],
["auth"],
["issueToken", "requireAuth"],
);
const bundle = retrieveContext("auth middleware", dir);
expect(bundle).toContain("src/auth/tokens.ts");
expect(bundle).toContain("src/auth/middleware.ts");
});
it("includes relevant symbols when present", () => {
writeMap(
"src/auth",
"Auth layer",
[{ name: "tokens.ts", purpose: "JWT tokens" }],
["auth"],
["issueToken", "verifyToken"],
);
const bundle = retrieveContext("auth", dir);
expect(bundle).toContain("## relevant symbols");
expect(bundle).toContain("issueToken");
expect(bundle).toContain("verifyToken");
});
it("omits symbol section when no symbols exist", () => {
writeMap(
"src/utils",
"Utilities",
[{ name: "helpers.ts", purpose: "Helpers" }],
["utils"],
[],
);
const bundle = retrieveContext("utils", dir);
expect(bundle).not.toContain("## relevant symbols");
});
it("includes instructions in every bundle", () => {
writeMap(
"src/cli",
"CLI entrypoint",
[{ name: "cli.ts", purpose: "CLI" }],
["cli"],
);
const bundle = retrieveContext("cli", dir);
expect(bundle).toContain("## instructions");
expect(bundle).toContain("Read the indexes first");
});
it("uses stable section order", () => {
writeMap(
"src/auth",
"Auth layer",
[{ name: "tokens.ts", purpose: "JWT tokens" }],
["auth"],
["issueToken"],
);
const bundle = retrieveContext("auth", dir);
const queryIdx = bundle.indexOf("## query");
const indexIdx = bundle.indexOf("## relevant indexes");
const mapIdx = bundle.indexOf("## relevant maps");
const fileIdx = bundle.indexOf("## likely files");
const symIdx = bundle.indexOf("## relevant symbols");
const instIdx = bundle.indexOf("## instructions");
expect(queryIdx).toBeGreaterThan(-1);
expect(indexIdx).toBeGreaterThan(queryIdx);
expect(mapIdx).toBeGreaterThan(indexIdx);
expect(fileIdx).toBeGreaterThan(mapIdx);
expect(symIdx).toBeGreaterThan(fileIdx);
expect(instIdx).toBeGreaterThan(symIdx);
});
it("scores file names and purposes", () => {
writeMap(
"src/auth",
"Auth layer",
[
{
name: "validateToken.ts",
purpose: "Token validation logic",
exports: ["validateToken"],
},
],
[],
[],
);
const bundle = retrieveContext("validate token", dir);
expect(bundle).toContain("src/auth/.pi-map.index.md");
});
});
tests/routing-metadata.test.ts
+219
View File
@@ -0,0 +1,219 @@
import { describe, it, expect } from "vitest";
import { createDirectoryModel } from "../src/directory-model.js";
import { populateRoutingMetadata } from "../src/routing-metadata.js";
describe("routing metadata", () => {
it("generates tags from file purposes and exports", () => {
const model = createDirectoryModel({
dir: "src/auth",
role: "Auth layer",
files: [
{
name: "tokens.ts",
purpose: "JWT generation and validation",
exports: ["issueToken", "verifyToken"],
deps: ["crypto"],
},
],
arch: "Auth",
});
populateRoutingMetadata(model);
expect(model.tags.length).toBeGreaterThan(0);
expect(model.tags).toContain("jwt");
expect(model.tags).toContain("token");
});
it("generates symbols from exports", () => {
const model = createDirectoryModel({
dir: "src/utils",
role: "Utilities",
files: [
{
name: "helpers.ts",
purpose: "Helpers",
exports: ["formatDate", "parseUrl", "formatDate"],
deps: [],
},
],
arch: "Utils",
});
populateRoutingMetadata(model);
expect(model.symbols.length).toBeGreaterThan(0);
expect(model.symbols).toContain("formatDate");
expect(model.symbols).toContain("parseUrl");
});
it("caps tags at default limit", () => {
const model = createDirectoryModel({
dir: "src/big",
role: "Big module",
files: Array.from({ length: 20 }, (_, i) => ({
name: `file${i}.ts`,
purpose: `Purpose ${i} with many unique words ${i}`,
exports: [`export${i}A`, `export${i}B`],
deps: [`dep${i}`],
})),
arch: "Big",
});
populateRoutingMetadata(model);
expect(model.tags.length).toBeLessThanOrEqual(8);
});
it("caps symbols at default limit", () => {
const model = createDirectoryModel({
dir: "src/big",
role: "Big module",
files: Array.from({ length: 20 }, (_, i) => ({
name: `file${i}.ts`,
purpose: `Purpose ${i}`,
exports: [`export${i}A`, `export${i}B`],
deps: [],
})),
arch: "Big",
});
populateRoutingMetadata(model);
expect(model.symbols.length).toBeLessThanOrEqual(8);
});
it("generates workflow hints for source directories", () => {
const model = createDirectoryModel({
dir: "src/cli",
role: "CLI",
files: [
{
name: "cli.ts",
purpose: "CLI entrypoint",
exports: ["main"],
deps: [],
},
{
name: "cli.test.ts",
purpose: "CLI tests",
exports: [],
deps: [],
},
],
arch: "CLI",
});
populateRoutingMetadata(model);
expect(model.workflows.length).toBeGreaterThan(0);
const changeBehavior = model.workflows.find((w) =>
w.task.includes("change"),
);
expect(changeBehavior).toBeDefined();
});
it("omits workflows for non-source directories", () => {
const model = createDirectoryModel({
dir: "docs",
role: "Documentation",
files: [
{
name: "README.md",
purpose: "Readme",
exports: [],
deps: [],
},
],
arch: "Docs",
});
populateRoutingMetadata(model);
expect(model.workflows).toEqual([]);
});
it("caps workflow hints at default limit", () => {
const model = createDirectoryModel({
dir: "src/cli",
role: "CLI",
files: [
{ name: "cli.ts", purpose: "CLI", exports: ["main"], deps: [] },
{ name: "config.ts", purpose: "Config", exports: [], deps: [] },
{ name: "cli.test.ts", purpose: "Tests", exports: [], deps: [] },
{ name: "commands.ts", purpose: "Commands", exports: [], deps: [] },
],
arch: "CLI",
});
model.children = ["src/cli/sub"];
populateRoutingMetadata(model);
expect(model.workflows.length).toBeLessThanOrEqual(5);
});
it("workflow hints include read targets for relevant files", () => {
const model = createDirectoryModel({
dir: "src/auth",
role: "Auth",
files: [
{
name: "tokens.ts",
purpose: "Tokens",
exports: ["issueToken"],
deps: [],
},
{
name: "tokens.test.ts",
purpose: "Token tests",
exports: [],
deps: [],
},
],
arch: "Auth",
});
populateRoutingMetadata(model);
const testWorkflow = model.workflows.find((w) => w.task.includes("test"));
expect(testWorkflow).toBeDefined();
expect(testWorkflow!.read).toContain("tokens.test.ts");
});
it("workflow hints include index targets for directories with children", () => {
const model = createDirectoryModel({
dir: "src",
role: "Source",
files: [
{
name: "index.ts",
purpose: "Exports",
exports: [],
deps: [],
},
],
arch: "Source",
children: ["src/auth", "src/cli"],
});
populateRoutingMetadata(model);
const exploreWorkflow = model.workflows.find((w) =>
w.task.includes("explore"),
);
expect(exploreWorkflow).toBeDefined();
expect(exploreWorkflow!.index).toContain("src/auth/.pi-map.index.md");
expect(exploreWorkflow!.index).toContain("src/cli/.pi-map.index.md");
});
it("respects explicit tagCap and workflowHintCap options", () => {
const model = createDirectoryModel({
dir: "src/big",
role: "Big module",
files: Array.from({ length: 20 }, (_, i) => ({
name: `file${i}.ts`,
purpose: `Purpose ${i} with many unique words ${i}`,
exports: [`export${i}A`, `export${i}B`],
deps: [`dep${i}`],
})),
arch: "Big",
children: ["src/big/sub"],
});
populateRoutingMetadata(model, { tagCap: 3, workflowHintCap: 2 });
expect(model.tags.length).toBeLessThanOrEqual(3);
expect(model.symbols.length).toBeLessThanOrEqual(3);
expect(model.workflows.length).toBeLessThanOrEqual(2);
});
});