Golang Project Boot
Although the Golang programming ecosystem is becoming more and more mature, these tools and frameworks exist independently to solve specific problems. Whenever a new Golang project is started, it requires a series of initialization; What’s worse is that whenever your switch the development environment, same process have to be repeated! This project is built to solve this problem by providing a tool named gbc*, which is similar to Maven or Gradle in the Java ecosystem together with a framework(glue) similar to SpringBoot. Please refer documents for details
- Everything is a plugin, you can use any tool you like as a plugin to customize your build process!
- Model driver SQL database DAO(data access object).
- IoC Container support via samber/do.
- Code generation for most popular frameworks scaffolding.
- Environment sensitive profile. application.yml for no-test environment and application-test.yml for test environment
- Friendly help messages
- More ....
Just likeSpringBoot, the most important part of a gob project is the configurations which define your project. There are two main configurations
- gob.yaml : it acts as the same as settings.gradle.kts( Gradle) or pom.xml(Maven), you can define any thrid party tool as a plugin in this file.
- application.yaml: it acts as the same application.yaml of SpringBoot
- Install
gbcwith below command
go install github.com/kcmvp/gob/cmd/gbc@latest- Initialize project with below command(in the project home directory)
gbc init| Git Hooks | Dependency Tree |
|---|---|
gbc takes everything defined in the gob.yaml as plugin.
flowchart TD
gbc --> gob.yaml
gob.yaml --> plugin1
gob.yaml --> plugin2
gob.yaml --> plugin3
You just need to tell gbc 3W(where,when and what)
- Where : where to download the tool
- When : when to execute to command
- What : what to do with the tool
Build Commands
Plugin Commands
Setup Commands
gbc initInitialize gbc for the project, it will do following initializations
- generate file
gob.yaml - generate file
.golangci.yaml, which is the configuration for golangci-lint - setup
git hooks(if project in the source control.)- commit-msg
- pre-commit
- pre-push
This command can be executed at any time.
Content of gob.yaml
exec:
commit-msg-hook: ^#[0-9]+:\s*.{10,}$
pre-commit-hook:
- lint
- test
pre-push-hook:
- test
plugins:
golangci-lint:
alias: lint #When : when issue `gbc lint`
args: run ./... #What: execute `golangci-lint run ./...`
url: github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.2 #Where: where to download the plugin
gotestsum:
alias: test
args: --format testname -- -coverprofile=target/cover.out ./...
url: gotest.tools/gotestsum@v1.11.0in most cases you don't need to edit the configuration manually. you can achieve this by plugin commands
gbc buildThis command would build all the candidate binaries(main methods in main packages) to the target folder.
- Final binary name is same as go source file name which contains
main method - Would fail if there are same name go main source file
gbc cleanThis command would clean target folder
gbc testThis command would run all tests for the project and generate coverage report at target/cover.html
gbc lintRun golangci-lint against project based on the configuration, a report named target/lint.log will be generated if there are any violations
gbc depsList project dependencies tree and indicate there are updates for a specific dependency
gbc plugin install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.2 lint run ./...It is an advanced version of go install, which supports multi-version.(eg:golangci-lint-v1.55.2, golangci-lint-v1.55.1)
- Install the versioned tool(just the same as
go install) - Set up the tool as plugin in
gob.yaml - You can update adjust the parameters of the plugin by editing
gob.yaml
gob plugin listList all the installed plugins
gob setup versionThis command will generate file version.go in infra folder, and project version information
will be injected into buildVersion when build the project with command gob build
// buildVersion don't change this
var buildVersion string-
When install a plugin, how to find out the url?
gob plugin installwork the same way asgo install, it take the same url asgo install. -
Just simply edit
gob.yamlfile and update the version you want.plugins: golangci-lint: alias: lint args: run ./... url: github.com/golangci/golangci-lint/cmd/golangci-lint@v1.55.2
`