NorfairKing/autodocodec
1
1
Fork 0
mirror of https://github.com/NorfairKing/autodocodec.git synced 2024-11-26 08:01:33 +03:00
Code Issues Projects Releases Wiki Activity
self(auto)- documenting encoders and decoders
28 Commits 18 Branches 1 Tag 1.9 MiB
Haskell 90.8%
Nix 9.2%
f608f4a338
Go to file
Tom Sydney Kerckhove f608f4a338 Hlint applied
2021-10-24 19:45:21 +02:00
.github Trying to set up CI 2021-10-24 19:21:59 +02:00
autodocodec Not too much ceremony for the either codec 2021-10-24 15:22:24 +02:00
autodocodec-aeson comments in json schema 2021-10-24 19:43:52 +02:00
autodocodec-yaml Hlint applied 2021-10-24 19:45:21 +02:00
nix test failure 2021-10-24 19:34:17 +02:00
.gitignore trying a thing 2021-10-20 17:59:50 +02:00
.hlint.yaml Hlint applied 2021-10-24 19:45:21 +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 Trying to set up CI 2021-10-24 19:21: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.