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

Jump to bottom

feat: rename logrlint to loggercheck #3144

Merged
merged 16 commits into from Sep 6, 2022
Merged

feat: rename logrlint to loggercheck #3144

merged 16 commits into from Sep 6, 2022

Conversation

timonwong
Copy link
Contributor

@timonwong timonwong commented Aug 26, 2022 •
edited

Since logrlint reaches v0.1.0, more loggers are supported (klog, zap).

So as suggested in #3140, logrlint is now deprecated, but since it's just a repo rename, so logrlint is renamed to loggercheck using alternate names.

New features:

  • checks for klog and zap
  • allow custom rules
  • allow disabling checks individually
  • allow check for logging key (require string literal/constant, ascii string)
  • allow check for printf-like specifiers (%s, %d, etc)

@timonwong timonwong marked this pull request as ready for review August 26, 2022 14:12
@ldez

This comment was marked as outdated.

Sign in to view
@ldez ldez self-requested a review August 26, 2022 14:17
@ldez ldez added the blocked Need's direct action from maintainer label Aug 26, 2022
@ldez

This comment was marked as outdated.

Sign in to view
@ldez ldez added linter: update version Update version of linter linter: update Update the linter implementation inside golangci-lint labels Aug 26, 2022
@timonwong timonwong force-pushed the add-loggercheck branch 3 times, most recently from 6fc71f1 to 80dc3cf Compare August 26, 2022 14:29
@timonwong timonwong changed the title feat: rename logrlint to loggercheck feat: add loggercheck; deprecate logrlint Aug 26, 2022
@ldez
Copy link
Member

ldez commented Aug 26, 2022

Please wait, I haven't seen that you have used the alternative names.

So you can "rename".

@ldez
Copy link
Member

ldez commented Aug 26, 2022 •
edited

@timonwong you can do the rename, read my previous message

@timonwong
Copy link
Contributor Author

Please wait, I haven't seen that you have used the alternative names.

So you can "rename".

@ldez Ok, I'll do it right now

@timonwong timonwong changed the title feat: add loggercheck; deprecate logrlint feat: rename logrlint to loggercheck Aug 26, 2022
ldez
ldez requested changes Aug 26, 2022
View reviewed changes
.golangci.reference.yml Outdated Show resolved Hide resolved
@timonwong timonwong closed this Aug 26, 2022
@timonwong timonwong reopened this Aug 26, 2022
@ldez ldez removed the blocked Need's direct action from maintainer label Aug 26, 2022
@ldez ldez mentioned this pull request Aug 28, 2022
Closed
@timonwong timonwong mentioned this pull request Aug 29, 2022
Merged
@ldez
Copy link
Member

ldez commented Aug 29, 2022

just a quick note about klog and kubernetes https://github.com/kubernetes-sigs/logtools/tree/main/logcheck

ldez
ldez requested changes Aug 29, 2022
View reviewed changes
.golangci.reference.yml Show resolved Hide resolved
@jkoelker jkoelker mentioned this pull request Aug 29, 2022
Closed
@timonwong
Copy link
Contributor Author

just a quick note about klog and kubernetes https://github.com/kubernetes-sigs/logtools/tree/main/logcheck

Hmmm, if knowing this before i may not create another linter myself 😂

@ldez ldez mentioned this pull request Aug 31, 2022
Merged
@timonwong timonwong requested a review from ldez September 6, 2022 05:19
@timonwong @ldez
feat: rename logrlint to loggercheck
6b21235 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
revert package rename
a11d085 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
rename logrlint to loggercheck
07a312f 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
timonwong and others added 13 commits September 6, 2022 22:23
@timonwong @ldez
Add comments for settings
9530cb5 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
fix tests
d430ac5 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@ldez
review
4f1b535
@ldez
review
9fe4e63
@timonwong @ldez
bump loggercheck; allow custom rules
a8b6e34 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
disable zap by default timonwong/loggercheck#27
dd0877d 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
fix doc for rules
1d8bf31 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
add support to require logging key as strings
76d6170 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
add support to go-kit/log
d458aa8 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
re-enable kitlog and zap by default
34c05e2 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
bump loggercheck; add support to no-printf-like
e9c8fe4 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
add custom rules example
82e647e 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
@timonwong @ldez
loggercheck version bump
cea6d9e 
Signed-off-by: Timon Wong <timon86.wang@gmail.com>
ldez
ldez approved these changes Sep 6, 2022
View reviewed changes
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ldez ldez merged commit 3a2ad90 into golangci:master Sep 6, 2022
@timonwong timonwong deleted the add-loggercheck branch September 7, 2022 14:34
@sebastien-rosset sebastien-rosset mentioned this pull request Oct 3, 2022
Closed
4 tasks
SeigeC pushed a commit to SeigeC/golangci-lint that referenced this pull request Apr 4, 2023
@timonwong @SeigeC
feat: rename logrlint to loggercheck (golangci#3144)
ec24632
@ldez ldez added this to the v1.50 milestone Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ldez ldez ldez approved these changes

Assignees
No one assigned
Labels
linter: update version Update version of linter linter: update Update the linter implementation inside golangci-lint
Projects
None yet
Milestone
v1.50
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@timonwong @ldez