AGENTS.md: no direct commits to main, all changes via feature branches

internal/healthcheck/healthcheck.go

@@ -1,3 +1,4 @@
+// Package healthcheck provides health status reporting for the server.
 package healthcheck
 
 import (
@@ -12,51 +13,57 @@ import (
 	"go.uber.org/fx"
 )
 
+// HealthcheckParams defines the dependencies for creating a Healthcheck.
 type HealthcheckParams struct {
 	fx.In
+
 	Globals  *globals.Globals
 	Config   *config.Config
 	Logger   *logger.Logger
 	Database *db.Database
 }
 
+// Healthcheck tracks server uptime and provides health status.
 type Healthcheck struct {
+	// StartupTime records when the server started.
 	StartupTime time.Time
-	log         *slog.Logger
-	params      *HealthcheckParams
+
+	log    *slog.Logger
+	params *HealthcheckParams
 }
 
+// New creates a new Healthcheck instance.
 func New(lc fx.Lifecycle, params HealthcheckParams) (*Healthcheck, error) {
 	s := new(Healthcheck)
 	s.params = &params
 	s.log = params.Logger.Get()
 
 	lc.Append(fx.Hook{
-		OnStart: func(ctx context.Context) error {
+		OnStart: func(_ context.Context) error {
 			s.StartupTime = time.Now()
+
 			return nil
 		},
-		OnStop: func(ctx context.Context) error {
+		OnStop: func(_ context.Context) error {
 			return nil
 		},
 	})
+
 	return s, nil
 }
 
+// HealthcheckResponse is the JSON response returned by the health endpoint.
 type HealthcheckResponse struct {
 	Status        string `json:"status"`
 	Now           string `json:"now"`
-	UptimeSeconds int64  `json:"uptime_seconds"`
-	UptimeHuman   string `json:"uptime_human"`
+	UptimeSeconds int64  `json:"uptimeSeconds"`
+	UptimeHuman   string `json:"uptimeHuman"`
 	Version       string `json:"version"`
 	Appname       string `json:"appname"`
-	Maintenance   bool   `json:"maintenance_mode"`
-}
-
-func (s *Healthcheck) uptime() time.Duration {
-	return time.Since(s.StartupTime)
+	Maintenance   bool   `json:"maintenanceMode"`
 }
 
+// Healthcheck returns the current health status of the server.
 func (s *Healthcheck) Healthcheck() *HealthcheckResponse {
 	resp := &HealthcheckResponse{
 		Status:        "ok",
@@ -66,5 +73,10 @@ func (s *Healthcheck) Healthcheck() *HealthcheckResponse {
 		Appname:       s.params.Globals.Appname,
 		Version:       s.params.Globals.Version,
 	}
+
 	return resp
 }
+
+func (s *Healthcheck) uptime() time.Duration {
+	return time.Since(s.StartupTime)
+}