Documentation
¶
Overview ¶
Package extract 提供从 Go 源码中提取本地化内容的功能
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Options ¶ added in v0.20.0
type Options struct {
// Language 提取的内容以此值作为本地化的 ID 保存
Language language.Tag
// 读取的根目录
//
// 需要位于一个 Go 的模块中。
Root string
// 是否读取子目录的内容
Recursive bool
// 忽略子模块
//
// 当 Recursive 为 true 时,此值为 true,可以不读取子模块的内容。
SkipSubModule bool
// 警告日志通道
//
// 默认为输出到终端。
WarnLog message.LogFunc
// 普通信息日志通道
//
// 主要报告提取的进度,如果为空,则不输出内容。
InfoLog message.LogFunc
// 用于提取本地化内容的函数列表
//
// 每个元素的格式为:
// mod/path[.type].func
//
// mod/path 为包的导出路径;
//
// type 为类型名称,可以省略;
//
// func 为用于实现本地化的调用,可能是与 type 关联的方法
// 或是无 type 的函数还有可能是简单的类型转换。
// func 至少需要一个参数,且其第一个参数的类型必须为 string。
//
// 能正确识别别名,比如:
// type x = localeutil.Printer
// 当在 Funcs 指定了 github.com/issue9/localeutil.Printer 时,也会识别 x。
//
// 如果指定的是接口类型的方法,在提取时不会主动判断是否实现了该接口,
// 必须在代码中明确为该接口类型的方法才会被提取:
// var p PrinterInterface = &Printer{}
// p.Printf(...) // 正常提取内容
// var p = &Printer{}
// p.Printf(...) // 即使 Printer 实现了 PrinterInterface 接口,也不会提取内容。
//
// 如果为空将不输出任何内容,格式错误将会触发 panic。
Funcs []string
// 指定用于提取 struct tag 中的特定内容作为翻译项
Tag string
}
Click to show internal directories.
Click to hide internal directories.