Add format-go boilerplate

src/gabo/internal/generator/all_options.go

@@ -10,6 +10,11 @@ import (
 type Option string
 
 const (
+	_BuildAndroid Option = "build-android"
+	_BuildDocker  Option = "build-docker"
+
+	_FormatGo Option = "format-go"
+
 	_LintAndroid     Option = "lint-android"
 	_LintDocker      Option = "lint-docker"
 	_LintGo          Option = "lint-go"
@@ -19,8 +24,6 @@ const (
 	_LintSolidity    Option = "lint-solidity"
 	_LintYaml        Option = "lint-yaml"
 
-	_BuildAndroid     Option = "build-android"
-	_BuildDocker      Option = "build-docker"
 	_TranslateAndroid Option = "translate-android"
 
 	// _LintHtml     Option   = "lint-html"
@@ -32,11 +35,11 @@ const (
 )
 
 var _options = []Option{
-	_TranslateAndroid,
-
 	_BuildAndroid,
 	_BuildDocker,
 
+	_FormatGo,
+
 	_LintAndroid,
 	_LintDocker,
 	_LintGo,
@@ -45,6 +48,8 @@ var _options = []Option{
 	_LintShellScript,
 	_LintSolidity,
 	_LintYaml,
+
+	_TranslateAndroid,
 }
 
 func GetOptions() []string {
@@ -67,6 +72,12 @@ func IsValid(val string) bool {
 // repoDir is root dir of the repository
 func (option Option) getOutputFileName(repoDir string) string {
 	switch option {
+	case _BuildAndroid:
+		return getPath(repoDir, "build-android.yaml")
+	case _BuildDocker:
+		return getPath(repoDir, "build-docker.yaml")
+	case _FormatGo:
+		return getPath(repoDir, "format-go.yaml")
 	case _LintAndroid:
 		return getPath(repoDir, "lint-android.yaml")
 	case _LintDocker:
@@ -84,10 +95,6 @@ func (option Option) getOutputFileName(repoDir string) string {
 	case _LintYaml:
 		return getPath(repoDir, "lint-yaml.yaml")
 
-	case _BuildAndroid:
-		return getPath(repoDir, "build-android.yaml")
-	case _BuildDocker:
-		return getPath(repoDir, "build-docker.yaml")
 	case _TranslateAndroid:
 		return getPath(repoDir, "translate-android.yaml")
 	default:
@@ -98,6 +105,12 @@ func (option Option) getOutputFileName(repoDir string) string {
 
 func (option Option) getYamlConfig(repoDir string) (*string, error) {
 	switch option {
+	case _BuildAndroid:
+		return generateBuildAndroidYaml(repoDir)
+	case _BuildDocker:
+		return generateBuildDockerYaml(repoDir)
+	case _FormatGo:
+		return &_formatGoYaml, nil
 	case _LintAndroid:
 		return &_lintAndroidYaml, nil
 	case _LintDocker:
@@ -115,10 +128,6 @@ func (option Option) getYamlConfig(repoDir string) (*string, error) {
 	case _LintYaml:
 		return &_lintYamlYaml, nil
 
-	case _BuildAndroid:
-		return generateBuildAndroidYaml(repoDir)
-	case _BuildDocker:
-		return generateBuildDockerYaml(repoDir)
 	case _TranslateAndroid:
 		return &_translateAndroidYaml, nil
 

src/gabo/internal/generator/data/format-go.yaml

@@ -0,0 +1,54 @@
+---
+name: Validate Go code formatting
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches: [main, master]
+    paths:
+      - "**/*.go"
+      - ".github/workflows/format-go.yaml"
+  pull_request:
+    branches: [main, master]
+    paths:
+      - "**/*.go"
+      - ".github/workflows/format-go.yaml"
+
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  validateCodeFormatGo:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    strategy:
+      matrix:
+        # Without quotes, 1.20 becomes 1.2!
+        go-version: ["1.20"]
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Go ${{ matrix.go-version }}
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      # Ref: https://github.com/actions/cache/blob/main/examples.md#go---modules
+      # Warning: This is Linux specific
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/go-build
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: Validate code formatting
+        run: |
+          gofmt -l .
+          test -z $(gofmt -l .)

src/gabo/internal/generator/yaml_embed_list.go

@@ -3,6 +3,8 @@ package generator
 import _ "embed"
 
 var (
+	//go:embed data/format-go.yaml
+	_formatGoYaml string
 	//go:embed data/lint-android.yaml
 	_lintAndroidYaml string
 	//go:embed data/lint-docker.yaml