git.iko.soy/bat
on 5f6e310 help sign in
bat/assets/README.md
44 lines 2.4 kB history raw
1## Syntax Highlighting in bat
3`bat` uses the [syntect](https://github.com/trishume/syntect) library to highlight source
4code. As a basis, syntect uses [Sublime Text](https://www.sublimetext.com/) syntax definitions
5in the `.sublime-syntax` format.
7In order to add new syntaxes to `bat`, follow these steps:
91. Find a Sublime Text syntax for the given language, preferably in a separate Git repository
10 which can be included as a submodule (under `assets/syntaxes`).
122. If the Sublime Text syntax is only available as a `.tmLanguage` file, open the file in
13 Sublime Text and convert it to a `.sublime-syntax` file via *Tools* -> *Developer* ->
14 *New Syntax from XXX.tmLanguage...*. Save the new file in the `assets/syntaxes` folder.
163. Run the `create.sh` script. It calls `bat cache --build` to parse all available
17 `.sublime-syntax` files and serialize them to a `syntaxes.bin` file (in this folder).
194. Re-compile `bat`. At compilation time, the `syntaxes.bin` file will be stored inside the
20 `bat` binary.
225. If you send a pull request with your changes, please do *not* include the changed `syntaxes.bin`
23 file. A new binary cache file will be created once before every new release of `bat`.
25### Troubleshooting
27Make sure that the local cache does not interfere with the internally stored syntaxes and
28themes (`bat cache --clear`).
30### Manual modifications
32The following files have been manually modified after converting from a `.tmLanguage` file:
34* `Dart.sublime-syntax` => removed `#regex.dart` include.
35* `INI.sublime-syntax` => added `.hgrc`, `hgrc`, and `desktop` file types.
36* `Org mode.sublime-syntax` => removed `task` file type.
38### Non-submodule additions
40* `Assembly (x86_64)` has been manually added from https://github.com/13xforever/x86-assembly-textmate-bundle due to `git clone` recursion problems
41* `Nim.sublime-syntax` has been added manually from https://github.com/getzola/zola/blob/master/sublime_syntaxes/Nim.sublime-syntax as there was no suitable Git repository for it. The original syntax seems to originate from https://github.com/Varriount/NimLime
42* `Rego.sublime-syntax` has been added manually from https://github.com/open-policy-agent/opa/blob/master/misc/syntax/sublime/rego.sublime-syntax
43 as it is not kept in a standalone repository. The file is generated from
44 https://github.com/open-policy-agent/opa/blob/master/misc/syntax/textmate/Rego.tmLanguage