status-im
/
NimYAML
mirror of https://github.com/status-im/NimYAML.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
YAML implementation for Nim https://nimyaml.org
147 Commits 6 Branches 28 Tags 2.3 MiB
Nim 98.7%
Nix 1.3%
Go to file
Felix Krause a5169230a3 Fixed JSON module to compile against new Nim API 2016-02-25 22:52:52 +01:00
bench Code cleanup; reduced compiler hints 2016-02-19 18:25:01 +01:00
doc Fixed link in generated documentation 2016-02-25 22:34:23 +01:00
private Fixed JSON module to compile against new Nim API 2016-02-25 22:52:52 +01:00
server Better error handling in server 2016-02-18 22:01:13 +01:00
test Fixes #5 2016-02-25 21:16:03 +01:00
.gitignore Build proper HTML documentation 2016-01-13 23:19:06 +01:00
CHANGELOG.md Version 0.2.0 2016-02-25 22:44:41 +01:00
README.md Version 0.2.0 2016-02-25 22:44:41 +01:00
config.nims Improved docs. Fixed serialization problem. 2016-02-15 22:54:05 +01:00
copying.txt Added copyright 2015-12-28 22:22:51 +01:00
nimdoc.cfg Fixed link in generated documentation 2016-02-25 22:34:23 +01:00
nimyaml.nimble Version 0.2.0 2016-02-25 22:44:41 +01:00
yaml.nim Implemented and documented DOM 2016-02-22 21:56:30 +01:00

README.md

NimYAML - YAML implementation for Nim

NimYAML is currently being developed. The current release 0.2.0 is not considered stable. See the documentation for an overview of already available features.

TODO list

  • Misc:
    • Add type hints for more scalar types
  • Serialization:
    • Support for more standard library types
    • Support polymorphism
    • Support variant objects
    • Support transient fields (i.e. fields that will not be (de-)serialized on objects and tuples)
    • Check for and avoid name clashes when generating local tags for custom object types.
    • Possibly use genSym for predefined and generated yamlTag procs because they are an implementation detail and should not be visible to the caller. same goes for lazyLoadTag and safeLoadUri.

Developers

nim tests # runs all tests
nim parserTests # runs parser tests
nim serializationTests # runs serialization tests
nim documentation # builds documentation to folder docout
nim server # builds the REST server used for the testing ground
nim bench # runs benchmarks, requires libyaml
nim clean # guess
nim build # build a library

Project is tested against current develop branch of Nim. Older Nim versions probably do not work.

License

MIT