@aigne/doc-smith 0.7.1 → 0.8.0

package/.github/workflows/ci.yml

@@ -4,6 +4,9 @@ env:
   NODE_OPTIONS: "--max_old_space_size=6144"
 
 on:
+  push:
+    branches:
+      - main
   pull_request:
     branches:
       - main
@@ -43,4 +46,9 @@ jobs:
         run: pnpm lint
 
       - name: Test
-        run: pnpm test:coverage
+        run: pnpm test:coverage
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.8.0](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.2...v0.8.0) (2025-09-03)
+
+
+### Features
+
+* **tests:** add comprehensive workflow test coverage ([#76](https://github.com/AIGNE-io/aigne-doc-smith/issues/76)) ([d5f6062](https://github.com/AIGNE-io/aigne-doc-smith/commit/d5f6062311f36dc5b6394ae0768583fb8f3853a4))
+* update custom component guidelines with formatting restrictions ([#79](https://github.com/AIGNE-io/aigne-doc-smith/issues/79)) ([76158de](https://github.com/AIGNE-io/aigne-doc-smith/commit/76158de236696e68c63c057f5ea4b8458a15e787))
+
+## [0.7.2](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.1...v0.7.2) (2025-09-01)
+
+
+### Miscellaneous Chores
+
+* release 0.7.2 ([c3be232](https://github.com/AIGNE-io/aigne-doc-smith/commit/c3be2323e885cf5d11d654629fe30cc3720f79d3))
+
 ## [0.7.1](https://github.com/AIGNE-io/aigne-doc-smith/compare/v0.7.0...v0.7.1) (2025-08-31)
 
 

package/README.md

@@ -1,3 +1,8 @@
+[![GitHub star chart](https://img.shields.io/github/stars/AIGNE-io/aigne-doc-smith?style=flat-square)](https://star-history.com/#AIGNE-io/aigne-doc-smith)
+[![Open Issues](https://img.shields.io/github/issues-raw/AIGNE-io/aigne-doc-smith?style=flat-square)](https://github.com/AIGNE-io/aigne-doc-smith/issues)
+[![codecov](https://codecov.io/gh/AIGNE-io/aigne-doc-smith/graph/badge.svg?token=95TQO2NKYC)](https://codecov.io/gh/AIGNE-io/aigne-doc-smith)
+[![NPM Version](https://img.shields.io/npm/v/@aigne/core)](https://www.npmjs.com/package/@aigne/doc-smith)
+
 # AIGNE DocSmith
 
 AIGNE DocSmith is a powerful, AI-driven documentation generation tool built on the [AIGNE Framework](https://www.aigne.io/en/framework). It automates the creation of detailed, structured, and multi-language documentation directly from your source code.

package/agents/check-detail-result.mjs

@@ -1,6 +1,13 @@
 import { checkMarkdown } from "../utils/markdown-checker.mjs";
 
 export default async function checkDetailResult({ structurePlan, reviewContent, docsDir }) {
+  if (!reviewContent || reviewContent.trim() === "") {
+    return {
+      isApproved: false,
+      detailFeedback: "Review content is empty",
+    };
+  }
+
   let isApproved = true;
   const detailFeedback = [];
 

package/agents/check-detail.mjs

@@ -81,8 +81,9 @@ export default async function checkDetail(
 
   // If file exists, check content validation
   let contentValidationFailed = false;
+  let validationResult = {};
   if (detailGenerated && fileContent && structurePlan) {
-    const validationResult = await checkDetailResult({
+    validationResult = await checkDetailResult({
       structurePlan,
       reviewContent: fileContent,
       docsDir,
@@ -121,6 +122,7 @@ export default async function checkDetail(
     sourceIds,
     originalStructurePlan,
     structurePlan,
+    detailFeedback: contentValidationFailed ? validationResult.detailFeedback : "",
   });
 
   return {

package/agents/detail-regenerator.yaml

@@ -54,6 +54,9 @@ input_schema:
     feedback:
       type: string
       description: Feedback for content improvement
+    reset:
+      type: boolean
+      description: Ignore previous results and regenerate content from scratch
 output_schema:
   type: object
   properties:

package/agents/find-items-by-paths.mjs

@@ -7,7 +7,7 @@ import {
 } from "../utils/docs-finder-utils.mjs";
 
 export default async function selectedDocs(
-  { docs, structurePlanResult, boardId, docsDir, isTranslate, feedback, locale },
+  { docs, structurePlanResult, boardId, docsDir, isTranslate, feedback, locale, reset = false },
   options,
 ) {
   let foundItems = [];
@@ -101,6 +101,14 @@ export default async function selectedDocs(
   // Add feedback to all results if provided
   foundItems = addFeedbackToItems(foundItems, userFeedback);
 
+  // if reset is true, set content to null for all items
+  if (reset) {
+    foundItems = foundItems.map((item) => ({
+      ...item,
+      content: null,
+    }));
+  }
+
   return {
     selectedDocs: foundItems,
     feedback: userFeedback,

package/agents/input-generator.mjs

@@ -2,7 +2,7 @@ import { mkdir, readFile, writeFile } from "node:fs/promises";
 import { dirname, join } from "node:path";
 import chalk from "chalk";
 import { stringify as yamlStringify } from "yaml";
-import { getFilteredOptions, validateSelection } from "../utils/conflict-detector.mjs";
+import { getFilteredOptions } from "../utils/conflict-detector.mjs";
 import {
   DEPTH_RECOMMENDATION_LOGIC,
   DOCUMENT_STYLES,
@@ -63,7 +63,7 @@ export default async function init(
       if (input.length === 0) {
         return "Please select at least one purpose.";
       }
-      return validateSelection("documentPurpose", input);
+      return true;
     },
   });
 
@@ -111,7 +111,7 @@ export default async function init(
       if (input.length === 0) {
         return "Please select at least one audience.";
       }
-      return validateSelection("targetAudienceTypes", input);
+      return true;
     },
   });
 

package/agents/load-sources.mjs

@@ -19,6 +19,7 @@ export default async function loadSources({
   boardId,
   useDefaultPatterns = true,
   lastGitHead,
+  reset = false,
 } = {}) {
   let files = Array.isArray(sources) ? [...sources] : [];
 
@@ -190,7 +191,7 @@ export default async function loadSources({
 
   // Get the last output result of the specified path
   let content;
-  if (docPath) {
+  if (docPath && !reset) {
     let fileFullName;
 
     // First try direct path matching (original format)

package/agents/save-docs.mjs

@@ -149,11 +149,7 @@ async function cleanupInvalidFiles(structurePlan, docsDir, translateLanguages, l
           message: `Deleted invalid file: ${file}`,
         });
       } catch (err) {
-        results.push({
-          path: file,
-          success: false,
-          error: `Failed to delete ${file}: ${err.message}`,
-        });
+        console.warn(`Failed to delete invalid file: ${file}, error: ${err.message}`);
       }
     }
 

package/codecov.yml

@@ -0,0 +1,15 @@
+coverage:
+  status:
+    project: #add everything under here, more options at https://docs.codecov.com/docs/commit-status
+      default:
+        # basic
+        target: auto #default
+        threshold: 0%
+        base: auto 
+comment:
+  layout: "header, changes, diff, flags, files"
+  behavior: default
+  require_changes: false
+  require_base: false
+  require_head: true
+  hide_project_coverage: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/doc-smith",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "",
   "publishConfig": {
     "access": "public"

package/prompts/content-detail-generator.md

@@ -98,6 +98,7 @@ parentId: {{parentId}}
 - 媒体资源以 markdown 格式提供，示例：![资源描述](https://xxxx)
 - 在生成结果中以 markdown 格式展示图片
 - 根据资源描述，在上下文相关的位置，合理的展示图片，让结果展示效果更丰富
+- 为了确保媒体资源路径正确，** 只能使用 media_list 中提供媒体资源或提供远程 URL 的媒体资源 **
 
 </media_rules>
 

package/prompts/document/custom-components.md

@@ -1,3 +1,4 @@
+<custom_component>
 When generating document details, you can use the following custom components at appropriate locations based on their descriptions and functionality to enhance document presentation:
 - `<x-card>`
 - `<x-cards>`
@@ -24,7 +25,11 @@ Attribute Rules:
 -	data-href (optional): Navigation link for clicking the card or button.
 -	data-horizontal (optional): Whether to use horizontal layout.
 -	data-cta (optional): Button text (call to action).
--	Body content: Must be written within <x-card>...</x-card> children.
+-	Body content: 
+  - Must be written within <x-card>...</x-card> children.
+  - **Markdown format rendering is not supported**
+  - **Code block rendering is not supported**
+  - Only supports plain text format without styling
 
 
 ### 2. `<x-cards>` Card List Component
@@ -49,32 +54,51 @@ Attribute Rules:
     -	Or all cards should have data-image.
     -	Avoid mixing (some with icons, some with only images).
 
-
-### 3. Examples
+<good_example>
+Use plain text without any styling
+<x-card data-title="alarm()" data-icon="lucide:alarm-clock"> SIGALRM: Sent when a real-time timer has expired.  </x-card>
 
 Single card:
-
-```
 <x-card data-title="Horizontal card" data-icon="lucide:atom" data-horizontal="true">
   This is an example of a horizontal card.
 </x-card>
-```
 
 Card list (all using icons, recommended approach):
-
-```
 <x-cards data-columns="3">
   <x-card data-title="Feature 1" data-icon="lucide:rocket">Description of Feature 1.</x-card>
   <x-card data-title="Feature 2" data-icon="lucide:bolt">Description of Feature 2.</x-card>
   <x-card data-title="Feature 3" data-icon="material-symbols:rocket-outline">Description of Feature 3.</x-card>
 </x-cards>
-```
 
 Card list (all using images):
-
-```
 <x-cards data-columns="2">
   <x-card data-title="Card A" data-image="https://picsum.photos/id/10/300/300">Content A</x-card>
   <x-card data-title="Card B" data-image="https://picsum.photos/id/11/300/300">Content B</x-card>
 </x-cards>
-```
+</good_example>
+
+<bad_example>
+
+`x-card` component body does not support markdown formatting inline code block
+<x-card data-title="alarm()" data-icon="lucide:alarm-clock"> `SIGALRM`: Sent when a real-time timer has expired.  </x-card>
+
+
+`x-card` component body does not support code blocks
+<x-card data-title="ctrl_break()" data-icon="lucide:keyboard">
+Creates a listener for "ctrl-break" events.
+```rust,no_run
+use tokio::signal::windows::ctrl_break;
+
+#[tokio::main]
+async fn main() -> std::io::Result<()> {
+let mut stream = ctrl_break()?;
+stream.recv().await;
+println!("got ctrl-break");
+Ok(())
+}
+```
+</x-card>
+
+</bad_example>
+
+</custom_component>