rstacruz / hicat Goto Github PK

Command-line syntax highlighter

JavaScript 100.00%

hicat's Introduction

hicat 🐱

cat with syntax highlighting. The language is auto-detected through the file extension.

hicat index.js

Pipe something to hicat. The language will be inferred from the contents.

curl http://example.com | hicat

If hicat fails to detect a language, specify it using -l LANG.

curl http://example.com | hicat -l xml

Installation

npm install -g hicat

Usage:

$ hicat --help

  Usage:
      hicat [options] FILE
      ... | hicat [options]

  Options:
      -h, --help         print usage information
      -v, --version      show version info and exit
      -l, --lang LANG    use a given language
          --languages    list available languages
          --no-pager     disable the pager

Tips and tricks

Add an alias to your ~/.bashrc to save a few keystrokes.

alias hi=hicat

Btw

highlight.js powers the syntax highlighter engine.

Thanks

ricostacruz.com · GitHub @rstacruz · Twitter @rstacruz

hicat's People

Contributors

Stargazers

Watchers

Forkers

fth-ship linusu jamacy vrigzalejo mohsen1 buckocee sudhanne isonic1 sergiozt laurenspiegel paisakya divjyot dpopov pratheekhegde mrmatt57 prasannavasan thegoillot iurisegtovich mariodev12 impersin worldnull alexander-poe lechen26 mellistibco jadanlucas mdr0id digeler anath007 ezhov-da angulartist karimessouabni chrisingoetlc nikolasmelui gabrielacepeda chamsbg phamhhuy grantmontgomery minnanalee primofin gstoichkov antonydevanchi charlene19 mesam0518 chengs-u navya-aggarwal felipefury rosovskyi kadumaverick normanfrieman samdsmx camilleo22 roberfonseca paliwalradhika97

hicat's Issues

Make it possible to do `alias cat=hicat`

Just came across this and the first thing I thought was that I can maybe (finally) use a seamless alias for cat. Unfortunately, after a hicat --help, I realized this is not possible as cat -n == hicat -N.

IMHO supporting cat's options would make this a lot more useful, filling the void where other "cat replacements" (highlight, src-highlite, pygmentize, etc...) fall a bit short.

Most of cat's (small set of) options are not taken up by hicat. I think that -n and -e are the most popular.

Thoughts?

$ touch some_file
$ cat some_file 
$ hicat some_file 
/usr/local/lib/node_modules/hicat/index.js:38
  if (!out || !out.value) throw new Error("failed to highlight");
                          ^

Error: failed to highlight
    at hicat (/usr/local/lib/node_modules/hicat/index.js:38:33)
    at /usr/local/lib/node_modules/hicat/bin/hicat:82:20
    at Array.forEach (native)
    at /usr/local/lib/node_modules/hicat/bin/hicat:77:9
    at read (/usr/local/lib/node_modules/hicat/lib/read.js:59:5)
    at Object.<anonymous> (/usr/local/lib/node_modules/hicat/bin/hicat:75:1)
    at Module._compile (module.js:410:26)
    at Object.Module._extensions..js (module.js:417:10)
    at Module.load (module.js:344:32)
    at Function.Module._load (module.js:301:12)

Would be great if this use case could be fixed.

Minimist requires upgrade due to vulnerability

https://snyk.io/test/npm/minimist/0.2.0