Skip to content

Documentation issue with loggercheck linter #3270

Closed
@sebastien-rosset

Description

@sebastien-rosset

Welcome

  • Yes, I'm using a binary release within 2 latest major releases. Only such installations are supported.
  • Yes, I've searched similar issues on GitHub and didn't find any.
  • Yes, I've included all information below (version, config, etc).
  • Yes, I've tried with the standalone linter if available. (https://golangci-lint.run/usage/linters/)

Description of the problem

I am reporting a documentation issue. The list of linters is documented at https://golangci-lint.run/usage/linters/. The list includes "loggercheck":

loggercheck ⚙️ Checks key valur pairs for common logger libraries (kitlog,klog,logr,zap). style, bugs   v1.49.0

There are two problems:

  1. There is a small typo: "value", not "valur".
  2. The loggercheck linter is not listed when typing the golangci-lint linters version 1.49. Instead, the command lists a logr linter which is not documented at https://golangci-lint.run/usage/linters/.

This seems to be a side effect of #3144, which was merged on Aug 31. Initially I thought that PR was merged before 1.49, but 1.49 was released before on Aug 24. The documentation refers to the new linter name.

Version of golangci-lint

$ golangci-lint version
golangci-lint has version 1.49.0 built from cc2d97f3 on 2022-08-24T10:24:37Z

Configuration file

Not applicable, this is a documentation issue.

$ cat .golangci.yml
# paste output here

Go environment

Not applicable, this is a documentation issue.

$ go version && go env
# paste output here

Verbose output of running

Not applicable, this is a documentation issue.

$ golangci-lint cache clean
$ golangci-lint run -v
# paste output here

Code example or link to a public repository

Not applicable, this is a documentation issue.

// add your code here

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions