feat: new fmt command with dedicated formatter configuration

[ldez]

Important

This PR deliberately omits documentation about the new options and section (but the JSONSchema is updated).
This is because I don't want to deprecate the previous elements for now: I think it is better to handle that when all the v2 proposals are managed to avoid multiple migrations.

---

The command golangci-lint fmt formats the code by default.

The current default is the same format used by go fmt (!= gofmt).

There is no support for stdin.

The formatters defined in the formatters.enable are added automatically to linters.enable.

If a formatter is enabled inside formatters and linters, the configuration of formatters.settings will override linters-settings even if the configuration is omitted or empty inside formatters.settings section.
This means the formatter activation and configurations should be defined only on the formatters or linters+linters-settings section and not mixed.

The exclusions from formatters.exclusions[].paths are converted to linters.exclusions[].rules automatically.

There are only 3(4) flags:

Flags:
  -c, --config PATH      Read config from file path PATH
      --no-config        Don't read config file
  -E, --enable strings   Enable specific formatter
  -d, --diff             display diffs instead of rewriting files

Note, that the -E, --enable flags work like --enable-only for linters: it overrides the formatters defined inside the configuration file.
It is the opposite of the behavior of the -E, --enable flags of the run command where this flag always adds linters to those defined inside the configuration file.

In v2, the configuration of formatters will not be allowed inside the linters-settings section.

formatters:
  enable:
    - gofumpt
    - gofmt
    - goimports
    - gci
  settings:
    gofumpt:
      # ...
    gofmt:
      # ...
    goimports:
      # ...
    gci:
      # ...
  exclusions:
    generated: strict
    paths:
      - foo
      - bar
      # ...

Fixes #5296

[bombsimon]

LGTM!

I think making this still supported as a linter and available with the --fix flag is a great suggestion.

Have you done any testing on performance? I'd imagine golangci-lint fmt on big codebases would potentially be faster than golangci-lint run --fix or are they the same? When would you suggest one over the other? On save in your editor?

[ldez]

Have you done any testing on performance? I'd imagine golangci-lint fmt on big codebases would potentially be faster than golangci-lint run --fix or are they the same?

Yes, I did it.

The fmt is significantly faster than run.
Because it's only focused on pure syntax analyzing, no type loading, no cache filling, etc.

When would you suggest one over the other? On save in your editor?

The 2 commands have different goals, I cannot suggest one over the other.

But I suggest always running fmt first because it's quick and safe.

[ldez]

I will not merge this PR for now: based on Go release cycle, go1.24 will be released in 2 weeks.

I want to keep this feature for v2 and I want the last v1 release to support go1.24.

Also, for now, I don't want to play with a dedicated v2 branch.

This is frustrating for me because I want to see this new command used and I have another PR ready based on the branch of this PR.

[Antonboom]

Can we validate and warn:

• if gci and goimports enabled both
• if gofmt and gofumt enabled both
• if formatter key presented in linters-settings, but linter enabled in formatters (and visa versa)

?

Sorry, If its already presented, but I missed it 🙏

[ldez]

if gci and goimports enabled both

We don't need to do that because in the way I implemented the frommatters (in the previous PR), the conflicts are not possible.

if gofmt and gofumt enabled both

The 2 linters should be able to run together because they don't have the same possibilities, and some are complementary.

if formatter key presented in linters-settings, but linter enabled in formatters (and visa vers

In v2, the formatters will not be allowed inside linter settings and definitions.