extern/bat
1
0
Fork 0
mirror of https://github.com/sharkdp/bat.git synced 2024-11-21 23:33:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Clarify syntax selection algorithm behaviour

Browse Source
This commit is contained in:
cyqsimon 2023-10-31 15:10:33 +08:00
parent 37fd050100
commit 52f94b4623
No known key found for this signature in database
GPG Key ID: 1D8CE2F297390D65
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/syntax_mapping/builtins/README.md
View File

@ -19,7 +19,8 @@ by the TOML files within this directory, and embed them into the binary.
## File syntax
Each TOML file should contain a single section named `mappings`, with each of
its keys being a language identifier (first column of `bat -L`).
its keys being a language identifier (first column of `bat -L`; also referred to
as "target").
The value of each key should be an array of strings, with each item being a glob
matcher. We will call each of these items a "rule".
@ -104,5 +105,6 @@ mapping `*.conf` files to unknown.
Generally this should not be much of a concern, since rules should be written as
specifically as possible for each application.
Rules within each TOML file are inserted (and therefore processed) in the order
in which they are defined.
Rules within each TOML file are processed (and therefore matched) in the order
in which they are defined. At runtime, the syntax selection algorithm will
short-circuit and return the target of the first matching rule.