Merge pull request #1189 from lightninglabs/lint-line-length

multi: enforce 80-char line length and add `nolint:ll` comments

Author: ffranr

.custom-gcl.yml

@@ -0,0 +1,4 @@
+version: v1.64.6
+plugins:
+  - module: 'github.com/lightninglabs/lightning-terminal/tools/linters'
+    path: ./tools/linters

.golangci.yml

@@ -14,6 +14,17 @@ run:
     - dev
 
 linters-settings:
+  custom:
+    ll:
+      type: "module"
+      description: "Custom lll linter with 'S' log line exclusion."
+      settings:
+        # Max line length, lines longer will be reported.
+        line-length: 80
+        # Tab width in spaces.
+        tab-width: 8
+        # The regex that we will use to detect the start of an `S` log line.
+        log-regex: "^\\s*.*(L|l)og\\.(Info|Debug|Trace|Warn|Error|Critical)S\\("
   govet:
     # Don't report about shadowed variables
     check-shadowing: false
@@ -39,7 +50,7 @@ linters-settings:
 
 linters:
   enable:
-    - lll
+    - ll
     - gofmt
     - tagliatelle
     - whitespace

Makefile

@@ -304,7 +304,7 @@ check-go-version: check-go-version-dockerfile check-go-version-yaml
 
 lint: check-go-version docker-tools
 	@$(call print, "Linting source.")
-	$(DOCKER_TOOLS) golangci-lint run -v $(LINT_WORKERS)
+	$(DOCKER_TOOLS) custom-gcl run -v $(LINT_WORKERS)
 
 mod:
 	@$(call print, "Tidying modules.")

accounts/checkers.go

@@ -110,6 +110,7 @@ func NewAccountChecker(service Service,
 		)
 	}
 
+	// nolint:ll
 	checkers := CheckerMap{
 		// Invoices:
 		"/lnrpc.Lightning/AddInvoice": mid.NewResponseRewriter(

accounts/checkers_test.go

@@ -379,6 +379,7 @@ func TestAccountCheckers(t *testing.T) {
 		originalRequest: &lnrpc.PendingChannelsRequest{},
 		originalResponse: &lnrpc.PendingChannelsResponse{
 			TotalLimboBalance: 123456,
+			// nolint:ll
 			PendingOpenChannels: []*lnrpc.PendingChannelsResponse_PendingOpenChannel{
 				{},
 			},

accounts/store_sql.go

@@ -31,7 +31,7 @@ const (
 // SQLQueries is a subset of the sqlc.Queries interface that can be used
 // to interact with accounts related tables.
 //
-//nolint:lll
+//nolint:ll
 type SQLQueries interface {
 	AddAccountInvoice(ctx context.Context, arg sqlc.AddAccountInvoiceParams) error
 	DeleteAccount(ctx context.Context, id int64) error

accounts/tlv.go

@@ -227,7 +227,9 @@ func PaymentEntryMapEncoder(w io.Writer, val any, buf *[8]byte) error {
 }
 
 // PaymentEntryMapDecoder decodes a map of payment entries.
-func PaymentEntryMapDecoder(r io.Reader, val any, buf *[8]byte, _ uint64) error {
+func PaymentEntryMapDecoder(r io.Reader, val any, buf *[8]byte,
+	_ uint64) error {
+
 	if typ, ok := val.(*AccountPayments); ok {
 		numItems, err := tlv.ReadVarInt(r, buf)
 		if err != nil {

autopilotserver/client.go

@@ -27,7 +27,7 @@ var ErrVersionIncompatible = fmt.Errorf("litd version is not compatible " +
 
 // Config holds the configuration options for the autopilot server client.
 //
-//nolint:lll
+//nolint:ll
 type Config struct {
 	// Disable will disable the autopilot client.
 	Disable bool `long:"disable" description:"disable the autopilot client"`

autopilotserver/mock/server.go

@@ -310,7 +310,8 @@ func (m *Server) GetPrivacyFlags(remoteKey *btcec.PublicKey) (
 	key := hex.EncodeToString(remoteKey.SerializeCompressed())
 	sess, ok := m.sessions[key]
 	if !ok {
-		return session.PrivacyFlags{}, fmt.Errorf("no such client found")
+		return session.PrivacyFlags{},
+			fmt.Errorf("no such client found")
 	}
 
 	privacyFlags, err := session.Deserialize(sess.privacyFlags)
@@ -436,7 +437,9 @@ func rulesToRPC(rulesMap map[string]*RuleRanges) (
 	return res, nil
 }
 
-func permissionsToRPC(ps map[string][]bakery.Op) []*autopilotserverrpc.Permissions {
+func permissionsToRPC(
+	ps map[string][]bakery.Op) []*autopilotserverrpc.Permissions {
+
 	res := make([]*autopilotserverrpc.Permissions, len(ps))
 
 	for method, ops := range ps {

cmd/litcli/accounts.go

@@ -146,7 +146,8 @@ var updateAccountCommand = cli.Command{
 	Name:      "update",
 	ShortName: "u",
 	Usage:     "Update an existing off-chain account.",
-	ArgsUsage: "[id | label] new_balance [new_expiration_date] [--save_to=]",
+	ArgsUsage: "[id | label] new_balance [new_expiration_date] " +
+		"[--save_to=]",
 	Description: "Updates an existing off-chain account and sets " +
 		"either a new balance or new expiration date or both.",
 	Flags: []cli.Flag{