balagan

🙅 put some order to all of this mess

Install

npm i balagan

Usage

import {
  help,
  hint,
  note,
  code,
  frame,
  inline,
  renderAnnotated,
} from "balagan";

// Styled messages
console.log(help("run with --verbose for more info"));
console.log(hint("try using a different port"));
console.log(note("this feature is experimental"));

// Inline code styling
console.log(`Use ${code("npm start")} to begin`);

// Frame content in a tree structure
console.log(
  frame("2 errors emitted", ["Missing semicolon", "Undefined variable"]),
);

// Annotate code with explanations (compiler-style)
console.log(inline`function ${["hello", "invalid name"]}() {}`);
// Output:
// function hello() {}
//          ──┬──
//            ╰▶ invalid name

// Or use renderAnnotated with absolute offsets
console.log(
  renderAnnotated("function hello() {}", [
    { start: 9, end: 14, explain: "invalid name" },
  ]),
);

API

• help(msg) - Blue "help:" prefixed message
• hint(msg) - Blue "hint:" prefixed message
• note(msg) - Blue "note:" prefixed message
• code(str) - Inline code with backticks
• frame(text, contents) - Tree-framed content
• inline - Template tag for inline annotations with underlines
• renderAnnotated(text, markers) - Annotate text with markers at absolute offsets

License

MIT