go_module

A very opiniated golang module template that fits my own taste and workflow

Features

These are the things you get if you use this template:

1. Clean and structured folder layout following the conventions
2. Support for logging using aspirador
3. Support for build, share, and run with docker
4. Support for environment config with env
5. Support for different type of modules: library, cli app and web service
6. Support for CORS (in case of web service)
7. Support for request throttling (in case of web service)
8. Support for private dependencies
9. Linting with golangci-lint
10. Git Client hooks to enforce codestyle before pushing changes

Usage

mason make go_module --name <package_name> --description <package_description> --author <package_author> --type <library|cli|webService> --license <MIT|GNUGPLV3|none> --modulePath <golang_module_path> --dependabot <true|false> --openSource <true|false>

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add go_module

# Install globally
mason add -g go_module

Usage 🚀

mason make go_module

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ✅   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.26 <0.1.0"

0.1.0+1

• Release first version of go_module
• Add support for:
  • Clean and structured folder layout following the conventions
  • Support for logging using aspirador
  • Support for build, share, and run with docker
  • Support for environment config with env
  • Support for different type of modules: library, cli app and web service
  • Support for CORS (in case of web service)
  • Support for request throttling (in case of web service)
  • Support for private dependencies
  • Linting with golangci-lint
  • Git Client hooks to enforce codestyle before pushing changes

MIT License

Copyright (c) 2023 dart-pacotes

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.