yaml/yamlscript

YAMLScript PHP binding - Program in YAML — Code is Data

Maintainers

Details

github.com/yaml/yamlscript-php

Homepage

Source

Issues

Chat

Documentation

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

0.2.2 2025-07-18 18:40 UTC

Requires

  • php: >=7.4
  • ext-ffi: *

Requires (Dev)

MIT 98395a92b0c683c952b46c606e443bb30decc0cc

  • Ingy döt Net <ingy.woop@ingy.net>

This package is auto-updated.

Last update: 2025-07-18 18:40:41 UTC

README

YS / YAMLScript

Add Logic to Your YAML Files

Synopsis

Load file.yaml with YS:

!YS-v0:

# Get data from external sources:
names-url =:
  'github:dominictarr/random-name/first-names.json'

name-list =: names-url:curl:json/load

# Data object with literal keys and generated values:
name:: name-list:shuffle:first
aka:: name-list:rand-nth
age:: &num 2 * 3 * 7
color:: &hue
  rand-nth: qw(red green blue yellow)
title:: "$(*num) shades of $(*hue)."

and get:

{
  "name": "Dolores",
  "aka": "Anita",
  "age": 42,
  "color": "green",
  "title": "42 shades of green."
}

Description

YS is a functional programming language with a clean YAML syntax.

YS can be used for enhancing ordinary YAML files with functional operations, such as:

  • Import (parts of) other YAML files to any node
  • String interpolation including function calls
  • Data transforms including ones defined by you

This YS library should be a drop-in replacement for your current YAML loader!

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

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

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

To see the Clojure code that YS compiles to, you can use the YS CLI binary ys to run:

$ ys --compile file.ys
(let
 [names-url "https://raw.githubusercontent.com/dominictarr/random-name/master/first-names.json"
  name-list (json/load (curl names-url))]
 (%
  "name" (first (shuffle name-list))
  "aka" (rand-nth name-list)
  "age" (_& 'num (mul+ 2 3 7))
  "color" (_& 'hue (rand-nth (qw red green blue yellow)))
  "title" (str (_** 'num) " shades of " (_** 'hue) ".")))

YAMLScript PHP

The PHP implementation of YAMLScript.

Installation

composer require yaml/yamlscript

Usage

use YAMLScript\YAMLScript;

$ys = new YAMLScript();
$result = $ys->load("inc: 41");
echo $result;  // Outputs: 42

Testing

composer test

Requirements

  • PHP 8.3 or later
  • Composer
  • Required PHP extensions:
    • dom
    • json
    • libxml
    • mbstring
    • tokenizer
    • xml
    • xmlwriter

See Also

Authors

Authors

  • Ingy döt Net

License & Copyright

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

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