feat: introduce air

Author: BoYanZh

.air.toml

@@ -0,0 +1,42 @@
+root = "."
+testdata_dir = "testdata"
+tmp_dir = "build/tmp"
+
+[build]
+  args_bin = ["-c", "exit"]
+  bin = "/bin/sh"
+  cmd = "make pre-dev"
+  delay = 0
+  exclude_dir = ["docs", "build"]
+  exclude_file = []
+  exclude_regex = ["_test.go"]
+  exclude_unchanged = false
+  follow_symlink = false
+  full_bin = ""
+  include_dir = []
+  include_ext = ["go", "tpl", "tmpl", "html"]
+  include_file = []
+  kill_delay = "0s"
+  log = "build-errors.log"
+  rerun = false
+  rerun_delay = 500
+  send_interrupt = false
+  stop_on_error = false
+
+[color]
+  app = ""
+  build = "yellow"
+  main = "magenta"
+  runner = "green"
+  watcher = "cyan"
+
+[log]
+  main_only = false
+  time = true
+
+[misc]
+  clean_on_exit = false
+
+[screen]
+  clear_on_rebuild = false
+  keep_scroll = true

.github/workflows/codeql.yml

@@ -1,3 +1,4 @@
+---
 # For most projects, this workflow file will not need changing; you simply need
 # to commit it to your repository.
 #
@@ -9,44 +10,44 @@
 # the `language` matrix defined below to confirm you have the correct set of
 # supported CodeQL languages.
 #
-name: "CodeQL"
+name: CodeQL
 
 on:
-  push:
-    branches: [ "master" ]
-  pull_request:
+    push:
+        branches: [master]
+    pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ "master" ]
-  schedule:
-    - cron: '16 20 * * 2'
+        branches: [master]
+    schedule:
+        - cron: 16 20 * * 2
 
 jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
+    analyze:
+        name: Analyze
+        runs-on: ubuntu-latest
+        permissions:
+            actions: read
+            contents: read
+            security-events: write
 
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'go' ]
+        strategy:
+            fail-fast: false
+            matrix:
+                language: [go]
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Use only 'java' to analyze code written in Java, Kotlin or both
         # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
         # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
+            - name: Initialize CodeQL
+              uses: github/codeql-action/init@v2
+              with:
+                  languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
         # By default, queries listed here will override any specified in a config file.
         # Prefix the list here with "+" to use these queries and those in the config file.
@@ -57,8 +58,8 @@ jobs:
 
     # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+            - name: Autobuild
+              uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -70,7 +71,7 @@ jobs:
     #     echo "Run, Build Application using script"
     #     ./location_of_script_within_repo/buildscript.sh
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
-      with:
-        category: "/language:${{matrix.language}}"
+            - name: Perform CodeQL Analysis
+              uses: github/codeql-action/analyze@v2
+              with:
+                  category: /language:${{matrix.language}}

Dockerfile

@@ -12,12 +12,12 @@ COPY . .
 
 # Set necessary environment variables needed for our image and build the API server.
 ENV CGO_ENABLED=0 GOOS=linux GOARCH=amd64
-RUN go build -ldflags="-s -w" -o apiserver .
+RUN go build -ldflags="-s -w" -o go-horse .
 
 FROM scratch
 
 # Copy binary and config files from /build to root folder of scratch container.
-COPY --from=builder ["/build/apiserver", "/"]
+COPY --from=builder ["/build/go-horse", "/"]
 
 ENV HOST="localhost" \
     PORT=34764 \
@@ -26,4 +26,4 @@ ENV HOST="localhost" \
 EXPOSE $PORT
 
 # Command to run when starting the container.
-ENTRYPOINT ["/apiserver"]
+ENTRYPOINT ["/go-horse"]

Makefile

@@ -1,38 +1,44 @@
-.PHONY: all dev clean pre-commit test build swag pre-dev
+.PHONY: all dev pre-dev clean pre-commit install-dev test build swag
 
 APP_NAME = go-horse
 BUILD_DIR = $(PWD)/build
 
 all: dev
 
 dev:
-	DEBUG=1 fiber dev -p "make pre-dev" -D docs -e go -e env
+	mkdir -p build
+	air
 
 pre-dev: swag
 	go mod tidy
+	make build
+	docker cp ./build/go-horse joj2-go-horse:/go-horse
+	docker restart joj2-go-horse
+	docker logs -f joj2-go-horse
 
 clean:
 	rm -rf ./build
 
 pre-commit:
 	pre-commit run --all-files
 
-pre-commit-install:
+install-dev:
+	go install github.com/swaggo/swag/cmd/swag@latest
+	go install github.com/cosmtrek/air@latest
 	python3 -m pip install -U pre-commit
 	go install golang.org/x/tools/cmd/goimports@latest
 	go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
 	pre-commit install
 
-test: clean critic
+test: clean
 	go test -v -timeout 30s -coverprofile=cover.out -cover ./...
 	go tool cover -func=cover.out
 
-build: test
-	CGO_ENABLED=0 go build -ldflags="-w -s" -o $(BUILD_DIR)/$(APP_NAME) main.go
+build:
+	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w" -o $(BUILD_DIR)/$(APP_NAME) .
 
 run: swag build
 	$(BUILD_DIR)/$(APP_NAME)
 
 swag:
 	swag init
-	pre-commit run --files ./docs/swagger.* || true

README.md

@@ -1,12 +1,14 @@
 # Go-Horse
 
-## Install `pre-commit` (Run Once)
+## Install Dev Deps (Run Once)
+
+Make sure `$(go env GOPATH)/bin` is in your `$PATH`.
 
 ```bash
-$ make pre-commit-install
+$ make install-dev
 ```
 
-## Run
+## Development (With joj-deploy-lite started)
 
 ```bash
 $ make dev