File: nn.sh
   1 #!/bin/sh
   2 
   3 # The MIT License (MIT)
   4 #
   5 # Copyright © 2020-2025 pacman64
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining a copy
   8 # of this software and associated documentation files (the “Software”), to deal
   9 # in the Software without restriction, including without limitation the rights
  10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11 # copies of the Software, and to permit persons to whom the Software is
  12 # furnished to do so, subject to the following conditions:
  13 #
  14 # The above copyright notice and this permission notice shall be included in
  15 # all copies or substantial portions of the Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23 # SOFTWARE.
  24 
  25 
  26 # nn [option...] [files...]
  27 #
  28 #
  29 # Nice Numbers restyles all runs of 4+ digits by alternating ANSI-styles
  30 # every 3-digit group, so long numbers become easier to read at a glance.
  31 #
  32 # All (optional) leading options start with either single or double-dash,
  33 # and most of them change the style/color used. Some of the options are,
  34 # shown in their single-dash form:
  35 #
  36 #     -h          show this help message
  37 #     -help       show this help message
  38 #
  39 #     -b          use a blue color
  40 #     -blue       use a blue color
  41 #     -bold       bold-style digits
  42 #     -g          use a green color
  43 #     -gray       use a gray color (default)
  44 #     -green      use a green color
  45 #     -hi         use a highlighting/inverse style
  46 #     -highlight  use a highlighting/inverse style
  47 #     -hilite     use a highlighting/inverse style
  48 #     -inverse    use a highlighting/inverse style
  49 #     -m          use a magenta color
  50 #     -magenta    use a magenta color
  51 #     -o          use an orange color
  52 #     -orange     use an orange color
  53 #     -p          use a purple color
  54 #     -purple     use a purple color
  55 #     -r          use a red color
  56 #     -red        use a red color
  57 #     -u          underline digits
  58 #     -underline  underline digits
  59 
  60 
  61 case "$1" in
  62     -h|--h|-help|--help)
  63         awk '/^# +nn /, /^$/ { gsub(/^# ?/, ""); print }' "$0"
  64         exit 0
  65     ;;
  66 esac
  67 
  68 [ "$1" = "--" ] && shift
  69 
  70 if [ -p 1 ] || [ -t 1 ]; then
  71     command="stdbuf -oL awk"
  72 else
  73     command="awk"
  74 fi
  75 
  76 name="${1:-gray}"
  77 [ $# -gt 0 ] && shift
  78 
  79 # general case to handle actual styles
  80 ${command} -v name="${name}" '
  81     BEGIN {
  82         orig = name
  83         gsub(/^-{1,2}/, "", name)
  84 
  85         # alias-lookup table
  86         a["r"] = "red"
  87         a["g"] = "green"
  88         a["b"] = "blue"
  89         a["o"] = "orange"
  90         a["p"] = "purple"
  91         a["m"] = "magenta"
  92         a["h"] = "invert"
  93         a["i"] = "invert"
  94         a["u"] = "underline"
  95         a["or"] = "orange"
  96         a["ma"] = "magenta"
  97         a["hi"] = "invert"
  98         a["in"] = "invert"
  99         a["un"] = "underline"
 100         a["inv"] = "invert"
 101         a["mag"] = "magenta"
 102         a["grey"] = "gray"
 103         a["inverse"] = "invert"
 104         a["inverted"] = "invert"
 105         a["hilite"] = "invert"
 106         a["hilited"] = "invert"
 107         a["highlight"] = "invert"
 108         a["highlighted"] = "invert"
 109         a["underlined"] = "underline"
 110         a["bb"] = "blueback"
 111         a["gb"] = "greenback"
 112         a["mb"] = "magentaback"
 113         a["ob"] = "orangeback"
 114         a["pb"] = "purpleback"
 115         a["rb"] = "redback"
 116         a["bg"] = "greenback"
 117         a["bm"] = "magentaback"
 118         a["bo"] = "orangeback"
 119         a["bp"] = "purpleback"
 120         a["br"] = "redback"
 121         a["bluebg"] = "blueback"
 122         a["graybg"] = "grayback"
 123         a["greenbg"] = "greenback"
 124         a["greyback"] = "grayback"
 125         a["greybg"] = "grayback"
 126         a["magentabg"] = "magentaback"
 127         a["orangebg"] = "orangeback"
 128         a["purplebg"] = "purpleback"
 129         a["redbg"] = "redback"
 130         a["magback"] = "magentaback"
 131         a["magbg"] = "magentaback"
 132         a["orback"] = "orangeback"
 133         a["orbg"] = "orangeback"
 134         a["purback"] = "purpleback"
 135         a["purbg"] = "purpleback"
 136 
 137         # style-lookup table
 138         s["red"] = "\x1b[38;2;204;0;0m"
 139         s["green"] = "\x1b[38;2;0;135;95m"
 140         s["blue"] = "\x1b[38;2;0;95;215m"
 141         s["orange"] = "\x1b[38;2;215;95;0m"
 142         s["purple"] = "\x1b[38;2;135;95;255m"
 143         s["magenta"] = "\x1b[38;2;215;0;255m"
 144         s["gray"] = "\x1b[38;2;168;168;168m"
 145         s["bold"] = "\x1b[1m"
 146         s["invert"] = "\x1b[7m"
 147         s["italic"] = "\x1b[3m"
 148         s["underline"] = "\x1b[4m"
 149         s["blueback"] = "\x1b[48;2;0;95;215m\x1b[38;2;238;238;238m"
 150         s["grayback"] = "\x1b[48;2;168;168;168m\x1b[38;2;238;238;238m"
 151         s["greenback"] = "\x1b[48;2;0;135;95m\x1b[38;2;238;238;238m"
 152         s["magentaback"] = "\x1b[48;2;215;0;255m\x1b[38;2;238;238;238m"
 153         s["orangeback"] = "\x1b[48;2;215;95;0m\x1b[38;2;238;238;238m"
 154         s["purpleback"] = "\x1b[48;2;135;95;255m\x1b[38;2;238;238;238m"
 155         s["redback"] = "\x1b[48;2;204;0;0m\x1b[38;2;238;238;238m"
 156 
 157         # resolve aliases
 158         if (a[name] != "") name = a[name]
 159 
 160         # handle unsupported style-names with an error
 161         if (s[name] == "") {
 162             fmt = "\x1b[31munsupported style/color name `%s`\x1b[0m\n"
 163             printf fmt, orig > "/dev/stderr"
 164             exit 1
 165         }
 166 
 167         # match ANSI-code to the name
 168         style = s[name]
 169     }
 170 
 171     # (re)style all long-enough digit-runs/numbers in lines
 172     {
 173         # ignore screen/buffer-switching ANSI-codes, to avoid corrupting them
 174         gsub(/\x1b\[([0-9]{4,}[A-Za-z])/, "")
 175 
 176         line = $0
 177 
 178         # restyle digit-runs which are longer than 3
 179         while (match(line, /[0-9]{4,}/)) {
 180             # give up on digit-runs which are unusually long, to mitigate the
 181             # quadratic time-complexity of slicing strings in a loop
 182             if (RLENGTH > 1000) {
 183                 printf "%s", substr(line, 1, RSTART + RLENGTH)
 184                 line = substr(line, RSTART + RLENGTH)
 185                 continue
 186             }
 187 
 188             len = RLENGTH
 189             lead = len % 3
 190             alt = lead > 0
 191 
 192             printf "%s", substr(line, 1, RSTART + lead - 1)
 193             line = substr(line, RSTART + lead)
 194             len -= lead
 195 
 196             while (len > 0) {
 197                 if (alt == 1) {
 198                     printf "%s%s\x1b[0m", style, substr(line, 1, 3)
 199                 } else {
 200                     printf "%s", substr(line, 1, 3)
 201                 }
 202 
 203                 alt = 1 - alt
 204                 line = substr(line, 4)
 205                 len -= 3
 206             }
 207         }
 208 
 209         printf "%s\n", line
 210     }
 211 ' "$@"