Skip to content

v0.2.0

Compare
Choose a tag to compare
@Exadra37 Exadra37 released this 06 Jun 21:56
· 6 commits to main since this release

Release v0.2.0

This is the first release that adds code, the ElixirScribe.Behaviour.TypedContract.

The Elixir Scribe Typed Contract guarantees the shape of data throughout the codebase. It will be used extensively through this package itself, and through all code generated by all the Elixir Scribe generators: scribe.gen.*.

To eliminate potential bugs that may be caused by creating the data with the wrong type, I strongly encourage you to also use it as a contract to guarantee the shape of your data at any point in time that your codebase needs to accept or return data. For example, for arguments, parameters, attributes or options of functions.

The usage of the Elixir Scribe Typed Contract leads to more robust code with fewer bugs and less tests needed to guarantee data correctness, compared to when a struct, a plain map or a Keyword list was previously used.

Full Changelog: https://github.com/Exadra37/elixir-scribe/commits/v0.2.0