Colora

DESCRIPTION

Colorizes terminal outputs.

Uses Rouge::Formatters::Terminal256 to theme/color output to the terminal. Color codes git diff.

INSTALL

$ gem install colora

Required Ruby version: >= 3.4

SYNOPSIS

$ colora ./README.md     # Color outputs file
$ cat README.md | colora # Colorizing filter
$ colora --git lib       # Git-diff with target
$ colora                 # Git-diff default

GIT-DIFF FILTERING

Colora will color code your git-diff output:

Deleted: :red
Replaced: :magenta
Inserted: :green
Edited: :black
Moved/Touched: :blue
Duplicated: :cyan
Context: :gray

One can choose to filter(via command line options) the diff output to:

Filter out context lines(quiet)
Just view in(+>) lines
Just view out(-<) lines
Just view edited code or comments
Just view duplicated code or comments
Toggle on/off lines on regexp

Additional features:

Swap tabs with tab symbol
Switch to a different theme(as provided by Rouge)

And I forgot to mention for the 1.0 release:

colora --git <\\h+..\\h+> will run git-diff on the given hex digests
colora --git <\\d> will diff to the nth(zero indexed) back commit
colora --git <\\d>..<\\d> will run git-diff on the given commit range(going back)

HELP

$ colora --help
Usage:
  colora [:options+] [<file=FILE>]
Options:
  -q --quiet
  --in           	 in lines, skip out lines
  --out          	 out lines, skip in lines
  -c --code      	 Show only new(changed) code
  -C --comment   	 Show only new(changed) comments
  -d --dupcode   	 Show only duplicate code
  -D --dupcomment	 Show only duplicate comments
  -G --git       	 Run git-diff
  -t --tab       	 Swap tab with ⇥
  --theme=NAME   	 Rouge theme(default: github)
  --lang=NAME    	 Language being diffed(default: ruby)
  --on=REGEXP    	 Start showing lines at this regexp
  --off=REGEXP   	 Stop showing lines at this regexp
  --fuzzy=FUZZY  	 Fuzzy match threshold (default: 0.618)
Types:
  FILE    /^[-\w\.\/]+$/
  NAME    /^[\d.a-z_]+$/
  REGEXP  /^\S+$/
  FUZZY   /^0.\d+$/
Exclusive:
  in out
  code comment dupcode dupcomment
# Notes: #
When no FILE is given and STDIN in a TTY, git-diff is run.
Known themes:
  base16 base16.monokai base16.solarized bw
  colorful
  github gruvbox
  igorpro
  magritte molokai monokai monokai.sublime
  pastie
  thankful_eyes tulip

LICENSE

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

colora

Runtime