https://github.com/jgautheron/goconst
Find in Go repeated strings that could be replaced by a constant
https://github.com/jgautheron/goconst
go linter
Last synced: 11 days ago
JSON representation
Find in Go repeated strings that could be replaced by a constant
- Host: GitHub
- URL: https://github.com/jgautheron/goconst
- Owner: jgautheron
- License: mit
- Created: 2015-12-24T01:42:15.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T20:18:14.000Z (about 1 month ago)
- Last Synced: 2025-04-18T10:43:17.524Z (about 1 month ago)
- Topics: go, linter
- Language: Go
- Homepage:
- Size: 74.2 KB
- Stars: 302
- Watchers: 11
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- go-awesome - goconst - Finds repeating strings that can be replaced with constants (Open source library / Code Analysis)
README
# goconst
Find repeated strings that could be replaced by a constant.
### Motivation
There are obvious benefits to using constants instead of repeating strings, mostly to ease maintenance. Cannot argue against changing a single constant versus many strings.
While this could be considered a beginner mistake, across time, multiple packages and large codebases, some repetition could have slipped in.
### Get Started
$ go install github.com/jgautheron/goconst/cmd/goconst@latest
$ goconst ./...
### Usage
```
Usage:
goconst ARGS
Flags:
-ignore exclude files matching the given regular expression
-ignore-strings exclude strings matching the given regular expression
-ignore-tests exclude tests from the search (default: true)
-min-occurrences report from how many occurrences (default: 2)
-min-length only report strings with the minimum given length (default: 3)
-match-constant look for existing constants matching the values
-find-duplicates look for constants with identical values
-numbers search also for duplicated numbers
-min minimum value, only works with -numbers
-max maximum value, only works with -numbers
-output output formatting (text or json)
-set-exit-status Set exit status to 2 if any issues are found
Examples:
goconst ./...
goconst -ignore "yacc|\.pb\." $GOPATH/src/github.com/cockroachdb/cockroach/...
goconst -min-occurrences 3 -output json $GOPATH/src/github.com/cockroachdb/cockroach
goconst -numbers -min 60 -max 512 .
goconst -min-occurrences 5 $(go list -m -f '{{.Dir}}')
```
### Development
#### Running Tests
The project includes a comprehensive test suite. To run the tests:
```bash
# Run all tests
go test ./...
# Run tests with verbose output
go test -v ./...
# Run tests with race detector
go test -race ./...
# Run benchmarks
go test -bench=. ./...
# Check test coverage
go test -cover ./...
```
#### Contributing
Contributions are welcome! Before submitting a PR:
1. Make sure all tests pass
2. Add tests for new functionality
3. Ensure your code passes linting checks
4. Update documentation as needed
### Other static analysis tools
- [gogetimports](https://github.com/jgautheron/gogetimports): Get a JSON-formatted list of imports.
- [usedexports](https://github.com/jgautheron/usedexports): Find exported variables that could be unexported.
### License
MIT