Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation issue with loggercheck linter #3270

Closed
4 tasks done
sebastien-rosset opened this issue Oct 3, 2022 · 1 comment
Closed
4 tasks done

Documentation issue with loggercheck linter #3270

sebastien-rosset opened this issue Oct 3, 2022 · 1 comment
Labels
question Further information is requested

Comments

@sebastien-rosset
Copy link
Contributor

sebastien-rosset commented Oct 3, 2022

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
@sebastien-rosset sebastien-rosset added the bug Something isn't working label Oct 3, 2022
@ldez ldez added question Further information is requested and removed bug Something isn't working labels Oct 3, 2022
@ldez
Copy link
Member

ldez commented Oct 3, 2022

Hello,

it's because logrlint has been renamed to loggercheck.

In the next release (v1.50.0), the name logrlint will be an alias on loggercheck.

The version at the end of the line is the version when the linter (logrlint) has been introduced.

We publish the documentation automatically, when required, without any "link" with a version of golangci-lint.

The typo valur is inside the linter itself:
https://github.com/timonwong/loggercheck/blob/v0.9.3/loggercheck.go#L21

And it's fixed on the main branch:
https://github.com/timonwong/loggercheck/blob/216be45f6bb8195e278d2c16608f9b0f3e2f0198/loggercheck.go#L21

@ldez ldez closed this as completed Oct 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants