Blyx

Towhee

Workflow framework · 0.1.0

Combine indentation and line-width diagnostics for a measured source file.

Locate the first actionable source-style violation

The second line exceeds its width limit and the third makes an illegal indentation jump. The first problem is zero-based row 1.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\towhee.exe --help in PowerShell or ./bin/towhee --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-towhee.git
cd blyx-towhee
blyxc native-run project.blyx -- "0,4,12" "60,88,70" 4 80

Why this framework exists

A line can have acceptable length but invalid indentation. Preserve both counts and show the earliest actionable row. PEP 8, indentation and line length

Install Towhee in your editor

Extension RahulChaube.blyx-towhee · 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-towhee-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 Towhee.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

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

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

You can also download Towhee as a ZIP. Extract its contents into vendor/towhee.

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

use vendor::towhee::towhee;

fn main() {
    let indent = [0, 4, 12];
    let widths = [60, 88, 70];
    let step = 4.0;
    let limit = 80.0;
    let result = towhee_lint(indent, widths, step, limit);
    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
1

API and input requirements

Returns [clean, indentation violations, overlong rows, first problem row]. Supply aligned nonblank physical lines and their display widths. Invalid arguments and nonfinite results return an empty vector.

APIUse
towhee_lint(indent, widths, step, limit)Returns [clean, indentation violations, overlong rows, first problem row]. Supply aligned nonblank physical lines and their display widths.

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.