Skip to content

Latest commit

 

History

History
42 lines (27 loc) · 1.82 KB

README.md

File metadata and controls

42 lines (27 loc) · 1.82 KB
Raw

YAML

LUA YAML parser, based on js-lua , fast and tiny. Although this implementation does not currently support the entire YAML specification, feel free to fork the project and submit a patch :)

Usage

require('yaml').eval(string_of_yaml)

Currently Supports

  • Comments
  • Sequences (arrays)
  • Maps (hashes)
  • Inline sequences
  • Inline maps
  • Nesting
  • Primitive scalars (integers, floats, booleans, etc)
  • Extended bools (enabled, disabled, yes, no, on, off, true, false)

Installation

$ luarocks install lua-yaml

Testing

Install busted & luacheck luarocks install busted && luarocks install luacheck and run:

$ busted
$ luacheck yaml.lua

or just:

$ make test

License

(The MIT License)

Copyright (c) 2017 Dominic Letz [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.