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') 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 From c7154e88396fec404edfc8b03899949a2ce284ba Mon Sep 17 00:00:00 2001 From: Jay Schwerberg Date: Tue, 5 Mar 2019 22:34:12 -0800 Subject: Add pygments style env var for colorized --- plugins/colorize/colorize.plugin.zsh | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) (limited to 'plugins/colorize') diff --git a/plugins/colorize/colorize.plugin.zsh b/plugins/colorize/colorize.plugin.zsh index b8790f260..4e383867a 100644 --- a/plugins/colorize/colorize.plugin.zsh +++ b/plugins/colorize/colorize.plugin.zsh @@ -1,6 +1,6 @@ # easier alias to use the plugin alias ccat='colorize_via_pygmentize' -alias cless='colorize_via_pygmentize_less' +alias cless='colorize_via_pygmentize_less' colorize_via_pygmentize() { if ! (( $+commands[pygmentize] )); then @@ -8,36 +8,44 @@ colorize_via_pygmentize() { return 1 fi + # If the environment varianle ZSH_COLORIZE_STYLE + # is set, use that theme instead. Otherwise, + # use the default. + if [ -z $ZSH_COLORIZE_STYLE ]; then + ZSH_COLORIZE_STYLE="default" + fi + # pygmentize stdin if no arguments passed if [ $# -eq 0 ]; then - pygmentize -g + pygmentize -O style="$ZSH_COLORIZE_STYLE" -g return $? fi # guess lexer from file extension, or # guess it from file contents if unsuccessful + local FNAME lexer for FNAME in "$@" do lexer=$(pygmentize -N "$FNAME") if [[ $lexer != text ]]; then - pygmentize -l "$lexer" "$FNAME" + pygmentize -O style="$ZSH_COLORIZE_STYLE" -l "$lexer" "$FNAME" else - pygmentize -g "$FNAME" + pygmentize -O style="$ZSH_COLORIZE_STYLE" -g "$FNAME" fi done } -colorize_via_pygmentize_less() ( +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") -- cgit v1.2.3-70-g09d2 From a46798b7903dab20adf48bcad7eb69de2c8ed8a7 Mon Sep 17 00:00:00 2001 From: Jay Schwerberg Date: Tue, 5 Mar 2019 22:34:31 -0800 Subject: Update colorize README.md with env var details --- plugins/colorize/README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'plugins/colorize') diff --git a/plugins/colorize/README.md b/plugins/colorize/README.md index 71fa87861..d1f878e62 100644 --- a/plugins/colorize/README.md +++ b/plugins/colorize/README.md @@ -11,6 +11,12 @@ To use it, add colorize to the plugins array of your zshrc file: plugins=(... colorize) ``` +## Styles + +Pygments offers multiple styles. By default, the `default` style is used, but you can choose another theme by setting the `ZSH_COLORIZE_STYLE` environment variable: + +`ZSH_COLORIZE_STYLE="colorful"` + ## Usage * `ccat [files]`: colorize the contents of the file (or files, if more than one are provided). -- cgit v1.2.3-70-g09d2 From 56610be1989011fc7a5e84d27a811ca8feb646ff Mon Sep 17 00:00:00 2001 From: danhimalplanet Date: Mon, 29 Apr 2019 11:51:29 -0700 Subject: colorize: fix mktemp parameter for compatibility (#7789) --- plugins/colorize/colorize.plugin.zsh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins/colorize') diff --git a/plugins/colorize/colorize.plugin.zsh b/plugins/colorize/colorize.plugin.zsh index b8790f260..bec9a2ac6 100644 --- a/plugins/colorize/colorize.plugin.zsh +++ b/plugins/colorize/colorize.plugin.zsh @@ -39,7 +39,7 @@ colorize_via_pygmentize_less() ( 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_file="$(mktemp -t "tmp.colorize.XXXX.$(sed 's/\//./g' <<< "$1")")" tmp_files+=("$tmp_file") colorize_via_pygmentize "$1" > "$tmp_file" shift 1 -- cgit v1.2.3-70-g09d2