bd2921655a
* Initial commit * Fixed goimports * Update pkg/golinters/mnd.go Co-Authored-By: Bot from GolangCI <42910462+golangcibot@users.noreply.github.com> * Run goimports * Update pkg/golinters/mnd.go Co-Authored-By: Bot from GolangCI <42910462+golangcibot@users.noreply.github.com> * Add prefix for goimport local * Run make README.md * Incorporate review comments Add test cases * Update readme * Update the description * Removed subpath in local-prefixes * Update readme
98 lines
1.8 KiB
Markdown
98 lines
1.8 KiB
Markdown
# go-mnd - Magic number detector for Golang
|
|
|
|
A vet analyzer to detect magic numbers.
|
|
|
|
> **What is a magic number?**
|
|
> A magic number is a numeric literal that is not defined as a constant, but which may change, and therefore can be hard to update. It's considered a bad programming practice to use numbers directly in any source code without an explanation. It makes programs harder to read, understand, and maintain.
|
|
|
|
## Project status
|
|
|
|
[](https://travis-ci.org/tommy-muehle/go-mnd)
|
|
[](https://goreportcard.com/report/github.com/tommy-muehle/go-mnd)
|
|
|
|
## Install
|
|
|
|
This analyzer requires Golang in version >= 1.12 because it's depends on the **go/analysis** API.
|
|
|
|
```
|
|
go get github.com/tommy-muehle/go-mnd/cmd/mnd
|
|
```
|
|
|
|
To install with [Homebrew](https://brew.sh/), run:
|
|
|
|
```
|
|
brew tap tommy-muehle/tap && brew install tommy-muehle/tap/mnd
|
|
```
|
|
|
|
On Windows download the [latest release](https://github.com/tommy-muehle/go-mnd/releases).
|
|
|
|
## Usage
|
|
|
|
[](https://asciinema.org/a/231021)
|
|
|
|
```
|
|
go vet -vettool $(which mnd) ./...
|
|
```
|
|
|
|
or directly
|
|
|
|
```
|
|
mnd ./...
|
|
```
|
|
|
|
The ```-checks``` option let's you define a comma separated list of checks.
|
|
|
|
## Checks
|
|
|
|
By default this detector analyses arguments, assigns, cases, conditions, operations and return statements.
|
|
|
|
* argument
|
|
|
|
```
|
|
t := http.StatusText(200)
|
|
```
|
|
|
|
* assign
|
|
|
|
```
|
|
c := &http.Client{
|
|
Timeout: 5 * time.Second,
|
|
}
|
|
```
|
|
|
|
* case
|
|
|
|
```
|
|
switch x {
|
|
case 3:
|
|
}
|
|
```
|
|
|
|
* condition
|
|
|
|
```
|
|
if x > 7 {
|
|
}
|
|
```
|
|
|
|
* operation
|
|
|
|
```
|
|
var x, y int
|
|
y = 10 * x
|
|
```
|
|
|
|
* return
|
|
|
|
```
|
|
return 3
|
|
```
|
|
|
|
## Notices
|
|
|
|
By default the number 0 is excluded!
|
|
|
|
## License
|
|
|
|
The MIT License (MIT). Please see [LICENSE](LICENSE) for more information.
|