Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.02 KB

README.md

File metadata and controls

41 lines (29 loc) · 1.02 KB
Raw

sqlclosecheck

Linter that checks if SQL rows/statements are closed. Unclosed rows and statements may cause DB connection pool exhaustion. Included in golangci-lint as sqlclosecheck.

Contributions are welcome. The original author is around, but this project is not near the top of his priorities. If you're interested taking an active role in the maintence and evolution of this linter, please reach out. Thank you.

Analyzers

  • defer-only - require that Close be deferred
  • closed - require that Close be called (EXPERIMENTAL)

Running

make build
make install

In your project directory:

go vet -vettool=$(which sqlclosecheck) ./...

Developers

Start by creating a test that should pass/fail. Test are located at pkg/analyzer/testdata. All PRs that modify the analyzer should include a test. Negative tests are just as important as positive tests.

Make changes to the analyzer (pkg/analyzer) and run the tests:

make test

CI

GitHub Actions that runs on push to main and PRs.