gocontracts
A Go tool that automatically generates pre- and post-condition checks from function descriptions to implement design-by-contract.
What is gocontracts?
gocontracts is a design-by-contract tool for Go that synchronizes contract specifications in documentation with runtime checks in code. It parses function descriptions to generate and update pre-condition, post-condition, and preamble code blocks, ensuring contracts are both documented and enforced. This approach helps maintain consistency between documentation and implementation.
Go developers and teams implementing formal design-by-contract methodologies in their codebases, particularly those needing automated synchronization of documented invariants with actual runtime checks.
Developers choose gocontracts because it uniquely synchronizes contract documentation with generated code, avoiding drift between specs and implementation. Unlike alternatives, it supports condition labels, initialization statements, state transitions via preambles, and build-time toggling, all while emphasizing logical invariants over input validation.
Overview
A tool for design-by-contract in Go
Use Cases
Best For
- Automatically generating runtime checks from contract specifications written in Go function docstrings
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
