f9d5e81f0e
Bat already has a base16 theme. The new base16-256 theme is for users of base16-shell, who configure their terminal with a 256-color variant of a base16 theme. These variants put some of the base16 colors in elsewhere in the 256-color table to avoid clobbering bright color slots (ansi codes 8 to 15) with colors that don't respect the ordinary meaning of that slot (e.g. bright green in ordinary base16 is not green). For more details, see https://github.com/chriskempson/base16-shell |
||
|---|---|---|
| .. | ||
| completions | ||
| manual | ||
| patches | ||
| syntaxes | ||
| themes | ||
| .gitattributes | ||
| .ignore | ||
| create.sh | ||
| README.md | ||
| syntaxes.bin | ||
| theme_preview.rs | ||
| themes.bin | ||
Syntax Highlighting in bat
bat uses the syntect library to highlight source
code. As a basis, syntect uses Sublime Text syntax definitions
in the .sublime-syntax format.
In order to add new syntaxes to bat, follow these steps:
-
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). -
If the Sublime Text syntax is only available as a
.tmLanguagefile, open the file in Sublime Text and convert it to a.sublime-syntaxfile via Tools -> Developer -> New Syntax from XXX.tmLanguage.... Save the new file in theassets/syntaxesfolder. -
Run the
create.shscript. It callsbat cache --buildto parse all available.sublime-syntaxfiles and serialize them to asyntaxes.binfile (in this folder). -
Re-compile
bat. At compilation time, thesyntaxes.binfile will be stored inside thebatbinary. -
If you send a pull request with your changes, please do not include the changed
syntaxes.binfile. A new binary cache file will be created once before every new release ofbat.
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.dartinclude.INI.sublime-syntax=> added.hgrc,hgrc, anddesktopfile types.Org mode.sublime-syntax=> removedtaskfile type.SML.sublime_syntax=> removedmlfile type.
Non-submodule additions
Assembly (x86_64)has been manually added from https://github.com/13xforever/x86-assembly-textmate-bundle due togit clonerecursion problemsNim.sublime-syntaxhas 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/NimLimeRego.sublime-syntaxhas 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.tmLanguageSML.sublime_syntaxhas 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.tmLanguageCabal.sublime_syntaxhas 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.