feat: add linter to CI

Author: hsluoyz

.github/workflows/build.yml

@@ -0,0 +1,79 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+
+  go-tests:
+    name: Running Go tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.17'
+          cache-dependency-path: ./go.mod
+      - name: Tests
+        run: go test -v $(go list ./...)
+
+  frontend:
+    name: Front-end
+    runs-on: ubuntu-latest
+    needs: [ go-tests ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+          cache: 'yarn'
+          cache-dependency-path: ./web/yarn.lock
+      - name: Build
+        run: |
+          yarn install
+          GENERATE_SOURCEMAP=false SKIP_PREFLIGHT_CHECK=true npx craco build
+        working-directory: ./web
+        env:
+          CI: false
+
+  backend:
+    name: Back-end
+    runs-on: ubuntu-latest
+    needs: [ go-tests ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.17'
+          cache-dependency-path: ./go.mod
+      - run: go version
+      - name: Build
+        run: |
+          go build -race -ldflags "-extldflags '-static'"
+        working-directory: ./
+
+  linter:
+    name: Go-Linter
+    runs-on: ubuntu-latest
+    needs: [ go-tests ]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.17'
+          cache: false
+
+      # gen a dummy config file
+      - run: touch dummy.yml
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+          args: --disable-all -c dummy.yml -E=gofumpt --max-same-issues=0 --timeout 5m --modules-download-mode=mod

.gitignore

@@ -22,4 +22,9 @@ tmpFiles/
 *.tmp
 logs/
 lastupdate.tmp
-commentsRouter*.go
+commentsRouter*.go
+
+# Build artifacts
+caswaf
+web/build
+web/nul

main.go

@@ -18,7 +18,7 @@ func main() {
 		AllowCredentials: true,
 	}))
 
-	//beego.DelStaticPath("/static")
+	// beego.DelStaticPath("/static")
 	beego.SetStaticPath("/static", "web/build/static")
 	// https://studygolang.com/articles/2303
 	beego.InsertFilter("/", beego.BeforeRouter, routers.TransparentStatic) // must has this for default page

object/dataset.go

@@ -85,7 +85,7 @@ func UpdateDataset(id string, dataset *Dataset) bool {
 		panic(err)
 	}
 
-	//return affected != 0
+	// return affected != 0
 	return true
 }
 

routers/router.go

@@ -11,12 +11,11 @@ func init() {
 }
 
 func initAPI() {
-	ns :=
-		beego.NewNamespace("/api",
-			beego.NSInclude(
-				&controllers.ApiController{},
-			),
-		)
+	ns := beego.NewNamespace("/api",
+		beego.NSInclude(
+			&controllers.ApiController{},
+		),
+	)
 	beego.AddNamespace(ns)
 
 	beego.Router("/api/signin", &controllers.ApiController{}, "POST:Signin")

util/json.go

@@ -4,7 +4,7 @@ import "encoding/json"
 
 func StructToJson(v interface{}) string {
 	data, err := json.MarshalIndent(v, "", "  ")
-	//data, err := json.Marshal(v)
+	// data, err := json.Marshal(v)
 	if err != nil {
 		panic(err)
 	}

util/string.go

@@ -88,7 +88,7 @@ func ReadStringFromPath(path string) string {
 }
 
 func WriteStringToPath(s string, path string) {
-	err := ioutil.WriteFile(path, []byte(s), 0644)
+	err := ioutil.WriteFile(path, []byte(s), 0o644)
 	if err != nil {
 		panic(err)
 	}
@@ -104,7 +104,7 @@ func ReadBytesFromPath(path string) []byte {
 }
 
 func WriteBytesToPath(b []byte, path string) {
-	err := ioutil.WriteFile(path, b, 0644)
+	err := ioutil.WriteFile(path, b, 0o644)
 	if err != nil {
 		panic(err)
 	}