fix: export package desc to markdown

Author: AsterDY

README.md

@@ -89,6 +89,7 @@ You can stop the process at anytime after step 2. You can restart the compressin
 5. Export the compressed results
 ```
 cargo run --bin cmd export https://xxx.git --out-dir {OUTPUT_DIR}
+```
 
 # Status Update
 

script/make_parser.sh

@@ -15,11 +15,6 @@
 
 root=$(dirname $(realpath $(dirname $0)))
 
-# # make go_ast
-# cd $root/src/compress/golang/plugin
-# go build -o ../../../../tools/parser/go_ast .
-
-
 # make lang
 cd $root/src/lang
 go build -o ../../tools/parser/lang .

src/bin/cmd.rs

@@ -59,7 +59,7 @@ compress: compress the repo. Including flags:
     --force-update-ast: force parsing repo and merge the previous result 
     --not-load-external-symbol: not load external external symbols to speed up parsing
     --no-need-comment: not need comment in symbol content (only works for Go now)
-export: export the compress result to csv or markdown (default). Including flags:
+export: export the result to csv or markdown (default). Including flags:
     --csv: export the compress result to csv
     --out-dir <path>: output directory path, default is $WORK_DIR
     --public-only: only export the public symbols

src/export.rs

@@ -198,6 +198,9 @@ pub fn to_markdown(repo: &Repository, opts: &ExportOptions) -> String {
         for (pkg_name, pkg) in module.packages.iter() {
             // 添加包标题
             md.push_str(&format!("## {}\n\n", pkg_name));
+            if let Some(data) = &pkg.compress_data {
+                md.push_str(&format!("{}\n\n", data));
+            }
 
             // 添加函数
             for (func_name, func) in pkg.functions.iter() {
@@ -207,7 +210,7 @@ pub fn to_markdown(repo: &Repository, opts: &ExportOptions) -> String {
 
                 md.push_str(&format!("### {}\n\n", func_name));
                 if let Some(data) = &func.compress_data {
-                    md.push_str(&format!("- Description\n\n{}\n\n", data));
+                    md.push_str(&format!("{}\n\n", data));
                 }
                 md.push_str(&format!("- Position\n\n{}:{}\n\n", func.file, func.line));
                 md.push_str(&format!(
@@ -224,7 +227,7 @@ pub fn to_markdown(repo: &Repository, opts: &ExportOptions) -> String {
 
                 md.push_str(&format!("### {}\n\n", type_name));
                 if let Some(data) = &typ.compress_data {
-                    md.push_str(&format!("- Description\n\n{}\n\n", data));
+                    md.push_str(&format!("{}\n\n", data));
                 }
                 md.push_str(&format!("- Position\n\n{}:{}\n\n", typ.file, typ.line));
                 md.push_str(&format!("- Codes\n\n```{}\n{}\n```\n\n", lang, typ.content));
@@ -238,7 +241,7 @@ pub fn to_markdown(repo: &Repository, opts: &ExportOptions) -> String {
 
                 md.push_str(&format!("### {}\n\n", var_name));
                 if let Some(data) = &var.compress_data {
-                    md.push_str(&format!("- Description\n\n{}\n\n", data));
+                    md.push_str(&format!("{}\n\n", data));
                 }
                 md.push_str(&format!("- Position\n\n{}:{}\n\n", var.file, var.line));
                 md.push_str(&format!("- Codes\n\n```{}\n{}\n```\n\n", lang, var.content));