everlastingbugstopper/billboard

create informational boxes in the terminal

Hi there 👋

I'm a devtools engineer! Check out averyharnish.com for my personal site.

Professional Repositories

In the past I've worked at Apollo GraphQL and Cloudflare.

At Apollo, I worked on the 🤖 Rover CLI. Related repositories are federation-rs, router, awc and apollo-rs.

At Cloudflare, I worked on v1 of the 🤠 Wrangler CLI. Related repositories are kv-asset-handler, worker-typescript-template, workers-docs, and worker-sites-template.

Open Source Repositories

I also maintain some open source Rust crates. Check out shell-candy if you want to shell out to a sub-process and handle their stdout/stderr as streams. Or, you can check out billboard if you want to display boxes with outlines in your terminal.

I also maintain binary-install which allows you to extract a binary from a tarball endpoint and shell out to it from node. It's not the best library out there and I'd love help modernizing it and rewriting it in TypeScript.

---

billboard's Issues

Polish documentation

The docs are inconsistent with punctuation and newlines

Add examples to documentation

There are overall examples in the examples directory, but there should also be good examples in the documentation.

Boxx layout is incorrect when text have ansi escape characters on it

Sometimes you want to put some color on the text inside of the Box.

Right now, if you do it Boxx will improperly calculate the length of the line where the colors are used.
See attached screenshot:

Some code that can trigger this is:

let message = format!(
        "There's a new version of the software! {} → {}\nUpdate with {}",
       "11".red(),
        "12".green(),
        "software self-update".green().bold()
    );
Boxx::builder().border_style(BorderStyle::Round).build().display(&message);

I think this can be easily solved by using a "cleaning" function over the provided text to Boxx, so ansi characters are cleaned out, similar to the following implementation in JS:

/**
  This function removes the ansi escape characters
  (normally used for printing colors and so)
  Inspired by: https://github.com/chalk/ansi-regex/blob/master/index.js
  MIT License Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
 */
const cleanStdout = (stdout) => {
  const pattern = [
    "[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)",
    "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))"
  ].join("|");

  const regexPattern = new RegExp(pattern, "g");
  return stdout.replace(regexPattern, "");
};

More context on the issue here: wasmerio/wapm-cli#169