Bodyguards is a collection of Go tools for improving the quality and performance of your Go code. The bodyguards keep your code safe from bugs and help you write more idiomatic, functional Go code. This project is inspired by Go Report Card.
To install Bodyguards, run the following command:
go install github.com/Goodnessuc/bodyguards@latestNext, run the bodyguards init command to initialize bodyguards for your project.
bodyguards initThe bodyguards init command will automatically create a boyguards.yaml file in your project's root directory (the
directory where there's a go.mod file).
To use any of the bodyguards tools, run the following command:
bodyguards [command] [path]The path is the path to the Go source code that you want to analyze. If no path is specified, the entire package will
be analyzed or fixed.
The configuration file is a YAML file where you can specify options for Bodyguards. Here are some available options:
linter: Lint your Go code withgolangci-lint.architecture: Set up the file architecture for your program following one of the popular architectural patterns.report: Generate a comprehensive report and rating of your project usingGo Report Card.documentation: Generate the documentation for your project withGodoc.
Here's the contents of an example bodyguards.yaml file
run:
architecture: clean # File architecture options
enable: # enable features
- linter
- report
- godocumentation
Once you've selected the configuration options for your app; You can use the run command to run bodyguards to
analyze/fix code errors with the specified options.
bodyguards run Additionally, You can generate a comprehensive report of the fixes/issues in your project with the report command
bodyguards report If you would like to contribute to this project, please feel free to fork the repository and submit a pull request.
This project is licensed under the MIT License.