cawdex 1.35.74 → 1.35.76

package/dist/docs-sync.js

@@ -111,104 +111,104 @@ export function buildDocsUpdatePrompt(cwd) {
     const docSummary = docFiles
         .map((d) => `  - ${d.type.toUpperCase()}: ${d.path}`)
         .join('\n');
-    return `Update and synchronize all documentation to match the current code.
-
-## Current Working Directory
-\`\`\`
-${cwd}
-\`\`\`
-
-## Detected Language
-${language}
-
-## Found Documentation Files
-\`\`\`
-${docSummary}
-\`\`\`
-
-## Instructions
-1. **Review all documentation files**:
-   - README.md: Check installation, usage, API overview
-   - CHANGELOG.md: Verify recent entries match recent code changes
-   - docs/*.md: Check all guides for outdated examples
-   - Source files: Check for missing or stale JSDoc/docstrings
-
-2. **Compare with actual code**:
-   - List all exported functions, classes, and types
-   - Check if they appear in documentation
-   - Verify function signatures match docs
-   - Check if CLI flags, config options are documented
-   - Look for examples that might be outdated
-
-3. **Identify gaps**:
-   - Missing JSDoc comments on public APIs
-   - Undocumented exports
-   - Examples that don't run
-   - Missing error documentation
-   - Deprecated features still documented
-   - New features not documented
-
-4. **Update stale documentation**:
-   - Fix outdated examples with current syntax
-   - Update API signatures if code changed
-   - Correct parameter names and types
-   - Update version numbers in examples
-   - Fix broken internal links
-
-5. **Add missing documentation**:
-   - Add JSDoc to all public functions and classes
-   - Document all public exports in README or API.md
-   - Add examples for common use cases
-   - Document error cases and exceptions
-   - Add CLI usage if applicable
-
-## Documentation Standards
-For JSDoc/Docstrings:
-\`\`\`typescript
-/**
- * Brief description of what this does.
- *
- * More detailed explanation if needed.
- *
- * @param paramName - Description of parameter
- * @returns Description of return value
- * @throws ErrorType If this condition occurs
- * @example
- * const result = myFunction('input');
- */
-function exampleFunction(paramName: string): string {
-  // ...
-}
-\`\`\`
-
-For README:
-- Brief project description
-- Installation instructions
-- Quick start example
-- Link to full API documentation
-- Contributing guidelines
-- License
-
-## Expected Output Format
-1. **Summary**:
-   - Total documentation files found
-   - Number of public exports
-   - Coverage % (documented vs total)
-
-2. **For each documentation file**:
-   - **File**: Path
-   - **Status**: (up-to-date / needs update / incomplete)
-   - **Issues Found**: Specific problems
-   - **Changes Made**: What was updated
-
-3. **For JSDoc/Docstrings**:
-   - **Functions without docs**: List
-   - **Outdated docs**: List with fixes
-   - **Missing examples**: Which functions need them
-
-4. **Overall Documentation Health**:
-   - Completeness score (0-100%)
-   - Key gaps remaining
+    return `Update and synchronize all documentation to match the current code.
+
+## Current Working Directory
+\`\`\`
+${cwd}
+\`\`\`
+
+## Detected Language
+${language}
+
+## Found Documentation Files
+\`\`\`
+${docSummary}
+\`\`\`
+
+## Instructions
+1. **Review all documentation files**:
+   - README.md: Check installation, usage, API overview
+   - CHANGELOG.md: Verify recent entries match recent code changes
+   - docs/*.md: Check all guides for outdated examples
+   - Source files: Check for missing or stale JSDoc/docstrings
+
+2. **Compare with actual code**:
+   - List all exported functions, classes, and types
+   - Check if they appear in documentation
+   - Verify function signatures match docs
+   - Check if CLI flags, config options are documented
+   - Look for examples that might be outdated
+
+3. **Identify gaps**:
+   - Missing JSDoc comments on public APIs
+   - Undocumented exports
+   - Examples that don't run
+   - Missing error documentation
+   - Deprecated features still documented
+   - New features not documented
+
+4. **Update stale documentation**:
+   - Fix outdated examples with current syntax
+   - Update API signatures if code changed
+   - Correct parameter names and types
+   - Update version numbers in examples
+   - Fix broken internal links
+
+5. **Add missing documentation**:
+   - Add JSDoc to all public functions and classes
+   - Document all public exports in README or API.md
+   - Add examples for common use cases
+   - Document error cases and exceptions
+   - Add CLI usage if applicable
+
+## Documentation Standards
+For JSDoc/Docstrings:
+\`\`\`typescript
+/**
+ * Brief description of what this does.
+ *
+ * More detailed explanation if needed.
+ *
+ * @param paramName - Description of parameter
+ * @returns Description of return value
+ * @throws ErrorType If this condition occurs
+ * @example
+ * const result = myFunction('input');
+ */
+function exampleFunction(paramName: string): string {
+  // ...
+}
+\`\`\`
+
+For README:
+- Brief project description
+- Installation instructions
+- Quick start example
+- Link to full API documentation
+- Contributing guidelines
+- License
+
+## Expected Output Format
+1. **Summary**:
+   - Total documentation files found
+   - Number of public exports
+   - Coverage % (documented vs total)
+
+2. **For each documentation file**:
+   - **File**: Path
+   - **Status**: (up-to-date / needs update / incomplete)
+   - **Issues Found**: Specific problems
+   - **Changes Made**: What was updated
+
+3. **For JSDoc/Docstrings**:
+   - **Functions without docs**: List
+   - **Outdated docs**: List with fixes
+   - **Missing examples**: Which functions need them
+
+4. **Overall Documentation Health**:
+   - Completeness score (0-100%)
+   - Key gaps remaining
    - Recommended priorities for next steps`;
 }
 /**