README
¶
pkgname
Linter and analyzer that detects package names that do not follow Go idiomatic naming conventions.
Usage
Install the linter:
go install github.com/uudashr/pkgname/cmd/pkgnamecheck@latest
Run the linter
pkgnamecheck ./...
Include import alias on the detection:
pkgnamecheck -include-import-alias ./...
References
Good package names are short and clear. They are lower case, with no
under_scoresormixedCaps. ...
The style of names typical of another language might not be idiomatic in a Go program. Here are two examples of names that might be good style in other languages but do not fit well in Go:
computeServiceClientpriority_queue
By convention, packages are given lower case, single-word names; there should be no need for underscores or mixedCaps. ...
Documentation
¶
Overview ¶
Package pkgname provides analyzer for Go idiomatic package naming conventions.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Analyzer = NewAnalyzer()
Analyzer analyzes Go idiomatic package naming conventions.
Functions ¶
func NewAnalyzer ¶
NewAnalyzer creates a new instance of the pkgname analyzer.
Types ¶
This section is empty.
Source Files
Directories