Skip to content

Add command to add comments inside the configuration #6508

@koct9i

Description

@koct9i

Welcome

How did you install golangci-lint?

I don't know

Your feature request related to a problem? Please describe

Usecase: after updating golangci-lint user have to review list of all linters to see what it could enable in config and which are ready enabled or disabled. Also it is nice to have in config not just cryptic names but short description for each linter.

I.e. this command should check which linters are already present in config or in comments and edit config file to add comment with list of new linters.

After that user could simply uncomment particular lines to check and configure new linters.

version: "2"

linters:
  enable:
    - bodyclose # checks whether HTTP response body is closed successfully
    - copyloopvar # a linter detects places where loop variables are copied
    - unused # Checks Go code for unused constants, variables, functions and types
    - whitespace # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc.
    # New linters
    # - arangolint  # opinionated best practices for arangodb client
    # - asasalint  # check for pass []any as any in variadic func(...any)
    # - asciicheck  # checks that all code identifiers does not have non-ASCII symbols in the name
    # - bidichk  # Checks for dangerous unicode character sequences modern language and library features.
    # - gomoddirectives  # Manage the use of 'replace', 'retract', and 'excludes' directives in go.mod.
    # - gomodguard_v2  # Allow and blocklist linter for direct Go module dependencies. 

Describe the solution you'd like

Proposed implementation: #6505

Describe alternatives you've considered

Feeding config to AI

Additional context

No response

Supporter

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions