From 576ada138fc5eed3f58a4aff8141e483310c90fb Mon Sep 17 00:00:00 2001 From: Stephan Salzmann Date: Fri, 19 Oct 2018 19:27:49 +0200 Subject: colorize: add README and refactor plugin (#7314) --- plugins/colorize/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 plugins/colorize/README.md (limited to 'plugins/colorize/README.md') diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md new file mode 100644 index 000000000..c006071f9 --- /dev/null +++ b/plugins/colorize/README.md @@ -0,0 +1,18 @@ +# colorize + +With this plugin you can syntax-highlight file contents of over 300 supported languages and other text formats. + +To use it, add colorize to the plugins array of your zshrc file: +``` +plugins=(... colorize) +``` + +## Usage + +* `ccat [files]`: colorize the contents of the file (or files, if more than one are provided). If no arguments are passed it will colorize the standard input or stdin. + +Colorize will highlight the content based on the filename extension. If it can't find a syntax-highlighting method for a given extension, it will try to find one by looking at the file contents. If no highlight method is found it will just cat the file normally, without syntax highlighting. + +## Requirements + +You have to install Pygments first: [pygments.org](http://pygments.org/download/) -- cgit v1.2.3-70-g09d2 From ebd13b60c107f424b40438404c18c3e8dc03433c Mon Sep 17 00:00:00 2001 From: Francisco de Zuviría Date: Mon, 22 Apr 2019 16:06:47 -0300 Subject: colorize: add ability to colorize multiple files into less (#7662) cless is an alias for a colorized less wrappper: colorize_via_pygmentize_less. Note that cless opens many files as independent files, navigatable with `:n` and `:p`. --- plugins/colorize/README.md | 15 +++++++++++++-- plugins/colorize/colorize.plugin.zsh | 23 ++++++++++++++++++++++- 2 files changed, 35 insertions(+), 3 deletions(-) (limited to 'plugins/colorize/README.md') diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md index c006071f9..71fa87861 100644 --- a/plugins/colorize/README.md +++ b/plugins/colorize/README.md @@ -2,6 +2,10 @@ With this plugin you can syntax-highlight file contents of over 300 supported languages and other text formats. +Colorize will highlight the content based on the filename extension. If it can't find a syntax-highlighting +method for a given extension, it will try to find one by looking at the file contents. If no highlight method +is found it will just cat the file normally, without syntax highlighting. + To use it, add colorize to the plugins array of your zshrc file: ``` plugins=(... colorize) @@ -9,9 +13,16 @@ plugins=(... colorize) ## Usage -* `ccat [files]`: colorize the contents of the file (or files, if more than one are provided). If no arguments are passed it will colorize the standard input or stdin. +* `ccat [files]`: colorize the contents of the file (or files, if more than one are provided). + If no arguments are passed it will colorize the standard input or stdin. + +* `cless [files]`: colorize the contents of the file (or files, if more than one are provided) and + open less. If no arguments are passed it will colorize the standard input or stdin. -Colorize will highlight the content based on the filename extension. If it can't find a syntax-highlighting method for a given extension, it will try to find one by looking at the file contents. If no highlight method is found it will just cat the file normally, without syntax highlighting. +Note that `cless` will behave as less when provided more than one file: you have to navigate files with +the commands `:n` for next and `:p` for previous. The downside is that less options are not supported. +But you can circumvent this by either using the LESS environment variable, or by running `ccat file1 file2|less --opts`. +In the latter form, the file contents will be concatenated and presented by less as a single file. ## Requirements diff --git a/plugins/colorize/colorize.plugin.zsh b/plugins/colorize/colorize.plugin.zsh index 8eede9a94..b8790f260 100644 --- a/plugins/colorize/colorize.plugin.zsh +++ b/plugins/colorize/colorize.plugin.zsh @@ -1,5 +1,6 @@ # easier alias to use the plugin alias ccat='colorize_via_pygmentize' +alias cless='colorize_via_pygmentize_less' colorize_via_pygmentize() { if ! (( $+commands[pygmentize] )); then @@ -16,7 +17,7 @@ colorize_via_pygmentize() { # guess lexer from file extension, or # guess it from file contents if unsuccessful local FNAME lexer - for FNAME in $@ + for FNAME in "$@" do lexer=$(pygmentize -N "$FNAME") if [[ $lexer != text ]]; then @@ -26,3 +27,23 @@ colorize_via_pygmentize() { fi done } + +colorize_via_pygmentize_less() ( + # this function is a subshell so tmp_files can be shared to cleanup function + declare -a tmp_files + + cleanup () { + [[ ${#tmp_files} -gt 0 ]] && rm -f "${tmp_files[@]}" + exit + } + trap 'cleanup' EXIT HUP TERM INT + + while (( $# != 0 )); do #TODO: filter out less opts + tmp_file="$(mktemp --tmpdir "tmp.colorize.XXXX.$(sed 's/\//./g' <<< "$1")")" + tmp_files+=("$tmp_file") + colorize_via_pygmentize "$1" > "$tmp_file" + shift 1 + done + + less -f "${tmp_files[@]}" +) -- cgit v1.2.3-70-g09d2