https://github.com/dgunay/ifacecapture
Go linter to detect misuse of a specific callback with interface pattern.
https://github.com/dgunay/ifacecapture
golangci-lint hacktoberfest static-analysis
Last synced: 3 months ago
JSON representation
Go linter to detect misuse of a specific callback with interface pattern.
- Host: GitHub
- URL: https://github.com/dgunay/ifacecapture
- Owner: dgunay
- License: gpl-3.0
- Created: 2022-05-07T03:53:46.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-31T07:23:08.000Z (over 2 years ago)
- Last Synced: 2025-03-26T20:49:28.519Z (3 months ago)
- Topics: golangci-lint, hacktoberfest, static-analysis
- Language: Go
- Homepage:
- Size: 76.2 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ifacecapture
Go linter that tries to find possibly unintentional usage of captured variables
implementing an inner-scoped parameter's interface.
This linter was originally designed to try and find mistakes like the following
in code implementing database transactions:
```go
type Database interface {
Transaction(tx Database)
DoQuery()
}
func doDatabaseStuff(db Database) {
db.Transaction(func(tx Database) { // tx is a transaction handle
db.DoQuery()
// the programmer probably meant to use the transaction handle "tx", but
// accidentally used the outer scope variable "db"
})
}
```
It searches for functions taking a callback, which itself takes one or
parameters which are of some interface type. It then searches for captures of
outer scope variables which implement that interface.
This linter may help you find similar patterns, where you have a callback
function intended to aid safe usage of an interface. Unintentional captures
of an outer scope variable that also implements that interface often means
that there was a mistake.
## How to test
```
go test ./... -cover -race
```
## How to release
You can build releases for all platforms with GoReleaser:
```bash
rm -rf ./dist
goreleaser build
```
To do a release using CI:
1. Tag a commit on the `main` branch (should be tagged according to semver). `git tag v0.x.x`.
2. Push tags to GitHub. `git push --tags`
## TODO:
- More tests
- Check multiple interface parameters
- Cleaner code
- Configurability