a359ffed34
- Added `migrate-layout.ts` to handle migration from old workspace layouts to the new `devclaw/` structure. - Introduced `migrate-layout.test.ts` for comprehensive tests covering various migration scenarios. - Updated `workspace.ts` to ensure default files are created post-migration, including `workflow.yaml` and role-specific prompts. - Refactored role instruction handling to accommodate new directory structure. - Enhanced project registration to scaffold prompt files in the new `devclaw/projects/<project>/prompts/` directory. - Adjusted setup tool descriptions and logic to reflect changes in file structure. - Updated templates to align with the new workflow configuration and role instructions.
99 lines
3.4 KiB
TypeScript
99 lines
3.4 KiB
TypeScript
/**
|
|
* setup/workspace.ts — Workspace file scaffolding.
|
|
*
|
|
* Writes AGENTS.md, HEARTBEAT.md, default role prompts, and projects.json.
|
|
*/
|
|
import fs from "node:fs/promises";
|
|
import path from "node:path";
|
|
import {
|
|
AGENTS_MD_TEMPLATE,
|
|
HEARTBEAT_MD_TEMPLATE,
|
|
WORKFLOW_YAML_TEMPLATE,
|
|
DEFAULT_ROLE_INSTRUCTIONS,
|
|
} from "../templates.js";
|
|
import { getAllRoleIds } from "../roles/index.js";
|
|
import { migrateWorkspaceLayout, DATA_DIR } from "./migrate-layout.js";
|
|
|
|
/**
|
|
* Ensure default data files exist in the workspace.
|
|
* Only creates files that are missing — never overwrites existing ones.
|
|
* Called automatically after migration (via ensureWorkspaceMigrated).
|
|
*/
|
|
export async function ensureDefaultFiles(workspacePath: string): Promise<void> {
|
|
const dataDir = path.join(workspacePath, DATA_DIR);
|
|
|
|
// devclaw/workflow.yaml
|
|
const workflowPath = path.join(dataDir, "workflow.yaml");
|
|
if (!await fileExists(workflowPath)) {
|
|
await fs.mkdir(dataDir, { recursive: true });
|
|
await fs.writeFile(workflowPath, WORKFLOW_YAML_TEMPLATE, "utf-8");
|
|
}
|
|
|
|
// devclaw/projects.json
|
|
const projectsJsonPath = path.join(dataDir, "projects.json");
|
|
if (!await fileExists(projectsJsonPath)) {
|
|
await fs.mkdir(dataDir, { recursive: true });
|
|
await fs.writeFile(projectsJsonPath, JSON.stringify({ projects: {} }, null, 2) + "\n", "utf-8");
|
|
}
|
|
|
|
// devclaw/projects/ directory
|
|
await fs.mkdir(path.join(dataDir, "projects"), { recursive: true });
|
|
|
|
// devclaw/prompts/ — default role instructions
|
|
const promptsDir = path.join(dataDir, "prompts");
|
|
await fs.mkdir(promptsDir, { recursive: true });
|
|
for (const role of getAllRoleIds()) {
|
|
const rolePath = path.join(promptsDir, `${role}.md`);
|
|
if (!await fileExists(rolePath)) {
|
|
const content = DEFAULT_ROLE_INSTRUCTIONS[role] ?? `# ${role.toUpperCase()} Worker Instructions\n\nAdd role-specific instructions here.\n`;
|
|
await fs.writeFile(rolePath, content, "utf-8");
|
|
}
|
|
}
|
|
|
|
// devclaw/log/ directory (audit.log created on first write)
|
|
await fs.mkdir(path.join(dataDir, "log"), { recursive: true });
|
|
}
|
|
|
|
/**
|
|
* Write all workspace files for a DevClaw agent.
|
|
* Returns the list of files that were written (skips files that already exist).
|
|
*/
|
|
export async function scaffoldWorkspace(workspacePath: string): Promise<string[]> {
|
|
// Migrate old layout if detected
|
|
await migrateWorkspaceLayout(workspacePath);
|
|
|
|
// AGENTS.md (backup existing — stays at workspace root)
|
|
await backupAndWrite(path.join(workspacePath, "AGENTS.md"), AGENTS_MD_TEMPLATE);
|
|
|
|
// HEARTBEAT.md (stays at workspace root)
|
|
await backupAndWrite(path.join(workspacePath, "HEARTBEAT.md"), HEARTBEAT_MD_TEMPLATE);
|
|
|
|
// Ensure all data-dir defaults (workflow.yaml, prompts, etc.)
|
|
await ensureDefaultFiles(workspacePath);
|
|
|
|
return ["AGENTS.md", "HEARTBEAT.md"];
|
|
}
|
|
|
|
// ---------------------------------------------------------------------------
|
|
// Private helpers
|
|
// ---------------------------------------------------------------------------
|
|
|
|
async function backupAndWrite(filePath: string, content: string): Promise<void> {
|
|
try {
|
|
await fs.access(filePath);
|
|
await fs.copyFile(filePath, filePath + ".bak");
|
|
} catch {
|
|
await fs.mkdir(path.dirname(filePath), { recursive: true });
|
|
}
|
|
await fs.writeFile(filePath, content, "utf-8");
|
|
}
|
|
|
|
async function fileExists(filePath: string): Promise<boolean> {
|
|
try {
|
|
await fs.access(filePath);
|
|
return true;
|
|
} catch {
|
|
return false;
|
|
}
|
|
}
|