mirror of
https://github.com/sharkdp/bat
synced 2024-11-08 19:10:41 +00:00
52 lines
2.9 KiB
Markdown
Vendored
52 lines
2.9 KiB
Markdown
Vendored
## Syntax Highlighting in bat
|
|
|
|
`bat` uses the [syntect](https://github.com/trishume/syntect) library to highlight source
|
|
code. As a basis, syntect uses [Sublime Text](https://www.sublimetext.com/) syntax definitions
|
|
in the `.sublime-syntax` format.
|
|
|
|
In order to add new syntaxes to `bat`, follow these steps:
|
|
|
|
1. Find a Sublime Text syntax for the given language, preferably in a separate Git repository
|
|
which can be included as a submodule (under `assets/syntaxes`).
|
|
|
|
2. If the Sublime Text syntax is only available as a `.tmLanguage` file, open the file in
|
|
Sublime Text and convert it to a `.sublime-syntax` file via *Tools* -> *Developer* ->
|
|
*New Syntax from XXX.tmLanguage...*. Save the new file in the `assets/syntaxes` folder.
|
|
|
|
3. Run the `create.sh` script. It calls `bat cache --build` to parse all available
|
|
`.sublime-syntax` files and serialize them to a `syntaxes.bin` file (in this folder).
|
|
|
|
4. Re-compile `bat`. At compilation time, the `syntaxes.bin` file will be stored inside the
|
|
`bat` binary.
|
|
|
|
5. If you send a pull request with your changes, please do *not* include the changed `syntaxes.bin`
|
|
file. A new binary cache file will be created once before every new release of `bat`.
|
|
|
|
### Troubleshooting
|
|
|
|
Make sure that the local cache does not interfere with the internally stored syntaxes and
|
|
themes (`bat cache --clear`).
|
|
|
|
### Manual modifications
|
|
|
|
The following files have been manually modified after converting from a `.tmLanguage` file:
|
|
|
|
* `Dart.sublime-syntax` => removed `#regex.dart` include.
|
|
* `INI.sublime-syntax` => added `.hgrc`, `hgrc`, and `desktop` file types.
|
|
* `Org mode.sublime-syntax` => removed `task` file type.
|
|
* `SML.sublime_syntax` => removed `ml` file type.
|
|
|
|
### Non-submodule additions
|
|
|
|
* `Assembly (x86_64)` has been manually added from https://github.com/13xforever/x86-assembly-textmate-bundle due to `git clone` recursion problems
|
|
* `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
|
|
* `Rego.sublime-syntax` has been added manually from https://github.com/open-policy-agent/opa/blob/master/misc/syntax/sublime/rego.sublime-syntax
|
|
as it is not kept in a standalone repository. The file is generated from
|
|
https://github.com/open-policy-agent/opa/blob/master/misc/syntax/textmate/Rego.tmLanguage
|
|
* `SML.sublime_syntax` has been added manually from
|
|
https://github.com/seanjames777/SML-Language-Definitiona as it is not
|
|
kept in a standalone repository. The file generated is from
|
|
https://github.com/seanjames777/SML-Language-Definition/blob/master/sml.tmLanguage
|
|
* `Cabal.sublime_syntax` has been added manually from
|
|
https://github.com/SublimeHaskell/SublimeHaskell/ - we don't want to include the whole submodule because it includes other syntaxes ("Haskell improved") as well.
|