compose-agentsmd 3.3.1 → 3.4.0

package/README.md

@@ -2,6 +2,10 @@
 
 This repository contains CLI tooling for composing per-project `AGENTS.md` files from modular rule sets.
 
+## Compatibility
+
+- Node.js >= 20
+
 ## Release notes
 
 See `CHANGELOG.md` for release notes.
@@ -147,11 +151,16 @@ npm install
 npm run lint
 npm run build
 npm test
-```
-
-## Overview
-This repository contains the compose-agentsmd project.
-
-## Requirements and Configuration
-- No required environment variables are documented.
-
+```
+
+## Overview
+
+This repository contains the compose-agentsmd project.
+
+## Documentation
+
+- [CHANGELOG.md](CHANGELOG.md)
+- [CONTRIBUTING.md](CONTRIBUTING.md)
+- [SECURITY.md](SECURITY.md)
+- [LICENSE](LICENSE)
+- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)

package/dist/compose-agents.js

@@ -252,7 +252,7 @@ const stripJsonComments = (input) => {
             i += 1;
             continue;
         }
-        if (char === "\"" || char === "'") {
+        if (char === '"' || char === "'") {
             inString = true;
             stringChar = char;
             output += char;
@@ -435,7 +435,9 @@ const resolveGithubRulesRoot = (source, refresh) => {
     if (!resolvedHash && !looksLikeCommitHash(resolvedRef)) {
         throw new Error(`Unable to resolve ref ${resolvedRef} for ${parsed.url}`);
     }
-    const cacheSegment = resolvedRef === "HEAD" ? sanitizeCacheSegment(resolvedHash ?? resolvedRef) : sanitizeCacheSegment(resolvedRef);
+    const cacheSegment = resolvedRef === "HEAD"
+        ? sanitizeCacheSegment(resolvedHash ?? resolvedRef)
+        : sanitizeCacheSegment(resolvedRef);
     const cacheDir = path.join(DEFAULT_CACHE_ROOT, parsed.owner, parsed.repo, cacheSegment);
     if (refresh && fs.existsSync(cacheDir)) {
         fs.rmSync(cacheDir, { recursive: true, force: true });
@@ -531,7 +533,8 @@ const resolveOutputPaths = (rulesetDir, projectRuleset) => {
     const claude = projectRuleset.claude ?? {};
     const companionEnabled = claude.enabled !== false;
     const configuredCompanionPath = resolveFrom(rulesetDir, claude.output ?? DEFAULT_CLAUDE_OUTPUT);
-    if (!companionEnabled || path.resolve(primaryOutputPath) === path.resolve(configuredCompanionPath)) {
+    if (!companionEnabled ||
+        path.resolve(primaryOutputPath) === path.resolve(configuredCompanionPath)) {
         return { primaryOutputPath };
     }
     return { primaryOutputPath, companionOutputPath: configuredCompanionPath };
@@ -585,7 +588,9 @@ const composeRuleset = (rulesetPath, rootDir, options) => {
     }
     let agentsMdDiff;
     if (options.emitAgentsMdDiff && path.basename(primaryOutputPath) === DEFAULT_OUTPUT) {
-        const before = fs.existsSync(primaryOutputPath) ? fs.readFileSync(primaryOutputPath, "utf8") : "";
+        const before = fs.existsSync(primaryOutputPath)
+            ? fs.readFileSync(primaryOutputPath, "utf8")
+            : "";
         if (before === primaryOutputContent) {
             agentsMdDiff = { status: "unchanged" };
         }
@@ -658,23 +663,23 @@ const formatInitRuleset = (ruleset) => {
     const claudeOutput = ruleset.claude?.output ?? DEFAULT_CLAUDE_OUTPUT;
     const lines = [
         "{",
-        '  // Rules source. Use github:owner/repo@ref or a local path.',
+        "  // Rules source. Use github:owner/repo@ref or a local path.",
         `  "source": "${ruleset.source}",`,
-        '  // Domain folders under rules/domains.',
+        "  // Domain folders under rules/domains.",
         `  "domains": ${domainsValue},`,
-        '  // Additional local rule files to append.',
+        "  // Additional local rule files to append.",
         `  "extra": ${extraValue},`
     ];
     if (ruleset.global === false) {
-        lines.push('  // Include rules/global from the source.');
+        lines.push("  // Include rules/global from the source.");
         lines.push('  "global": false,');
     }
-    lines.push('  // Claude Code companion output settings.');
+    lines.push("  // Claude Code companion output settings.");
     lines.push('  "claude": {');
     lines.push(`    "enabled": ${claudeEnabled ? "true" : "false"},`);
     lines.push(`    "output": "${claudeOutput}"`);
     lines.push("  },");
-    lines.push('  // Output file name.');
+    lines.push("  // Output file name.");
     lines.push(`  "output": "${ruleset.output ?? DEFAULT_OUTPUT}"`);
     lines.push("}");
     return `${lines.join("\n")}\n`;
@@ -700,7 +705,9 @@ const confirmInit = async (args) => {
     }
 };
 const initProject = async (args, rootDir, rulesetName) => {
-    const rulesetPath = args.ruleset ? resolveFrom(rootDir, args.ruleset) : path.join(rootDir, rulesetName);
+    const rulesetPath = args.ruleset
+        ? resolveFrom(rootDir, args.ruleset)
+        : path.join(rootDir, rulesetName);
     const rulesetDir = path.dirname(rulesetPath);
     const ruleset = buildInitRuleset(args);
     const outputPaths = resolveOutputPaths(rulesetDir, ruleset);
@@ -892,9 +899,7 @@ const main = async () => {
         const expectedPath = normalizePath(path.join(rootDir, rulesetName));
         throw new Error(`Missing ruleset file: ${expectedPath}`);
     }
-    const outputs = rulesetFiles
-        .sort()
-        .map((rulesetPath) => composeRuleset(rulesetPath, rootDir, {
+    const outputs = rulesetFiles.sort().map((rulesetPath) => composeRuleset(rulesetPath, rootDir, {
         refresh: args.refresh,
         dryRun: args.dryRun,
         emitAgentsMdDiff: !args.quiet && !args.json
@@ -903,7 +908,10 @@ const main = async () => {
         process.stdout.write(JSON.stringify({ composed: outputs.flatMap((result) => result.outputs), dryRun: !!args.dryRun }, null, 2) + "\n");
     }
     else if (!args.quiet) {
-        process.stdout.write(`Composed AGENTS.md:\n${outputs.flatMap((result) => result.outputs).map((filePath) => `- ${filePath}`).join("\n")}\n`);
+        process.stdout.write(`Composed AGENTS.md:\n${outputs
+            .flatMap((result) => result.outputs)
+            .map((filePath) => `- ${filePath}`)
+            .join("\n")}\n`);
         for (const result of outputs) {
             printAgentsMdDiffIfPresent(result);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "compose-agentsmd",
-  "version": "3.3.1",
+  "version": "3.4.0",
   "description": "CLI tools for composing per-project AGENTS.md files from modular rule sets",
   "license": "MIT",
   "repository": {
@@ -34,18 +34,29 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "lint": "tsc -p tsconfig.json --noEmit",
+    "lint": "eslint . && tsc -p tsconfig.json --noEmit",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
     "prepare": "npm run build",
     "prepack": "npm run build",
-    "test": "npm run build && node --test",
+    "test": "npm run build && vitest run",
+    "verify": "npm run lint && npm run format:check && npm test",
     "compose": "npm run build && node dist/compose-agents.js"
   },
   "engines": {
     "node": ">=20"
   },
   "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@types/diff": "^7.0.2",
     "@types/node": "^25.1.0",
-    "typescript": "^5.7.3"
+    "@typescript-eslint/eslint-plugin": "^8.56.0",
+    "@typescript-eslint/parser": "^8.56.0",
+    "eslint": "^10.0.1",
+    "globals": "^17.3.0",
+    "prettier": "^3.8.1",
+    "typescript": "^5.7.3",
+    "vitest": "^4.0.18"
   },
   "dependencies": {
     "ajv": "^8.17.1",

package/tools/tool-rules.md

@@ -1,13 +1,12 @@
 # Tool Rules (compose-agentsmd)
+
 - Before starting any work, run `compose-agentsmd` from the project root.
 - `compose-agentsmd` intentionally regenerates `AGENTS.md`; any resulting `AGENTS.md` diff is expected and must not be treated as an unexpected external change.
 - If `compose-agentsmd` is not available, install it via npm: `npm install -g compose-agentsmd`.
-- To update shared rules, run `compose-agentsmd edit-rules`, edit the workspace rules, then run `compose-agentsmd apply-rules`.
+- To update shared/global rules, use `compose-agentsmd edit-rules` to locate the writable rules workspace, make changes only in that workspace, then run `compose-agentsmd apply-rules` (do not manually clone or edit the rules source repo outside this workflow).
+- If you find an existing clone of the rules source repo elsewhere, do not assume it is the correct rules workspace; always treat `compose-agentsmd edit-rules` output as the source of truth.
 - `compose-agentsmd apply-rules` pushes the rules workspace when `source` is GitHub (if the workspace is clean), then regenerates `AGENTS.md` with refreshed rules.
 - Do not edit `AGENTS.md` directly; update the source rules and regenerate.
 - `tools/tool-rules.md` is the shared rule source for all repositories that use compose-agentsmd.
-- Before applying any rule updates, present the planned changes first (prefer a colorized diff-style preview), ask for explicit approval, then make the edits.
-- These tool rules live in tools/tool-rules.md in the compose-agentsmd repository; do not duplicate them in global rule modules.
-- When updating rules, include a colorized diff-style summary in the final response. Use `git diff --stat` first, then include the raw ANSI-colored output of `git diff --color=always` (no sanitizing or reformatting), and limit the output to the rule files that changed.
-- Also provide a short, copy-pasteable command the user can run to view the diff in the same format. Use absolute paths so it works regardless of the current working directory, and scope it to the changed rule files.
-- If a diff is provided, a separate detailed summary is not required. If a diff is not possible, include a detailed summary of what changed (added/removed/modified items).
+- Before applying any rule updates, present the planned changes first with an ANSI-colored diff-style preview, ask for explicit approval, then make the edits.
+- These tool rules live in tools/tool-rules.md in the compose-agentsmd repository; do not duplicate them in other rule modules.