style: standardize multiline formatting for functions and assertions

appleboy · appleboy · commit 6e348a9d031a · 2025-12-07T12:22:14.000+08:00
- Add golines as an additional formatter to the linter configuration
- Refactor all multi-argument function signatures to use one-argument-per-line formatting
- Improve formatting in test assertions for clarity and consistency
- Refactor groupings of tokens in notification test cases for readability
- Standardize fmt.Sprintf calls to multi-line format where arguments are long
- Make function signatures consistent across files, enhancing code readability

Signed-off-by: appleboy &lt;appleboy.tw@gmail.com&gt;
diff --git a/.golangci.yml b/.golangci.yml
@@ -42,6 +42,7 @@ formatters:
     - gofmt
     - gofumpt
     - goimports
+    - golines
   exclusions:
     generated: lax
     paths:
diff --git a/app/options.go b/app/options.go
@@ -57,7 +57,12 @@ func (o *Options) BindFlags() {
 
 	// Huawei options
 	flag.StringVar(&o.Conf.Huawei.AppSecret, "hk", "", "Huawei api key configuration for gorush")
-	flag.StringVar(&o.Conf.Huawei.AppSecret, "hmskey", "", "Huawei api key configuration for gorush")
+	flag.StringVar(
+		&o.Conf.Huawei.AppSecret,
+		"hmskey",
+		"",
+		"Huawei api key configuration for gorush",
+	)
 	flag.StringVar(&o.Conf.Huawei.AppID, "hid", "", "HMS app id configuration for gorush")
 	flag.StringVar(&o.Conf.Huawei.AppID, "hmsid", "", "HMS app id configuration for gorush")
 	flag.BoolVar(&o.Conf.Huawei.Enabled, "huawei", false, "send huawei notification")
diff --git a/app/sender.go b/app/sender.go
@@ -118,7 +118,12 @@ func SendIOSNotification(ctx context.Context, cfg *config.ConfYaml, opts CLISend
 }
 
 // SendNotification sends a notification based on platform type.
-func SendNotification(ctx context.Context, platform int, cfg *config.ConfYaml, opts CLISendOptions) error {
+func SendNotification(
+	ctx context.Context,
+	platform int,
+	cfg *config.ConfYaml,
+	opts CLISendOptions,
+) error {
 	switch platform {
 	case core.PlatFormAndroid:
 		return SendAndroidNotification(ctx, cfg, opts)
diff --git a/config/config_test.go b/config/config_test.go
@@ -202,7 +202,11 @@ func (suite *ConfigTestSuite) TestValidateConf() {
 	assert.Equal(suite.T(), "", suite.ConfGorush.Core.FeedbackURL)
 	assert.Equal(suite.T(), int64(10), suite.ConfGorush.Core.FeedbackTimeout)
 	assert.Equal(suite.T(), 1, len(suite.ConfGorush.Core.FeedbackHeader))
-	assert.Equal(suite.T(), "x-gorush-token:4e989115e09680f44a645519fed6a976", suite.ConfGorush.Core.FeedbackHeader[0])
+	assert.Equal(
+		suite.T(),
+		"x-gorush-token:4e989115e09680f44a645519fed6a976",
+		suite.ConfGorush.Core.FeedbackHeader[0],
+	)
 	assert.Equal(suite.T(), false, suite.ConfGorush.Core.SSL)
 	assert.Equal(suite.T(), "cert.pem", suite.ConfGorush.Core.CertPath)
 	assert.Equal(suite.T(), "key.pem", suite.ConfGorush.Core.KeyPath)
@@ -474,7 +478,11 @@ func TestValidateAddress(t *testing.T) {
 					return
 				}
 				if tt.errMsg != "" && !strings.Contains(err.Error(), tt.errMsg) {
-					t.Errorf("ValidateAddress() error = %v, want error containing %v", err, tt.errMsg)
+					t.Errorf(
+						"ValidateAddress() error = %v, want error containing %v",
+						err,
+						tt.errMsg,
+					)
 				}
 			} else if err != nil {
 				t.Errorf("ValidateAddress() error = %v, want nil", err)
@@ -574,7 +582,11 @@ func TestValidatePIDPath(t *testing.T) {
 					return
 				}
 				if tt.errMsg != "" && !strings.Contains(err.Error(), tt.errMsg) {
-					t.Errorf("ValidatePIDPath() error = %v, want error containing %v", err, tt.errMsg)
+					t.Errorf(
+						"ValidatePIDPath() error = %v, want error containing %v",
+						err,
+						tt.errMsg,
+					)
 				}
 			} else if err != nil {
 				t.Errorf("ValidatePIDPath() error = %v, want nil", err)
@@ -625,7 +637,11 @@ func TestValidateConfig(t *testing.T) {
 				}
 
 				if tt.errMsg != "" && !strings.Contains(err.Error(), tt.errMsg) {
-					t.Errorf("ValidateConfig() error = %v, want error containing %v", err, tt.errMsg)
+					t.Errorf(
+						"ValidateConfig() error = %v, want error containing %v",
+						err,
+						tt.errMsg,
+					)
 				}
 			} else if err != nil {
 				t.Errorf("ValidateConfig() error = %v, want nil", err)
diff --git a/logx/log.go b/logx/log.go
@@ -33,7 +33,7 @@ type LogPushEntry struct {
 
 var isTerm bool
 
-//nolint
+// nolint
 func init() {
 	isTerm = isatty.IsTerminal(os.Stdout.Fd())
 }
diff --git a/notify/feedback.go b/notify/feedback.go
@@ -34,7 +34,13 @@ func extractHeaders(headers []string) map[string]string {
 //
 // Returns:
 //   - error: An error if the request fails or the response status is not OK.
-func DispatchFeedback(ctx context.Context, log logx.LogPushEntry, url string, timeout int64, header []string) error {
+func DispatchFeedback(
+	ctx context.Context,
+	log logx.LogPushEntry,
+	url string,
+	timeout int64,
+	header []string,
+) error {
 	if url == "" {
 		return errors.New("url can't be empty")
 	}
diff --git a/notify/notification.go b/notify/notification.go
@@ -68,8 +68,8 @@ type PushNotification struct {
 	ID               string      `json:"notif_id,omitempty"`
 	To               string      `json:"to,omitempty"`
 	Topic            string      `json:"topic,omitempty"` // FCM and iOS only
-	Tokens           []string    `json:"tokens" binding:"required"`
-	Platform         int         `json:"platform" binding:"required"`
+	Tokens           []string    `json:"tokens"                      binding:"required"`
+	Platform         int         `json:"platform"                    binding:"required"`
 	Message          string      `json:"message,omitempty"`
 	Title            string      `json:"title,omitempty"`
 	Image            string      `json:"image,omitempty"`
@@ -286,7 +286,13 @@ func SendNotification(
 		}
 
 		for _, l := range logs {
-			err := DispatchFeedback(ctx, l, cfg.Core.FeedbackURL, cfg.Core.FeedbackTimeout, cfg.Core.FeedbackHeader)
+			err := DispatchFeedback(
+				ctx,
+				l,
+				cfg.Core.FeedbackURL,
+				cfg.Core.FeedbackTimeout,
+				cfg.Core.FeedbackHeader,
+			)
 			if err != nil {
 				logx.LogError.Error(err)
 			}
diff --git a/notify/notification_apns.go b/notify/notification_apns.go
@@ -59,7 +59,9 @@ type Sound struct {
 }
 
 // loadCertFromFile loads certificate or auth key from a file path.
-func loadCertFromFile(keyPath, password string) (tls.Certificate, *ecdsa.PrivateKey, string, error) {
+func loadCertFromFile(
+	keyPath, password string,
+) (tls.Certificate, *ecdsa.PrivateKey, string, error) {
 	var cert tls.Certificate
 	var authKey *ecdsa.PrivateKey
 	var err error
@@ -80,7 +82,9 @@ func loadCertFromFile(keyPath, password string) (tls.Certificate, *ecdsa.Private
 }
 
 // loadCertFromBase64 loads certificate or auth key from base64 encoded data.
-func loadCertFromBase64(keyBase64, keyType, password string) (tls.Certificate, *ecdsa.PrivateKey, string, error) {
+func loadCertFromBase64(
+	keyBase64, keyType, password string,
+) (tls.Certificate, *ecdsa.PrivateKey, string, error) {
 	var cert tls.Certificate
 	var authKey *ecdsa.PrivateKey
 
@@ -105,7 +109,10 @@ func loadCertFromBase64(keyBase64, keyType, password string) (tls.Certificate, *
 }
 
 // createAPNSClientWithToken creates an APNS client using a p8 token.
-func createAPNSClientWithToken(cfg *config.ConfYaml, authKey *ecdsa.PrivateKey) (*apns2.Client, error) {
+func createAPNSClientWithToken(
+	cfg *config.ConfYaml,
+	authKey *ecdsa.PrivateKey,
+) (*apns2.Client, error) {
 	if cfg.Ios.KeyID == "" || cfg.Ios.TeamID == "" {
 		return nil, errors.New("you should provide ios.KeyID and ios.TeamID for p8 token")
 	}
@@ -134,7 +141,11 @@ func InitAPNSClient(ctx context.Context, cfg *config.ConfYaml) error {
 	case cfg.Ios.KeyPath != "":
 		certificateKey, authKey, ext, err = loadCertFromFile(cfg.Ios.KeyPath, cfg.Ios.Password)
 	case cfg.Ios.KeyBase64 != "":
-		certificateKey, authKey, ext, err = loadCertFromBase64(cfg.Ios.KeyBase64, cfg.Ios.KeyType, cfg.Ios.Password)
+		certificateKey, authKey, ext, err = loadCertFromBase64(
+			cfg.Ios.KeyBase64,
+			cfg.Ios.KeyType,
+			cfg.Ios.Password,
+		)
 	}
 
 	if err != nil {
@@ -316,7 +327,10 @@ func setLiveActivityFields(p *payload.Payload, req *PushNotification) {
 	}
 }
 
-func iosAlertDictionary(notificationPayload *payload.Payload, req *PushNotification) *payload.Payload {
+func iosAlertDictionary(
+	notificationPayload *payload.Payload,
+	req *PushNotification,
+) *payload.Payload {
 	if len(req.InterruptionLevel) > 0 {
 		notificationPayload.InterruptionLevel(payload.EInterruptionLevel(req.InterruptionLevel))
 	}
@@ -446,7 +460,11 @@ func getApnsClient(cfg *config.ConfYaml, req *PushNotification) (client *apns2.C
 }
 
 // PushToIOS provide send notification to APNs server.
-func PushToIOS(ctx context.Context, req *PushNotification, cfg *config.ConfYaml) (resp *ResponsePush, err error) {
+func PushToIOS(
+	ctx context.Context,
+	req *PushNotification,
+	cfg *config.ConfYaml,
+) (resp *ResponsePush, err error) {
 	logx.LogAccess.Debug("Start push notification for iOS")
 
 	var (
diff --git a/notify/notification_apns_test.go b/notify/notification_apns_test.go
@@ -264,8 +264,16 @@ func TestIOSSummaryArg(t *testing.T) {
 	assert.Equal(t, testMessage, notification.ApnsID)
 	assert.Equal(t, testMessage, notification.Topic)
 	assert.Equal(t, ApnsPriorityLow, notification.Priority)
-	assert.Equal(t, "test", dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["summary-arg"])
-	assert.Equal(t, float64(3), dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["summary-arg-count"])
+	assert.Equal(
+		t,
+		"test",
+		dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["summary-arg"],
+	)
+	assert.Equal(
+		t,
+		float64(3),
+		dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["summary-arg-count"],
+	)
 }
 
 // Silent Notification which payload’s aps dictionary must not contain the alert, sound, or badge keys.
@@ -414,9 +422,21 @@ func TestAlertStringExample2ForIos(t *testing.T) {
 		panic(err)
 	}
 
-	assert.Equal(t, title, dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["title"])
-	assert.Equal(t, body, dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["body"])
-	assert.Equal(t, actionLocKey, dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["action-loc-key"])
+	assert.Equal(
+		t,
+		title,
+		dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["title"],
+	)
+	assert.Equal(
+		t,
+		body,
+		dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["body"],
+	)
+	assert.Equal(
+		t,
+		actionLocKey,
+		dat["aps"].(map[string]interface{})["alert"].(map[string]interface{})["action-loc-key"],
+	)
 }
 
 // URL: https://goo.gl/5xFo3C
@@ -769,7 +789,10 @@ func TestPushToIOS(t *testing.T) {
 
 	req := &PushNotification{
 		//nolint
-		Tokens:   []string{"11aa01229f15f0f0c52029d8cf8cd0aeaf2365fe4cebc4af26cd6d76b7919ef7", "11aa01229f15f0f0c52029d8cf8cd0aeaf2365fe4cebc4af26cd6d76b7919ef1"},
+		Tokens: []string{
+			"11aa01229f15f0f0c52029d8cf8cd0aeaf2365fe4cebc4af26cd6d76b7919ef7",
+			"11aa01229f15f0f0c52029d8cf8cd0aeaf2365fe4cebc4af26cd6d76b7919ef1",
+		},
 		Platform: 1,
 		Message:  "Welcome",
 	}
@@ -1125,7 +1148,11 @@ func TestLoadCertFromBase64(t *testing.T) {
 	assert.Equal(t, ".invalid", invalidExt)
 
 	// Test invalid base64
-	badBase64Cert, badBase64AuthKey, badBase64Ext, err := loadCertFromBase64("not-valid-base64!!!", "p12", "")
+	badBase64Cert, badBase64AuthKey, badBase64Ext, err := loadCertFromBase64(
+		"not-valid-base64!!!",
+		"p12",
+		"",
+	)
 	assert.Error(t, err)
 	assert.Empty(t, badBase64Cert.Certificate)
 	assert.Nil(t, badBase64AuthKey)
diff --git a/notify/notification_fcm.go b/notify/notification_fcm.go
@@ -259,7 +259,11 @@ func logDevMessages(messages []*messaging.Message) {
 }
 
 // PushToAndroid provide send notification to Android server.
-func PushToAndroid(ctx context.Context, req *PushNotification, cfg *config.ConfYaml) (resp *ResponsePush, err error) {
+func PushToAndroid(
+	ctx context.Context,
+	req *PushNotification,
+	cfg *config.ConfYaml,
+) (resp *ResponsePush, err error) {
 	logx.LogAccess.Debug("Start push notification for Android")
 
 	if err = CheckMessage(req); err != nil {
@@ -298,7 +302,13 @@ Retry:
 		return resp, newErr
 	}
 
-	logx.LogAccess.Debug(fmt.Sprintf("Android Success count: %d, Failure count: %d", res.SuccessCount, res.FailureCount))
+	logx.LogAccess.Debug(
+		fmt.Sprintf(
+			"Android Success count: %d, Failure count: %d",
+			res.SuccessCount,
+			res.FailureCount,
+		),
+	)
 	status.StatStorage.AddAndroidSuccess(int64(res.SuccessCount))
 	status.StatStorage.AddAndroidError(int64(res.FailureCount))
 
@@ -318,7 +328,12 @@ Retry:
 	return resp, nil
 }
 
-func logPush(cfg *config.ConfYaml, status, token string, req *PushNotification, err error) logx.LogPushEntry {
+func logPush(
+	cfg *config.ConfYaml,
+	status, token string,
+	req *PushNotification,
+	err error,
+) logx.LogPushEntry {
 	return logx.LogPush(&logx.InputLog{
 		ID:          req.ID,
 		Status:      status,
diff --git a/notify/notification_hms.go b/notify/notification_hms.go
@@ -156,7 +156,11 @@ func GetHuaweiNotification(req *PushNotification) (*model.MessageRequest, error)
 }
 
 // PushToHuawei provide send notification to Android server.
-func PushToHuawei(ctx context.Context, req *PushNotification, cfg *config.ConfYaml) (resp *ResponsePush, err error) {
+func PushToHuawei(
+	ctx context.Context,
+	req *PushNotification,
+	cfg *config.ConfYaml,
+) (resp *ResponsePush, err error) {
 	logx.LogAccess.Debug("Start push notification for Huawei")
 
 	var (
diff --git a/router/server.go b/router/server.go
@@ -76,7 +76,11 @@ func pushHandler(cfg *config.ConfYaml, q *queue.Queue) gin.HandlerFunc {
 		}
 
 		if int64(len(form.Notifications)) > cfg.Core.MaxNotification {
-			msg = fmt.Sprintf("Number of notifications(%d) over limit(%d)", len(form.Notifications), cfg.Core.MaxNotification)
+			msg = fmt.Sprintf(
+				"Number of notifications(%d) over limit(%d)",
+				len(form.Notifications),
+				cfg.Core.MaxNotification,
+			)
 			logx.LogAccess.Debug(msg)
 			abortWithError(c, http.StatusBadRequest, msg)
 			return
diff --git a/router/server_lambda.go b/router/server_lambda.go
@@ -14,7 +14,12 @@ import (
 )
 
 // RunHTTPServer provide run http or https protocol.
-func RunHTTPServer(ctx context.Context, cfg *config.ConfYaml, q *queue.Queue, s ...*http.Server) (err error) {
+func RunHTTPServer(
+	ctx context.Context,
+	cfg *config.ConfYaml,
+	q *queue.Queue,
+	s ...*http.Server,
+) (err error) {
 	if !cfg.Core.Enabled {
 		logx.LogAccess.Debug("httpd server is disabled.")
 		return nil
diff --git a/router/server_normal.go b/router/server_normal.go
@@ -18,7 +18,12 @@ import (
 )
 
 // RunHTTPServer provide run http or https protocol.
-func RunHTTPServer(ctx context.Context, cfg *config.ConfYaml, q *queue.Queue, s ...*http.Server) (err error) {
+func RunHTTPServer(
+	ctx context.Context,
+	cfg *config.ConfYaml,
+	q *queue.Queue,
+	s ...*http.Server,
+) (err error) {
 	var server *http.Server
 
 	if !cfg.Core.Enabled {
diff --git a/router/server_test.go b/router/server_test.go
diff --git a/rpc/server.go b/rpc/server.go

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ type LogPushEntry struct {`
`33`	`33`
`34`	`34`	`var isTerm bool`
`35`	`35`
`36`		`-//nolint`
	`36`	`+// nolint`
`37`	`37`	`func init() {`
`38`	`38`	`isTerm = isatty.IsTerminal(os.Stdout.Fd())`
`39`	`39`	`}`