npm - pi-monofold - Versions diffs - 0.3.0 → 0.3.2 - Mend

pi-monofold 0.3.0 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -1,206 +1,172 @@
-# Pi Monofold
-[![npm version](https://img.shields.io/npm/v/pi-monofold?color=cb3837&logo=npm)](https://www.npmjs.com/package/pi-monofold)
-[![Publish to npm](https://github.com/eiei114/pi-monofold/actions/workflows/publish.yml/badge.svg)](https://github.com/eiei114/pi-monofold/actions/workflows/publish.yml)
-[![Auto Release](https://github.com/eiei114/pi-monofold/actions/workflows/auto-release.yml/badge.svg)](https://github.com/eiei114/pi-monofold/actions/workflows/auto-release.yml)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
-[![Pi Package](https://img.shields.io/badge/Pi-package-6f42c1)](https://github.com/eiei114/pi-monofold)
-Pi Monofold (`pi-monofold`) is a Pi Coding Agent extension that folds multiple local repositories and folders into a guarded **Virtual Monorepo** for AI agents.
-It keeps repositories physically separate, while giving Pi a lightweight manifest, routed writes, workspace-aware reads, guarded commands, and explicit git flows.
-## Why
-AI coding agents work best when documentation, rules, product context, and implementation code are visible as one connected system. Physical monorepos are not always practical. Pi Monofold gives Pi a logical monorepo boundary without forcing repository migration.
-## Install
-Pi Monofold is a Pi package. Install it with Pi's package installer from git or npm.
-> Security: Pi packages run with full system access. Review packages before installing third-party code.
-### From git
-```powershell
-pi install git:github.com/eiei114/pi-monofold
-```
-Install into the current project settings instead of user settings:
-```powershell
-pi install -l git:github.com/eiei114/pi-monofold
-```
-Pin a version/ref:
-```powershell
-pi install git:github.com/eiei114/pi-monofold@v0.1.0
-```
-Try without installing:
-```powershell
-pi -e git:github.com/eiei114/pi-monofold
-```
-### From npm
-After the package is published to npm:
-```powershell
-pi install npm:pi-monofold
-```
-Install into the current project settings instead of user settings:
-```powershell
-pi install -l npm:pi-monofold
-```
-Pin a version:
-```powershell
-pi install npm:pi-monofold@0.1.0
-```
-Try without installing:
-```powershell
-pi -e npm:pi-monofold
-```
-### Local development
-```powershell
-git clone https://github.com/eiei114/pi-monofold.git
-cd pi-monofold
-npm install
-npm run typecheck
-```
-Try the local checkout without installing:
-```powershell
-pi -e .
-```
-## Config
-Place config in the control repository:
-```text
-<control-repo>/.pi/monofold.yaml
-```
-Example:
-```yaml
-version: 1
-defaults:
-  filenameTemplate: "{{date}}-{{slug}}.md"
-  metadata:
-    created: "{{date}}"
-    source: "pi-monofold"
-focusPresets:
-  - id: control
-    label: Control workspace focus
-    targets:
-      - targetTags: [control]
-workspaces:
-  - name: "Product docs"
-    path: "../business"
-    tags: [business, markdown, planning]
-    capabilities: [read, writeDocs, git]
-    contextFiles: [README.md, CONTEXT.md]
-    routes:
-      default: "Notes"
-      prd:
-        path: "Docs/PRD"
-        filenameTemplate: "prd-{{slug}}.md"
-        metadata:
-          type: prd
-    projects:
-      - name: "Launch plan"
-        path: "Projects/Launch"
-        tags: [project, launch]
-        contextFiles: [CONTEXT.md]
-        routes:
-          default: "."
-          progress: "Progress"
-  - name: "Application"
-    path: "../app"
-    tags: [development, app]
-    capabilities: [read, editCode, runCommands, git]
-    contextFiles: [README.md, AGENTS.md]
-```
-## Focus presets
-Optional `focusPresets` define tag-based focus targets for the control workspace. Preset `id` values must be unique. Each target uses `targetTags`, matching workspace tags the same way as other Monofold target selectors. Targets that match zero configured workspaces are allowed in config and emit a runtime warning when the active preset is applied.
-Active focus (the selected preset id) lives in extension session memory only. It resets when Pi restarts. When `focusPresets` is non-empty, the first preset in YAML order becomes active at session start unless a later slice changes it.
-The example above includes a generic seed preset `control`. Add matching workspace tags in your own config when you adopt it.
-## Commands
-Human-facing commands accept natural-language arguments and hand off interpretation to the Pi agent:
-- `/monofold:explore [request]`: list, read, search, or inspect workspace trees.
-- `/monofold:write [request]`: create routed Markdown outputs.
-- `/monofold:config [request]`: add or change Workspaces and Project Workspaces.
-- `/monofold:git [request]`: run git status, commit, push, or commit+push workflows.
-- `/monofold:guide`: start an interactive guide for Explore, Write, Config, Git, init, and update flows.
-- `/monofold:init`: create or update `.pi/monofold.yaml` with an interactive wizard.
-- `/monofold:update [request]`: migrate/clean up legacy config and optionally hand a config-change request to the agent.
-Examples:
-```text
-/monofold:explore show the project workspaces
-/monofold:write write today's progress note for Pi Monofold
-/monofold:config add 4_Project/NewApp as a Project Workspace under Obsidian Vault with tag project,newapp
-/monofold:git commit and push the pi-monofold dev workspace
-/monofold:guide
-```
-Fine-grained legacy commands such as `/monofold:list`, `/monofold:read`, `/monofold:search`, `/monofold:tree`, `/monofold:add`, `/monofold:project-add`, and underscore aliases are not part of the human command surface.
-## Agent API
-Pi agents use strict `monofold_*` tools behind the natural-language command surface:
-- `monofold_list`: show manifest and git status summary.
-- `monofold_read`: read files, search text, or show a tree inside readable workspaces.
-- `monofold_write`: create routed Markdown outputs by `routeType`, `title`, and `body`.
-- `monofold_git`: run guarded workspace git `status`, `commit`, `push`, or `commitPush`.
-- `monofold_init`: queue `/monofold:init`.
-Project Workspaces are listed under `workspaces[].projects`. Their `path` is relative to the parent workspace, `tags` are combined with parent tags, `capabilities` inherit unless explicitly replaced, and missing routes default to `default: "."` when the effective target has `writeDocs`.
-## Updating configuration
-`.pi/monofold.yaml` is the canonical config file. Legacy `.pi/monofold.yml` is still readable. Intent commands try to migrate a legacy-only config automatically, show a notice, and continue with the legacy config if migration fails. `/monofold:update` migrates or cleans up legacy config, writes timestamped backups such as `.pi/monofold.yml.bak-20260524-153012`, and removes the legacy file after a successful write. If both `.yaml` and `.yml` exist, normal intent commands prefer canonical `.yaml`; `/monofold:update` handles legacy cleanup.
-`/monofold:update` is a configuration migration command, not a Pi package updater. Use `pi update`, `pi update --extensions`, or `pi install ...@new-ref` for package updates.
-After migration, you can provide a natural-language configuration change request. The command hands that request to the Pi agent, which edits `.pi/monofold.yaml` directly and validates the result through the manifest path:
-```text
-/monofold:update add 4_Project/NewApp as a Project Workspace under Obsidian Vault with tags project,newapp and progress route Progress
-```
-## Guard
-When `.pi/monofold.yaml` or legacy `.pi/monofold.yml` exists, Pi Monofold guards standard `read/write/edit/grep/find/bash` calls against workspace capabilities.
-- Unknown path: confirm in UI, block without UI.
-- Docs write: requires `writeDocs`.
-- Code edit: requires `editCode`.
-- Bash: requires workspace cwd and `runCommands`.
-- Git commit/push via bash: blocked; use `/monofold:git` or the `monofold_git` agent tool.
+# pi-monofold
+[![CI](https://github.com/eiei114/pi-monofold/actions/workflows/ci.yml/badge.svg)](https://github.com/eiei114/pi-monofold/actions/workflows/ci.yml)
+[![Publish](https://github.com/eiei114/pi-monofold/actions/workflows/publish.yml/badge.svg)](https://github.com/eiei114/pi-monofold/actions/workflows/publish.yml)
+[![npm version](https://img.shields.io/npm/v/pi-monofold?color=cb3837&logo=npm)](https://www.npmjs.com/package/pi-monofold)
+[![npm downloads](https://img.shields.io/npm/dw/pi-monofold)](https://www.npmjs.com/package/pi-monofold)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
+[![Pi Package](https://img.shields.io/badge/Pi-package-6f42c1)](https://github.com/eiei114/pi-monofold)
+[![Trusted Publishing](https://img.shields.io/badge/npm-provenance-yellow)](https://docs.npmjs.com/generating-provenance-statements)
+Pi extension that folds multiple local repositories and folders into a guarded **Virtual Monorepo** for AI agents.
+## What this is
+Pi Monofold (`pi-monofold`) keeps repositories physically separate while giving Pi a lightweight manifest, routed writes, workspace-aware reads, guarded commands, and explicit git flows. Documentation, rules, product context, and implementation code can appear as one connected system without migrating everything into a single git repository.
+See [docs/usage.md](./docs/usage.md) for configuration, commands, agent tools, and guard behavior.
+## Features
+- **Virtual monorepo manifest** — declare workspaces and project workspaces in `.pi/monofold.yaml`
+- **Routed Markdown writes** — route PRDs, progress notes, and other doc types to configured folders
+- **Workspace-aware reads** — list, read, search, and tree views scoped to readable workspaces
+- **Capability guard** — block or confirm `read` / `write` / `edit` / `grep` / `find` / `bash` based on workspace tags
+- **Focus presets** — tag-based focus targets for the control workspace
+- **Natural-language commands** — `/monofold:explore`, `/monofold:write`, `/monofold:config`, `/monofold:git`, and more
+- **Strict agent tools** — `monofold_*` tools for programmatic access behind the command surface
+- **Config migration** — upgrade legacy `.pi/monofold.yml` with backups and validation
+## Install
+Pi Monofold is a Pi package. Install it with Pi's package installer from git or npm.
+> Security: Pi packages run with full system access. Review packages before installing third-party code.
+### From git
+```powershell
+pi install git:github.com/eiei114/pi-monofold
+```
+Project-local install:
+```powershell
+pi install -l git:github.com/eiei114/pi-monofold
+```
+Pin a version:
+```powershell
+pi install git:github.com/eiei114/pi-monofold@v0.3.2
+```
+Try without installing:
+```powershell
+pi -e git:github.com/eiei114/pi-monofold
+```
+### From npm
+```powershell
+pi install npm:pi-monofold
+```
+Project-local install:
+```powershell
+pi install -l npm:pi-monofold
+```
+Pin a version:
+```powershell
+pi install npm:pi-monofold@0.3.2
+```
+Try without installing:
+```powershell
+pi -e npm:pi-monofold
+```
+## Quick start
+1. Install the extension (see [Install](#install)).
+2. In your control repository, create `.pi/monofold.yaml` with at least one workspace entry (or run `/monofold:init`).
+3. Start Pi in the control repository and run `/monofold:explore show the project workspaces`.
+4. Use `/monofold:write` for routed Markdown outputs and `/monofold:git` for guarded git workflows.
+Example command flows: [docs/examples.md](./docs/examples.md).
+## Usage summary
+| Surface | Purpose |
+|---------|---------|
+| `/monofold:explore` | List, read, search, or inspect workspace trees |
+| `/monofold:write` | Create routed Markdown outputs |
+| `/monofold:config` | Add or change workspaces and project workspaces |
+| `/monofold:git` | Run guarded git status, commit, push, or commit+push |
+| `/monofold:guide` | Interactive guide for common flows |
+| `/monofold:init` | Create or update `.pi/monofold.yaml` |
+| `/monofold:update` | Migrate legacy config and optionally request config edits |
+Agent tools (`monofold_list`, `monofold_read`, `monofold_write`, `monofold_git`, `monofold_init`) sit behind these commands. Full reference: [docs/usage.md](./docs/usage.md).
+## Package contents
+```text
+pi-monofold/
+├── .github/workflows/
+│   ├── auto-release.yml            # Auto-tag + release on merge to main
+│   ├── ci.yml                      # Validate on PR / push
+│   └── publish.yml                 # Publish to npm (Trusted Publishing)
+├── docs/
+│   ├── usage.md                    # Config, commands, agent API, guard
+│   ├── examples.md                 # Command examples
+│   └── release.md                  # Release and publish flow
+├── tests/
+│   └── focus-preset.test.ts
+├── CHANGELOG.md
+├── SECURITY.md
+├── focus-preset.ts
+├── index.ts
+├── LICENSE
+├── package.json
+├── README.md
+├── validation.ts
+└── tsconfig.json
+```
+## Development
+Clone and validate:
+```powershell
+git clone https://github.com/eiei114/pi-monofold.git
+cd pi-monofold
+npm install
+npm run check
+```
+Try the local checkout without installing:
+```powershell
+pi -e .
+```
+## Release
+Releases are automated. See [docs/release.md](./docs/release.md) for details.
+1. Bump `version` in `package.json` and update `CHANGELOG.md`.
+2. Merge to `main`.
+3. **Auto Release** tags `v<version>` and creates a GitHub release when the tag is new.
+4. The tag triggers **Publish**, which publishes to npm with OIDC provenance.
+## Security
+Pi Monofold intercepts standard Pi tool calls when monofold config is present. Writes and shell commands are allowed only when the resolved workspace grants the matching capability. Git commit/push via raw `bash` is blocked; use `/monofold:git` or `monofold_git` instead.
+Report vulnerabilities per [SECURITY.md](./SECURITY.md).
+## Links
+- **Repository**: <https://github.com/eiei114/pi-monofold>
+- **npm**: <https://www.npmjs.com/package/pi-monofold>
+- **Issues**: <https://github.com/eiei114/pi-monofold/issues>
+## License
+[MIT](LICENSE)

package/file-read-preview.ts ADDED Viewed

@@ -0,0 +1,208 @@
+export const DEFAULT_PREVIEW_LINES = 20;
+export const DEFAULT_PREVIEW_CHARS = 2_000;
+export type FileReadOptions = {
+  includeContent?: boolean;
+  maxChars?: number;
+  head?: number;
+  tail?: number;
+};
+export type FileReadFileStat = {
+  size: number;
+  mtime: Date;
+};
+export type FileReadDetails = {
+  byteSize: number;
+  characterCount: number;
+  lineCount: number;
+  modifiedTime: string;
+  truncated: boolean;
+  previewLineCount: number;
+  previewCharacterCount: number;
+  includeContent: boolean;
+  maxChars?: number;
+  head?: number;
+  tail?: number;
+};
+export type FileReadResponse = {
+  text: string;
+  details: FileReadDetails;
+};
+export function assertPositiveInt(value: number, label: string): number {
+  if (!Number.isInteger(value) || value <= 0) {
+    throw new Error(`${label} must be a positive integer`);
+  }
+  return value;
+}
+function splitLines(content: string): string[] {
+  if (content.length === 0) {
+    return [""];
+  }
+  const normalized = content.replace(/\r\n/g, "\n").replace(/\r/g, "\n");
+  const lines = normalized.split("\n");
+  if (lines.at(-1) === "" && (content.endsWith("\n") || content.endsWith("\r"))) {
+    lines.pop();
+  }
+  return lines.length === 0 ? [""] : lines;
+}
+function takeHeadLines(lines: string[], count: number): string[] {
+  return lines.slice(0, count);
+}
+function takeTailLines(lines: string[], count: number): string[] {
+  if (count >= lines.length) {
+    return lines;
+  }
+  return lines.slice(lines.length - count);
+}
+function truncateChars(text: string, maxChars: number): { text: string; truncated: boolean } {
+  if (text.length <= maxChars) {
+    return { text, truncated: false };
+  }
+  return { text: text.slice(0, maxChars), truncated: true };
+}
+export function truncationHint(details: FileReadDetails): string {
+  const parts: string[] = [];
+  if (details.truncated) {
+    parts.push(
+      `Showing ${details.previewLineCount} of ${details.lineCount} lines and ${details.previewCharacterCount} of ${details.characterCount} characters.`,
+    );
+  }
+  parts.push(
+    "Pass includeContent: true for full content, or use head, tail, and/or maxChars for a larger bounded range.",
+  );
+  return parts.join(" ");
+}
+function buildHeadTailPreview(lines: string[], head: number | undefined, tail: number | undefined): string {
+  const headCount = head ?? 0;
+  const tailCount = tail ?? 0;
+  if (headCount > 0 && tailCount > 0) {
+    const headLines = takeHeadLines(lines, headCount);
+    const tailLines = takeTailLines(lines, tailCount);
+    if (headCount + tailCount >= lines.length) {
+      return lines.join("\n");
+    }
+    const omitted = lines.length - headLines.length - tailLines.length;
+    return [
+      ...headLines,
+      `... [${omitted} line${omitted === 1 ? "" : "s"} omitted] ...`,
+      ...tailLines,
+    ].join("\n");
+  }
+  if (headCount > 0) {
+    return takeHeadLines(lines, headCount).join("\n");
+  }
+  if (tailCount > 0) {
+    return takeTailLines(lines, tailCount).join("\n");
+  }
+  return takeHeadLines(lines, DEFAULT_PREVIEW_LINES).join("\n");
+}
+function resolveExplicitLimits(options: FileReadOptions): {
+  includeContent: boolean;
+  maxChars?: number;
+  head?: number;
+  tail?: number;
+} {
+  const includeContent = options.includeContent === true;
+  const maxChars = options.maxChars === undefined ? undefined : assertPositiveInt(options.maxChars, "maxChars");
+  const head = options.head === undefined ? undefined : assertPositiveInt(options.head, "head");
+  const tail = options.tail === undefined ? undefined : assertPositiveInt(options.tail, "tail");
+  return { includeContent, maxChars, head, tail };
+}
+export function buildFileReadResponse(
+  content: string,
+  options: FileReadOptions,
+  fileStat: FileReadFileStat,
+  context: { relativePath: string },
+): FileReadResponse {
+  const limits = resolveExplicitLimits(options);
+  const lines = splitLines(content);
+  const lineCount = lines.length;
+  const characterCount = content.length;
+  let previewText: string;
+  let truncated: boolean;
+  let previewLineCount: number;
+  let previewCharacterCount: number;
+  if (limits.includeContent && limits.maxChars === undefined && limits.head === undefined && limits.tail === undefined) {
+    previewText = content;
+    truncated = false;
+    previewLineCount = lineCount;
+    previewCharacterCount = characterCount;
+  } else if (limits.head !== undefined || limits.tail !== undefined) {
+    const headCount = limits.head ?? 0;
+    const tailCount = limits.tail ?? 0;
+    previewText = buildHeadTailPreview(lines, limits.head, limits.tail);
+    const maxChars = limits.maxChars ?? Number.POSITIVE_INFINITY;
+    const charResult = truncateChars(previewText, maxChars);
+    previewText = charResult.text;
+    const linesFullyShown =
+      headCount + tailCount >= lineCount ||
+      (headCount > 0 && tailCount === 0 && headCount >= lineCount) ||
+      (tailCount > 0 && headCount === 0 && tailCount >= lineCount);
+    truncated = charResult.truncated || !linesFullyShown;
+    previewLineCount = previewText === "" ? 0 : previewText.split("\n").length;
+    previewCharacterCount = previewText.length;
+  } else if (limits.maxChars !== undefined) {
+    const charResult = truncateChars(content, limits.maxChars);
+    previewText = charResult.text;
+    truncated = charResult.truncated || previewText.length < content.length;
+    previewLineCount = previewText === "" ? 0 : previewText.split("\n").length;
+    previewCharacterCount = previewText.length;
+  } else {
+    const defaultLines = takeHeadLines(lines, DEFAULT_PREVIEW_LINES);
+    previewText = defaultLines.join("\n");
+    const charResult = truncateChars(previewText, DEFAULT_PREVIEW_CHARS);
+    previewText = charResult.text;
+    truncated = charResult.truncated || defaultLines.length < lines.length;
+    previewLineCount = previewText === "" ? 0 : previewText.split("\n").length;
+    previewCharacterCount = previewText.length;
+  }
+  const details: FileReadDetails = {
+    byteSize: fileStat.size,
+    characterCount,
+    lineCount,
+    modifiedTime: fileStat.mtime.toISOString(),
+    truncated,
+    previewLineCount,
+    previewCharacterCount,
+    includeContent: limits.includeContent,
+    ...(limits.maxChars === undefined ? {} : { maxChars: limits.maxChars }),
+    ...(limits.head === undefined ? {} : { head: limits.head }),
+    ...(limits.tail === undefined ? {} : { tail: limits.tail }),
+  };
+  const metadataLines = [
+    `Path: ${context.relativePath}`,
+    `Byte size: ${details.byteSize}`,
+    `Characters: ${details.characterCount}`,
+    `Lines: ${details.lineCount}`,
+    `Modified: ${details.modifiedTime}`,
+  ];
+  const sections = [metadataLines.join("\n")];
+  if (previewText.length > 0) {
+    sections.push("", "--- preview ---", previewText);
+  }
+  if (truncated) {
+    sections.push("", `[truncated] ${truncationHint(details)}`);
+  }
+  return {
+    text: sections.join("\n"),
+    details,
+  };
+}