Skip to content

Commit

Permalink
Add cmd-help syntax
Browse files Browse the repository at this point in the history
To highlight command --help messages.
  • Loading branch information
victor-gp committed Apr 7, 2022
1 parent 520081a commit 1352a2b
Show file tree
Hide file tree
Showing 5 changed files with 115 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -239,3 +239,8 @@
[submodule "assets/syntaxes/02_Extra/SublimeJQ"]
path = assets/syntaxes/02_Extra/SublimeJQ
url = https://github.com/zogwarg/SublimeJQ.git
[submodule "assets/syntaxes/02_Extra/cmd-help"]
path = assets/syntaxes/02_Extra/cmd-help
url = https://github.com/victor-gp/cmd-help-sublime-syntax.git
branch = main
shallow = true
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

- Mapped clang-format config file (.clang-format) to YAML syntax (@TruncatedDinosour)
- log syntax: improved handling of escape characters in double quoted strings. See #2123 (@keith-hall)
- Added cmd-help syntax to scope --help messages. See #2148 (@victor-gp)

## Themes

Expand Down
1 change: 1 addition & 0 deletions assets/syntaxes/02_Extra/cmd-help
Submodule cmd-help added at 1e513f
54 changes: 54 additions & 0 deletions tests/syntax-tests/highlighted/cmd-help/test.cmd-help
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
bat 0.20.0 (e735562-modified)
A cat(1) clone with syntax highlighting and Git integration.

USAGE:
 bat [OPTIONS] [FILE]...
 bat <SUBCOMMAND>

OPTIONS:
 -A, --show-all
 Show non-printable characters (space, tab, newline, ..).

 -p, --plain Show plain style (alias for '--style=plain').
 -l, --language <language> Set the language for syntax highlighting.
 -H, --highlight-line <N:M>... Highlight lines N through M.
 --file-name <name>... Specify the name to display for a file.
 -d, --diff
 Only show lines that have been added/removed/modified.

 --tabs <T> Set the tab width to T spaces.
 --wrap <mode>
 Specify the text-wrapping mode (*auto*, never, character).

 -n, --number
 Show line numbers (alias for '--style=numbers').

 --color <when> When to use colors (*auto*, never, always).
 --italic-text <when> Use italics in output (always, *never*)
 --decorations <when>
 When to show the decorations (*auto*, never, always).

 --paging <when>
 Specify when to use the pager, or use `-P` to disable (*auto*, never,
 always).
 -m, --map-syntax <glob:syntax>...
 Use the specified syntax for files matching the glob pattern
 ('*.cpp:C++').
 --theme <theme> Set the color theme for syntax highlighting.
 --list-themes Display all supported highlighting themes.
 --style <components>
 Comma-separated list of style elements to display (*auto*, full, plain,
 changes, header, grid, rule, numbers, snip).
 -r, --line-range <N:M>... Only print the lines from N to M.
 -L, --list-languages Display all supported languages.
 -h, --help Print this help message.
 -V, --version Show version information.

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

SUBCOMMANDS:
 cache Modify the syntax-definition and theme cache

Note: `bat -h` prints a short and concise overview while `bat --help` gives all
details.
54 changes: 54 additions & 0 deletions tests/syntax-tests/source/cmd-help/test.cmd-help
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
bat 0.20.0 (e735562-modified)
A cat(1) clone with syntax highlighting and Git integration.

USAGE:
bat [OPTIONS] [FILE]...
bat <SUBCOMMAND>

OPTIONS:
-A, --show-all
Show non-printable characters (space, tab, newline, ..).

-p, --plain Show plain style (alias for '--style=plain').
-l, --language <language> Set the language for syntax highlighting.
-H, --highlight-line <N:M>... Highlight lines N through M.
--file-name <name>... Specify the name to display for a file.
-d, --diff
Only show lines that have been added/removed/modified.

--tabs <T> Set the tab width to T spaces.
--wrap <mode>
Specify the text-wrapping mode (*auto*, never, character).

-n, --number
Show line numbers (alias for '--style=numbers').

--color <when> When to use colors (*auto*, never, always).
--italic-text <when> Use italics in output (always, *never*)
--decorations <when>
When to show the decorations (*auto*, never, always).

--paging <when>
Specify when to use the pager, or use `-P` to disable (*auto*, never,
always).
-m, --map-syntax <glob:syntax>...
Use the specified syntax for files matching the glob pattern
('*.cpp:C++').
--theme <theme> Set the color theme for syntax highlighting.
--list-themes Display all supported highlighting themes.
--style <components>
Comma-separated list of style elements to display (*auto*, full, plain,
changes, header, grid, rule, numbers, snip).
-r, --line-range <N:M>... Only print the lines from N to M.
-L, --list-languages Display all supported languages.
-h, --help Print this help message.
-V, --version Show version information.

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

SUBCOMMANDS:
cache Modify the syntax-definition and theme cache

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

0 comments on commit 1352a2b

Please sign in to comment.