Rand Stats

YAMLScript

zef:ingy

YAMLScript

Program in YAML — Code is Data

Synopsis

#!/usr/bin/env ys-0

defn main(name='world'):
  say: "Hello, $name!"

Description

YAMLScript is a functional programming language with a stylized YAML syntax.

YAMLScript can be used for:

YAMLScript should be a drop-in replacement for your YAML loader!

Most existing YAML files are already valid YAMLScript files. This means that YAMLScript works as a normal YAML loader, but can also evaluate functional expressions if asked to.

Under the hood, YAMLScript code compiles to the Clojure programming language. This makes YAMLScript a complete functional programming language right out of the box.

Even though YAMLScript compiles to Clojure, and Clojure compiles to Java, there is no dependency on Java or the JVM. YAMLScript is compiled to a native shared library (libyamlscript.so) that can be used by any programming language that can load shared libraries.

To see the Clojure code that YAMLScript compiles to, you can use the YAMLScript command line utility, ys, to run:

$ ys --compile file.ys

Raku Usage

File prog.raku:

use YAMLScript;
my $program = slurp 'file.ys';
my YAMLScript $ys .= new;
say $ys.load($program);

File file.ys:

!yamlscript/v0

name =: "World"

=>::
  foo: [1, 2, ! inc(41)]
  bar:: load("other.yaml")
  baz:: "Hello, $name!"

File other.yaml:

oh: Hello

Run:

$ raku prog.raku
{bar => {oh => Hello}, baz => Hello, World!, foo => [1 2 42]}

Installation

You can install this module like any other Raku module:

$ zef install YAMLScript

but you will need to have a system install of libyamlscript.so.

One simple way to do that is with:

$ curl https://yamlscript.org/install | bash

Note: The above command will install the latest version of the YAMLScript command line utility, ys, and the shared library, libyamlscript.so, into ~/local/bin and ~/.local/lib respectively.

See https://github.com/yaml/yamlscript?#installing-yamlscript for more info.

See Also

Authors

Copyright 2022-2024 Ingy döt Net ingy@ingy.net

This project is licensed under the terms of the MIT license. See LICENSE for more details.