Initial commit

Author: jrbeverly

.bazelrc

@@ -0,0 +1,2 @@
+build --stamp --workspace_status_command=./bazel/scripts/stamp.bash
+test --test_output=all

.gitignore

@@ -0,0 +1,31 @@
+.idea
+.vscode
+bazel-*
+
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+*.o
+*.a
+*.so
+
+# Folders
+_obj
+_test
+
+# Architecture specific extensions/prefixes
+*.[568vq]
+[568vq].out
+
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+
+_testmain.go
+
+*.exe
+*.test
+*.prof
+
+app
+debug

.gitpod.yml

@@ -0,0 +1,22 @@
+# ports:
+#   - port: 8080
+#     onOpen: open-preview
+
+checkoutLocation: "go/src/github.com/jrbeverly/golang-gin-consignment"
+workspaceLocation: "go/src/github.com/jrbeverly/golang-gin-consignment"
+
+image:
+  file: .gitpod/Dockerfile
+
+# tasks:
+#   - init: >
+#       go build -o app
+#     command: >
+#       ./app
+ 
+vscode:
+  extensions:
+    - golang.go
+    - ms-azuretools.vscode-docker
+    - bazelbuild.vscode-bazel
+    - hashicorp.terraform

.gitpod/Dockerfile

@@ -0,0 +1,14 @@
+FROM gitpod/workspace-full
+USER root
+
+RUN mkdir $HOME/bin
+RUN npm install -g @bazel/bazelisk
+RUN npm install -g @bazel/ibazel
+
+ARG BAZEL_BUILDTOOLS_URL="https://github.com/bazelbuild/buildtools/releases/download"
+RUN curl -sSL "${BAZEL_BUILDTOOLS_URL}/5.1.0/buildozer-linux-amd64" > /usr/local/bin/buildozer && \
+    curl -sSL "${BAZEL_BUILDTOOLS_URL}/5.1.0/buildifier-linux-amd64" >  /usr/local/bin/buildifier && \
+    chmod +x /usr/local/bin/buildozer && \
+    chmod +x /usr/local/bin/buildifier 
+
+USER gitpod

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch",
+            "type": "go",
+            "request": "launch",
+            "mode": "debug",
+            "program": "${workspaceFolder}"
+        }
+    ]
+}

BUILD.bazel

@@ -0,0 +1,20 @@
+load("@bazel_gazelle//:def.bzl", "gazelle")
+
+# gazelle:prefix github.com/jrbeverly/cobra-cmd-with-docs
+gazelle(name = "gazelle")
+
+gazelle(
+    name = "gazelle-update-repos",
+    args = [
+        "-from_file=go.mod",
+        "-to_macro=bazel/go/deps.bzl%go_dependencies",
+        "-prune",
+    ],
+    command = "update-repos",
+)
+
+filegroup(
+    name = "templates",
+    srcs = glob(["templates/*"]),
+    visibility = ["//visibility:public"],
+)

Makefile

@@ -0,0 +1,25 @@
+.DEFAULT_GOAL:=all
+SHELL:=/bin/bash
+
+.PHONY: run
+run: ## Invoke the executable
+	bazel run //cmd/cobradocs -- server
+	# -- $(PWD)/cmd/golang-jsonschema/toolchain.yaml $(PWD)/cmd/golang-jsonschema/toolchain.json
+
+.PHONY: all build test generate
+all: build test ## Build & test all targets
+
+build: ## Build all targets
+	bazel build //...
+
+test: ## Test all targets
+	bazel test //...
+
+generate: ## Generate the models
+	bazel run //:gazelle
+	bazel run //:gazelle-update-repos
+	bazel run //:gazelle
+
+.PHONY: help
+help: ## Display this help message
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

README.md

@@ -0,0 +1,20 @@
+# Golang Gin & Gitpod
+
+Fiddling with the Dev experience of Golang gin within Gitpod
+
+Based on [gitpod-io/go-gin-app](https://github.com/gitpod-io/go-gin-app)
+
+## Notes
+
+- Prefer the pattern of combining this with cobra
+- Server rendered HTML is pretty straightforward
+- Returning simple JSON pretty straightforward
+- Can be combined with GRPC + Proto
+- What about swagger for generating the modules?
+- Considerations about how to organize the elements (cli, server, routes, models, database, etc)
+- What about logging for this?
+- Gitpod has occassionally issues with the import of gin
+- References for things like `templates/` at the top level is nice
+- Log while running is excellent
+
+Overall positive.

WORKSPACE

@@ -0,0 +1,30 @@
+workspace(name = "golang-gin-consignment")
+
+load("//:bazel/rules/deps.bzl", "bazel_dependencies")
+
+bazel_dependencies()
+
+load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
+load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")
+load("//:bazel/go/deps.bzl", "BAZEL_GOLANG_VERSION", "go_dependencies")
+
+# gazelle:repository_macro bazel/go/deps.bzl%go_dependencies
+go_dependencies()
+
+go_rules_dependencies()
+
+go_register_toolchains(version = BAZEL_GOLANG_VERSION)
+
+gazelle_dependencies()
+
+load("@rules_pkg//:deps.bzl", "rules_pkg_dependencies")
+
+rules_pkg_dependencies()
+
+load("@io_bazel_rules_docker//repositories:repositories.bzl", container_repositories = "repositories")
+
+container_repositories()
+
+load("@io_bazel_rules_docker//go:image.bzl", _go_image_repos = "repositories")
+
+_go_image_repos()