0.1.0 • Published 11 months ago

@bearz/ansi v0.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

@bearz/ansi

Overview

The ansi module provides color detection, writing ansi codes, and an ansi writer.

logo

JSR npm version GitHub version

Documentation

Documentation is available on jsr.io

A list of other modules can be found at github.com/bearz-io/js

Usage

import { blue, writer, bgBlue, green, bold, apply } from "@bearz/ansi";

console.log(blue("test"));
console.log(green("success"));
writer.write("Hello, World!").writeLine();
writer.debug("Hello, World!");
writer.info("Hello, World!");
writer.success("Hello, World!");
writer.writeLine(apply("Hello, World!", bold, green, bgBlue) + " test");
writer.styleLine("Hello, World", bold, green);
writer.info("An informational message");
writer.writeLine(blue("My message"));
writer.writeLine(apply("Multiple Styles", bgBlue, bold));
writer.style("ok, ", blue);
writer.styleLine("success", green);

Notes

The core ansi functions in the styles module comes from Deno's @std/fmt/color with addition modififcations such as being less tied to deno and additional functions like apply and rgb24To8.

The detector module is heavily based on support color, but isn't a direct port.

The @bearz/process module is used for the writer class rather than console.log so that text is directly written to stdout and because stdout in that module abstracts the runtime specific stuff for deno, node, and bun.

License

Deno's MIT License

Support Colors MIT License

MIT License