update

gone-io · May 21, 2024 · aa10243 · aa10243
1 parent 0f80ce3
commit aa10243
Show file tree

Hide file tree

Showing 14 changed files with 89 additions and 28 deletions.
diff --git a/docs/zh/guide/README.md b/docs/zh/guide/README.md
@@ -7,11 +7,24 @@ next: ../references/
 # 开发指南
 
 ## [Gone的核心概念](./core-concept.md)
-## [Gone支持哪些方式注入？](./goner-inject.md)
-## [如何优雅使用内置Goners?](./use-inner-goner.md)
-## [通过内置Goners支持配置文件](./config.md)
-## [通过内置Goners支持数据库连接](./xorm.md)
-## [Hook函数](./hooks.md)
-## [日志输出](./logrus.md)
-## [使用traceId追踪日志](./tracer.md)
-## [自动生成Priest](./auto-gen-priest.md)
+
+## 依赖注入
+### [goner和依赖注入](./gone-and-inject)
+### [Gone支持哪些方式注入？](./goner-inject.md)
+### [对比 Gone 和 Spring 的依赖注入](./gone-vs-spring.md)
+
+## 内置模块使用
+### [如何优雅使用内置Goners?](./inner-goner.md)
+### [通过内置Goners支持配置文件](./config.md)
+### [日志输出](./logrus.md)
+### [使用traceId追踪日志](./tracer.md)
+### [通过内置Goners支持数据库连接](./xorm.md)
+### [利用redis提供分布式锁和分布式缓存](./redis)
+### [用cron表达式配置定时任务](./schedule)
+
+## 效率提升
+
+### [自动生成Priest](./auto-gen-priest.md)
+### [Hook函数](./hooks.md)
+### [错误处理](./error)
+### [单元测试](./unit-test)
diff --git a/docs/zh/guide/auto-gen-priest.md b/docs/zh/guide/auto-gen-priest.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
-prev: ./tracer
-next: ./redis
+prev: ./schedule
+next: ./hooks
 ---
 
 # 自动生成Priest

diff --git a/docs/zh/guide/config.md b/docs/zh/guide/config.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
 prev: ./inner-goner
-next: ./xorm
+next: ./logrus
 ---
 
 # 通过内置Goners支持配置文件

diff --git a/docs/zh/guide/error.md b/docs/zh/guide/error.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
-prev: ./schedule
-next: false
+prev: ./hooks
+next: ./unit-test
 ---
 
 # 错误处理

diff --git a/docs/zh/guide/goner-inject.md b/docs/zh/guide/goner-inject.md
@@ -1,6 +1,6 @@
 ---
 sidebar: auto
-prev: ./core-concept
+prev: ./gone-and-inject
 next: ./gone-vs-spring
 ---
 

diff --git a/docs/zh/guide/hooks.md b/docs/zh/guide/hooks.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
-prev: ./xorm
-next: ./logrus
+prev: ./auto-gen-priest
+next: ./error
 ---
 
 # Gone的Hook函数

diff --git a/docs/zh/guide/logrus.md b/docs/zh/guide/logrus.md
@@ -1,6 +1,6 @@
 ---
 sidebar: auto
-prev: ./hooks
+prev: ./config
 next: ./tracer
 ---
 

diff --git a/docs/zh/guide/redis.md b/docs/zh/guide/redis.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
-prev: ./auto-gen-priest
-next: ./unit-test
+prev: ./xorm
+next: ./schedule
 ---
 
 # 利用redis提供分布式锁和分布式缓存

diff --git a/docs/zh/guide/schedule.md b/docs/zh/guide/schedule.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
-prev: ./unit-test
-next: ./error
+prev: ./redis
+next: ./auto-gen-priest
 ---
 
 # 用cron表达式配置定时任务

diff --git a/docs/zh/guide/tracer.md b/docs/zh/guide/tracer.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
 prev: ./logrus
-next: ./auto-gen-priest
+next: ./xorm
 ---
 
 # 使用traceId追踪日志

diff --git a/docs/zh/guide/unit-test.md b/docs/zh/guide/unit-test.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
-prev: ./redis
-next: ./schedule
+prev: ./error
+next: false
 ---
 
 # 单元测试

diff --git a/docs/zh/guide/xorm.md b/docs/zh/guide/xorm.md
@@ -1,7 +1,7 @@
 ---
 sidebar: auto
-prev: ./config
-next: ./hooks
+prev: ./tracer
+next: ./redis
 ---
 
 # 通过内置Goners支持数据库操作

diff --git a/docs/zh/references/README.md b/docs/zh/references/README.md
@@ -8,6 +8,6 @@ next: ../goners/
 
 ## [gone辅助工具](./gone-tool.md)
 
-## [http 注入说明](./http-inject.md)
+## [HTTP 注入说明](./http-inject.md)
 
 ## [Gone对Xorm的增强](./xorm.md)
diff --git a/docs/zh/references/gone-tool.md b/docs/zh/references/gone-tool.md
@@ -38,5 +38,53 @@ GLOBAL OPTIONS:
 ```
 
 ### 生成项目
+**命令格式：**
+```bash
+gone create [-t ${template} [-m ${modName}]] ${appName}
+```
+**参数说明:**
+- `-t`: 指定模板，默认为`web`，支持的模板类型如下：
+  - web：生成空白的web项目
+  - web+mysql：生成web项目，并集成mysql
+- `-m`: 指定项目模块名称，默认为项目名
+- `appName`: 指定项目名，默认为demo
+
+例子可以参考[快速开始#Web 项目](https://goner.fun/zh/quick-start/web.html)
+
+
+### 生成Priest函数
+该命令的作用是扫描代码中的特殊注释`//go:gone`，生成一个**Priest**函数，将其标注的New函数生成的**Goner**埋葬到**Cemetery**中。
+> 关于**Priest**函数、**Goner**、**Cemetery**的详细介绍，请参考[Gone的核心概念](https://goner.fun/zh/guide/core-concept.html)。
+
+**命令格式：**
+```bash
+gone priest -s ${scanPackageDir} -p ${pkgName} -f ${funcName} -o ${outputFilePath} [-w] [--stat]
+```
+
+**参数说明:**
+- `-s`: 指定扫描的包路径，不可缺省
+- `-p`: 指定生成代码的包名，不可缺省
+- `-f`: 指定生成Priest函数的名称，不可缺省
+- `-o`: 指定生成Priest函数的输出文件路径，不可缺省
+- `-w`: 监听文件变化，自动生成，默认为`false`
+- `--stat`: 输出统计信息，默认为`false`
 
-### 生成Priest函数
+例子可以参考[自动生成Priest](https://goner.fun/zh/guide/auto-gen-priest.html)
+
+### 生成Mock代码
+该命令用于给工具**mockgen**生成的Mock代码进行处理，给mock结构体嵌入`gone.Flag`，使其mock生成的值为**Goner**。
+
+**命令格式：**
+```bash
+gone mock -f ${fromGoFile} -o ${outGoFile}
+```
+
+**参数说明:**
+- `-f`: 指定要处理的go文件路径，不可缺省
+- `-o`: 指定输出文件路径，不可缺省
+
+支持管道符号，例如：
+```bash
+mockgen -package=gin -source=../cmux/interface.go -mock_names=Server=CmuxServer -|gone mock -o cumx_Server_mock_test.go
+```
+例子可以参考[单元测试](https://goner.fun/zh/guide/unit-test.html)