Blyx

Bulbul

Workflow framework · 0.1.0

Check required and extra fields in an already parsed object.

Validate required and extra object fields

The example both omits required field 2 and supplies unrecognized field 9. The report retains both counts.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\bulbul.exe --help in PowerShell or ./bin/bulbul --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-bulbul.git
cd blyx-bulbul
blyxc native-run project.blyx -- "1,9" "1,2" "1,2" 1

Why this framework exists

Rejecting unknown fields and enforcing required fields are independent policy choices. Return both diagnostics in one pass through the workflow. JSON Schema, object properties

Install Bulbul in your editor

Extension RahulChaube.blyx-bulbul · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-bulbul-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Bulbul.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Bulbul 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-bulbul=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/bulbul/main.blyx

To use this package in your application, copy share/blyx/bulbul/vendor/bulbul from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-bulbul.git vendor/bulbul

You can also download Bulbul as a ZIP. Extract its contents into vendor/bulbul.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::bulbul::bulbul;

fn main() {
    let present = [1, 9];
    let allowed = [1, 2];
    let required = [1, 2];
    let closed = 1.0;
    let result = bulbul_shape(present, allowed, required, closed);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

0
1
1
2

API and input requirements

Returns [accepted, missing count, extra count, first missing ID]. Use an explicit field-name-to-ID map. Closed mode rejects extra fields; required IDs must be in the declared allowed set. Invalid arguments and nonfinite results return an empty vector.

APIUse
bulbul_shape(present, allowed, required, closed)Returns [accepted, missing count, extra count, first missing ID]. Use an explicit field-name-to-ID map. Closed mode rejects extra fields; required IDs must be in the declared allowed set.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.