@dalzoubi/dev-agents-sync 1.0.26 → 2.0.1

package/tests/e2e/readme-coverage.test.mjs

@@ -0,0 +1,183 @@
+/**
+ * tests/e2e/readme-coverage.test.mjs
+ *
+ * Asserts that the CLI README documents CLAUDE.md injection in the
+ * init → update → check flow.
+ *
+ * These tests are RED until the README is updated to describe the feature.
+ *
+ * The README must:
+ *   1. Mention "CLAUDE.md" somewhere in the document.
+ *   2. Describe "auto-route" or "routing" in the context of init/update/check.
+ *   3. Mention the auto-route feature in the init section (so users know it
+ *      happens on first run).
+ *   4. Mention the auto-route feature in the update section (so users know
+ *      the block is refreshed on update).
+ *   5. Mention CLAUDE.md or routing in the check section (so users know
+ *      check verifies the block).
+ *
+ * Implement agent must update `packages/dev-agents-sync/README.md` before
+ * these tests go green.
+ */
+
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { readFileSync, existsSync } from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const README_PATH = path.join(__dirname, '..', '..', 'README.md');
+
+function readReadme() {
+  assert.ok(
+    existsSync(README_PATH),
+    `README.md must exist at ${README_PATH}`,
+  );
+  return readFileSync(README_PATH, 'utf8');
+}
+
+// ---------------------------------------------------------------------------
+// Criterion 1 — README mentions "CLAUDE.md"
+// ---------------------------------------------------------------------------
+
+describe('README: mentions CLAUDE.md', () => {
+  it('README.md contains the string "CLAUDE.md"', () => {
+    const content = readReadme();
+    assert.ok(
+      content.includes('CLAUDE.md'),
+      'README.md must mention "CLAUDE.md" to document the injection feature.\n' +
+      'The init → update → check flow injects a fenced routing block into the ' +
+      "consumer's CLAUDE.md — this must be documented.",
+    );
+  });
+});
+
+// ---------------------------------------------------------------------------
+// Criterion 2 — README mentions "auto-route" or "routing"
+// ---------------------------------------------------------------------------
+
+describe('README: mentions routing/auto-route', () => {
+  it('README.md contains "auto-route" or "routing"', () => {
+    const content = readReadme();
+    const mentionsRouting =
+      content.includes('auto-route') ||
+      content.toLowerCase().includes('routing');
+
+    assert.ok(
+      mentionsRouting,
+      'README.md must mention "auto-route" or "routing" to describe what ' +
+      'the CLAUDE.md injection feature does (it injects an auto-routing block).',
+    );
+  });
+});
+
+// ---------------------------------------------------------------------------
+// Criterion 3 — init section describes CLAUDE.md injection
+// ---------------------------------------------------------------------------
+
+describe('README: init section describes CLAUDE.md injection', () => {
+  it('the init section (or surrounding text) mentions CLAUDE.md injection', () => {
+    const content = readReadme();
+
+    // Find the region around `init` documentation.
+    // Accept any of: a code block containing `init`, a heading containing init,
+    // or a paragraph mentioning init alongside CLAUDE.md.
+    //
+    // Strategy: check that both "init" and "CLAUDE.md" appear, and that
+    // there's a passage where they are in proximity (within 500 chars).
+    const initIndex = content.indexOf('init');
+    assert.notEqual(
+      initIndex,
+      -1,
+      'README.md must contain the text "init" to document the init subcommand',
+    );
+
+    // Find the nearest occurrence of CLAUDE.md to any occurrence of init.
+    let foundProximity = false;
+    let searchFrom = 0;
+    while (true) {
+      const idx = content.indexOf('init', searchFrom);
+      if (idx === -1) break;
+      // Look for CLAUDE.md within 600 characters before or after this occurrence.
+      const windowStart = Math.max(0, idx - 300);
+      const windowEnd = Math.min(content.length, idx + 300);
+      const window = content.slice(windowStart, windowEnd);
+      if (window.includes('CLAUDE.md')) {
+        foundProximity = true;
+        break;
+      }
+      searchFrom = idx + 1;
+    }
+
+    assert.ok(
+      foundProximity,
+      'README.md must describe CLAUDE.md injection in proximity to the "init" section.\n' +
+      'Users running `init` need to know that CLAUDE.md will be created/updated with ' +
+      'the auto-routing fenced block.',
+    );
+  });
+});
+
+// ---------------------------------------------------------------------------
+// Criterion 4 — update section describes CLAUDE.md injection
+// ---------------------------------------------------------------------------
+
+describe('README: update section describes CLAUDE.md injection', () => {
+  it('the update section (or surrounding text) mentions CLAUDE.md or routing', () => {
+    const content = readReadme();
+
+    let foundProximity = false;
+    let searchFrom = 0;
+    while (true) {
+      const idx = content.indexOf('update', searchFrom);
+      if (idx === -1) break;
+      const windowStart = Math.max(0, idx - 300);
+      const windowEnd = Math.min(content.length, idx + 300);
+      const window = content.slice(windowStart, windowEnd);
+      if (window.includes('CLAUDE.md') || window.toLowerCase().includes('routing') || window.includes('auto-route')) {
+        foundProximity = true;
+        break;
+      }
+      searchFrom = idx + 1;
+    }
+
+    assert.ok(
+      foundProximity,
+      'README.md must describe CLAUDE.md or routing in proximity to the "update" section.\n' +
+      'Users running `update` need to know that the CLAUDE.md routing block will be refreshed.',
+    );
+  });
+});
+
+// ---------------------------------------------------------------------------
+// Criterion 5 — check section describes CLAUDE.md or routing verification
+// ---------------------------------------------------------------------------
+
+describe('README: check section describes CLAUDE.md / routing verification', () => {
+  it('the check section (or surrounding text) mentions CLAUDE.md or routing', () => {
+    const content = readReadme();
+
+    let foundProximity = false;
+    let searchFrom = 0;
+    while (true) {
+      const idx = content.indexOf('check', searchFrom);
+      if (idx === -1) break;
+      const windowStart = Math.max(0, idx - 300);
+      const windowEnd = Math.min(content.length, idx + 300);
+      const window = content.slice(windowStart, windowEnd);
+      if (window.includes('CLAUDE.md') || window.toLowerCase().includes('routing') || window.includes('auto-route')) {
+        foundProximity = true;
+        break;
+      }
+      searchFrom = idx + 1;
+    }
+
+    assert.ok(
+      foundProximity,
+      'README.md must describe CLAUDE.md or routing in proximity to the "check" section.\n' +
+      'Users running `check` need to know that drift in the CLAUDE.md routing block ' +
+      'is detected (exit 1, CLAUDE.md named in the error).',
+    );
+  });
+});