b089890 · bat · git.iko.soy

git.iko.soy/bat

Syntax: add cmd-help (#2148)

* Add cmd-help syntax To highlight command --help messages. * README.md: mention help message highlighting * README.md: edit help message highlighting

commitb0898900ce0d1e70a7c1e805a1bcfce7d1e2b824 authorVíctor González Prieto <victor.gp.dev@gmail.com> dateTue 26 Apr 2022, 19:42 (5 years ago) parent3239d3b

6 files changed+133

compare with master

unifiedsplit

.gitmodules+5 CHANGELOG.md+1 README.md+18 assets/syntaxes/02_Extra/cmd-help+1 tests/syntax-tests/highlighted/cmd-help/test.cmd-help+54 tests/syntax-tests/source/cmd-help/test.cmd-help+54

.gitmodules+5

@@ -239,3 +239,8 @@

239239[submodule "assets/syntaxes/02_Extra/SublimeJQ"]

240240 path = assets/syntaxes/02_Extra/SublimeJQ

241241 url = https://github.com/zogwarg/SublimeJQ.git

242+[submodule "assets/syntaxes/02_Extra/cmd-help"]

243+ path = assets/syntaxes/02_Extra/cmd-help

244+ url = https://github.com/victor-gp/cmd-help-sublime-syntax.git

245+ branch = main

246+ shallow = true

CHANGELOG.md+1

@@ -16,6 +16,7 @@

1616

1717- Mapped clang-format config file (.clang-format) to YAML syntax (@TruncatedDinosour)

1818- log syntax: improved handling of escape characters in double quoted strings. See #2123 (@keith-hall)

19+- Added cmd-help syntax to scope --help messages. See #2148 (@victor-gp)

1920

2021## Themes

2122

README.md+18

@@ -212,6 +212,24 @@ Also, note that this will [not work](https://github.com/sharkdp/bat/issues/1145)

212212

213213The [`prettybat`](https://github.com/eth-p/bat-extras/blob/master/doc/prettybat.md) script is a wrapper that will format code and print it with `bat`.

214214

215+#### Highlighting `--help` messages

216+

217+You can use `bat` to colorize help text: `$ cp --help | bat -plhelp`

218+

219+You can also use a wrapper around this:

220+

221+```bash

222+# in your .bashrc/.zshrc/*rc

223+alias bathelp='bat --plain --language=help'

224+help() {

225+ "$@" --help 2>&1 | bathelp

226+}

227+```

228+

229+Then you can do `$ help cp` or `$ help git commit`.

230+

231+Please report any issues with the help syntax in [this repository](https://github.com/victor-gp/cmd-help-sublime-syntax).

232+

215233

216234## Installation

217235

assets/syntaxes/02_Extra/cmd-helpnew file+1

Submodule changed.

tests/syntax-tests/highlighted/cmd-help/test.cmd-helpnew file+54

@@ -0,0 +1,54 @@

1+[38;2;248;248;242mbat 0.20.0 (e735562-modified)[0m

2+[38;2;248;248;242mA cat(1) clone with syntax highlighting and Git integration.[0m

4+[38;2;253;151;31mUSAGE:[0m

5+[38;2;248;248;242m bat [OPTIONS] [FILE]...[0m

6+[38;2;248;248;242m bat <SUBCOMMAND>[0m

8+[38;2;253;151;31mOPTIONS:[0m

9+[38;2;248;248;242m [0m[38;2;166;226;46m-A[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--show-all[0m

10+[38;2;248;248;242m Show non-printable characters (space, tab, newline, ..).[0m

11+

12+[38;2;248;248;242m [0m[38;2;166;226;46m-p[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--plain[0m[38;2;248;248;242m Show plain style (alias for '--style=plain').[0m

13+[38;2;248;248;242m [0m[38;2;166;226;46m-l[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--language[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<language>[0m[38;2;248;248;242m Set the language for syntax highlighting.[0m

14+[38;2;248;248;242m [0m[38;2;166;226;46m-H[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--highlight-line[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<N:M>[0m[3;38;2;253;151;31m...[0m[38;2;248;248;242m Highlight lines N through M.[0m

15+[38;2;248;248;242m [0m[38;2;166;226;46m--file-name[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<name>[0m[3;38;2;253;151;31m...[0m[38;2;248;248;242m Specify the name to display for a file.[0m

16+[38;2;248;248;242m [0m[38;2;166;226;46m-d[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--diff[0m

17+[38;2;248;248;242m Only show lines that have been added/removed/modified.[0m

18+

19+[38;2;248;248;242m [0m[38;2;166;226;46m--tabs[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<T>[0m[38;2;248;248;242m Set the tab width to T spaces.[0m

20+[38;2;248;248;242m [0m[38;2;166;226;46m--wrap[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<mode>[0m

21+[38;2;248;248;242m Specify the text-wrapping mode (*auto*, never, character).[0m

22+

23+[38;2;248;248;242m [0m[38;2;166;226;46m-n[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--number[0m

24+[38;2;248;248;242m Show line numbers (alias for '--style=numbers').[0m

25+

26+[38;2;248;248;242m [0m[38;2;166;226;46m--color[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<when>[0m[38;2;248;248;242m When to use colors (*auto*, never, always).[0m

27+[38;2;248;248;242m [0m[38;2;166;226;46m--italic-text[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<when>[0m[38;2;248;248;242m Use italics in output (always, *never*)[0m

28+[38;2;248;248;242m [0m[38;2;166;226;46m--decorations[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<when>[0m

29+[38;2;248;248;242m When to show the decorations (*auto*, never, always).[0m

30+

31+[38;2;248;248;242m [0m[38;2;166;226;46m--paging[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<when>[0m

32+[38;2;248;248;242m Specify when to use the pager, or use `-P` to disable (*auto*, never,[0m

33+[38;2;248;248;242m always).[0m

34+[38;2;248;248;242m [0m[38;2;166;226;46m-m[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--map-syntax[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<glob:syntax>[0m[3;38;2;253;151;31m...[0m

35+[38;2;248;248;242m Use the specified syntax for files matching the glob pattern[0m

36+[38;2;248;248;242m ('*.cpp:C++').[0m

37+[38;2;248;248;242m [0m[38;2;166;226;46m--theme[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<theme>[0m[38;2;248;248;242m Set the color theme for syntax highlighting.[0m

38+[38;2;248;248;242m [0m[38;2;166;226;46m--list-themes[0m[38;2;248;248;242m Display all supported highlighting themes.[0m

39+[38;2;248;248;242m [0m[38;2;166;226;46m--style[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<components>[0m

40+[38;2;248;248;242m Comma-separated list of style elements to display (*auto*, full, plain,[0m

41+[38;2;248;248;242m changes, header, grid, rule, numbers, snip).[0m

42+[38;2;248;248;242m [0m[38;2;166;226;46m-r[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--line-range[0m[38;2;248;248;242m [0m[3;38;2;253;151;31m<N:M>[0m[3;38;2;253;151;31m...[0m[38;2;248;248;242m Only print the lines from N to M.[0m

43+[38;2;248;248;242m [0m[38;2;166;226;46m-L[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--list-languages[0m[38;2;248;248;242m Display all supported languages.[0m

44+[38;2;248;248;242m [0m[38;2;166;226;46m-h[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--help[0m[38;2;248;248;242m Print this help message.[0m

45+[38;2;248;248;242m [0m[38;2;166;226;46m-V[0m[38;2;248;248;242m, [0m[38;2;166;226;46m--version[0m[38;2;248;248;242m Show version information.[0m

46+

47+[38;2;253;151;31mARGS:[0m

48+[38;2;248;248;242m [0m[3;38;2;253;151;31m<FILE>...[0m[38;2;248;248;242m File(s) to print / concatenate. Use '-' for standard input.[0m

49+

50+[38;2;253;151;31mSUBCOMMANDS:[0m

51+[38;2;248;248;242m [0m[38;2;249;38;114mcache[0m[38;2;248;248;242m Modify the syntax-definition and theme cache[0m

52+

53+[38;2;248;248;242mNote: `bat -h` prints a short and concise overview while `bat --help` gives all[0m

54+[38;2;248;248;242mdetails.[0m

tests/syntax-tests/source/cmd-help/test.cmd-helpnew file+54

@@ -0,0 +1,54 @@

1+bat 0.20.0 (e735562-modified)

2+A cat(1) clone with syntax highlighting and Git integration.

4+USAGE:

5+ bat [OPTIONS] [FILE]...

6+ bat <SUBCOMMAND>

8+OPTIONS:

9+ -A, --show-all

10+ Show non-printable characters (space, tab, newline, ..).

11+

12+ -p, --plain Show plain style (alias for '--style=plain').

13+ -l, --language <language> Set the language for syntax highlighting.

14+ -H, --highlight-line <N:M>... Highlight lines N through M.

15+ --file-name <name>... Specify the name to display for a file.

16+ -d, --diff

17+ Only show lines that have been added/removed/modified.

18+

19+ --tabs <T> Set the tab width to T spaces.

20+ --wrap <mode>

21+ Specify the text-wrapping mode (*auto*, never, character).

22+

23+ -n, --number

24+ Show line numbers (alias for '--style=numbers').

25+

26+ --color <when> When to use colors (*auto*, never, always).

27+ --italic-text <when> Use italics in output (always, *never*)

28+ --decorations <when>

29+ When to show the decorations (*auto*, never, always).

30+

31+ --paging <when>

32+ Specify when to use the pager, or use `-P` to disable (*auto*, never,

33+ always).

34+ -m, --map-syntax <glob:syntax>...

35+ Use the specified syntax for files matching the glob pattern

36+ ('*.cpp:C++').

37+ --theme <theme> Set the color theme for syntax highlighting.

38+ --list-themes Display all supported highlighting themes.

39+ --style <components>

40+ Comma-separated list of style elements to display (*auto*, full, plain,

41+ changes, header, grid, rule, numbers, snip).

42+ -r, --line-range <N:M>... Only print the lines from N to M.

43+ -L, --list-languages Display all supported languages.

44+ -h, --help Print this help message.

45+ -V, --version Show version information.

46+

47+ARGS:

48+ <FILE>... File(s) to print / concatenate. Use '-' for standard input.

49+

50+SUBCOMMANDS:

51+ cache Modify the syntax-definition and theme cache

52+

53+Note: `bat -h` prints a short and concise overview while `bat --help` gives all

54+details.