@bradygaster/squad-sdk 0.9.1 → 0.9.2-insider.1

package/dist/sharing/consult.js

@@ -14,11 +14,13 @@
  *
  * @module sharing/consult
  */
-import fs from 'node:fs';
+import { cpSync } from 'node:fs'; // cpSync retained for recursive directory copy — StorageProvider.copySync is file-only
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { execSync } from 'node:child_process';
+import { FSStorageProvider } from '../storage/fs-storage-provider.js';
 import { resolveGlobalSquadPath } from '../resolution.js';
+const storage = new FSStorageProvider();
 // ============================================================================
 // Typed Errors
 // ============================================================================
@@ -51,22 +53,22 @@ export class ExtractionDisabledError extends Error {
  * Consult mode preamble to inject after frontmatter in squad.agent.md.
  * This tells Squad it's in consult mode and should skip Init Mode.
  */
-const CONSULT_MODE_PREAMBLE = `
-<!-- consult-mode: true -->
-
-## ⚡ Consult Mode Active
-
-This project is in **consult mode**. Your personal squad has been copied into \`.squad/\` for this session.
-
-**Key differences from normal mode:**
-- **Skip Init Mode** — The team already exists (copied from your personal squad)
-- **Isolated changes** — All changes stay local until you run \`squad extract\`
-- **Invisible to project** — Both \`.squad/\` and this agent file are in \`.git/info/exclude\`
-
-**When done:** Run \`squad extract\` to review learnings and merge generic ones back to your personal squad.
-
----
-
+const CONSULT_MODE_PREAMBLE = `
+<!-- consult-mode: true -->
+
+## ⚡ Consult Mode Active
+
+This project is in **consult mode**. Your personal squad has been copied into \`.squad/\` for this session.
+
+**Key differences from normal mode:**
+- **Skip Init Mode** — The team already exists (copied from your personal squad)
+- **Isolated changes** — All changes stay local until you run \`squad extract\`
+- **Invisible to project** — Both \`.squad/\` and this agent file are in \`.git/info/exclude\`
+
+**When done:** Run \`squad extract\` to review learnings and merge generic ones back to your personal squad.
+
+---
+
 `;
 /**
  * Get the full squad.agent.md template path.
@@ -76,13 +78,13 @@ function getSquadAgentTemplatePath() {
     // Use fileURLToPath for cross-platform compatibility (handles Windows drive letters, URL encoding)
     const currentDir = path.dirname(fileURLToPath(import.meta.url));
     // Try relative to this file (in dist/)
-    const distPath = path.resolve(currentDir, '../../templates/squad.agent.md');
-    if (fs.existsSync(distPath)) {
+    const distPath = path.resolve(currentDir, '../../templates/squad.agent.md.template');
+    if (storage.existsSync(distPath)) {
         return distPath;
     }
     // Try relative to package root
-    const pkgPath = path.resolve(currentDir, '../../../templates/squad.agent.md');
-    if (fs.existsSync(pkgPath)) {
+    const pkgPath = path.resolve(currentDir, '../../../templates/squad.agent.md.template');
+    if (storage.existsSync(pkgPath)) {
         return pkgPath;
     }
     return null;
@@ -119,8 +121,8 @@ function getGitRemoteUrl(projectRoot) {
  */
 function getConsultAgentContent(projectName) {
     const templatePath = getSquadAgentTemplatePath();
-    if (templatePath && fs.existsSync(templatePath)) {
-        const template = fs.readFileSync(templatePath, 'utf-8');
+    if (templatePath && storage.existsSync(templatePath)) {
+        const template = storage.readSync(templatePath) ?? '';
         // Find the end of frontmatter (second ---)
         const frontmatterEnd = template.indexOf('---', template.indexOf('---') + 3);
         if (frontmatterEnd !== -1) {
@@ -135,24 +137,24 @@ function getConsultAgentContent(projectName) {
         return template + '\n' + CONSULT_MODE_PREAMBLE;
     }
     // Fallback: minimal agent if template not found
-    return `---
-name: Squad
-description: "Your AI team. Consulting on ${projectName} using your personal squad."
----
-
-${CONSULT_MODE_PREAMBLE}
-
-You are **Squad (Consultant)** — working on **${projectName}** using a copy of your personal squad.
-
-### Available Context (local copy in .squad/)
-
-- **Team:** \`.squad/team.md\` for roster and roles
-- **Routing:** \`.squad/routing.md\` for task routing rules  
-- **Decisions:** \`.squad/decisions.md\` for your established patterns
-- **Skills:** \`.copilot/skills/\` for reusable capabilities
-- **Agents:** \`.squad/agents/\` for your squad agents
-
-Work as you would with your personal squad, but in this external codebase.
+    return `---
+name: Squad
+description: "Your AI team. Consulting on ${projectName} using your personal squad."
+---
+
+${CONSULT_MODE_PREAMBLE}
+
+You are **Squad (Consultant)** — working on **${projectName}** using a copy of your personal squad.
+
+### Available Context (local copy in .squad/)
+
+- **Team:** \`.squad/team.md\` for roster and roles
+- **Routing:** \`.squad/routing.md\` for task routing rules  
+- **Decisions:** \`.squad/decisions.md\` for your established patterns
+- **Skills:** \`.copilot/skills/\` for reusable capabilities
+- **Agents:** \`.squad/agents/\` for your squad agents
+
+Work as you would with your personal squad, but in this external codebase.
 `;
 }
 // ============================================================================
@@ -162,65 +164,65 @@ Work as you would with your personal squad, but in this external codebase.
  * Consult mode instructions to append to Scribe charter.
  * This enables Scribe to classify decisions as generic or project-specific.
  */
-const CONSULT_MODE_SCRIBE_PATCH = `
-
----
-
-## Consult Mode Extraction
-
-**This squad is in consult mode.** When merging decisions from the inbox, also classify each decision:
-
-### Classification
-
-For each decision in \`.squad/decisions/inbox/\`:
-
-1. **Generic** (applies to any project) → Copy to \`.squad/extract/\` with the same filename
-   - Signals: "always use", "never use", "prefer X over Y", "best practice", coding standards, patterns that work anywhere
-   - These will be extracted to the personal squad via \`squad extract\`
-
-2. **Project-specific** (only applies here) → Keep in local \`decisions.md\` only
-   - Signals: Contains file paths from this project, references "this project/codebase/repo", mentions project-specific config/APIs/schemas
-
-Generic decisions go to BOTH \`.squad/decisions.md\` (for this session) AND \`.squad/extract/\` (for later extraction).
-
-### Extract Directory
-
-\`\`\`
-.squad/extract/           # Generic learnings staged for personal squad
-├── decision-1.md         # Ready for extraction
-└── pattern-auth.md       # Ready for extraction
-\`\`\`
-
-Run \`squad extract\` to review and merge these to your personal squad.
+const CONSULT_MODE_SCRIBE_PATCH = `
+
+---
+
+## Consult Mode Extraction
+
+**This squad is in consult mode.** When merging decisions from the inbox, also classify each decision:
+
+### Classification
+
+For each decision in \`.squad/decisions/inbox/\`:
+
+1. **Generic** (applies to any project) → Copy to \`.squad/extract/\` with the same filename
+   - Signals: "always use", "never use", "prefer X over Y", "best practice", coding standards, patterns that work anywhere
+   - These will be extracted to the personal squad via \`squad extract\`
+
+2. **Project-specific** (only applies here) → Keep in local \`decisions.md\` only
+   - Signals: Contains file paths from this project, references "this project/codebase/repo", mentions project-specific config/APIs/schemas
+
+Generic decisions go to BOTH \`.squad/decisions.md\` (for this session) AND \`.squad/extract/\` (for later extraction).
+
+### Extract Directory
+
+\`\`\`
+.squad/extract/           # Generic learnings staged for personal squad
+├── decision-1.md         # Ready for extraction
+└── pattern-auth.md       # Ready for extraction
+\`\`\`
+
+Run \`squad extract\` to review and merge these to your personal squad.
 `;
 /**
  * Patch the Scribe charter in the copied squad with consult mode instructions.
  */
 function patchScribeCharterForConsultMode(squadDir) {
     const charterPath = path.join(squadDir, 'agents', 'scribe', 'charter.md');
-    if (!fs.existsSync(charterPath)) {
+    if (!storage.existsSync(charterPath)) {
         // No scribe charter to patch — skip silently
         return;
     }
-    const existing = fs.readFileSync(charterPath, 'utf-8');
+    const existing = storage.readSync(charterPath) ?? '';
     // Don't patch if already patched
     if (existing.includes('Consult Mode Extraction')) {
         return;
     }
-    fs.appendFileSync(charterPath, CONSULT_MODE_SCRIBE_PATCH);
+    storage.appendSync(charterPath, CONSULT_MODE_SCRIBE_PATCH);
 }
 /**
  * List files recursively in a directory.
  */
 function listFilesInDir(dir, basePath = '') {
-    if (!fs.existsSync(dir))
+    if (!storage.existsSync(dir))
         return [];
     const files = [];
-    const entries = fs.readdirSync(dir, { withFileTypes: true });
+    const entries = storage.listSync(dir);
     for (const entry of entries) {
-        const relativePath = basePath ? path.join(basePath, entry.name) : entry.name;
-        if (entry.isDirectory()) {
-            files.push(...listFilesInDir(path.join(dir, entry.name), relativePath));
+        const relativePath = basePath ? path.join(basePath, entry) : entry;
+        if (storage.isDirectorySync(path.join(dir, entry))) {
+            files.push(...listFilesInDir(path.join(dir, entry), relativePath));
         }
         else {
             files.push(relativePath);
@@ -230,10 +232,10 @@ function listFilesInDir(dir, basePath = '') {
 }
 /**
  * Get the personal squad root path.
- * Returns {globalSquadPath}/.squad/
+ * Returns {globalSquadPath}/personal-squad/
  */
 export function getPersonalSquadRoot() {
-    return path.resolve(resolveGlobalSquadPath(), '.squad');
+    return path.resolve(resolveGlobalSquadPath(), 'personal-squad');
 }
 /**
  * Resolve the git exclude path using git rev-parse (handles worktrees/submodules).
@@ -272,7 +274,7 @@ export async function setupConsultMode(options = {}) {
     const agentFile = path.resolve(projectRoot, '.github', 'agents', 'squad.agent.md');
     // Check if we're in a git repository (handle worktrees/submodules where .git is a file)
     const gitPath = path.resolve(projectRoot, '.git');
-    if (!fs.existsSync(gitPath)) {
+    if (!storage.existsSync(gitPath)) {
         throw new Error('Not a git repository. Consult mode requires git.');
     }
     // Resolve exclude path via git rev-parse (handles worktrees/submodules)
@@ -282,16 +284,16 @@ export async function setupConsultMode(options = {}) {
         return path.isAbsolute(excludePath) ? excludePath : path.resolve(projectRoot, excludePath);
     })();
     // Check if personal squad exists
-    if (!fs.existsSync(personalSquadRoot)) {
+    if (!storage.existsSync(personalSquadRoot)) {
         throw new PersonalSquadNotFoundError();
     }
     // Read source squad's config to inherit extractionDisabled setting
     // Option takes precedence, then fall back to source config
     let extractionDisabled = options.extractionDisabled ?? false;
     const sourceConfigPath = path.join(personalSquadRoot, 'config.json');
-    if (fs.existsSync(sourceConfigPath)) {
+    if (storage.existsSync(sourceConfigPath)) {
         try {
-            const sourceConfig = JSON.parse(fs.readFileSync(sourceConfigPath, 'utf-8'));
+            const sourceConfig = JSON.parse(storage.readSync(sourceConfigPath) ?? '{}');
             // Inherit from source unless explicitly overridden in options
             if (options.extractionDisabled === undefined && sourceConfig.extractionDisabled) {
                 extractionDisabled = true;
@@ -302,7 +304,7 @@ export async function setupConsultMode(options = {}) {
         }
     }
     // Check if project already has .squad/
-    if (fs.existsSync(squadDir)) {
+    if (storage.existsSync(squadDir)) {
         throw new Error('This project already has a .squad/ directory. Cannot use consult mode on squadified projects.');
     }
     // List files in personal squad (for dry run preview or later count)
@@ -310,7 +312,7 @@ export async function setupConsultMode(options = {}) {
     if (!dryRun) {
         // Copy personal squad contents into project's .squad/
         // This isolates changes during the consult session
-        fs.cpSync(personalSquadRoot, squadDir, { recursive: true });
+        cpSync(personalSquadRoot, squadDir, { recursive: true });
         // Write/overwrite config.json with consult: true
         // Include SquadDirConfig fields so loadDirConfig() can read it
         // Note: version must be numeric for loadDirConfig() compatibility
@@ -323,30 +325,30 @@ export async function setupConsultMode(options = {}) {
             createdAt: new Date().toISOString(),
             extractionDisabled,
         };
-        fs.writeFileSync(path.join(squadDir, 'config.json'), JSON.stringify(config, null, 2), 'utf-8');
+        storage.writeSync(path.join(squadDir, 'config.json'), JSON.stringify(config, null, 2));
         // Create sessions directory for tracking (if not copied)
         const sessionsDir = path.join(squadDir, 'sessions');
-        if (!fs.existsSync(sessionsDir)) {
-            fs.mkdirSync(sessionsDir, { recursive: true });
+        if (!storage.existsSync(sessionsDir)) {
+            storage.mkdirSync(sessionsDir, { recursive: true });
         }
         // Create extract/ directory for staging generic learnings
         const extractDir = path.join(squadDir, 'extract');
-        fs.mkdirSync(extractDir, { recursive: true });
+        storage.mkdirSync(extractDir, { recursive: true });
         // Patch scribe-charter.md with consult mode extraction instructions
         patchScribeCharterForConsultMode(squadDir);
         // Create .github/agents/squad.agent.md for `gh copilot --agent squad`
         const agentDir = path.dirname(agentFile);
-        if (!fs.existsSync(agentDir)) {
-            fs.mkdirSync(agentDir, { recursive: true });
+        if (!storage.existsSync(agentDir)) {
+            storage.mkdirSync(agentDir, { recursive: true });
         }
-        fs.writeFileSync(agentFile, getConsultAgentContent(projectName), 'utf-8');
+        storage.writeSync(agentFile, getConsultAgentContent(projectName));
         // Add .squad/ and .github/agents/squad.agent.md to .git/info/exclude
         const excludeDir = path.dirname(gitExclude);
-        if (!fs.existsSync(excludeDir)) {
-            fs.mkdirSync(excludeDir, { recursive: true });
+        if (!storage.existsSync(excludeDir)) {
+            storage.mkdirSync(excludeDir, { recursive: true });
         }
-        const excludeContent = fs.existsSync(gitExclude)
-            ? fs.readFileSync(gitExclude, 'utf-8')
+        const excludeContent = storage.existsSync(gitExclude)
+            ? storage.readSync(gitExclude) ?? ''
             : '';
         const excludeLines = [];
         if (!excludeContent.includes('.squad/')) {
@@ -356,7 +358,7 @@ export async function setupConsultMode(options = {}) {
             excludeLines.push('.github/agents/squad.agent.md');
         }
         if (excludeLines.length > 0) {
-            fs.appendFileSync(gitExclude, '\n# Squad consult mode (local only)\n' + excludeLines.join('\n') + '\n');
+            storage.appendSync(gitExclude, '\n# Squad consult mode (local only)\n' + excludeLines.join('\n') + '\n');
         }
     }
     // List files created (from squad dir after copy, or from source for dry run)
@@ -381,15 +383,15 @@ export async function setupConsultMode(options = {}) {
 export function loadSessionHistory(squadDir) {
     const sessionsDir = path.join(squadDir, 'sessions');
     const entries = [];
-    if (!fs.existsSync(sessionsDir)) {
+    if (!storage.existsSync(sessionsDir)) {
         return { entries };
     }
-    const files = fs.readdirSync(sessionsDir)
+    const files = storage.listSync(sessionsDir)
         .filter(f => f.endsWith('.json'))
         .sort();
     for (const file of files) {
         try {
-            const content = fs.readFileSync(path.join(sessionsDir, file), 'utf-8');
+            const content = storage.readSync(path.join(sessionsDir, file)) ?? '';
             const session = JSON.parse(content);
             // Extract learnings from session data
             if (session.learnings && Array.isArray(session.learnings)) {
@@ -442,14 +444,14 @@ export async function extractLearnings(options = {}) {
     const squadDir = path.resolve(projectRoot, '.squad');
     const projectName = options.projectName || path.basename(projectRoot);
     // Check if we're in consult mode
-    if (!fs.existsSync(squadDir)) {
+    if (!storage.existsSync(squadDir)) {
         throw new Error('Not in consult mode. No .squad/ directory found.');
     }
     const configPath = path.join(squadDir, 'config.json');
-    if (!fs.existsSync(configPath)) {
+    if (!storage.existsSync(configPath)) {
         throw new Error('Invalid consult mode: missing config.json');
     }
-    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+    const config = JSON.parse(storage.readSync(configPath) ?? '{}');
     if (!config.consult) {
         throw new Error('This project has a .squad/ but is not in consult mode. Use normal squad commands.');
     }
@@ -459,8 +461,8 @@ export async function extractLearnings(options = {}) {
     }
     // Detect license
     const licensePath = path.join(projectRoot, 'LICENSE');
-    const licenseContent = fs.existsSync(licensePath)
-        ? fs.readFileSync(licensePath, 'utf-8')
+    const licenseContent = storage.existsSync(licensePath)
+        ? storage.readSync(licensePath) ?? ''
         : '';
     const license = detectLicense(licenseContent);
     // Block copyleft extraction unless --accept-risks
@@ -514,12 +516,12 @@ export async function extractLearnings(options = {}) {
         consultationLogPath = await logConsultation(personalSquadRoot, result);
         // Remove extracted files from .squad/extract/
         for (const learning of staged) {
-            fs.rmSync(learning.filepath, { force: true });
+            storage.deleteSync(learning.filepath);
         }
     }
     // Clean up entire .squad/ if requested
     if (clean && !dryRun) {
-        fs.rmSync(squadDir, { recursive: true, force: true });
+        storage.deleteDirSync(squadDir);
         cleaned = true;
     }
     return {
@@ -615,14 +617,14 @@ export function detectLicense(licenseContent) {
 export function loadStagedLearnings(squadDir) {
     const extractDir = path.join(squadDir, 'extract');
     const learnings = [];
-    if (!fs.existsSync(extractDir)) {
+    if (!storage.existsSync(extractDir)) {
         return learnings;
     }
-    const files = fs.readdirSync(extractDir).filter(f => f.endsWith('.md'));
+    const files = storage.listSync(extractDir).filter(f => f.endsWith('.md'));
     for (const file of files) {
         const filepath = path.join(extractDir, file);
         try {
-            const content = fs.readFileSync(filepath, 'utf-8');
+            const content = storage.readSync(filepath) ?? '';
             learnings.push({
                 filename: file,
                 filepath,
@@ -652,25 +654,25 @@ export async function logConsultation(personalSquadRoot, result) {
     const consultDir = path.join(personalSquadRoot, 'consultations');
     const logPath = path.join(consultDir, `${result.projectName}.md`);
     // Create consultations directory if needed
-    if (!fs.existsSync(consultDir)) {
-        fs.mkdirSync(consultDir, { recursive: true });
+    if (!storage.existsSync(consultDir)) {
+        storage.mkdirSync(consultDir, { recursive: true });
     }
     const today = result.timestamp.split('T')[0] ?? new Date().toISOString().split('T')[0]; // YYYY-MM-DD format
-    if (fs.existsSync(logPath)) {
+    if (storage.existsSync(logPath)) {
         // Append to existing log — update "Last session" and add new entry
-        let content = fs.readFileSync(logPath, 'utf-8');
+        let content = storage.readSync(logPath) ?? '';
         // Update "Last session" date
         content = content.replace(/\*\*Last session:\*\* \d{4}-\d{2}-\d{2}/, `**Last session:** ${today}`);
         // Build session entry
         const sessionEntry = formatSessionEntry(result, today);
         // Append to file
-        fs.writeFileSync(logPath, content + sessionEntry, 'utf-8');
+        storage.writeSync(logPath, content + sessionEntry);
     }
     else {
         // Create new consultation log with full header
         const header = formatLogHeader(result, today);
         const sessionEntry = formatSessionEntry(result, today);
-        fs.writeFileSync(logPath, header + sessionEntry, 'utf-8');
+        storage.writeSync(logPath, header + sessionEntry);
     }
     return logPath;
 }
@@ -682,14 +684,14 @@ function formatLogHeader(result, date) {
         ? `**Repository:** ${result.repoUrl}\n`
         : '';
     const licenseName = result.license.spdxId || result.license.name || result.license.type;
-    return `# ${result.projectName}
-
-${repoLine}**First consulted:** ${date}
-**Last session:** ${date}
-**License:** ${licenseName}
-
-## Extracted Learnings
-
+    return `# ${result.projectName}
+
+${repoLine}**First consulted:** ${date}
+**Last session:** ${date}
+**License:** ${licenseName}
+
+## Extracted Learnings
+
 `;
 }
 /**
@@ -697,16 +699,16 @@ ${repoLine}**First consulted:** ${date}
  */
 function formatSessionEntry(result, date) {
     if (result.extracted.length === 0) {
-        return `### ${date}
-- No learnings extracted
-
+        return `### ${date}
+- No learnings extracted
+
 `;
     }
     // Just list titles/filenames, not content
     const lines = result.extracted.map(l => `- ${l.filename}`);
-    return `### ${date}
-${lines.join('\n')}
-
+    return `### ${date}
+${lines.join('\n')}
+
 `;
 }
 // ============================================================================
@@ -763,20 +765,20 @@ export async function mergeToPersonalSquad(learnings, personalSquadRoot) {
         const skillName = extractSkillName(skill.content) || skill.filename.replace('.md', '');
         const skillDir = path.join(skillsDir, skillName);
         // Create skill directory if needed
-        if (!fs.existsSync(skillDir)) {
-            fs.mkdirSync(skillDir, { recursive: true });
+        if (!storage.existsSync(skillDir)) {
+            storage.mkdirSync(skillDir, { recursive: true });
         }
         const skillPath = path.join(skillDir, 'SKILL.md');
         // Write skill (overwrites if exists — newer extraction wins)
-        fs.writeFileSync(skillPath, skill.content, 'utf-8');
+        storage.writeSync(skillPath, skill.content);
         skillsAdded++;
     }
     // Route decisions to personal squad directory at decisions.md
     if (decisions.length > 0) {
         const decisionsPath = path.join(personalSquadRoot, 'decisions.md');
         const newContent = decisions.map(d => d.content.trim()).join('\n\n');
-        if (fs.existsSync(decisionsPath)) {
-            const existing = fs.readFileSync(decisionsPath, 'utf-8');
+        if (storage.existsSync(decisionsPath)) {
+            const existing = storage.readSync(decisionsPath) ?? '';
             // Check if we already have an "Extracted from Consultations" section
             if (existing.includes('## Extracted from Consultations')) {
                 // Append under the existing section (before any subsequent ## heading)
@@ -789,27 +791,27 @@ export async function mergeToPersonalSquad(learnings, personalSquadRoot) {
                     // Insert before next section
                     const sectionContent = afterSection.slice(0, nextSectionMatch.index);
                     const rest = afterSection.slice(nextSectionMatch.index);
-                    fs.writeFileSync(decisionsPath, beforeSection +
+                    storage.writeSync(decisionsPath, beforeSection +
                         '## Extracted from Consultations' +
                         sectionContent.trimEnd() +
                         '\n\n' +
                         newContent +
                         '\n' +
-                        rest, 'utf-8');
+                        rest);
                 }
                 else {
                     // No next section — append to end
-                    fs.writeFileSync(decisionsPath, existing.trimEnd() + '\n\n' + newContent + '\n', 'utf-8');
+                    storage.writeSync(decisionsPath, existing.trimEnd() + '\n\n' + newContent + '\n');
                 }
             }
             else {
                 // No extraction section yet — create one
-                fs.writeFileSync(decisionsPath, existing.trimEnd() + '\n\n## Extracted from Consultations\n\n' + newContent + '\n', 'utf-8');
+                storage.writeSync(decisionsPath, existing.trimEnd() + '\n\n## Extracted from Consultations\n\n' + newContent + '\n');
             }
         }
         else {
             // Create new decisions file
-            fs.writeFileSync(decisionsPath, `# Squad Decisions\n\n## Extracted from Consultations\n\n${newContent}\n`, 'utf-8');
+            storage.writeSync(decisionsPath, `# Squad Decisions\n\n## Extracted from Consultations\n\n${newContent}\n`);
         }
         decisionsAdded = decisions.length;
     }