pi-soly 2.1.3 → 2.1.5

package/built-in-rules/temp-files.md

@@ -0,0 +1,173 @@
+# Temporary Files Rule
+
+> **OS-aware temp paths.** Never hardcode `/tmp` — it's wrong on Windows
+> (`%TEMP%` resolves to `C:\Users\<user>\AppData\Local\Temp`, not `/tmp`),
+> wrong on macOS (`$TMPDIR` is per-user, e.g. `/var/folders/xx/yy/T/`),
+> and fragile in multi-tenant / CI scenarios. Always resolve the
+> OS-correct temp dir at runtime and put files under a project-scoped
+> subfolder.
+
+## The rule
+
+When creating temporary files — intermediate build artifacts, scratch
+data, debug dumps, test fixtures, atomic-write staging, anything that
+isn't meant to outlive the process:
+
+1. **Resolve the OS temp dir at runtime.** Never hardcode `/tmp`,
+   `/var/folders`, `C:\Temp`, `~/tmp`, or any other literal path.
+2. **Use a project-scoped subfolder** like `<tempdir>/<project>-<hash>/`
+   so multiple projects don't collide and cleanup is easy.
+3. **Clean up after yourself** — when the work is done, remove the
+   directory (or use `try`/`finally` / `trap EXIT` / `defer`).
+4. **Prefer atomic-write patterns** for files that will be renamed into
+   place: write to a temp file in the **same directory** as the target,
+   `fsync` if durability matters, then rename. Avoids half-written
+   files on crash and avoids cross-device rename failures.
+
+## How to get the temp dir per runtime
+
+| Runtime       | API                          | Notes                              |
+|---------------|------------------------------|------------------------------------|
+| Node.js / Bun | `os.tmpdir()`                | already OS-aware; returns absolute |
+| Python        | `tempfile.gettempdir()`      | stdlib                             |
+| Go            | `os.TempDir()`               | stdlib                             |
+| Rust          | `std::env::temp_dir()`       | stdlib; returns `PathBuf`          |
+| .NET          | `Path.GetTempPath()`         | returns trailing slash              |
+| Java          | `System.getProperty("java.io.tmpdir")` | JVM-resolved            |
+| Bash (POSIX)  | `${TMPDIR:-/tmp}`            | fallback only if env unset          |
+| PowerShell    | `$env:TEMP`                  | Windows                            |
+| cmd.exe       | `%TEMP%`                     | Windows                            |
+
+**Do not** `cd /tmp && touch foo`. Use the API for the runtime you're in.
+
+## Why this matters
+
+- **Windows**: `C:\Temp` may not exist or be writable; the real temp is
+  `C:\Users\<user>\AppData\Local\Temp`. Hardcoding `/tmp` either fails
+  outright or pollutes the wrong location.
+- **macOS**: `$TMPDIR` is per-user and changes per reboot. `/tmp` is a
+  shared system directory, not appropriate for app scratch data.
+- **Linux / multi-user**: `/tmp` is shared across users on the host.
+  Mixing files across users is a data-leak / collision risk.
+- **CI/CD**: runners typically wipe `/tmp` between jobs but leave the
+  per-user temp dir intact, so using the right dir keeps artifacts
+  available for inspection post-run.
+- **Sandboxing**: macOS sandbox and certain Linux sandboxes redirect
+  `/tmp` to a per-process private dir. The runtime API follows these
+  redirects; hardcoded `/tmp` does not.
+
+## Examples
+
+### Node.js / Bun
+
+```ts
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+
+const projectId = "pi-soly"; // or hash(repoUrl) for uniqueness
+const scratchDir = path.join(os.tmpdir(), `${projectId}-${process.pid}`);
+fs.mkdirSync(scratchDir, { recursive: true });
+
+try {
+  // ... use scratchDir for intermediate files ...
+} finally {
+  fs.rmSync(scratchDir, { recursive: true, force: true });
+}
+```
+
+For atomic writes to a target file:
+
+```ts
+import * as fs from "node:fs";
+import * as os from "node:os";
+import * as path from "node:path";
+
+function atomicWrite(target: string, data: string | Uint8Array): void {
+  const dir = path.dirname(target);
+  const tmp = path.join(dir, `.${path.basename(target)}.${process.pid}.tmp`);
+  const fh = fs.openSync(tmp, "w");
+  try {
+    fs.writeSync(fh, data);
+    fs.fsyncSync(fh);
+  } finally {
+    fs.closeSync(fh);
+  }
+  fs.renameSync(tmp, target); // atomic on same filesystem
+}
+```
+
+### Python
+
+```python
+import shutil
+import tempfile
+
+scratch = tempfile.mkdtemp(prefix="myproject-")
+try:
+    # ... use scratch ...
+    pass
+finally:
+    shutil.rmtree(scratch, ignore_errors=True)
+
+# Atomic write:
+import os
+def atomic_write(path: str, data: bytes) -> None:
+    tmp = f"{path}.{os.getpid()}.tmp"
+    with open(tmp, "wb") as f:
+        f.write(data)
+        f.flush()
+        os.fsync(f.fileno())
+    os.replace(tmp, path)
+```
+
+### Bash (POSIX: Linux / macOS)
+
+```bash
+SCRATCH="${TMPDIR:-/tmp}/myproject-$$"
+mkdir -p "$SCRATCH"
+trap 'rm -rf "$SCRATCH"' EXIT
+# ... work in "$SCRATCH" ...
+```
+
+### PowerShell (Windows)
+
+```powershell
+$scratch = Join-Path $env:TEMP "myproject-$PID"
+New-Item -ItemType Directory -Path $scratch -Force | Out-Null
+try {
+    # ... work in $scratch ...
+} finally {
+    Remove-Item -Recurse -Force $scratch -ErrorAction SilentlyContinue
+}
+```
+
+## Forbidden patterns
+
+```ts
+// ❌ Hardcoded path — breaks on Windows, breaks sandboxing
+const dir = "/tmp/myapp";
+const dir = "C:\\Temp\\myapp";
+const dir = path.join("/tmp", "myapp");
+
+// ❌ mkdir without cleanup — leaks across runs
+fs.mkdirSync("/tmp/myapp", { recursive: true });
+// ... no rmSync ...
+
+// ❌ Atomic write to /tmp when target is elsewhere — cross-device rename fails
+const tmp = `/tmp/${path.basename(target)}`;
+fs.writeFileSync(tmp, data);
+fs.renameSync(tmp, target); // EXDEV on different filesystems
+
+// ✓ Correct: resolve temp dir at runtime, project-scoped, cleaned up
+const dir = path.join(os.tmpdir(), `${projectId}-${process.pid}`);
+fs.mkdirSync(dir, { recursive: true });
+try { /* work */ } finally { fs.rmSync(dir, { recursive: true, force: true }); }
+```
+
+## Override
+
+This rule is **built-in to the soly extension** and ships with every
+install. It has highest priority and cannot be overridden by user rules.
+If you need a different convention, name your rule differently
+(e.g., `temp-files-windows-only.md` so the paths don't collide).

package/core.ts

@@ -16,6 +16,7 @@
 import * as fs from "node:fs";
 import * as os from "node:os";
 import * as path from "node:path";
+import { fileURLToPath } from "node:url";
 
 // Shared leaf utilities now live in util.ts; re-exported here so existing
 // `import { ... } from "./core.ts"` call sites keep working unchanged.
@@ -58,7 +59,8 @@ export type RuleSource =
   | "phase-soly"
   | "project-agents"
   | "global-agents"
-  | "phase-agents";
+  | "phase-agents"
+  | "built-in";
 
 export interface RuleFrontmatter {
   description?: string;
@@ -259,6 +261,40 @@ function loadRulesFromSource(spec: SourceSpec): RuleFile[] {
   return rules;
 }
 
+/**
+ * Resolve the path to the extension's `built-in-rules/` directory. Lives
+ * at `<package>/built-in-rules/` relative to the compiled module. We use
+ * `fileURLToPath(import.meta.url)` so this works whether the package is
+ * loaded directly from source (Bun, tsx) or from compiled output.
+ *
+ * `here` is the directory containing this core.ts file (i.e. the package
+ * root for source, the package root for compiled output too — both files
+ * live alongside package.json), so we don't need to traverse up.
+ */
+export function builtInRulesDir(): string {
+	const here = path.dirname(fileURLToPath(import.meta.url));
+	return path.resolve(here, "built-in-rules");
+}
+
+/**
+ * Load every markdown rule from the extension's `built-in-rules/` directory.
+ * These rules ship with the soly extension and are always present in the
+ * system prompt. Source spec uses priority=10 (highest), so a user rule at
+ * the same relPath is silently dropped into `overridden[]` — built-in
+ * rules win by design. `sourceLabel: "soly"` makes them visible in
+ * `/rules list` so users know which rules come from the package itself.
+ */
+export function loadBuiltInRules(): RuleFile[] {
+	const dir = builtInRulesDir();
+	if (!fs.existsSync(dir)) return [];
+	return loadRulesFromSource({
+		dir,
+		source: "built-in",
+		sourceLabel: "soly",
+		priority: 10,
+	});
+}
+
 export function loadAllRules(sources: SourceSpec[]): {
   rules: RuleFile[];
   overridden: string[];
@@ -537,17 +573,26 @@ export function buildRulesSection(
     if (r.interactiveOnly) interactive.push(r.relPath);
   }
 
+  // Split into built-in (shipped with soly) vs project/user rules. The two
+  // groups render in two distinct sections so the LLM can see the priority
+  // structure at a glance: vendor rules at the top (cannot be overridden),
+  // user rules below (can be edited locally).
+  const builtInRules = applicable.filter((r) => r.source === "built-in");
+  const userRules = applicable.filter((r) => r.source !== "built-in");
+
   // Optional grouping: phase rules in their own group, then everything else.
-  let blocks: string[];
+  // Phase grouping only applies to user rules — built-in rules are always
+  // always-on and don't move with phases.
+  let userBlocks: string[];
   let headerHint: string;
   if (options?.groupByPhase) {
     const phase = options.phaseNumber;
-    const phaseRules = applicable.filter((r) => r.phaseNumber === phase);
-    const otherRules = applicable.filter((r) => r.phaseNumber !== phase);
-    blocks = [...phaseRules.map(render), ...otherRules.map(render)];
+    const phaseRules = userRules.filter((r) => r.phaseNumber === phase);
+    const otherRules = userRules.filter((r) => r.phaseNumber !== phase);
+    userBlocks = [...phaseRules.map(render), ...otherRules.map(render)];
     headerHint = `Phase ${phase} rules are loaded for the currently active phase; all other rules are always-on. Inline @see references are resolved recursively.`;
   } else {
-    blocks = applicable.map(render);
+    userBlocks = userRules.map(render);
     headerHint = `The following rules are loaded from \`.agents/rules/\` and \`~/.agents/rules/\` and are mandatory. Follow them strictly. Inline @see references are resolved recursively.`;
   }
 
@@ -557,7 +602,26 @@ export function buildRulesSection(
         .join(", ")}_`
     : "";
 
-  const section = `
+  // Built-in section (shipped with soly, cannot be overridden).
+  // Renders ABOVE the MANDATORY project-rules section so the LLM sees the
+  // vendor content first, with a stronger "this is system-managed" framing.
+  const builtInSection = builtInRules.length
+    ? `
+
+## 🔒 Built-in rules (shipped with soly)
+
+**The following rules ship with the soly extension and apply to every
+session.** They are the highest-priority rules and cannot be overridden
+by user rules in \`.agents/rules/\` or \`~/.agents/rules/\` (a user rule
+at the same relPath is dropped silently). Follow them strictly.
+
+${builtInRules.map(render).join("\n\n---\n\n")}
+`
+    : "";
+
+  // Project/user rules section (the existing MANDATORY contract).
+  const projectSection = userBlocks.length
+    ? `
 
 ## ⚠️ MANDATORY: soly project rules
 
@@ -565,8 +629,11 @@ export function buildRulesSection(
 
 ${headerHint}
 
-${blocks.join("\n\n---\n\n")}${skippedNote}
-`;
+${userBlocks.join("\n\n---\n\n")}${skippedNote}
+`
+    : "";
+
+  const section = builtInSection + projectSection;
 
   return { section, loaded: applicable.map(ruleKey), interactive };
 }

package/index.ts

@@ -34,6 +34,8 @@ import {
 	extractFilePathsFromPrompt,
 	formatTok,
 	loadAllRules,
+	builtInRulesDir,
+	loadBuiltInRules,
 	loadPhaseRules,
 	loadProjectState,
 	matchesGlob,
@@ -441,10 +443,14 @@ export default function solyExtension(pi: ExtensionAPI) {
 		// Project rules always beat global rules. `.agents/rules.local/` is
 		// gitignored — for personal overrides on top of the project's rules.
 		// `.agents/rules/` is the vendor-neutral project-level convention.
+		// Built-in rules ship with the extension (priority=10 — highest) and
+		// can't be overridden: a user rule at the same relPath is dropped
+		// silently into the `overridden[]` list (see loadAllRules).
 		ruleSources = [
-			{ dir: path.join(ctx.cwd, ".agents", "rules.local"), source: "project-agents", sourceLabel: "local", priority: 5 },
-			{ dir: path.join(ctx.cwd, ".agents", "rules"), source: "project-agents", sourceLabel: "agents", priority: 3 },
+			{ dir: builtInRulesDir(), source: "built-in", sourceLabel: "soly", priority: 10 },
 			{ dir: path.join(os.homedir(), ".agents", "rules"), source: "global-agents", sourceLabel: "agents", priority: 1 },
+			{ dir: path.join(ctx.cwd, ".agents", "rules"), source: "project-agents", sourceLabel: "agents", priority: 3 },
+			{ dir: path.join(ctx.cwd, ".agents", "rules.local"), source: "project-agents", sourceLabel: "local", priority: 5 },
 		];
 		refreshRules();
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-soly",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "Project management + workflow framework for pi-coding-agent. Plans, state, MANDATORY rules, self-review, multi-question picker, native footer + welcome chrome — one npm install, zero config. The LLM drives the workflow inline via the soly_workflow tool — no external subagent plugin.",
   "type": "module",
   "main": "index.ts",
@@ -60,7 +60,8 @@
     "init.ts",
     "codemap.ts",
     "state.ts",
-    "hotreload.ts"
+    "hotreload.ts",
+    "built-in-rules"
   ],
   "keywords": [
     "pi",