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

.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{

cmd/litcli/actions.go

@@ -53,7 +53,8 @@ var listActionsCommand = cli.Command{
 			Name: "state",
 			Usage: "The action state to filter on. If not set, " +
 				"then actions of any state will be returned. " +
-				"Options include: 'pending', 'done' and 'error'.",
+				"Options include: 'pending', 'done' and " +
+				"'error'.",
 		},
 		cli.Uint64Flag{
 			Name: "index_offset",

cmd/litcli/autopilot.go

@@ -131,11 +131,11 @@ var addAutopilotSessionCmd = cli.Command{
 		},
 		cli.StringFlag{
 			Name: "privacy-flags",
-			Usage: "String representation of privacy flags to set " +
-				"for the session. Each individual flag will " +
-				"remove privacy from certain aspects of " +
-				"messages transmitted to autopilot. " +
-				"The strongest privacy is on by " +
+			Usage: "String representation of privacy flags " +
+				"to set for the session. Each individual " +
+				"flag will remove privacy from certain " +
+				"aspects of messages transmitted to " +
+				"autopilot. The strongest privacy is on by " +
 				"default and an empty string means full " +
 				"privacy. Some features may not be able to " +
 				"run correctly with full privacy, see the " +

cmd/litcli/proxy.go

@@ -17,8 +17,8 @@ var litCommands = []cli.Command{
 		Name: "bakesupermacaroon",
 		Usage: "Bake a new super macaroon with all of LiT's active " +
 			"permissions",
-		Description: "Bake a new super macaroon with all of LiT's active " +
-			"permissions.",
+		Description: "Bake a new super macaroon with all of LiT's " +
+			"active permissions.",
 		Category: "LiT",
 		Action:   bakeSuperMacaroon,
 		Flags: []cli.Flag{
@@ -47,8 +47,8 @@ var litCommands = []cli.Command{
 		Name: "getinfo",
 		Usage: "Returns basic information related to the active " +
 			"daemon",
-		Description: "Returns basic information related to the active " +
-			"daemon.",
+		Description: "Returns basic information related to the " +
+			"active daemon.",
 		Category: "LiT",
 		Action:   getInfo,
 	},

cmd/litcli/sessions.go

@@ -121,17 +121,16 @@ func addSession(cli *cli.Context) error {
 	sessionExpiry := time.Now().Add(sessionLength).Unix()
 
 	ctx := getContext()
-	resp, err := client.AddSession(
-		ctx, &litrpc.AddSessionRequest{
-			Label:                     cli.String("label"),
-			SessionType:               sessType,
-			ExpiryTimestampSeconds:    uint64(sessionExpiry),
-			MailboxServerAddr:         cli.String("mailboxserveraddr"),
-			DevServer:                 cli.Bool("devserver"),
-			MacaroonCustomPermissions: macPerms,
-			AccountId:                 cli.String("account_id"),
-		},
-	)
+	req := litrpc.AddSessionRequest{
+		Label:                     cli.String("label"),
+		SessionType:               sessType,
+		ExpiryTimestampSeconds:    uint64(sessionExpiry),
+		MailboxServerAddr:         cli.String("mailboxserveraddr"),
+		DevServer:                 cli.Bool("devserver"),
+		MacaroonCustomPermissions: macPerms,
+		AccountId:                 cli.String("account_id"),
+	}
+	resp, err := client.AddSession(ctx, &req)
 	if err != nil {
 		return err
 	}

config.go

@@ -146,7 +146,7 @@ var (
 // all config items of its enveloping subservers, each prefixed with their
 // daemon's short name.
 //
-//nolint:lll
+//nolint:ll
 type Config struct {
 	ShowVersion bool `long:"version" description:"Display version information and exit."`
 
@@ -284,6 +284,8 @@ func (c *Config) lndConnectParams() (string, lndclient.Network, string,
 // defaultConfig returns a configuration struct with all default values set.
 func defaultConfig() *Config {
 	defaultLogCfg := build.DefaultLogConfig()
+
+	// nolint:ll
 	return &Config{
 		HTTPSListen: defaultHTTPSListen,
 		TLSCertPath: DefaultTLSCertPath,
@@ -539,10 +541,15 @@ func loadAndValidateConfig(interceptor signal.Interceptor) (*Config, error) {
 	// the remote connection as well.
 	defaultFaradayCfg := faraday.DefaultConfig()
 	if cfg.faradayRemote && cfg.Network != DefaultNetwork {
-		if cfg.Remote.Faraday.MacaroonPath == defaultFaradayCfg.MacaroonPath {
-			cfg.Remote.Faraday.MacaroonPath = cfg.Faraday.MacaroonPath
+		if cfg.Remote.Faraday.MacaroonPath ==
+			defaultFaradayCfg.MacaroonPath {
+
+			cfg.Remote.Faraday.MacaroonPath =
+				cfg.Faraday.MacaroonPath
 		}
-		if cfg.Remote.Faraday.TLSCertPath == defaultFaradayCfg.TLSCertPath {
+		if cfg.Remote.Faraday.TLSCertPath ==
+			defaultFaradayCfg.TLSCertPath {
+
 			cfg.Remote.Faraday.TLSCertPath = cfg.Faraday.TLSCertPath
 		}
 	}
@@ -553,9 +560,10 @@ func loadAndValidateConfig(interceptor signal.Interceptor) (*Config, error) {
 		cfg.faradayRpcConfig.MacaroonPath = cfg.Faraday.MacaroonPath
 
 		if cfg.Faraday.ChainConn {
-			cfg.faradayRpcConfig.BitcoinClient, err = chain.NewBitcoinClient(
-				cfg.Faraday.Bitcoin,
-			)
+			cfg.faradayRpcConfig.BitcoinClient, err =
+				chain.NewBitcoinClient(
+					cfg.Faraday.Bitcoin,
+				)
 			if err != nil {
 				return nil, err
 			}
@@ -583,13 +591,16 @@ func loadAndValidateConfig(interceptor signal.Interceptor) (*Config, error) {
 
 	defaultTapCfg := tapcfg.DefaultConfig()
 	if cfg.tapRemote && cfg.Network != DefaultNetwork {
-		if cfg.Remote.TaprootAssets.MacaroonPath == defaultTapCfg.RpcConf.MacaroonPath {
+		if cfg.Remote.TaprootAssets.MacaroonPath ==
+			defaultTapCfg.RpcConf.MacaroonPath {
+
 			macaroonPath := cfg.TaprootAssets.RpcConf.MacaroonPath
 			cfg.Remote.TaprootAssets.MacaroonPath = macaroonPath
 		}
-		if cfg.Remote.TaprootAssets.TLSCertPath == defaultTapCfg.RpcConf.TLSCertPath {
-			tlsCertPath := cfg.TaprootAssets.RpcConf.TLSCertPath
+		if cfg.Remote.TaprootAssets.TLSCertPath ==
+			defaultTapCfg.RpcConf.TLSCertPath {
 
+			tlsCertPath := cfg.TaprootAssets.RpcConf.TLSCertPath
 			cfg.Remote.TaprootAssets.TLSCertPath = tlsCertPath
 		}
 	}

config_dev.go

@@ -39,7 +39,7 @@ var defaultSqliteDatabasePath = filepath.Join(
 // features not yet available in production. Since our itests are built with
 // the dev tag, we can test these features in our itests.
 //
-// nolint:lll
+// nolint:ll
 type DevConfig struct {
 	// DatabaseBackend is the database backend we will use for storing all
 	// account related data. While this feature is still in development, we

db/postgres.go

@@ -44,7 +44,7 @@ var (
 
 // PostgresConfig holds the postgres database configuration.
 //
-// nolint:lll
+// nolint:ll
 type PostgresConfig struct {
 	SkipMigrations     bool          `long:"skipmigrations" description:"Skip applying migrations on startup."`
 	Host               string        `long:"host" description:"Database server hostname."`

db/sqlite.go

@@ -47,7 +47,7 @@ var (
 // SqliteConfig holds all the config arguments needed to interact with our
 // sqlite DB.
 //
-// nolint: lll
+// nolint:ll
 type SqliteConfig struct {
 	// SkipMigrations if true, then all the tables will be created on start
 	// up if they don't already exist.

firewall/caveats_test.go

@@ -25,10 +25,11 @@ const (
 // formatted as a caveat and then parsed again successfully.
 func TestInterceptMetaInfo(t *testing.T) {
 	info := &InterceptMetaInfo{
-		ActorName:          "autopilot",
-		Feature:            "re-balance",
-		Trigger:            "channel 7413345453234435345 depleted",
-		Intent:             "increase outbound liquidity by 2000000 sats",
+		ActorName: "autopilot",
+		Feature:   "re-balance",
+		Trigger:   "channel 7413345453234435345 depleted",
+		Intent: "increase outbound liquidity by 2000000 " +
+			"sats",
 		StructuredJsonData: "{}",
 	}
 
@@ -93,6 +94,7 @@ func TestParseMetaInfoCaveat(t *testing.T) {
 // caveat and then parsed again successfully.
 func TestInterceptRule(t *testing.T) {
 	rules := &InterceptRules{
+		// nolint:ll
 		FeatureRules: map[string]map[string]string{
 			"AutoFees": {
 				"first-hop-ignore-list": "03abcd...,02badb01...",

firewall/config.go

@@ -2,14 +2,14 @@ package firewall
 
 // Config holds all config options for the firewall.
 //
-//nolint:lll
+//nolint:ll
 type Config struct {
 	RequestLogger *RequestLoggerConfig `group:"request-logger" namespace:"request-logger" description:"request logger settings"`
 }
 
 // RequestLoggerConfig holds all the config options for the request logger.
 //
-//nolint:lll
+//nolint:ll
 type RequestLoggerConfig struct {
 	RequestLoggerLevel RequestLoggerLevel `long:"level" description:"Set the request logger level. Options include 'all', 'full' and 'interceptor''"`
 }