diff options
author | toonn <toonn@toonn.io> | 2018-10-09 15:30:05 +0200 |
---|---|---|
committer | toonn <toonn@toonn.io> | 2019-06-18 13:26:21 +0200 |
commit | 429003ff268887c39eb73a15aa19dc400c8a11c4 (patch) | |
tree | 96243c031a5feb231849359b322f0ad3dc2abaee /ranger | |
parent | 19b62a6776e4e7820036919fddd4ce918085a358 (diff) | |
download | ranger-429003ff268887c39eb73a15aa19dc400c8a11c4.tar.gz |
Double up comment characters for comments
To make it easy to automatically strip comments from sections of code I doubled up the comment characters for actual comments. This works for everything but the shebang line.
Diffstat (limited to 'ranger')
-rwxr-xr-x | ranger/data/scope.sh | 117 |
1 files changed, 59 insertions, 58 deletions
diff --git a/ranger/data/scope.sh b/ranger/data/scope.sh index 5a0ece2b..9dad8609 100755 --- a/ranger/data/scope.sh +++ b/ranger/data/scope.sh @@ -3,27 +3,27 @@ set -o noclobber -o noglob -o nounset -o pipefail IFS=$'\n' -# If the option `use_preview_script` is set to `true`, -# then this script will be called and its output will be displayed in ranger. -# ANSI color codes are supported. -# STDIN is disabled, so interactive scripts won't work properly - -# This script is considered a configuration file and must be updated manually. -# It will be left untouched if you upgrade ranger. - -# Meanings of exit codes: -# code | meaning | action of ranger -# -----+------------+------------------------------------------- -# 0 | success | Display stdout as preview -# 1 | no preview | Display no preview at all -# 2 | plain text | Display the plain content of the file -# 3 | fix width | Don't reload when width changes -# 4 | fix height | Don't reload when height changes -# 5 | fix both | Don't ever reload -# 6 | image | Display the image `$IMAGE_CACHE_PATH` points to as an image preview -# 7 | image | Display the file directly as an image - -# Script arguments +## If the option `use_preview_script` is set to `true`, +## then this script will be called and its output will be displayed in ranger. +## ANSI color codes are supported. +## STDIN is disabled, so interactive scripts won't work properly + +## This script is considered a configuration file and must be updated manually. +## It will be left untouched if you upgrade ranger. + +## Meanings of exit codes: +## code | meaning | action of ranger +## -----+------------+------------------------------------------- +## 0 | success | Display stdout as preview +## 1 | no preview | Display no preview at all +## 2 | plain text | Display the plain content of the file +## 3 | fix width | Don't reload when width changes +## 4 | fix height | Don't reload when height changes +## 5 | fix both | Don't ever reload +## 6 | image | Display the image `$IMAGE_CACHE_PATH` points to as an image preview +## 7 | image | Display the file directly as an image + +## Script arguments FILE_PATH="${1}" # Full path of the highlighted file PV_WIDTH="${2}" # Width of the preview pane (number of fitting characters) PV_HEIGHT="${3}" # Height of the preview pane (number of fitting characters) @@ -33,7 +33,7 @@ PV_IMAGE_ENABLED="${5}" # 'True' if image previews are enabled, 'False' otherwi FILE_EXTENSION="${FILE_PATH##*.}" FILE_EXTENSION_LOWER="$(printf "%s" "${FILE_EXTENSION}" | tr '[:upper:]' '[:lower:]')" -# Settings +## Settings HIGHLIGHT_SIZE_MAX=262143 # 256KiB HIGHLIGHT_TABWIDTH=${HIGHLIGHT_TABWIDTH:-8} HIGHLIGHT_STYLE=${HIGHLIGHT_STYLE:-pablo} @@ -43,48 +43,48 @@ PYGMENTIZE_STYLE=${PYGMENTIZE_STYLE:-autumn} handle_extension() { case "${FILE_EXTENSION_LOWER}" in - # Archive + ## Archive a|ace|alz|arc|arj|bz|bz2|cab|cpio|deb|gz|jar|lha|lz|lzh|lzma|lzo|\ rpm|rz|t7z|tar|tbz|tbz2|tgz|tlz|txz|tZ|tzo|war|xpi|xz|Z|zip) atool --list -- "${FILE_PATH}" && exit 5 bsdtar --list --file "${FILE_PATH}" && exit 5 exit 1;; rar) - # Avoid password prompt by providing empty password + ## Avoid password prompt by providing empty password unrar lt -p- -- "${FILE_PATH}" && exit 5 exit 1;; 7z) - # Avoid password prompt by providing empty password + ## Avoid password prompt by providing empty password 7z l -p -- "${FILE_PATH}" && exit 5 exit 1;; - # PDF + ## PDF pdf) - # Preview as text conversion + ## Preview as text conversion pdftotext -l 10 -nopgbrk -q -- "${FILE_PATH}" - | fmt -w "${PV_WIDTH}" && exit 5 mutool draw -F txt -i -- "${FILE_PATH}" 1-10 | fmt -w "${PV_WIDTH}" && exit 5 exiftool "${FILE_PATH}" && exit 5 exit 1;; - # BitTorrent + ## BitTorrent torrent) transmission-show -- "${FILE_PATH}" && exit 5 exit 1;; - # OpenDocument + ## OpenDocument odt|ods|odp|sxw) - # Preview as text conversion + ## Preview as text conversion odt2txt "${FILE_PATH}" && exit 5 exit 1;; - # HTML + ## HTML htm|html|xhtml) - # Preview as text conversion + ## Preview as text conversion w3m -dump "${FILE_PATH}" && exit 5 lynx -dump -- "${FILE_PATH}" && exit 5 elinks -dump "${FILE_PATH}" && exit 5 ;; # Continue with next handler on failure - # JSON + ## JSON json) jq --color-output . "${FILE_PATH}" && exit 5 python -m json.tool -- "${FILE_PATH}" && exit 5 @@ -93,46 +93,47 @@ handle_extension() { } handle_image() { - # Size of the preview if there are multiple options or it has to be rendered - # from vector graphics. If the conversion program allows specifying only one - # dimension while keeping the aspect ratio, the width will be used. + ## Size of the preview if there are multiple options or it has to be + ## rendered from vector graphics. If the conversion program allows + ## specifying only one dimension while keeping the aspect ratio, the width + ## will be used. local DEFAULT_SIZE="1920x1080" local mimetype="${1}" case "${mimetype}" in - # SVG + ## SVG # image/svg+xml|image/svg) # convert -- "${FILE_PATH}" "${IMAGE_CACHE_PATH}" && exit 6 # exit 1;; - # DjVu + ## DjVu # image/vnd.djvu) # ddjvu -format=tiff -quality=90 -page=1 -size="${DEFAULT_SIZE}" \ # - "${IMAGE_CACHE_PATH}" < "${FILE_PATH}" \ # && exit 6 || exit 1;; - # Image + ## Image image/*) local orientation orientation="$( identify -format '%[EXIF:Orientation]\n' -- "${FILE_PATH}" )" - # If orientation data is present and the image actually - # needs rotating ("1" means no rotation)... + ## If orientation data is present and the image actually + ## needs rotating ("1" means no rotation)... if [[ -n "$orientation" && "$orientation" != 1 ]]; then - # ...auto-rotate the image according to the EXIF data. + ## ...auto-rotate the image according to the EXIF data. convert -- "${FILE_PATH}" -auto-orient "${IMAGE_CACHE_PATH}" && exit 6 fi - # `w3mimgdisplay` will be called for all images (unless overridden as above), - # but might fail for unsupported types. + ## `w3mimgdisplay` will be called for all images (unless overriden + ## as above), but might fail for unsupported types. exit 7;; - # Video + ## Video # video/*) # # Thumbnail # ffmpegthumbnailer -i "${FILE_PATH}" -o "${IMAGE_CACHE_PATH}" -s 0 && exit 6 # exit 1;; - # PDF + ## PDF # application/pdf) # pdftoppm -f 1 -l 1 \ # -scale-to-x "${DEFAULT_SIZE%x*}" \ @@ -142,18 +143,18 @@ handle_image() { # -- "${FILE_PATH}" "${IMAGE_CACHE_PATH%.*}" \ # && exit 6 || exit 1;; - # ePub, MOBI, FB2 (using Calibre) + ## ePub, MOBI, FB2 (using Calibre) # application/epub+zip|application/x-mobipocket-ebook|application/x-fictionbook+xml) # ebook-meta --get-cover="${IMAGE_CACHE_PATH}" -- "${FILE_PATH}" > /dev/null \ # && exit 6 || exit 1;; - # ePub (using <https://github.com/marianosimone/epub-thumbnailer>) + ## ePub (using <https://github.com/marianosimone/epub-thumbnailer>) # application/epub+zip) # epub-thumbnailer \ # "${FILE_PATH}" "${IMAGE_CACHE_PATH}" "${DEFAULT_SIZE%x*}" \ # && exit 6 || exit 1;; - # Font + ## Font application/font*|application/*opentype) preview_png="/tmp/$(basename "${IMAGE_CACHE_PATH%.*}").png" if fontimage -o "${preview_png}" \ @@ -174,8 +175,8 @@ handle_image() { fi ;; - # Preview archives using the first image inside. - # (Very useful for comic book collections for example.) + ## Preview archives using the first image inside. + ## (Very useful for comic book collections for example.) # application/zip|application/x-rar|application/x-7z-compressed|\ # application/x-xz|application/x-bzip2|application/x-gzip|application/x-tar) # local fn=""; local fe="" @@ -216,9 +217,9 @@ handle_image() { handle_mime() { local mimetype="${1}" case "${mimetype}" in - # Text + ## Text text/* | */xml) - # Syntax highlight + ## Syntax highlight if [[ "$( stat --printf='%s' -- "${FILE_PATH}" )" -gt "${HIGHLIGHT_SIZE_MAX}" ]]; then exit 2 fi @@ -236,21 +237,21 @@ handle_mime() { -- "${FILE_PATH}" && exit 5 exit 2;; - # DjVu + ## DjVu image/vnd.djvu) - # Preview as text conversion (requires djvulibre) + ## Preview as text conversion (requires djvulibre) djvutxt "${FILE_PATH}" | fmt -w ${PV_WIDTH} && exit 5 exiftool "${FILE_PATH}" && exit 5 exit 1;; - # Image + ## Image image/*) - # Preview as text conversion + ## Preview as text conversion # img2txt --gamma=0.6 --width="${PV_WIDTH}" -- "${FILE_PATH}" && exit 4 exiftool "${FILE_PATH}" && exit 5 exit 1;; - # Video and audio + ## Video and audio video/* | audio/*) mediainfo "${FILE_PATH}" && exit 5 exiftool "${FILE_PATH}" && exit 5 |