github.com/eleztian/type2md
通过ast解析 将golang 的结构定义转化为markdown 表格。
支持将golang 的数据类型定义转化为markdown 表格
$ go install github.com/eleztian/type2md
$ type2md -h
Usage of type2md:
-f string
file path
-t string
file title
-tag string
struct tag name (default "json")
-v show version
package test
import "github.com/eleztian/type2md/test/ext"
//go:generate type2md -f ../docs/doc_config.md github.com/eleztian/type2md/test Config
// Config doc.
type Config struct {
Pre ext.Hook
Post *ext.Hook
Servers map[string]struct {
Host string `json:"host,omitempty"`
Port int `json:"port" enums:"22,65522" require:"false"`
} `json:"servers"` // server list
InlineStruct `json:",inline"` // inline struct
Slice []string // sss
MapData map[string]map[int]*OtherStruct
ArrayData [][2]string `json:"array_data"`
C []interface{} // slice interface{}
}
// InlineStruct inline struct.
type InlineStruct struct {
A string `json:"a"` // inline struct field a
}
// OtherStruct other struct
// this is use for test.
type OtherStruct struct {
A string `json:"a" require:"true" default:"default value"`
B [][2]ext.Mode `json:"b"` // array string
C map[string]interface{} `json:"c"` // map[string]interface{}
D *OtherStruct `json:"d"` // nested struct
}
执行下列命令
$ go generate ./...
2022/10/28 23:56:16 Current Module: github.com/eleztian/type2md
2022/10/28 23:56:16 start generate github.com/eleztian/type2md/test.Config
2022/10/28 23:56:16 start to save to ../docs/doc_config.md
得到下面的文档:
Config doc.
Key | Type | Require | Default | Describe |
---|---|---|---|---|
Pre | true | |||
Post | true | |||
servers.{string}.host | string | false | ||
servers.{string}.port | int | false |
| |
a | string | true | inline struct field a. | |
Slice.[] | string | true | sss. | |
MapData.{string}.{int}. | true | |||
array_data.[] .[2] | string | true | ||
C.[] | any | true | slice interface{}. |
Hook hook config.
Key | Type | Require | Default | Describe |
---|---|---|---|---|
name | string | false | example | hook name. |
commands.[] | string | true | command list. | |
envs.{string} | string | true | env key map. | |
mode | true | 1 | run mode. |
OtherStruct other struct
this is use for test.
Key | Type | Require | Default | Describe |
---|---|---|---|---|
a | string | true | default value | |
b.[] .[2] | true | array string. | ||
c.{string} | any | true | map[string] interface{}. | |
d | true | nested struct. |
Type: int
Mode mode define.
Enum Value | Describe |
---|---|
1 | mode q. |
2 | mode a. |
github.com/eleztian/type2md/test.Config
GENERATED BY THE COMMAND type2md
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。
原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。
如有侵权,请联系 cloudcommunity@tencent.com 删除。