Git Product home page Git Product logo

yamly's Introduction

EO principles respected here

Responsible: MSE

Yamly

Simple encapsulation of YamlDotNet and the querying extension YamlPathForYamlDotNet to read and navigate yaml documents

Usage

The IYAML interface provides method to read values from a yaml or naviagte to deeper nodes:

/// <summary>
/// methods for reading a yaml file
/// </summary>
public interface IYaml
{
    /// <summary>
    /// lists all nodes at the given path
    /// </summary>
    IList<IYaml> Nodes(string path);

    /// <summary>
    /// the value at the given path
    /// </summary>
    string Value(string path, string def = "");

    /// <summary>
    /// the values at the given path
    /// </summary>
    IList<string> Values(string path);

    YamlNode AsNode();
}

To use it just call the implementation class new YamlOf(yourYamlContentText) and navigate with yaml path, which is documented here

Examples

yamlContent:

root:
  object:
    name: test
    type: text
    value: hello
  objectlist:
    - name: test1
      type: text
      value: hello
    - name: test2
      type: number
      value: 2
  list:
    - test1
    - test2
    - test3
[Fact]
public void ReadsValues()
{
    var yaml = new YamlOf(yamlContent);

    Assert.Equal(
        new ManyOf("test1", "test2", "test3"),
        yaml.Values("/root/list/*")
    );
}

yamly's People

Contributors

mse1188 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.