erikwdev/nyml

Nyml is a simple YAML-1.0-like implementation for Nim language

😋 A stupid simple YAML-like implementation in Nim language. From YML to JsonNode
Fast • Dependency free

Work in progress

Nyml has no serialization, tags, indicators or any weird things. In fact, Nyml is somewhere between toml and yaml If you need a YAML 1.2 compatible library go with flyx's NimYAML.

😍 Key Features

• integer, string, boolean, array, object
• GET access using dot annotations
• Rules and Validator
• Open Source | MIT License

Installing

nimble install nyml

Examples

The following example is taken from Madam's Configurator

Contents example

name: "Madam"
path: "./example"
port: 1230

templates:
    views: "views"
    layouts: "layouts"
    partials: "partials"

assets:
    source: "./dist/assets/*"
    public: "/assets"

console:
    logger: true                    # Enable http request logger
    clear: true                     # Clear previous console output on request

let doc = Nyml(engine: Y2J).parse(readFile("sample.yml"),
            rules = @[
                "name*:string",
                "path*:string",
                "port:int|1234",
                
                "templates*:object",
                "templates.layouts*:string",
                "templates.views*:string",
                "templates.partials*:string"
                
                "console:object"
                "console.logger:bool|true"
                "console.clear:bool|true"
            ])

if doc.hasErrorRules():
    let count = doc.getErrorsCount()
    let errorWord = if count == 1: "error" else: "errors"
    echo "👉 Found $1 $2 in your Madam configuration:" % [$count, errorWord]
    for err in doc.getErrorRules():
        echo err.getErrorMessage()
else:
    echo doc.get("name").getStr                     # Madam
    echo doc.get("assets.source").getStr            # ./dist/assets/*

Rules & Validators

need tests

Write your own rules as a seq[string]. The rule syntax is very simple, you got field_name*:string.

Note that field_name should point to a field_name key in your .yml file.

When followed by * it becomes a required field. Then you have the field type.

Now, let's take for example port:int|1234, which is an optional field of int type, with a default value 1234.

Roadmap

• Add tests
• Add more examples

❤ Contributions

If you like this project you can contribute to Nyml project by opening new issues, fixing bugs, contribute with code, ideas and you can even donate via PayPal address 🥰

👑 Discover Nim language

What's Nim? Nim is a statically typed compiled systems programming language. It combines successful concepts from mature languages like Python, Ada and Modula. Find out more about Nim language

Why Nim? Performance, fast compilation and C-like freedom. We want to keep code clean, readable, concise, and close to our intention. Also a very good language to learn in 2022.

🎩 License

Nyml is an Open Source Software released under MIT license. Developed by Humans from OpenPeep.
Copyright © 2022 OpenPeep & Contributors — All rights reserved.