Before v1.0.0

[gabbhack]

Documentation

General

• Data model
• How to make bindings
• Write serialize/deserialize by hand
• How to test serialize and deserialize procedures
• Errors
• All examples in documentation are tested via runnableExample. pragmas too.
• Move to own domain
• Pragmas
• Quick example in README
• Quick example in documentation
• How to de/serialize distinct types
• Error: generic instantiation too nested #17

Deserialize

• Visitor
• SeqAccess
• MapAccess
• Deserializer
• Helper templates documentation and examples
• How deserialization works for case objects with untagged pragma and multiple conditions in of.

Serialize

• SerializeArray
• SerializeMap
• SerializeSeq
• SerializeStruct
• Serializer
• Helper templates documentation and examples

Contribution

• Issue and PR templates
• How to debug make macros
• How does code generation works (about intermediate representation and functions)

Not documentation

• Drop support for aliases (because aliases supported by default). make... macros must raise an error.
• Add full support for inheritance. Now the parent's fields are not taken into account
• Better errors instead of Error: Expected one of {nnkSym, nnkObjectTy, nnkRefTy} for make... macros
• More hints for pragmas. Like this and this. Example: Use renamed instead of renameSerialize and renameDeserialize
• Add alias pragma. Like this
• Add deserWith pragma. Like this
• Add skipPrivate pragma
• Add support for field {.defaultValue.} instead of field {.defaultValue(value).}
• Reimplement renameAll as pragma for support distinct types and inheritance
• Named tuples must de/serialized as objects (also change docs in Supported std-types)
• Serialize nil as none token
• Option to disable duplication check
• Dont use {.requiresInit.} #22
• New visitBytesSlice, deserializeBytesSlice and visitStringSlice, deserializeStringSlice methods #21
• Divide the parsing stage into parsing and processing #23
• Support VM, JS and CPP backends #27

[gabbhack]

• Maintaining code that respects styleCheck is hard, especially with third-party dependencies. Therefore, support for styleCheck has been removed from the priorities for this release.
• Support for aliases should be completely removed, including for the Foo = ref Bar cases, for consistency. The library should provide a generalized function to de/serialize ref types based on generated serialization functions for base types.
• Support for distinct is removed from the priorities for this release. A way to de/serialize distinct types should be documented as part of this release.