Blyx

Nuthatch

Workflow framework · 0.1.0

Wrap a message and preserve a valid scroll position after resizing a terminal.

Keep terminal help visible after a resize

Four words each occupy their own line. A scroll request past the end selects the last two visible lines.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\nuthatch.exe --help in PowerShell or ./bin/nuthatch --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-nuthatch.git
cd blyx-nuthatch
blyxc native-run project.blyx -- "4,4,4,4" 6 99 2

Why this framework exists

After a terminal becomes wider, the old scroll offset can leave an otherwise valid help screen blank. Python, text wrapping

Install Nuthatch in your editor

Extension RahulChaube.blyx-nuthatch · 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-nuthatch-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 Nuthatch.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Nuthatch 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-nuthatch=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/nuthatch/main.blyx

To use this package in your application, copy share/blyx/nuthatch/vendor/nuthatch 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-nuthatch.git vendor/nuthatch

You can also download Nuthatch as a ZIP. Extract its contents into vendor/nuthatch.

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

use vendor::nuthatch::nuthatch;

fn main() {
    let widths = [4, 4, 4, 4];
    let columns = 6.0;
    let start = 99.0;
    let height = 2.0;
    let result = nuthatch_layout(widths, columns, start, height);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

4
2
4
4

API and input requirements

Returns [wrapped line count, first visible line, exclusive end, last line width]. The host supplies display-cell widths for its font. Invalid arguments and nonfinite results return an empty vector.

APIUse
nuthatch_layout(widths, columns, start, height)Returns [wrapped line count, first visible line, exclusive end, last line width]. The host supplies display-cell widths for its font.

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.