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: about 1 month 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 (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T16:32:30.000Z (5 months ago)
• Last Synced: 2024-08-03T17:18:38.655Z (4 months ago)
• Topics: go, linter
• Language: Go
• Homepage:
• Size: 37.1 KB
• Stars: 285
• Watchers: 10
• Forks: 16
• Open Issues: 1
• 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

  -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}}')

```

### 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