golang-template 🏷

Golang project general template for me. (pkg)

Table of contents 💿

---

• golang-template 🏷
  • Table of contents 💿
  • Setup 🔌
    • Setup by Command
    • Setup on GitHub
  • Usage ✈️
    • Install ⚓️
    • Test 🚦
    • Pre-commit 🏊
  • Recommend ⭐⭐⭐⭐⭐️
    • Packages 📦
    • Github Workflows ⛓
      • Golang Test And Coverage
      • Autotag
      • Goreleaser
      • Github Markdown TOC
  • License 💾

---

Setup 🔌

Setup by Command

1. git clone https://github.com/yiranzai/golang-template your_awesome_project
2. Replace all strings yiranzai/golang-template in this repository to your_github_username/your_awesome_project
3. Replace all strings golang-template in this repository to your_awesome_project

Setup on GitHub

Click "Use this template" button on GitHub project page.

Usage ✈️

Something.

Install ⚓️

go get github.com/yiranzai/golang-template

Test 🚦

make test

Pre-commit 🏊

check or fix code style.

see .pre-commit-config.yaml

e.g:

• go fmt
• golines
• go mod tiny
• go vet

Install the pre-commit

pip install pre-commit
pre-commit install
vim .pre-commit-config.yaml

Recommend ⭐⭐⭐⭐⭐️

Packages 📦

• github.com/spf13/cobra powerful modern CLI
• github.com/spf13/viper Go configuration with fangs
• github.com/stretchr/testify Go code (golang) set of packages that provide many tools for testifying that your code will behave as you intend.

Github Workflows ⛓

This repo used some workflows

Golang Test And Coverage

Golang Test And Coverage upload to Codecov

Autotag

Automatically increment version tags to a git repo based on commit messages.

Goreleaser

GitHub Action for GoReleaser

Github Markdown TOC

This Github Markdown TOC fork for @ekalinin's Github Markdown TOC.

I Added flags to support for more features.

See ekalinin/github-markdown-toc#110 and ekalinin/github-markdown-toc#115

--all Find all Markdown files for non-hidden folders
--auto Ignore ts/te tags, Automatically at the end/head of the file
--head The TOC is generated in the header of the file, requires --auto

License 💾

This project is licensed under the MIT License. See the LICENSE file for the full license text.