Command line utility for highlighting log files
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
tests
.gitignore
LICENSE
README.md
config.js
highlighter.js
lch.js
liner.js
package-lock.json
package.json
parseCmd.js
sample.png
string-argv.js

README.md

log-color-highlight

Node Js command line utility for highlighting log files.

Demo

Install

$ npm install log-color-highlight -g

Usage

lch [options] -style1 regex1 [-style2 regex2] ...

Options

-f filePath     Input file path.
                If this is not provided standard input is used
-c configPath   Path to configuration file.
-s style        Implicit style.
-cs             Case sensitive.
                By default text matching is done case insensitive.
-p              Add style/modifier preset.
-h --help       Prints this help message.

Highlighting

Multiple styles may be combined using dot notation.

echo Information, warnings, errors | lch -green info -yellow.bold warn error failure

If no style is specified it defaults to red. This behavior may be altered with -s option which is mostly useful if specified in configuration files.

echo Some errors | lch error

Styles

Colors: black, red, green, yellow, blue, magenta, cyan, white, gray

Background colors: bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite

Styling: reset, bold, dim, italic, underline, inverse, hidden, strikethrough

Modifiers

cs Forces matches to be case sensitive..

echo Info, Warn | lch -green.cs info -yellow warn

wl Highlights the whole line

echo highlight whole line | node lch.js -green.wl whole -yellow light

esc Escapes regex special characters

echo [error] ... [info] | lch -red.esc [error] -yellow "\[info\]"

Presets

Define common style. Useful together with configuration files.

echo "[error] ... [info]" | lch -p err=red.bold -p inf=yellow.bold -err error -inf info

Configuration file

Supports the same highlighting syntax as used from command line. In addition allows multiple lines and comments.

# Presets
-p failure=red.bold
-p success=green.bold

# Highlighting
-yellow.bold warn warning warnings deprecated

-success success successful successfully
-success "Operation.*completed"

-failure "Operation.*failed"
-failure err error errors erroneous
-failure wrong
-failure fail failure
echo Successful, warnings, errors | lch -c lch.conf

Examples

Highlight 'error' and 'warn' in default color (red)

echo some errors and warnings | lch error warn

Styles

echo "log color highlight" | lch -red.bold log -blue.italic.underline highlight

Implicit style

echo "implicit style" | lch -s bold -red implicit -red.reset style

Force case sensitive globally

echo "case sensitive" | lch -cs sensitive CASE

Toggle case sensitivity per pattern using cs and ci modifiers

echo "case sensitive Case Sensitive" | lch -green.cs sensitive -red case
echo "case sensitive Case Sensitive" | lch -cs -green sensitive -red.ci.bold case

Regular expressions

echo "using regular expressions" | lch -green .*regular -blue exp.*

Escape regex special characters. Following examples are equivalent.

echo "[ERROR] On receive (ctrl) - monitorId" | lch -red.esc [error] -cyan.esc "receive (ctrl) - monitorId"
echo "[ERROR] On receive (ctrl) - monitorId" | lch -red \[error\] -cyan "receive \(ctrl\) - monitorId"

Later options take precedence over previous ones

echo "log color highlight" | lch -green "log color highlight" -blue "color" -red "lor hi"

Nested highlights

echo "log color highlight" | lch -blue "color" -red "log color"

Test

cd log-color-highlight
npm install
npm test

Changelog

1.4.0 whole line modifier
      updated cli help message/readme
1.3.0 config file is searched in user home folder or LCH_CONFIG env variable path
1.2.0 presets
1.1.1 regular expression escape modifier
1.1.0 case sensitivity modifiers

Alternatives

Lch doesn't fit? Try one of the following.