NorfairKing/autodocodec
1
1
Fork 0
mirror of https://github.com/NorfairKing/autodocodec.git synced 2024-12-02 09:52:01 +03:00
Code Issues Projects Releases Wiki Activity
self(auto)- documenting encoders and decoders
51 Commits 18 Branches 1 Tag 1.9 MiB
Haskell 90.8%
Nix 9.2%
4bfa61d352
Go to file
Tom Sydney Kerckhove 4bfa61d352 got the decoding the wrong way around
2021-10-30 02:34:30 +02:00
.github Trying to set up CI 2021-10-24 19:21:59 +02:00
autodocodec something is going wrong with numbers 2021-10-30 02:32:53 +02:00
autodocodec-aeson something is going wrong with numbers 2021-10-30 02:32:53 +02:00
autodocodec-api-usage got the decoding the wrong way around 2021-10-30 02:34:30 +02:00
autodocodec-yaml move all tests to the api usage module 2021-10-30 00:34:47 +02:00
nix Refactor api usage tests into separate package 2021-10-30 00:29:59 +02:00
.gitignore trying a thing 2021-10-20 17:59:50 +02:00
.hlint.yaml a finite recursive schema 2021-10-29 19:56:07 +02:00
ci.nix Trying to set up CI 2021-10-24 19:21:59 +02:00
default.nix Trying to set up CI 2021-10-24 19:21:59 +02:00
LICENSE trying a thing 2021-10-24 19:29:57 +02:00
README.md something that roundtrips 2021-10-20 18:23:55 +02:00
shell.nix test failure 2021-10-24 19:34:17 +02:00
stack.yaml Refactor api usage tests into separate package 2021-10-30 00:29:59 +02:00

README.md

Autodocodec

Autodocodec is short for "self(auto)- documenting encoder and decoder".

Goals:

  • Correct-by-construction encoding and decoding, without generating code.
  • Generate automatically-correct documentation from code.
  • Fun but not important: Be able to provide instances without depending on aeson and/or yaml.
  • Would be nice: support for recursive types.