mirror of https://github.com/status-im/NimYAML.git
YAML implementation for Nim
https://nimyaml.org
d1c8c171a1
|
||
|---|---|---|
| bench | ||
| doc | ||
| private | ||
| server | ||
| test | ||
| .gitignore | ||
| CHANGELOG.md | ||
| README.md | ||
| config.nims | ||
| copying.txt | ||
| nimdoc.cfg | ||
| nimyaml.nimble | ||
| yaml.nim | ||
README.md
NimYAML - YAML implementation for Nim
NimYAML is currently being developed. The current release 0.3.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 generic 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.
Developers
nim tests # runs unit tests (serialization, dom, json)
# for parser tests, see yamlTestSuite
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
nim yamlTestSuite # execute YAML test suite (git-clones yaml-dev-kit)
Project is tested against current develop branch of Nim. Older Nim versions probably do not work.