介绍
generator-golang-boilerplate 是一个适用于 Golang 项目的脚手架生成器，可以快速搭建出一个基于若干个模块的 Golang 项目，并包含了基本的测试、文档生成、代码格式化、代码发布等功能。
安装
使用 npm 命令进行全局安装：
npm install -g generator-golang-boilerplate
用法
首先要确保通过 Go 安装 golangci-lint，否则代码格式化功能无法使用。
生成器的使用方法如下：
生成器会在当前目录下创建一个以项目名称命名的文件夹，并生成脚手架代码。
包结构
在使用完成后，生成器会自动生成一个类似如下结构的项目：
-- -------------------- ---- ------- --- --- - --- ------- --- ------ - --- --------- - --- -------------- --- -------- - --- --- - - --- ------ - - --- ----------- - - --- ------------- - - --- ------------------ - --- ---------- - - --- ------------- - - --- ------------------ - - --- ------------------- - - --- ---------- - - --- ---------- - --- ------- - - --- ---------- - - --- --------------- - --- ----- - --- -------- - --- ------------- --- --- - --- --- - - --- ------ - --- ----- - - --- -------- - - --- ------------- - --- ------- - --- ---------- - --- --------------- --- ---------- --- -------- --- --------- --- ------ --- ------ --- ---------- --- ---------- --- ------- --- -------- - --- ---------- - --- ---------- --- ------
功能
脚手架生成器提供了如下功能：
1. 测试
生成器自带了基本的单元测试、集成测试及测试覆盖率风格文件，并且可以使用 go test 命令来运行所有测试用例。
2. 代码格式化
脚手架生成器会在代码提交前进行代码格式化，并且支持使用 gofmt 和 golangci-lint 来对代码进行自动格式化和检查。
3. 文档生成
生成器提供了基于 godoc 的文档自动生成功能，可以自动生成所有 Go 代码的文档。在项目根目录下运行 godoc -http=:6060，就可以查看整个项目的文档信息。
4. 代码构建和发布
使用脚手架生成器，可以方便地使用 Makefile 构建和发布代码，支持一键发布代码到 Github 和 Docker Hub 等平台。
总结
通过使用 generator-golang-boilerplate，可以方便快捷地搭建一个 Golang 项目脚手架，并且支持基本的测试、文档生成、代码格式化、代码发布等功能，为 Golang 项目开发提供了很大的便利。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055eb181e8991b448dc50f