Skip to content

Latest commit

 

History

History
151 lines (108 loc) · 7.33 KB

README.md

File metadata and controls

151 lines (108 loc) · 7.33 KB
Raw

Console.hx is a haxe logging utility for easy rich output in both native and browser consoles via a familiar HTML-like tag syntax. Supports haxe 3 and haxe 4.

For example:

Console.log('<b>Don’t</> <red,u>Panic.</>');

This will print in your console something like:

don't-panic

(Depending on your console color settings). This will also work in a browser console when targeting the web. All console output can be disable by passing -D no_console.

Installing

haxelib install console.hx

And add -lib Console.hx when compiling your haxe code

API

Console.log(...args)

log() prints all arguments to stdout. String type arguments will have <tags> processed by the formatter. The log prefix can be configured by setting Console.logPrefix.

Example

Console.log('<b>Hello</>', '<i>world</i>')

> Hello world

Console.warn(...args)

warn() prints all arguments to stderr. String type arguments will have <tags> processed by the formatter. The warn prefix can be configured by setting Console.warnPrefix.

Console.error(...args)

error() prints all arguments to stderr. String type arguments will have <tags> processed by the formatter. By default, errors will be printed in red, the error prefix (including formatting) configured by setting Console.errorPrefix.

Console.success(...args)

success() prints all arguments to stdout. String type arguments will have <tags> processed by the formatter. The success prefix can be configured by setting Console.successPrefix.

Console.debug(...args)

debug() output will only appear in the console when the haxe -debug flag is set and output is prefixed with the line number like trace(). String type arguments will have <tags> processed by the formatter. The debug prefix can be configured by setting Console.debugPrefix.

Example

Console.debug('hello', 'world')

> Main:5: hello world

Console.examine(...args)

examine() prints variable names alongside their values

Example

var x = 31.1;
var y = 65.3;
Console.examine(x, y);

> x: 32.1 y: 65.3

Console.printlnFormatted( string: String, outputStream: Log | Warn | Error | Debug = Log)

Print a line to the console after processing <tags> but without a log prefix

Console.println( string: String, outputStream: Log | Warn | Error | Debug = Log)

Print a line directly to the console without processing formatting <tags>.

Formatting

  • Apply formatting with HTML-like tags: <b>bold</b> or <i>italic</i>
  • Close the last tag with shorthand </>: <b>bold</> not bold
  • A double-closing tag like <//> will clear all active formatting
  • Formatting can be combined into a single tag: <b,i>bold and italic</>
  • Hex colors can be used (including CSS shorthand form), for example
    • <#FF0000>Red Text</>
    • <bg#F00>Red Background</>
  • Whitespace is not allowed in tags, so <b > would be ignored and printed as-is
  • Tags can be escaped with a leading backslash: \<b> would be printed as <b>
  • CSS can be used when targeting web browsers: for example: <{color: red; font-size: 20px}>Inline CSS</>. These will have no affect on native consoles

Available Tags

Tag Name Description
<reset>, <//> Clear all previous formatting
</> Close last open formatting
<bold>, <b> Format as bold
<italic>, <i> Format as italic
<dim> Dimmed color
<underline>, <u> Underline
<blink> Blink (Native console only)
<invert>, <!> Invert colors (Native console only)
<hidden> Hide text (Native console only)
<#FF0000> Use hex for text color
<bg#FF0000> Use hex for background color
<black> Black text color
<red> Red text color
<green> Green text color
<yellow> Yellow text color
<blue> Blue text color
<magenta> Magenta text color
<cyan> Cyan text color
<white> White text color
<light_black>, <gray> Light black text color / gray
<light_red> Light red text color
<light_green> Light green text color
<light_yellow> Light yellow text color
<light_blue> Light blue text color
<light_magenta> Light magenta text color
<light_cyan> Light cyan text color
<light_white> Light white text color
<bg_black> Text background black
<bg_red> Text background red
<bg_green> Text background green
<bg_yellow> Text background yellow
<bg_blue> Text background blue
<bg_magenta> Text background magenta
<bg_cyan> Text background cyan
<bg_white> Text background white
<bg_light_black>, <gray> Text background light black / gray
<bg_light_red> Text background light red
<bg_light_green> Text background light green
<bg_light_yellow> Text background light yellow
<bg_light_blue> Text background light blue
<bg_light_magenta> Text background light magenta
<bg_light_cyan> Text background light cyan
<bg_light_white> Text background light white

Supported Targets

Formatting should work on mac, linux and browser consoles for all targets, however for built-in Windows consoles like Command Prompt and PowerShell, only Neko and C++ will produce colored output (assuming you're running a fairly recent build of Windows 10)

Target Platform Supported
JS Chrome, Firefox, Safari ✔
JS, C++, Neko, PHP, Python, HL MacOS ✔
JS, C++, Neko, PHP, Python, HL Linux Common Terminals ✔
C++, Neko Windows Command Prompt ✔