@aigne/doc-smith 0.4.4 → 0.5.1

package/tests/save-value-to-config.test.mjs

@@ -1,3 +1,4 @@
+import { afterEach, beforeEach, describe, expect, test } from "bun:test";
 import { existsSync } from "node:fs";
 import { mkdir, readFile, rm, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
@@ -44,221 +45,151 @@ async function createInitialConfig(content) {
   await writeFile(TEST_CONFIG_PATH, content, "utf8");
 }
 
-// Test utilities
-function assertContains(content, expected, message) {
-  if (!content.includes(expected)) {
-    throw new Error(
-      `${message}\nExpected content to contain: ${expected}\nActual content:\n${content}`,
-    );
-  }
-}
+// Test suite
+describe("saveValueToConfig", () => {
+  beforeEach(async () => {
+    await setupTestDir();
+  });
 
-function assertNotContains(content, unexpected, message) {
-  if (content.includes(unexpected)) {
-    throw new Error(
-      `${message}\nExpected content NOT to contain: ${unexpected}\nActual content:\n${content}`,
-    );
-  }
-}
+  afterEach(async () => {
+    await teardownTestDir();
+  });
 
-function assertEqual(actual, expected, message) {
-  if (actual !== expected) {
-    throw new Error(`${message}\nExpected: ${expected}\nActual: ${actual}`);
-  }
-}
+  test("Save string value to empty file", async () => {
+    await saveValueToConfig("projectName", "test-project");
+    const content = await readConfigFile();
+
+    expect(content).toContain('projectName: "test-project"');
+  });
+
+  test("Save string value with comment to empty file", async () => {
+    await saveValueToConfig("projectDesc", "A test project", "Project description");
+    const content = await readConfigFile();
+
+    expect(content).toContain("# Project description");
+    expect(content).toContain('projectDesc: "A test project"');
+  });
+
+  test("Save array value to empty file", async () => {
+    await saveValueToConfig("translateLanguages", ["zh", "ja", "ko"]);
+    const content = await readConfigFile();
+
+    expect(content).toContain("translateLanguages:");
+    expect(content).toContain("  - zh");
+    expect(content).toContain("  - ja");
+    expect(content).toContain("  - ko");
+  });
+
+  test("Save empty array", async () => {
+    await saveValueToConfig("emptyArray", []);
+    const content = await readConfigFile();
+
+    expect(content).toContain("emptyArray: []");
+  });
+
+  test("Save array with comment", async () => {
+    await saveValueToConfig("sourcePaths", ["./src", "./lib"], "Source code paths");
+    const content = await readConfigFile();
+
+    expect(content).toContain("# Source code paths");
+    expect(content).toContain("sourcePaths:");
+    expect(content).toContain("  - ./src");
+    expect(content).toContain("  - ./lib");
+  });
+
+  test("Update existing string value", async () => {
+    await createInitialConfig('projectName: "old-project"\nversion: "1.0.0"');
+
+    await saveValueToConfig("projectName", "new-project");
+    const content = await readConfigFile();
+
+    expect(content).toContain('projectName: "new-project"');
+    expect(content).toContain('version: "1.0.0"');
+    expect(content).not.toContain("old-project");
+  });
 
-// Test cases
-const tests = [
-  // Test 1: Save string value to empty file
-  {
-    name: "Save string value to empty file",
-    async run() {
-      await saveValueToConfig("projectName", "test-project");
-      const content = await readConfigFile();
-
-      assertContains(
-        content,
-        'projectName: "test-project"',
-        "Should save string value with quotes",
-      );
-    },
-  },
-
-  // Test 2: Save string value with comment to empty file
-  {
-    name: "Save string value with comment to empty file",
-    async run() {
-      await saveValueToConfig("projectDesc", "A test project", "Project description");
-      const content = await readConfigFile();
-
-      assertContains(content, "# Project description", "Should include comment");
-      assertContains(content, 'projectDesc: "A test project"', "Should save string value");
-    },
-  },
-
-  // Test 3: Save array value to empty file
-  {
-    name: "Save array value to empty file",
-    async run() {
-      await saveValueToConfig("translateLanguages", ["zh", "ja", "ko"]);
-      const content = await readConfigFile();
-
-      assertContains(content, "translateLanguages:", "Should have array key");
-      assertContains(content, "  - zh", "Should have first array item");
-      assertContains(content, "  - ja", "Should have second array item");
-      assertContains(content, "  - ko", "Should have third array item");
-    },
-  },
-
-  // Test 4: Save empty array
-  {
-    name: "Save empty array",
-    async run() {
-      await saveValueToConfig("emptyArray", []);
-      const content = await readConfigFile();
-
-      assertContains(content, "emptyArray: []", "Should save empty array as []");
-    },
-  },
-
-  // Test 5: Save array with comment
-  {
-    name: "Save array with comment",
-    async run() {
-      await saveValueToConfig("sourcePaths", ["./src", "./lib"], "Source code paths");
-      const content = await readConfigFile();
-
-      assertContains(content, "# Source code paths", "Should include comment");
-      assertContains(content, "sourcePaths:", "Should have array key");
-      assertContains(content, "  - ./src", "Should have first path");
-      assertContains(content, "  - ./lib", "Should have second path");
-    },
-  },
-
-  // Test 6: Update existing string value
-  {
-    name: "Update existing string value",
-    async run() {
-      await createInitialConfig('projectName: "old-project"\nversion: "1.0.0"');
-
-      await saveValueToConfig("projectName", "new-project");
-      const content = await readConfigFile();
-
-      assertContains(content, 'projectName: "new-project"', "Should update string value");
-      assertContains(content, 'version: "1.0.0"', "Should preserve other values");
-      assertNotContains(content, "old-project", "Should not contain old value");
-    },
-  },
-
-  // Test 7: Update existing array value
-  {
-    name: "Update existing array value",
-    async run() {
-      await createInitialConfig(`translateLanguages:
+  test("Update existing array value", async () => {
+    await createInitialConfig(`translateLanguages:
   - en
   - fr
 version: "1.0.0"`);
 
-      await saveValueToConfig("translateLanguages", ["zh", "ja"]);
-      const content = await readConfigFile();
-
-      assertContains(content, "translateLanguages:", "Should have array key");
-      assertContains(content, "  - zh", "Should have new first item");
-      assertContains(content, "  - ja", "Should have new second item");
-      assertNotContains(content, "  - en", "Should not contain old first item");
-      assertNotContains(content, "  - fr", "Should not contain old second item");
-      assertContains(content, 'version: "1.0.0"', "Should preserve other values");
-    },
-  },
-
-  // Test 8: Update array to empty array
-  {
-    name: "Update array to empty array",
-    async run() {
-      await createInitialConfig(`translateLanguages:
+    await saveValueToConfig("translateLanguages", ["zh", "ja"]);
+    const content = await readConfigFile();
+
+    expect(content).toContain("translateLanguages:");
+    expect(content).toContain("  - zh");
+    expect(content).toContain("  - ja");
+    expect(content).not.toContain("  - en");
+    expect(content).not.toContain("  - fr");
+    expect(content).toContain('version: "1.0.0"');
+  });
+
+  test("Update array to empty array", async () => {
+    await createInitialConfig(`translateLanguages:
   - en
   - fr
 version: "1.0.0"`);
 
-      await saveValueToConfig("translateLanguages", []);
-      const content = await readConfigFile();
+    await saveValueToConfig("translateLanguages", []);
+    const content = await readConfigFile();
 
-      assertContains(content, "translateLanguages: []", "Should update to empty array");
-      assertNotContains(content, "  - en", "Should remove old items");
-      assertContains(content, 'version: "1.0.0"', "Should preserve other values");
-    },
-  },
+    expect(content).toContain("translateLanguages: []");
+    expect(content).not.toContain("  - en");
+    expect(content).toContain('version: "1.0.0"');
+  });
 
-  // Test 9: Update empty array to populated array
-  {
-    name: "Update empty array to populated array",
-    async run() {
-      await createInitialConfig(`translateLanguages: []
+  test("Update empty array to populated array", async () => {
+    await createInitialConfig(`translateLanguages: []
 version: "1.0.0"`);
 
-      await saveValueToConfig("translateLanguages", ["zh", "ja"]);
-      const content = await readConfigFile();
-
-      assertContains(content, "translateLanguages:", "Should have array key");
-      assertContains(content, "  - zh", "Should have first item");
-      assertContains(content, "  - ja", "Should have second item");
-      assertNotContains(content, "translateLanguages: []", "Should not contain empty array format");
-      assertContains(content, 'version: "1.0.0"', "Should preserve other values");
-    },
-  },
-
-  // Test 10: Add comment to existing value without comment
-  {
-    name: "Add comment to existing value without comment",
-    async run() {
-      await createInitialConfig('projectName: "test-project"\nversion: "1.0.0"');
-
-      await saveValueToConfig("projectName", "updated-project", "Updated project name");
-      const content = await readConfigFile();
-
-      assertContains(content, "# Updated project name", "Should add comment");
-      assertContains(content, 'projectName: "updated-project"', "Should update value");
-    },
-  },
-
-  // Test 11: Update value that already has comment
-  {
-    name: "Update value that already has comment",
-    async run() {
-      await createInitialConfig(`# Project information
+    await saveValueToConfig("translateLanguages", ["zh", "ja"]);
+    const content = await readConfigFile();
+
+    expect(content).toContain("translateLanguages:");
+    expect(content).toContain("  - zh");
+    expect(content).toContain("  - ja");
+    expect(content).not.toContain("translateLanguages: []");
+    expect(content).toContain('version: "1.0.0"');
+  });
+
+  test("Add comment to existing value without comment", async () => {
+    await createInitialConfig('projectName: "test-project"\nversion: "1.0.0"');
+
+    await saveValueToConfig("projectName", "updated-project", "Updated project name");
+    const content = await readConfigFile();
+
+    expect(content).toContain("# Updated project name");
+    expect(content).toContain('projectName: "updated-project"');
+  });
+
+  test("Update value that already has comment", async () => {
+    await createInitialConfig(`# Project information
 projectName: "old-project"
 version: "1.0.0"`);
 
-      await saveValueToConfig("projectName", "new-project", "Updated project info");
-      const content = await readConfigFile();
-
-      assertContains(content, "# Project information", "Should preserve existing comment");
-      assertContains(content, 'projectName: "new-project"', "Should update value");
-      assertNotContains(content, "# Updated project info", "Should not add duplicate comment");
-    },
-  },
-
-  // Test 12: Complex array with various items
-  {
-    name: "Complex array with various items",
-    async run() {
-      const complexArray = ["./src/components", "./lib/utils", "./modules/auth"];
-      await saveValueToConfig("sourcePaths", complexArray, "All source paths");
-      const content = await readConfigFile();
-
-      assertContains(content, "# All source paths", "Should include comment");
-      assertContains(content, "sourcePaths:", "Should have array key");
-      assertContains(content, "  - ./src/components", "Should have first complex path");
-      assertContains(content, "  - ./lib/utils", "Should have second complex path");
-      assertContains(content, "  - ./modules/auth", "Should have third complex path");
-    },
-  },
-
-  // Test 13: Mixed content preservation
-  {
-    name: "Mixed content preservation",
-    async run() {
-      await createInitialConfig(`# Project configuration
+    await saveValueToConfig("projectName", "new-project", "Updated project info");
+    const content = await readConfigFile();
+
+    expect(content).toContain("# Project information");
+    expect(content).toContain('projectName: "new-project"');
+    expect(content).not.toContain("# Updated project info");
+  });
+
+  test("Complex array with various items", async () => {
+    const complexArray = ["./src/components", "./lib/utils", "./modules/auth"];
+    await saveValueToConfig("sourcePaths", complexArray, "All source paths");
+    const content = await readConfigFile();
+
+    expect(content).toContain("# All source paths");
+    expect(content).toContain("sourcePaths:");
+    expect(content).toContain("  - ./src/components");
+    expect(content).toContain("  - ./lib/utils");
+    expect(content).toContain("  - ./modules/auth");
+  });
+
+  test("Mixed content preservation", async () => {
+    await createInitialConfig(`# Project configuration
 projectName: "original-project"
 translateLanguages:
   - en
@@ -267,104 +198,50 @@ translateLanguages:
 version: "1.0.0"
 locale: en`);
 
-      await saveValueToConfig("translateLanguages", ["zh", "ja", "ko"], "Updated languages");
-      const content = await readConfigFile();
-
-      assertContains(content, "# Project configuration", "Should preserve file header comment");
-      assertContains(content, 'projectName: "original-project"', "Should preserve string value");
-      assertContains(content, "# Updated languages", "Should add new comment");
-      assertContains(content, "translateLanguages:", "Should have updated array key");
-      assertContains(content, "  - zh", "Should have new array items");
-      assertContains(content, "  - ja", "Should have new array items");
-      assertContains(content, "  - ko", "Should have new array items");
-      assertContains(content, "# Other settings", "Should preserve other comments");
-      assertContains(content, 'version: "1.0.0"', "Should preserve other values");
-      assertContains(content, "locale: en", "Should preserve other values");
-      assertNotContains(content, "  - en", "Should remove old array items");
-      assertNotContains(content, "  - fr", "Should remove old array items");
-    },
-  },
-
-  // Test 14: Array in middle of file
-  {
-    name: "Array in middle of file",
-    async run() {
-      await createInitialConfig(`projectName: "test-project"
+    await saveValueToConfig("translateLanguages", ["zh", "ja", "ko"], "Updated languages");
+    const content = await readConfigFile();
+
+    expect(content).toContain("# Project configuration");
+    expect(content).toContain('projectName: "original-project"');
+    expect(content).toContain("# Updated languages");
+    expect(content).toContain("translateLanguages:");
+    expect(content).toContain("  - zh");
+    expect(content).toContain("  - ja");
+    expect(content).toContain("  - ko");
+    expect(content).toContain("# Other settings");
+    expect(content).toContain('version: "1.0.0"');
+    expect(content).toContain("locale: en");
+    expect(content).not.toContain("  - en");
+    expect(content).not.toContain("  - fr");
+  });
+
+  test("Array in middle of file", async () => {
+    await createInitialConfig(`projectName: "test-project"
 translateLanguages:
   - en
   - fr
 locale: en
 version: "1.0.0"`);
 
-      await saveValueToConfig("translateLanguages", ["zh"]);
-      const content = await readConfigFile();
-
-      assertContains(content, 'projectName: "test-project"', "Should preserve content before");
-      assertContains(content, "translateLanguages:", "Should have array key");
-      assertContains(content, "  - zh", "Should have new array item");
-      assertContains(content, "locale: en", "Should preserve content after");
-      assertContains(content, 'version: "1.0.0"', "Should preserve content after");
-      assertNotContains(content, "  - en", "Should remove old items");
-      assertNotContains(content, "  - fr", "Should remove old items");
-    },
-  },
-
-  // Test 15: Handle undefined values
-  {
-    name: "Handle undefined values",
-    async run() {
-      const initialContent = 'projectName: "test-project"';
-      await createInitialConfig(initialContent);
-
-      await saveValueToConfig("undefinedKey", undefined);
-      const content = await readConfigFile();
-
-      assertEqual(content, initialContent, "Should not modify file when value is undefined");
-    },
-  },
-];
-
-// Run all tests
-async function runTests() {
-  console.log("🧪 Running saveValueToConfig tests...\n");
-
-  let passed = 0;
-  let failed = 0;
-
-  for (const test of tests) {
-    try {
-      await setupTestDir();
-      await test.run();
-      console.log(`✅ ${test.name}`);
-      passed++;
-    } catch (error) {
-      console.log(`❌ ${test.name}`);
-      console.log(`   Error: ${error.message}\n`);
-      failed++;
-    } finally {
-      await teardownTestDir();
-    }
-  }
+    await saveValueToConfig("translateLanguages", ["zh"]);
+    const content = await readConfigFile();
 
-  console.log(`\n📊 Test Results:`);
-  console.log(`   Passed: ${passed}`);
-  console.log(`   Failed: ${failed}`);
-  console.log(`   Total:  ${tests.length}`);
+    expect(content).toContain('projectName: "test-project"');
+    expect(content).toContain("translateLanguages:");
+    expect(content).toContain("  - zh");
+    expect(content).toContain("locale: en");
+    expect(content).toContain('version: "1.0.0"');
+    expect(content).not.toContain("  - en");
+    expect(content).not.toContain("  - fr");
+  });
 
-  if (failed > 0) {
-    console.log(`\n❌ ${failed} test(s) failed`);
-    process.exit(1);
-  } else {
-    console.log(`\n🎉 All tests passed!`);
-  }
-}
+  test("Handle undefined values", async () => {
+    const initialContent = 'projectName: "test-project"';
+    await createInitialConfig(initialContent);
 
-// Run tests if this file is executed directly
-if (import.meta.url === `file://${process.argv[1]}`) {
-  runTests().catch((error) => {
-    console.error("Test runner failed:", error);
-    process.exit(1);
-  });
-}
+    await saveValueToConfig("undefinedKey", undefined);
+    const content = await readConfigFile();
 
-export { runTests, tests };
+    expect(content).toBe(initialContent);
+  });
+});

package/utils/constants.mjs

@@ -176,13 +176,13 @@ export const DOCUMENT_STYLES = {
       "Optimizes for: Architecture, concepts, decision rationale.\nSkips: Quick wins, copy-paste solutions.",
   },
   solveProblems: {
-    name: "Solve problems",
+    name: "Troubleshoot common issues",
     description: "Help users troubleshoot and fix issues",
     content:
       "Optimizes for: Error scenarios, diagnostics, solutions.\nSkips: Happy path tutorials, feature overviews.",
   },
   mixedPurpose: {
-    name: "Mix of above",
+    name: "Serve multiple purposes",
     description: "Comprehensive documentation covering multiple needs",
     content:
       "Optimizes for: Balanced coverage, multiple entry points.\nTrade-off: Longer, requires good navigation.",
@@ -198,13 +198,13 @@ export const TARGET_AUDIENCES = {
       "Writing: Plain language, UI-focused, avoid technical terms.\nExamples: Screenshots, step-by-step clicks, business outcomes.",
   },
   developers: {
-    name: "Developers integrating",
+    name: "Developers integrating your product/API",
     description: "Engineers adding this to their projects",
     content:
       "Writing: Code-first, copy-paste ready, technical accuracy.\nExamples: SDK usage, API calls, configuration snippets.",
   },
   devops: {
-    name: "DevOps/Infrastructure",
+    name: "DevOps / SRE / Infrastructure teams",
     description: "Teams deploying, monitoring, maintaining systems",
     content:
       "Writing: Operations-focused, troubleshooting emphasis.\nExamples: Deployment configs, monitoring setup, scaling guides.",
@@ -232,19 +232,19 @@ export const TARGET_AUDIENCES = {
 // Reader knowledge level - what do readers typically know when they arrive?
 export const READER_KNOWLEDGE_LEVELS = {
   completeBeginners: {
-    name: "Complete beginners",
+    name: "Is a total beginner, starting from scratch",
     description: "New to this domain/technology entirely",
     content:
       "Content: Define terms, explain concepts, assume nothing.\nStructure: Linear progression, prerequisite checks.\nTone: Patient, educational, confidence-building.",
   },
   domainFamiliar: {
-    name: "Domain-familiar, tool-new",
+    name: "Has used similar tools before",
     description: "Know the problem space, new to this specific solution",
     content:
       'Content: Focus on differences, migration, unique features.\nStructure: Comparison-heavy, "coming from X" sections.\nTone: Efficient, highlight advantages, skip basics.',
   },
   experiencedUsers: {
-    name: "Experienced users",
+    name: "Is an expert trying to do something specific",
     description: "Regular users needing reference/advanced topics",
     content:
       "Content: Dense information, edge cases, performance tips.\nStructure: Reference-style, searchable, task-oriented.\nTone: Concise, technical precision, assume competence.",
@@ -256,7 +256,7 @@ export const READER_KNOWLEDGE_LEVELS = {
       "Content: Symptom → diagnosis → solution format.\nStructure: Problem-first, solution-prominent, escalation paths.\nTone: Clear, actionable, confidence-inspiring.",
   },
   exploringEvaluating: {
-    name: "Exploring/evaluating",
+    name: "Is evaluating this tool against others",
     description: "Trying to understand if this fits their needs",
     content:
       "Content: Use cases, comparisons, getting started quickly.\nStructure: Multiple entry points, progressive commitment.\nTone: Persuasive but honest, show value quickly.",