utils/lexers_matcher/README.md

0001 # Minted lexer matcher
0002
0003 Purpose of this tool is to make matchin between `minted` availabl lexers and syntax schemas provided by `syntax-highlighter`.
0004
0005 ### Usage
0006
0007 Call script with xml files as arguments. The `latex.xml` in the input will be ignored.
0008
0009 ```bash
0010 match_languages.py ../../data/syntax/*.xml
0011 ```
0012
0013 The script will generate an output file `lexers_found.xml` which should be manually merged into `../../data/syntax/latex.xml`, e.g.
0014
0015 ```bash
0016 meld lexers_found.xml ../../data/syntax/latex.xml
0017 ```
0018
0019 Additional options to the script:
0020
0021 * `-v` - more verbose output
0022 * `-o file_name` - output file name
0023
0024 ### Configuration
0025
0026 `config.yml` provides extra configuration for the tool.
0027
0028 * `fuzz_level` - used for fuzzy matching, not used anymore
0029 * `minted_blacklisted` - list of languages in minted, which should be ignored (e.g. due to duplication or latex incompatible names, like 'c++' and 'cpp' in minted, only 'cpp' will work with `mycode`
0030 * `minted_mapping` - list of `key: val` pairs, where `key` is minted name of language, anbd `val` is corresponfing lexer in this repository, for all pairs which do not have exact matching
0031 * `lstlisting_mapping` - same as for minted but for lstlistings, currenlty not supported yet.
0032
0033 Whenever `minted` language name is references in fact it refeers to `pygments` which provides syntax highlighting for `minted`.
0034
0035 ## LICENSE
0036
0037 The script is distributed under MIT license.