feat(docs): update

feat(docs): update

feat(docs): update

Author: jaronnie

cmd/new.go

@@ -29,8 +29,9 @@ import (
 
 // newCmd represents the new command
 var newCmd = &cobra.Command{
-	Use:   "new",
-	Short: `Used to create project from templates`,
+	Use:          "new",
+	Short:        `Used to create project from templates`,
+	SilenceUsage: true,
 	RunE: func(cmd *cobra.Command, args []string) error {
 		if config.C.New.Output == "" {
 			config.C.New.Output = args[0]
@@ -109,6 +110,7 @@ var newCmd = &cobra.Command{
 			base = filepath.Join("frame", "api", "app")
 		}
 
+		// 没有设置 home，则使用内置模板持久化的默认路径 ~/.jzero/templates/$version
 		if !pathx.FileExists(embeded.Home) {
 			embeded.Home = filepath.Join(home, ".jzero", "templates", Version)
 		}

config/config.go

@@ -141,6 +141,7 @@ type GenDocsConfig struct {
 }
 
 type GenCrudConfig struct {
+	// todo: add flag
 }
 
 type IvmConfig struct {

docs/src/guide/check.md

@@ -37,7 +37,7 @@ docker tag registry.cn-hangzhou.aliyuncs.com/ghcr.io/jaronnie/jzero:latest ghcr.
 
 ## 不同姿势使用 jzero
 
-:::important 必看!!!
+:::important 涨知识的小技巧
 :::
 
 * 支持通过配置文件 .jzero.yaml 控制各种参数(**强烈推荐在每个项目的根目录新建该文件**)

docs/src/guide/develop/api.md

@@ -10,23 +10,43 @@ tag:
 
 ## 前言
 
+通过 go-zero 自研的 api 文件定义, 称为 api 可描述语言, 可用于
 
+* 自动生成多语言服务端代码
+* 自动生成文档(json/html/swagger)
+* 自动生成多语言客户端代码
+
+与 proto 文件有异曲同工之妙, 但是比 proto 更简单易用
+
+[go-zero api 教程](https://go-zero.dev/docs/tutorials)
+
+![](http://oss.jaronnie.com/image-20250120232337438.png)
 
 ## api 字段校验
 
-> jzero 集成 [https://github.com/go-playground/validator](https://github.com/go-playground/validator) 进行字段校验
+> jzero 默认集成 [https://github.com/go-playground/validator](https://github.com/go-playground/validator) 进行字段校验
 
-```api
+```shell
 syntax = "v1"
 
 type CreateRequest {
     name string `json:"name" validate:"gte=2,lte=30"` // 名称
 }
 ```
 
-## api types 文件分组分文件夹
+## 将 types 文件夹按照 go_package 进行分组
+
+:::important go_package 的选项, 参考自 proto 文件, 能将 message 生成的结构体分组
+
+在 api 文件中同理, go_package 选项能将定义的 type 生成的结构体分组
+
+两大优点: 
+1. 避免默认生成的 types/types.go 爆炸
 
-```api
+2. 提升开发体验, 不同 group 下的 type 命名不会冲突
+:::
+
+```shell
 syntax = "v1"
 
 info (
@@ -36,7 +56,7 @@ info (
 
 ## 合并同一个 group 的 handler 为同一个文件
 
-```api
+```shell
 @server (
 	prefix:          /api/v1
 	group:           system/user
@@ -55,4 +75,10 @@ service simpleapi {
 
 ```shell
 jzero ivm add api --name user
+```
+
+完整命令如下:
+
+```shell
+jzero ivm add api --name user --handlers get:List,get:Get,post:Edit,get:Delete
 ```