feat(golang): create barebones golang project

Makefile

@@ -21,6 +21,10 @@ blank:
 	@$(MAKE) .create DIRECTORY=blank
 .PHONY: blank
 
+golang:
+	@$(MAKE) .create DIRECTORY=golang
+.PHONY: golang
+
 golang-cobra:
 	@$(MAKE) .create DIRECTORY=golang-cobra
 .PHONY: golang-cobra

golang/README.md

@@ -0,0 +1,8 @@
+# Golang
+
+Barebones Golang starter project. This is typically used for libraries rather
+than Golang projects which will be released as standalone applications.
+
+```shell
+make golang
+```

golang/cookiecutter.json

@@ -0,0 +1,6 @@
+{
+  "project_name": null,
+  "description": "Barebones Golang starter project",
+  "author": "Simon Emms <[email protected]>",
+  "repo": "github.com/mrsimonemms/{{ cookiecutter.project_name | lower | replace(' ', '-') }}"
+}

golang/hooks/post_gen_project.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+go mod init "{{ cookiecutter.repo }}"
+git init -b main
+git add .
+git commit -m "chore: initial commit"

golang/{{ cookiecutter.project_name }}/.commitlintrc.yaml

@@ -0,0 +1,2 @@
+extends:
+  - "@commitlint/config-conventional"

golang/{{ cookiecutter.project_name }}/.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+  "name": "devcontainer",
+  "image": "ghcr.io/mrsimonemms/devcontainers/full",
+  "features": {
+    "ghcr.io/guiyomh/features/goreleaser:0": {}
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-vscode.makefile-tools",
+        "golang.go"
+      ],
+      "settings": {}
+    }
+  },
+  "postCreateCommand": {
+    "bootstrap": "ln -s $PWD/.cobra.yaml $HOME/.cobra.yaml && if [ ! -f \"go.mod\" ]; then go mod init \"{{ cookiecutter.repo }}\"; fi && if [ ! -f \"main.go\" ]; then cobra-cli init && go mod tidy; fi"
+  },
+  "containerEnv": {
+    "GIT_REPO": "{{ cookiecutter.repo }}"
+  }
+}

golang/{{ cookiecutter.project_name }}/.editorconfig

@@ -0,0 +1,18 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.go]
+indent_style = tab
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+indent_size = 4

golang/{{ cookiecutter.project_name }}/.github/workflows/build.yml

@@ -0,0 +1,53 @@
+name: Build
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+permissions:
+  contents: write
+  packages: write
+  pull-requests: read
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: '{{ "${{ secrets.GITHUB_TOKEN }}" }}'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # fetch-depth is required
+
+      - uses: wagoid/commitlint-github-action@v6
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Required for pre-commit to be able scan history
+
+      - name: Set up Go
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: go.mod
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+
+      - name: Install dependencies
+        run: go install ./...
+
+      - name: go-vet
+        run: go vet -v ./...
+
+      - name: go-test
+        run: go test -v ./...
+
+      - uses: pre-commit/[email protected]

golang/{{ cookiecutter.project_name }}/.gitignore

@@ -0,0 +1,10 @@
+dist
+tmp
+
+node_modules
+
+.idea
+.DS_Store
+Thumbs.db
+.envrc
+go.work.sum

golang/{{ cookiecutter.project_name }}/.licenserc.yaml

@@ -0,0 +1,23 @@
+header:
+  license:
+    spdx-id: Apache-2.0
+    copyright-owner: "{{ cookiecutter.author }}"
+    copyright-year: {% now 'utc', '%Y' %}
+  paths-ignore:
+    - dist
+    - tmp
+    - LICENSE
+    - .*
+    - "go.*"
+    - "**/*.{json,md,yml,yaml}"
+    - "**/.gitkeep"
+  comment: on-failure
+  language:
+    Go:
+      extensions:
+        - ".go"
+      comment_style_id: SlashAsterisk
+
+dependency:
+  files:
+    - go.mod # If this is a Go project.

golang/{{ cookiecutter.project_name }}/.markdownlint.json

@@ -0,0 +1,12 @@
+{
+  "MD007": {
+    "indent": 2
+  },
+  "MD013": {
+    "code_blocks": false,
+    "tables": false
+  },
+  "MD032": false,
+  "MD033": false,
+  "default": true
+}

golang/{{ cookiecutter.project_name }}/.pre-commit-config.yaml

@@ -0,0 +1,47 @@
+repos:
+  - repo: https://github.com/mrsimonemms/pre-commit-hooks
+    rev: v1.2.0
+    hooks:
+      - id: license-eye
+      - id: go-fmt-import
+      - id: go-vet
+      - id: gofumpt
+      - id: go-err-check
+      - id: go-static-check
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: pretty-format-json
+        args:
+          - --autofix
+          - --no-sort-keys
+      - id: check-json
+      - id: check-yaml
+        args:
+          - --allow-multiple-documents
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v3.2.0
+    hooks:
+      - id: conventional-pre-commit
+        stages:
+          - commit-msg
+  - repo: https://github.com/trussworks/pre-commit-hooks
+    rev: v1.1.1
+    hooks:
+      - id: markdown-toc
+  - repo: https://github.com/DavidAnson/markdownlint-cli2
+    rev: v0.13.0
+    hooks:
+      - id: markdownlint-cli2
+  - repo: https://github.com/golangci/golangci-lint
+    rev: v1.58.2
+    hooks:
+      - id: golangci-lint
+  - repo: https://github.com/mrsimonemms/toodaloo
+    rev: v0.2.2
+    hooks:
+      - id: scan

golang/{{ cookiecutter.project_name }}/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "editor.formatOnSave": true,
+  "editor.rulers": [
+    80
+  ],
+  "yaml.schemas": {
+    "https://json.schemastore.org/github-workflow.json": [
+      ".github/workflows/*.{yml,yaml}"
+    ]
+  }
+}

golang/{{ cookiecutter.project_name }}/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.