Subchapter 9.6

Agents Md

install/agents-md.mjs

JavaScript43 lines3 KB

1// Writes a new project's agent config files — AGENTS.md, CLAUDE.md (an import of it),
2// .gemini/settings.json. The AGENTS.md text is the file beside this one, `install/AGENTS.md`,
3// with {{SKILL}} (the installed skill folder's name) and {{STACK}} filled in. It keeps the CLI's
4// shape (the CLI commands pointer `wix create` writes) and says what the CLI's cannot: which skills
5// this project carries, where, how to restore them, and the one rule about Wix calls.
6// `wix create` writes its own set only when @wix/cli resolves from the project's node_modules at
7// scaffold time; setup scaffolds with --skip-install and attach never runs the CLI scaffold,
8// so we write them. Fill-only: a file that exists is left alone.
9import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
10import { dirname, join } from "node:path";

agents-md.mjs on GitHub

import { fileURLToPath } from "node:url";

const TEMPLATE = join(dirname(fileURLToPath(import.meta.url)), "AGENTS.md");

// The three files, as the CLI names them. Exported so setup can drop the CLI's own copies from

// the scaffold before moving it up (ours replaces them; a file the USER already has is kept).

export const AGENT_CONFIG_FILES = ["AGENTS.md", "CLAUDE.md", ".gemini"];

export function writeAgentsMd(projectDir, vars) {

const written = [], kept = [];

const agents = join(projectDir, "AGENTS.md");

if (existsSync(agents)) kept.push("AGENTS.md");

else {

// {{MIGRATION}} is a paragraph on a migration preview (vars.migration = { parentSiteId, deploySiteId }), else nothing.

const migration = vars.migration

? `\n\n**Under migration.** \`wix.config.json\` names site ${vars.migration.deploySiteId}, which only hosts this deployment; the site being migrated is ${vars.migration.parentSiteId} — its content is what the pages show and its dashboard (\`https://manage.wix.com/dashboard/${vars.migration.parentSiteId}\`) is where the business is managed. \`.env.local\` (\`wix env pull\`) carries that site's app: the SDK client and every admin, discovery and seed call run against it; only \`wix release\` goes to the deploy site. Completing the migration, once the user approves the preview, follows \`.agents/skills/${vars.skill}/guides/migration.md\`.`

: "";

const text = readFileSync(TEMPLATE, "utf8").replace(/\{\{(\w+)\}\}/g, (_, k) => (k === "MIGRATION" ? migration : (vars[k.toLowerCase()] ?? "")));

writeFileSync(agents, text); written.push("AGENTS.md");

}

const claude = join(projectDir, "CLAUDE.md");

if (existsSync(claude)) kept.push("CLAUDE.md");

else { writeFileSync(claude, "@AGENTS.md"); written.push("CLAUDE.md"); }

const gemini = join(projectDir, ".gemini", "settings.json");

if (existsSync(gemini)) kept.push(".gemini/settings.json");

else {

mkdirSync(join(projectDir, ".gemini"), { recursive: true });

writeFileSync(gemini, JSON.stringify({ contextFileName: "AGENTS.md" }, null, 2) + "\n");

written.push(".gemini/settings.json");

}

// kept: the folder already had its own — left untouched, so it says nothing about these skills

return { written, kept };

}