Source code analyzer that helps you to maintain variable/field naming conventions inside your project.
To install go-namecheck binary under your $(go env GOPATH)/bin:
go get -v github.com/quasilyte/go-namecheckIf $GOPATH/bin is under your system $PATH, go-namecheck command should be available after that.
This should print the help message:
go-namecheck --helpIn big teams, same things end up being called differently eventually.
Sometimes you bring inconsistencies on your own.
Suppose it's considered idiomatic to call string parameter s if
you can't figure a more descriptive name, but sometimes you see str
names used by other programmers from your team.
This is where go-namecheck can help.
For a better illustration, suppose we also want to catch regexp
variables that use re prefix and propose RE suffix instead,
so var reFoo *regexp.Regexp becomes var fooRE *regexp.Regexp.
{
"string": {"param": {"str": "s"}},
"regexp\\.Regexp": {
"local+global": {"^re[A-Z]\\w*$": "use RE suffix instead of re prefix"}
}
}Rules above implement checks we described.
First key describes regular expression that matches a type. For that key there is an object for scopes. Scope can be one of:
param- function input paramsreceiver- method receiverglobal- any global constant or variablelocal- any local constant or variablefield- struct field
You can combine several scopes like param+receiver+local, etc.
Inside a scope there is an JSON object that maps "from" => "to" pair.
In the simplest form, it's a simple literal matching that suggests
to replace one name with another, like in str=>s rule.
Key can also be a regular expression, in this case, the "to" part
does not describe exact substitution, but rather describes
how to make name idiomatic (what to change).
You start by creating your rules file (or borrowing someone else set).
Then you can run go-namecheck like this:
go-namecheck foo.go bar.go mypkgYou can also use std, ./... and other conventional targets that are normally
understood by Go tools.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent