# pretty-trace [![build status](https://secure.travis-ci.org/thlorenz/pretty-trace.png)](http://travis-ci.org/thlorenz/pretty-trace) [![testling badge](https://ci.testling.com/thlorenz/pretty-trace.png)](https://ci.testling.com/thlorenz/pretty-trace) Prettifies traces emitted by tools like lldb. ```js var prettyTrace = require('pretty-trace'); var lines = fs.readFileSync(__dirname + '/test/fixtures/lldb-trace.txt', 'utf8').split('\n'); var prettyLines = prettyTrace.lines(lines, prettyTrace.terminalTheme); console.log(prettyLines.join('\n')) ``` ![lldb-trace](https://raw.githubusercontent.com/thlorenz/pretty-trace/master/assets/lldb-trace.png) ## CLI ``` cat ./test/fixtures/lldb-trace.txt | pretty-trace ``` ## Installation npm install pretty-trace *Used by [resolve-jit-symbols](http://thlorenz.github.io/resolve-jit-symbols/web/)*.

prettyTrace::htmlTheme

A theme that surrounds the given trace using with spans classed trace-* in order to allow styling with CSS.

Source:

pretty-trace.js , lineno 202

prettyTrace::regexes::instruments

Regexes used to match callgraphs generated with Mac Instruments.

Source:

pretty-trace.js , lineno 44

prettyTrace::regexes::lldb

Regexes used to match debug traces created by tools like lldb.

Source:

pretty-trace.js , lineno 4

prettyTrace::regexes::perf

Regexes used to match callgraphs generated running Linux perf, i.e. perf script.

Source:

pretty-trace.js , lineno 60

prettyTrace::terminalTheme

A theme that colorizes the given trace using ANSI color codes.

Source:

pretty-trace.js , lineno 179

prettyTrace::line(line, theme) → {string}

Prettifies the given line.

Parameters:

Name Type Description

line

string

the line to be prettified

theme

Object

theme that specifies how to prettify a trace

Properties

Name	Type	Description
`raw`	function	invoked to surround an unparsable line
`frame`	function	invoked to surround the frame number
`address`	function	invoked to surround the hex address
`symbol`	function	invoked to surround the symbol corresponding to the address, i.e. a function name
`location`	function	invoked to surround the location in the file at which the symbol is found

Source:

pretty-trace.js , lineno 76

Returns:

prettified line

Type: string

prettyTrace::lines(lines, theme) → {Array.<string>}

Prettifies multiple lines.

Parameters:

Name	Type	Description
`lines`	Array.<string>	lines to be prettified
`theme`	Object	theme that specifies how to prettify a trace @see prettyTrace::line

Source:

pretty-trace.js , lineno 158

Returns:

the prettified lines

Type: Array.<string>

*generated with [docme](https://github.com/thlorenz/docme)*

## License MIT