feat: new help commands related to formatters

Author: ldez

.github/workflows/pr.yml

@@ -153,5 +153,7 @@ jobs:
 
       - run: ./golangci-lint help
       - run: ./golangci-lint help linters
+      - run: ./golangci-lint help formatters
       - run: ./golangci-lint linters
+      - run: ./golangci-lint formatters
       - run: ./golangci-lint version

.golangci.yml

@@ -182,6 +182,11 @@ linters:
           - gocritic
         text: "hugeParam:"
 
+      # The codes are close but this is not duplication.
+      - path: pkg/commands/(formatters|linters).go
+        linters:
+          - dupl
+
 formatters:
   enable:
     - gofmt

pkg/commands/formatters.go

@@ -0,0 +1,112 @@
+package commands
+
+import (
+	"fmt"
+
+	"github.com/fatih/color"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/goformatters"
+	"github.com/golangci/golangci-lint/pkg/lint/linter"
+	"github.com/golangci/golangci-lint/pkg/lint/lintersdb"
+	"github.com/golangci/golangci-lint/pkg/logutils"
+)
+
+type formattersOptions struct {
+	config.LoaderOptions
+}
+
+type formattersCommand struct {
+	viper *viper.Viper
+	cmd   *cobra.Command
+
+	opts formattersOptions
+
+	cfg *config.Config
+
+	log logutils.Log
+
+	dbManager *lintersdb.Manager
+}
+
+func newFormattersCommand(logger logutils.Log) *formattersCommand {
+	c := &formattersCommand{
+		viper: viper.New(),
+		cfg:   config.NewDefault(),
+		log:   logger,
+	}
+
+	formattersCmd := &cobra.Command{
+		Use:               "formatters",
+		Short:             "List current formatters configuration",
+		Args:              cobra.NoArgs,
+		ValidArgsFunction: cobra.NoFileCompletions,
+		RunE:              c.execute,
+		PreRunE:           c.preRunE,
+		SilenceUsage:      true,
+	}
+
+	fs := formattersCmd.Flags()
+	fs.SortFlags = false // sort them as they are defined here
+
+	setupConfigFileFlagSet(fs, &c.opts.LoaderOptions)
+	setupLintersFlagSet(c.viper, fs)
+
+	c.cmd = formattersCmd
+
+	return c
+}
+
+func (c *formattersCommand) preRunE(cmd *cobra.Command, args []string) error {
+	loader := config.NewLoader(c.log.Child(logutils.DebugKeyConfigReader), c.viper, cmd.Flags(), c.opts.LoaderOptions, c.cfg, args)
+
+	err := loader.Load(config.LoadOptions{Validation: true})
+	if err != nil {
+		return fmt.Errorf("can't load config: %w", err)
+	}
+
+	dbManager, err := lintersdb.NewManager(c.log.Child(logutils.DebugKeyLintersDB), c.cfg,
+		lintersdb.NewLinterBuilder(), lintersdb.NewPluginModuleBuilder(c.log), lintersdb.NewPluginGoBuilder(c.log))
+	if err != nil {
+		return err
+	}
+
+	c.dbManager = dbManager
+
+	return nil
+}
+
+func (c *formattersCommand) execute(_ *cobra.Command, _ []string) error {
+	enabledLintersMap, err := c.dbManager.GetEnabledLintersMap()
+	if err != nil {
+		return fmt.Errorf("can't get enabled formatters: %w", err)
+	}
+
+	var enabledLinters []*linter.Config
+	var disabledLCs []*linter.Config
+
+	for _, lc := range c.dbManager.GetAllSupportedLinterConfigs() {
+		if lc.Internal {
+			continue
+		}
+
+		if !goformatters.IsFormatter(lc.Name()) {
+			continue
+		}
+
+		if enabledLintersMap[lc.Name()] == nil {
+			disabledLCs = append(disabledLCs, lc)
+		} else {
+			enabledLinters = append(enabledLinters, lc)
+		}
+	}
+
+	color.Green("Enabled by your configuration formatters:\n")
+	printFormatters(enabledLinters)
+	color.Red("\nDisabled by your configuration formatters:\n")
+	printFormatters(disabledLCs)
+
+	return nil
+}

pkg/commands/help.go

@@ -1,34 +1,17 @@
 package commands
 
 import (
-	"encoding/json"
-	"fmt"
-	"maps"
-	"slices"
 	"strings"
 	"unicode"
 	"unicode/utf8"
 
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 
-	"github.com/golangci/golangci-lint/pkg/config"
-	"github.com/golangci/golangci-lint/pkg/lint/linter"
 	"github.com/golangci/golangci-lint/pkg/lint/lintersdb"
 	"github.com/golangci/golangci-lint/pkg/logutils"
 )
 
-type linterHelp struct {
-	Name        string   `json:"name"`
-	Desc        string   `json:"description"`
-	Groups      []string `json:"groups"`
-	Fast        bool     `json:"fast"`
-	AutoFix     bool     `json:"autoFix"`
-	Deprecated  bool     `json:"deprecated"`
-	Since       string   `json:"since"`
-	OriginalURL string   `json:"originalURL,omitempty"`
-}
-
 type helpOptions struct {
 	JSON bool
 }
@@ -60,12 +43,23 @@ func newHelpCommand(logger logutils.Log) *helpCommand {
 		Short:             "Help about linters",
 		Args:              cobra.NoArgs,
 		ValidArgsFunction: cobra.NoFileCompletions,
-		RunE:              c.execute,
-		PreRunE:           c.preRunE,
+		RunE:              c.lintersExecute,
+		PreRunE:           c.lintersPreRunE,
 	}
 
 	helpCmd.AddCommand(lintersCmd)
 
+	formattersCmd := &cobra.Command{
+		Use:               "formatters",
+		Short:             "Help about formatters",
+		Args:              cobra.NoArgs,
+		ValidArgsFunction: cobra.NoFileCompletions,
+		RunE:              c.formattersExecute,
+		PreRunE:           c.formattersPreRunE,
+	}
+
+	helpCmd.AddCommand(formattersCmd)
+
 	fs := lintersCmd.Flags()
 	fs.SortFlags = false // sort them as they are defined here
 
@@ -76,122 +70,6 @@ func newHelpCommand(logger logutils.Log) *helpCommand {
 	return c
 }
 
-func (c *helpCommand) preRunE(_ *cobra.Command, _ []string) error {
-	// The command doesn't depend on the real configuration.
-	// It just needs the list of all plugins and all presets.
-	dbManager, err := lintersdb.NewManager(c.log.Child(logutils.DebugKeyLintersDB), config.NewDefault(), lintersdb.NewLinterBuilder())
-	if err != nil {
-		return err
-	}
-
-	c.dbManager = dbManager
-
-	return nil
-}
-
-func (c *helpCommand) execute(_ *cobra.Command, _ []string) error {
-	if c.opts.JSON {
-		return c.printJSON()
-	}
-
-	c.print()
-
-	return nil
-}
-
-func (c *helpCommand) printJSON() error {
-	var linters []linterHelp
-
-	for _, lc := range c.dbManager.GetAllSupportedLinterConfigs() {
-		if lc.Internal {
-			continue
-		}
-
-		groups := []string{config.GroupAll}
-
-		if !lc.IsSlowLinter() {
-			groups = append(groups, config.GroupFast)
-		}
-
-		linters = append(linters, linterHelp{
-			Name:        lc.Name(),
-			Desc:        formatDescription(lc.Linter.Desc()),
-			Groups:      slices.Concat(groups, slices.Collect(maps.Keys(lc.Groups))),
-			Fast:        !lc.IsSlowLinter(),
-			AutoFix:     lc.CanAutoFix,
-			Deprecated:  lc.IsDeprecated(),
-			Since:       lc.Since,
-			OriginalURL: lc.OriginalURL,
-		})
-	}
-
-	return json.NewEncoder(c.cmd.OutOrStdout()).Encode(linters)
-}
-
-func (c *helpCommand) print() {
-	var enabledLCs, disabledLCs []*linter.Config
-	for _, lc := range c.dbManager.GetAllSupportedLinterConfigs() {
-		if lc.Internal {
-			continue
-		}
-
-		if lc.FromGroup(config.GroupStandard) {
-			enabledLCs = append(enabledLCs, lc)
-		} else {
-			disabledLCs = append(disabledLCs, lc)
-		}
-	}
-
-	color.Green("Enabled by default linters:\n")
-	printLinters(enabledLCs)
-
-	color.Red("\nDisabled by default linters:\n")
-	printLinters(disabledLCs)
-}
-
-func printLinters(lcs []*linter.Config) {
-	slices.SortFunc(lcs, func(a, b *linter.Config) int {
-		if a.IsDeprecated() && b.IsDeprecated() {
-			return strings.Compare(a.Name(), b.Name())
-		}
-
-		if a.IsDeprecated() {
-			return 1
-		}
-
-		if b.IsDeprecated() {
-			return -1
-		}
-
-		return strings.Compare(a.Name(), b.Name())
-	})
-
-	for _, lc := range lcs {
-		desc := formatDescription(lc.Linter.Desc())
-
-		deprecatedMark := ""
-		if lc.IsDeprecated() {
-			deprecatedMark = " [" + color.RedString("deprecated") + "]"
-		}
-
-		var capabilities []string
-		if !lc.IsSlowLinter() {
-			capabilities = append(capabilities, color.BlueString("fast"))
-		}
-		if lc.CanAutoFix {
-			capabilities = append(capabilities, color.GreenString("auto-fix"))
-		}
-
-		var capability string
-		if capabilities != nil {
-			capability = " [" + strings.Join(capabilities, ", ") + "]"
-		}
-
-		_, _ = fmt.Fprintf(logutils.StdOut, "%s%s: %s%s\n",
-			color.YellowString(lc.Name()), deprecatedMark, desc, capability)
-	}
-}
-
 func formatDescription(desc string) string {
 	desc = strings.TrimSpace(desc)