Terminal Formatter

ANSI escape codes for shell output.

Options

Runtime	Options
Rust	language, theme, background, width
Elixir	language, theme, background, width
JavaScript	language, theme
Java	withLang(), withTheme(), withFormatter(Formatter.TERMINAL)
CLI	default formatter, --theme, --background, --width

Example

JavaScript

import {highlight} from '@lumis-sh/lumis'
import {terminal} from '@lumis-sh/lumis/formatters'
import javascript from '@lumis-sh/lumis/langs/javascript'
import dracula from '@lumis-sh/themes/dracula'

const ansi = await highlight('const x = 1', terminal({language: javascript, theme: dracula}))
console.log(ansi)

Rust

use lumis::{highlight, TerminalBackground, TerminalBuilder, languages::Language, themes};

let ansi = highlight(
    "fn main() {}",
    TerminalBuilder::new()
        .language(Language::Rust)
        .theme(Some(themes::get("dracula").unwrap()))
        .background(TerminalBackground::Theme)
        .width(Some(120))
        .build()
        .unwrap(),
);

println!("{}", ansi);

Elixir

Lumis.highlight!(
  "fn main() {}",
  formatter: {:terminal, language: "rust", theme: "dracula", background: :theme, width: 120}
)

Java

import io.roastedroot.lumis4j.core.Formatter;
import io.roastedroot.lumis4j.core.Lang;
import io.roastedroot.lumis4j.core.Lumis;
import io.roastedroot.lumis4j.core.Theme;

var lumis = Lumis.builder().build();

var highlighter = lumis.highlighter()
    .withLang(Lang.JAVASCRIPT)
    .withTheme(Theme.DRACULA)
    .withFormatter(Formatter.TERMINAL)
    .build();

var ansi = highlighter.highlight("const x = 1").string();
System.out.println(ansi);

lumis.close();

CLI

lumis highlight main.rs --theme dracula
# same as: lumis highlight main.rs --formatter terminal --theme dracula
lumis highlight main.rs --theme dracula --background theme
lumis highlight main.rs -b '#282a36' -w 120

Output format

Terminal output is plain text wrapped in ANSI escape sequences:

\x1b[38;2;229;192;123mfn\x1b[0m \x1b[38;2;97;175;239mmain\x1b[0m() {}

• the source stays as terminal text, not HTML
• ANSI escape sequences set foreground color and text styles
• background / --background controls the fallback background: omit it to inherit the output background, use theme to reuse the theme background, or pass a hex color
• width / --width pads each rendered line to the requested width; in the CLI, auto uses the current terminal width when available, and -w is the short form
• \x1b[0m resets formatting between styled segments

When to use it

• CLI tools
• logs and local scripts
• previewing highlighted code in a terminal