Skip to content

Commit

Permalink
feat: add usestdlibvars (#3016)
Browse files Browse the repository at this point in the history
  • Loading branch information
sashamelentyev committed Aug 3, 2022
1 parent 15cba44 commit 0ba1388
Show file tree
Hide file tree
Showing 7 changed files with 91 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .golangci.reference.yml
Expand Up @@ -1669,6 +1669,29 @@ linters-settings:
# Default: true
begin: false

usestdlibvars:
# Suggest the use of http.MethodXX
# Default: true
http-method: false
# Suggest the use of http.StatusXX
# Default: true
http-status-code: false
# Suggest the use of time.Weekday
# Default: true
time-weekday: true
# Suggest the use of time.Month
# Default: false
time-month: true
# Suggest the use of time.Layout
# Default: false
time-layout: true
# Suggest the use of crypto.Hash
# Default: false
crypto-hash: true
# Suggest the use of pc.DefaultXXPath
# Default: false
default-rpc-path: true

unparam:
# Inspect exported functions.
#
Expand Down Expand Up @@ -1934,6 +1957,7 @@ linters:
- unconvert
- unparam
- unused
- usestdlibvars
- varcheck
- varnamelen
- wastedassign
Expand Down Expand Up @@ -2035,6 +2059,7 @@ linters:
- unconvert
- unparam
- unused
- usestdlibvars
- varcheck
- varnamelen
- wastedassign
Expand Down
1 change: 1 addition & 0 deletions go.mod
Expand Up @@ -74,6 +74,7 @@ require (
github.com/ryancurrah/gomodguard v1.2.4
github.com/ryanrolds/sqlclosecheck v0.3.0
github.com/sanposhiho/wastedassign/v2 v2.0.6
github.com/sashamelentyev/usestdlibvars v1.8.0
github.com/securego/gosec/v2 v2.12.0
github.com/shazow/go-diff v0.0.0-20160112020656-b6b7b6733b8c
github.com/shirou/gopsutil/v3 v3.22.6
Expand Down
2 changes: 2 additions & 0 deletions go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions pkg/config/linters_settings.go
Expand Up @@ -178,6 +178,7 @@ type LintersSettings struct {
Thelper ThelperSettings
Unparam UnparamSettings
Unused StaticCheckSettings
UseStdlibVars UseStdlibVarsSettings
Varcheck VarCheckSettings
Varnamelen VarnamelenSettings
Whitespace WhitespaceSettings
Expand Down Expand Up @@ -587,6 +588,16 @@ type TenvSettings struct {
All bool `mapstructure:"all"`
}

type UseStdlibVarsSettings struct {
HTTPMethod bool `mapstructure:"http-method"`
HTTPStatusCode bool `mapstructure:"http-status-code"`
TimeWeekday bool `mapstructure:"time-weekday"`
TimeMonth bool `mapstructure:"time-month"`
TimeLayout bool `mapstructure:"time-layout"`
CryptoHash bool `mapstructure:"crypto-hash"`
DefaultRPCPathFlag bool `mapstructure:"default-rpc-path"`
}

type UnparamSettings struct {
CheckExported bool `mapstructure:"check-exported"`
Algo string
Expand Down
33 changes: 33 additions & 0 deletions pkg/golinters/usestdlibvars.go
@@ -0,0 +1,33 @@
package golinters

import (
"github.com/sashamelentyev/usestdlibvars/pkg/analyzer"
"golang.org/x/tools/go/analysis"

"github.com/golangci/golangci-lint/pkg/config"
"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
)

func NewUseStdlibVars(cfg *config.UseStdlibVarsSettings) *goanalysis.Linter {
a := analyzer.New()

cfgMap := make(map[string]map[string]interface{})
if cfg != nil {
cfgMap[a.Name] = map[string]interface{}{
analyzer.HTTPMethodFlag: cfg.HTTPMethod,
analyzer.HTTPStatusCodeFlag: cfg.HTTPStatusCode,
analyzer.TimeWeekdayFlag: cfg.TimeWeekday,
analyzer.TimeMonthFlag: cfg.TimeMonth,
analyzer.TimeLayoutFlag: cfg.TimeLayout,
analyzer.CryptoHashFlag: cfg.CryptoHash,
analyzer.DefaultRPCPathFlag: cfg.DefaultRPCPathFlag,
}
}

return goanalysis.NewLinter(
a.Name,
a.Doc,
[]*analysis.Analyzer{a},
cfgMap,
).WithLoadMode(goanalysis.LoadModeSyntax)
}
6 changes: 6 additions & 0 deletions pkg/lint/lintersdb/manager.go
Expand Up @@ -164,6 +164,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
thelperCfg *config.ThelperSettings
unparamCfg *config.UnparamSettings
unusedCfg *config.StaticCheckSettings
usestdlibvars *config.UseStdlibVarsSettings
varcheckCfg *config.VarCheckSettings
varnamelenCfg *config.VarnamelenSettings
whitespaceCfg *config.WhitespaceSettings
Expand Down Expand Up @@ -767,6 +768,11 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
WithChangeTypes().
WithURL("https://github.com/dominikh/go-tools/tree/master/unused"),

linter.NewConfig(golinters.NewUseStdlibVars(usestdlibvars)).
WithSince("v1.48.0").
WithPresets(linter.PresetStyle).
WithURL("https://github.com/sashamelentyev/usestdlibvars"),

linter.NewConfig(golinters.NewVarcheck(varcheckCfg)).
WithSince("v1.0.0").
WithLoadForGoAnalysis().
Expand Down
13 changes: 13 additions & 0 deletions test/testdata/usestdlibvars.go
@@ -0,0 +1,13 @@
//golangcitest:args -Eusestdlibvars
package testdata

import "net/http"

func _200() {
_ = 200
}

func _200_1() {
var w http.ResponseWriter
w.WriteHeader(200) // ERROR `"200" can be replaced by http.StatusOK`
}

0 comments on commit 0ba1388

Please sign in to comment.