✨ add .golangci.yml

Author: yuanyu90221

.golangci.yml

@@ -0,0 +1,159 @@
+run:
+  # Concurrently run upto 4
+  concurrency: 4
+  # Issue exit code
+  issues-exit-code: 1
+  # Lint tests
+  tests: true
+  # Lint timeout
+  timeout: 5m
+
+linters-settings:
+  errcheck:
+    # report about assignment of errors to blank identifier: `num, _ := strconv.Atoi(numStr)`.
+    # Such cases aren't reported by default.
+    # Default: false
+    check-blank: true
+    # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
+    # Such cases aren't reported by default.
+    # Default: false
+    check-type-assertions: true
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+  gocyclo:
+    min-complexity: 15
+  gofumpt:
+    module-path: github.com/leetcode-golang-classroom/golang-rest-api-sample
+    extra-rules: true
+  # Import statements are formatted
+  goimports:
+    local-prefixes: github.com/leetcode-golang-classroom/golang-rest-api-sample
+  gosimple:
+    checks: ["all"]
+  govet:
+    enable-all: true
+    disable:
+      - fieldalignment
+  ireturn:
+    allow:
+      - error
+  lll:
+    line-length: 160
+  misspell:
+    locale: US
+  nolintlint:
+    allow-unused: false
+    require-explanation: true
+    require-specific: true
+  prealloc:
+    simple: true
+    range-loops: true
+    for-loops: true
+  promlinter:
+    strict: true
+  revive:
+    rules:
+      - name: blank-imports
+        disabled: true
+      - name: context-as-argument
+      - name: context-keys-type
+      - name: dot-imports
+      - name: error-return
+      - name: error-strings
+      - name: error-naming
+      - name: exported
+      - name: if-return
+      - name: increment-decrement
+      - name: var-naming
+      - name: var-declaration
+        disabled: true
+      - name: package-comments
+      - name: range
+      - name: receiver-naming
+      - name: time-naming
+      - name: unexported-return
+      - name: indent-error-flow
+      - name: errorf
+      - name: empty-block
+      - name: superfluous-else
+      - name: unused-parameter
+      - name: unreachable-code
+      - name: redefines-builtin-id
+  staticcheck:
+    checks: ["all"]
+  stylecheck:
+    checks: ["all"]
+    http-status-code-whitelist: []
+
+linters:
+  enable:
+    - asasalint
+    - asciicheck
+    - bidichk
+    - bodyclose
+    - containedctx
+    - contextcheck
+    - dogsled
+    - dupl
+    - durationcheck
+    - errname
+    - errorlint
+    - exhaustive
+    - exportloopref
+    - forbidigo
+    - forcetypeassert
+    - goconst
+    - gocritic
+    - gocyclo
+    - godot
+    - gofumpt
+    - goimports
+    - goprintffuncname
+    - gosec
+    - interfacebloat
+    # - ireturn
+    - lll
+    - misspell
+    - nakedret
+    - nestif
+    - nilerr
+    - nilnil
+    - noctx
+    - nolintlint
+    - prealloc
+    - predeclared
+    - promlinter
+    - revive
+    - rowserrcheck
+    - sqlclosecheck
+    - stylecheck
+    - tenv
+    - testpackage
+    - thelper
+    - tparallel
+    - unconvert
+    - unparam
+    - usestdlibvars
+    - wastedassign
+    - whitespace
+    - wrapcheck
+
+issues:
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - bodyclose
+        - forcetypeassert
+        - goconst
+        - ireturn
+        - dupl
+        - containedctx
+  include:
+    - EXC0012
+    - EXC0014
+  fix: true

cmd/main.go

@@ -19,7 +19,7 @@ func main() {
 		},
 	))
 	rootContext := context.WithValue(context.Background(), mlog.CtxKey{}, logger)
-	app := application.New(config.AppConfig, rootContext)
+	app := application.New(rootContext, config.AppConfig)
 	ctx, cancel := signal.NotifyContext(rootContext, os.Interrupt, syscall.SIGTERM, syscall.SIGINT)
 	defer cancel()
 	err := app.Start(ctx)

interanl/application/app.go

@@ -7,31 +7,35 @@ import (
 	"time"
 
 	"github.com/gin-gonic/gin"
+
 	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/config"
 	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/logger"
 )
 
-// define app dependency
+// App define app dependency.
 type App struct {
 	Router *gin.Engine
-	config *config.Config
+	cfg    *config.Config
 }
 
-func New(config *config.Config, ctx context.Context) *App {
+// New - app constructor.
+func New(ctx context.Context, cfg *config.Config) *App {
 	app := &App{
-		config: config,
+		cfg: cfg,
 	}
 	app.SetupRoutes(ctx)
 	return app
 }
 
+// Start - app 啟動.
 func (app *App) Start(ctx context.Context) error {
-	logger := logger.FromContext(ctx)
+	log := logger.FromContext(ctx)
 	server := &http.Server{
-		Addr:    fmt.Sprintf(":%s", app.config.Port),
-		Handler: app.Router,
+		Addr:              fmt.Sprintf(":%s", app.cfg.Port),
+		Handler:           app.Router,
+		ReadHeaderTimeout: time.Minute,
 	}
-	logger.Info(fmt.Sprintf("Starting server on %s", app.config.Port))
+	log.Info(fmt.Sprintf("Starting server on %s", app.cfg.Port))
 	errCh := make(chan error, 1)
 	go func() {
 		err := server.ListenAndServe()
@@ -45,9 +49,13 @@ func (app *App) Start(ctx context.Context) error {
 	case err := <-errCh:
 		return err
 	case <-ctx.Done():
-		logger.Info("server cancel")
-		timeout, cancel := context.WithTimeout(context.Background(), time.Second*10)
+		log.Info("server cancel")
+		timeout, cancel := context.WithTimeout(ctx, time.Second*10)
 		defer cancel()
-		return server.Shutdown(timeout)
+		err := server.Shutdown(timeout)
+		if err != nil {
+			return fmt.Errorf("%w", err)
+		}
+		return nil
 	}
 }

interanl/application/route.go

@@ -5,14 +5,15 @@ import (
 	"net/http"
 
 	"github.com/gin-gonic/gin"
+	sloggin "github.com/samber/slog-gin"
+
 	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/logger"
 	"github.com/leetcode-golang-classroom/golang-rest-api-sample/interanl/services/news"
-	sloggin "github.com/samber/slog-gin"
 )
 
-// define route
+// SetupRoutes - define route.
 func (app *App) SetupRoutes(ctx context.Context) {
-	gin.SetMode(app.config.GinMode)
+	gin.SetMode(app.cfg.GinMode)
 	router := gin.New()
 	// recovery middleward
 	router.Use(sloggin.New(logger.FromContext(ctx)))
@@ -24,8 +25,10 @@ func (app *App) SetupRoutes(ctx context.Context) {
 	app.SetupNewsRoutes()
 }
 
+// SetupNewsRoutes - setup new routes.
 func (app *App) SetupNewsRoutes() {
 	newGroups := app.Router.Group("/news")
-	handler := news.NewHandler()
+	newsStore := news.NewNewsStore()
+	handler := news.NewHandler(newsStore)
 	handler.RegisterRoute(newGroups)
 }

interanl/config/config.go

@@ -6,11 +6,13 @@ import (
 	"github.com/spf13/viper"
 )
 
+// Config - App config.
 type Config struct {
 	Port    string `mapstructure:"PORT"`
 	GinMode string `mapstructure:"GIN_MODE"`
 }
 
+// AppConfig - global config.
 var AppConfig *Config
 
 func init() {

interanl/logger/log.go

@@ -6,8 +6,10 @@ import (
 	"os"
 )
 
+// CtxKey - struct.
 type CtxKey struct{}
 
+// CtxWithLogger - create ctx with logger.
 func CtxWithLogger(ctx context.Context, logger *slog.Logger) context.Context {
 	if logger == nil {
 		return ctx
@@ -18,6 +20,7 @@ func CtxWithLogger(ctx context.Context, logger *slog.Logger) context.Context {
 	return context.WithValue(ctx, CtxKey{}, logger)
 }
 
+// FromContext - get slog from ctx.
 func FromContext(ctx context.Context) *slog.Logger {
 	if logger, ok := ctx.Value(CtxKey{}).(*slog.Logger); ok {
 		return logger

interanl/logger/log_test.go

@@ -69,10 +69,10 @@ func Test_FromContext(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			logger := logger.FromContext(tc.ctx)
+			log := logger.FromContext(tc.ctx)
 
-			if tc.expected && logger == nil {
-				t.Errorf("expected: %v, got: %v", tc.expected, logger)
+			if tc.expected && log == nil {
+				t.Errorf("expected: %v, got: %v", tc.expected, log)
 			}
 		})
 	}

interanl/services/news/model.go

@@ -7,7 +7,8 @@ import (
 	"time"
 )
 
-type NewsPostReqBody struct {
+// PostReqBody - PostReqBody struct.
+type PostReqBody struct {
 	Author    string   `json:"author"`
 	Title     string   `json:"title"`
 	Summary   string   `json:"summary"`
@@ -17,7 +18,8 @@ type NewsPostReqBody struct {
 	Tags      []string `json:"tags"`
 }
 
-func (n NewsPostReqBody) Validate() (errs error) {
+// Validate - validate request body.
+func (n *PostReqBody) Validate() (errs error) {
 	if n.Author == "" {
 		errs = errors.Join(errs, fmt.Errorf("author is empty: %s", n.Author))
 	}

interanl/services/news/model_test.go

@@ -9,32 +9,32 @@ import (
 func TestNewsPostBody_Validate(t *testing.T) {
 	testCases := []struct {
 		name        string
-		req         news.NewsPostReqBody
+		req         news.PostReqBody
 		expectedErr bool
 	}{
 		{
 			name:        "author empty",
-			req:         news.NewsPostReqBody{},
+			req:         news.PostReqBody{},
 			expectedErr: true,
 		},
 		{
 			name: "title empty",
-			req: news.NewsPostReqBody{
+			req: news.PostReqBody{
 				Author: "test-author",
 			},
 			expectedErr: true,
 		},
 		{
 			name: "summary invalid",
-			req: news.NewsPostReqBody{
+			req: news.PostReqBody{
 				Author: "test-author",
 				Title:  "test-title",
 			},
 			expectedErr: true,
 		},
 		{
 			name: "time invalid",
-			req: news.NewsPostReqBody{
+			req: news.PostReqBody{
 				Author:    "test-author",
 				Title:     "test-title",
 				Summary:   "test-summary",
@@ -44,7 +44,7 @@ func TestNewsPostBody_Validate(t *testing.T) {
 		},
 		{
 			name: "source invalid",
-			req: news.NewsPostReqBody{
+			req: news.PostReqBody{
 				Author:    "test-author",
 				Title:     "test-title",
 				Summary:   "test-summary",
@@ -54,7 +54,7 @@ func TestNewsPostBody_Validate(t *testing.T) {
 		},
 		{
 			name: "tags is empty",
-			req: news.NewsPostReqBody{
+			req: news.PostReqBody{
 				Author:    "test-author",
 				Title:     "test-title",
 				Summary:   "test-summary",
@@ -65,7 +65,7 @@ func TestNewsPostBody_Validate(t *testing.T) {
 		},
 		{
 			name: "validate",
-			req: news.NewsPostReqBody{
+			req: news.PostReqBody{
 				Author:    "test-author",
 				Title:     "test-title",
 				Summary:   "test-summary",