feat: allow add custom logger

[ttys3]

feat: allow add custom logger, also allow others like golangci-lint to have custom logger checker configs

we wrap zap logger in most cases, so I hope this linter can also allow user to check zap, logr or klog based wrapper or anyother logger.

update:

refactored to using a config file to define custom loggers.

the config file format is yaml

sample config file:

# loggercheck sample config
disable:
    - klog
    - logr
    - zap
custom-checkers:
    - name: customlogger
      package-import: example.com/customlogger
      funcs:
        - example.com/customlogger.Debug
        - example.com/customlogger.Info
        - example.com/customlogger.Warn
        - example.com/customlogger.Error
    - name: mylogger
      package-import: foo.example.com/bar
      funcs:
        - (*foo.example.com/bar.Logger).Debugw
        - (*foo.example.com/bar.Logger).Infow
        - (*foo.example.com/bar.Logger).Warnw
        - (*foo.example.com/bar.Logger).Errorw

[codecov]

Codecov Report

Merging #19 (f799a59) into master (a05b1e1) will increase coverage by 3.00%.
The diff coverage is 86.93%.

❗ Current head f799a59 differs from pull request most recent head 20319dc. Consider uploading reports for the commit 20319dc to get more accurate results

@@            Coverage Diff             @@
##           master      #19      +/-   ##
==========================================
+ Coverage   82.14%   85.14%   +3.00%     
==========================================
  Files           6       10       +4     
  Lines         168      303     +135     
==========================================
+ Hits          138      258     +120     
- Misses         22       31       +9     
- Partials        8       14       +6     

Impacted Files	Coverage Δ
checker.go	45.45% <45.45%> (-54.55%)	⬇️
flags.go	81.57% <80.95%> (-0.24%)	⬇️
loggercheck.go	85.55% <87.50%> (+3.90%)	⬆️
rules/rules.go	88.88% <88.88%> (ø)
config.go	100.00% <100.00%> (ø)
internal/bytebufferpool/pool.go	100.00% <100.00%> (ø)
options.go	100.00% <100.00%> (ø)
sets/stringset.go	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[timonwong]

@ttys3 Thanks, but for now I'll hold this pr for a while.

Because I decide to rename this repo, since it's not logr specific anymore :)

[timonwong]

I have some ideas, I'll apply some changes to your PR

[ttys3]

OK.

the main idea purpose is:

1. allow tools like golanci-lint can config custom logger and other opion (currently with WithConfig Option)
2. and this also works with the cmd cli flags (currently via the -config)

[timonwong]

@ttys3 I've pushed my changes, PTAL

[timonwong]

I should rename pattern to rules

[timonwong]

Thanks!

[ttys3]

I have some idea on the exported Config struct.
I think it's better keep the consistency between cli and golabgci-lint user

[ttys3]

I'm try to make a PR to show the idea when I have time

[timonwong]

@ttys3 I think the clean way to do that is re-implement singlechecker.Main. So we accept string list for "disable" and "rules" and do the parse later prior to run.

Or we can doing the parse during "run", though not very clean.