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
208 Commits 6 Branches 31 Tags 2.3 MiB
Nim 98.7%
Nix 1.3%
Go to file
Felix Krause cde346b85c Switched to indentation of 2 spaces 2016-04-02 17:48:22 +02:00
bench Added benchmark for processing YAML input 2016-03-20 10:32:14 +01:00
doc Added advanced example to index.html 2016-03-25 23:12:00 +01:00
private Switched to indentation of 2 spaces 2016-04-02 17:48:22 +02:00
server Switched to indentation of 2 spaces 2016-04-02 17:48:22 +02:00
test Switched to indentation of 2 spaces 2016-04-02 17:48:22 +02:00
.gitignore Added benchmark for processing YAML input 2016-03-20 10:32:14 +01:00
CHANGELOG.md Version 0.4.0 2016-03-25 23:20:17 +01:00
README.md Version 0.4.0 2016-03-25 23:20:17 +01:00
config.nims Switched to indentation of 2 spaces 2016-04-02 17:48:22 +02: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.4.0 2016-03-25 23:20:17 +01:00
yaml.nim Switched to indentation of 2 spaces 2016-04-02 17:48:22 +02:00

README.md

NimYAML - YAML implementation for Nim

NimYAML is currently being developed. The current release 0.4.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.

License

MIT