texcat

screenshot

It supports syntax parser:

[x] tree-sitter grammars
[x] textmate/VS Code language XML/json

It supports color themes:

[x] textmate/VS Code theme XML/json
[ ] syncat themes

Bench

Terminal output

$ hyperfine -Nw10 'texcat test.lua' 'texcat --syntax-type=textmate test.lua' 'pygmentize test.lua' 'bat test.lua'
Benchmark 1: texcat test.lua
  Time (mean ± σ):      56.8 ms ±   1.9 ms    [User: 49.8 ms, System: 6.3 ms]
  Range (min … max):    54.4 ms …  64.2 ms    50 runs

Benchmark 2: texcat --syntax-type=textmate test.lua
  Time (mean ± σ):      73.1 ms ±  11.2 ms    [User: 70.7 ms, System: 7.4 ms]
  Range (min … max):    62.0 ms …  89.7 ms    47 runs

Benchmark 3: pygmentize test.lua
  Time (mean ± σ):     154.4 ms ±  19.9 ms    [User: 140.0 ms, System: 12.8 ms]
  Range (min … max):   137.4 ms … 217.3 ms    21 runs

Benchmark 4: bat test.lua
  Time (mean ± σ):       8.0 ms ±   0.5 ms    [User: 7.4 ms, System: 4.2 ms]
  Range (min … max):     7.0 ms …  10.0 ms    429 runs

Summary
  bat test.lua ran
    7.14 ± 0.50 times faster than texcat test.lua
    9.18 ± 1.52 times faster than texcat --syntax-type=textmate test.lua
   19.40 ± 2.77 times faster than pygmentize test.lua

LaTeX output

$ hyperfine -Nw10 'texcat --output-format=latex test.lua' 'texcat --output-format=latex --syntax-type=textmate test.lua' 'pygmentize -f latex -O full=True test.lua'

Benchmark 1: texcat --output-format=latex test.lua
  Time (mean ± σ):      56.3 ms ±   1.2 ms    [User: 49.6 ms, System: 6.1 ms]
  Range (min … max):    54.9 ms …  60.9 ms    53 runs

Benchmark 2: texcat --output-format=latex --syntax-type=textmate test.lua
  Time (mean ± σ):      63.8 ms ±   0.8 ms    [User: 61.5 ms, System: 7.0 ms]
  Range (min … max):    62.5 ms …  66.5 ms    45 runs

Benchmark 3: pygmentize -f latex -O full=True test.lua
  Time (mean ± σ):     110.7 ms ±   1.2 ms    [User: 99.2 ms, System: 10.7 ms]
  Range (min … max):   109.1 ms … 114.3 ms    27 runs

Summary
  texcat --output-format=latex test.lua ran
    1.13 ± 0.03 times faster than texcat --output-format=latex --syntax-type=textmate test.lua
    1.97 ± 0.05 times faster than pygmentize -f latex -O full=True test.lua

Dependencies

TextMate

By default, it will search color themes or syntax parsers in VS Code directory.

git clone --depth=1 https://github.com/microsoft/vscode ~/.vscode

Then you can see:

$ texcat --list themes
Abyss: /home/wzy/.vscode/extensions/theme-abyss/./themes/abyss-color-theme.json
Abyss theme for Visual Studio Code
publisher: vscode

# ...
$ texcat --list syntaxes --syntax-type=textmate
bat: .bat
%description%

# ...

If you use texrocks, there is a package for you:

lx add -b vscode-extensions

Tree-sitter

By default, it will search syntax parsers in Neovim directory.

$ texcat --list syntaxes
c: /usr/lib/nvim/parser/c.so

# ...

If you use texrocks, you can install parsers by yourself.

lx add -b tree-sitter-XXX

Add https://nvim-neorocks.github.io/rocks-binaries/ to ~/.config/lux/config.toml to save compile time.

extra_servers = [
  "https://nvim-neorocks.github.io/rocks-binaries/",
  "https://ustctug.github.io/texrocks/",
]

Usage

$ texcat --help
Usage: /home/wzy/Desktop/texrocks/packages/texcat/bin/texcat [-h]
       [--completion {bash,zsh,fish}] [--output <output>]
       [--syntax <syntax>] [--theme <theme>]
       [--syntax-type {textmate,tree-sitter}]
       [--theme-type {textmate}] [--extensions-dir <extensions_dir>]
       [--output-format {ansi,empty,latex,preamble.tex,test,tex,txt}]
       [--list {themes,syntaxes,extensions_dirs,colors,links}]
       [--command-prefix <command_prefix>]
       [--math-escape <math_escape>] [<file>] ...

Arguments:
   file                  file name

Options:
   -h, --help            Show this help message and exit.
   --completion {bash,zsh,fish}
                         Output a shell completion script for the specified shell.
   --output <output>     output file name, - means stdout
   --syntax <syntax>     set syntax, auto means decided by extension
   --theme <theme>       set theme, auto means first theme such as Abyss
   --syntax-type {textmate,tree-sitter}
                         syntax highlight type (default: tree-sitter)
   --theme-type {textmate}
                         color scheme type (default: textmate)
   --extensions-dir <extensions_dir>
                         directories for VSCode extensions and tree-sitter grammars/queries
   --output-format {ansi,empty,latex,preamble.tex,test,tex,txt}
                         output format (default: ansi)
   --list {themes,syntaxes,extensions_dirs,colors,links}
                         list all themes/syntaxes/... (default: themes)
   --command-prefix <command_prefix>
                         command prefix for TeX
   --math-escape <math_escape>
                         the scope to escape $math TeX code$ (default: comment)
$ texcat lua/texcat.lua --output-format=latex --output=main.tex
$ lualatex main.tex

For a source code:

test.lua:

---last index $i\in\mathbb{Z}$
local function get_last_index(input)
    local offsets = { 1 }
    if input ~= nil then
        print(#input - offsets[1])
    end
    return true
end
return get_last_index

texcat test.lua --output-format=tex will generate:

\PYAbyss{comment}{\PYAbyssZhy{}\PYAbyssZhy{}\PYAbyssZhy{}last index $i\in\mathbb{Z}$}
\PYAbyss{keyword}{local}\PYAbyss{source}{ }\PYAbyss{keyword.function}{function}\PYAbyss{source}{ }\PYAbyss{variable}{get\PYAbyssZus{}last\PYAbyssZus{}index}\PYAbyss{source}{(}\PYAbyss{variable}{input}\PYAbyss{source}{)}
\PYAbyss{source}{    }\PYAbyss{keyword}{local}\PYAbyss{source}{ }\PYAbyss{variable}{offsets}\PYAbyss{source}{ }\PYAbyss{operator}{=}\PYAbyss{source}{ }\PYAbyss{constructor}{\PYAbyssZob{}}\PYAbyss{source}{ }\PYAbyss{number}{1}\PYAbyss{source}{ }\PYAbyss{constructor}{\PYAbyssZcb{}}
\PYAbyss{source}{    }\PYAbyss{keyword.conditional}{if}\PYAbyss{source}{ }\PYAbyss{variable}{input}\PYAbyss{source}{ }\PYAbyss{operator}{\PYAbyssZti{}=}\PYAbyss{source}{ }\PYAbyss{constant.builtin}{nil}\PYAbyss{source}{ }\PYAbyss{keyword.conditional}{then}
\PYAbyss{source}{        }\PYAbyss{variable}{print}\PYAbyss{source}{(}\PYAbyss{operator}{\PYAbyssZsh{}}\PYAbyss{variable}{input}\PYAbyss{source}{ }\PYAbyss{operator}{\PYAbyssZhy{}}\PYAbyss{source}{ }\PYAbyss{variable}{offsets}\PYAbyss{source}{[}\PYAbyss{number}{1}\PYAbyss{source}{])}
\PYAbyss{source}{    }\PYAbyss{keyword.conditional}{end}
\PYAbyss{source}{    }\PYAbyss{keyword.return}{return}\PYAbyss{source}{ true}
\PYAbyss{keyword.function}{end}
\PYAbyss{keyword.return}{return}\PYAbyss{source}{ }\PYAbyss{variable}{get\PYAbyssZus{}last\PYAbyssZus{}index}

See example to know how to use it in your LuaLaTeX document.

For texlive's ctan.zip and tds.zip, vscode-extensions, tree-sitter-lua and tree-sitter-latex for GNU/Linux are attached. Tell correct environment variables:

LUA_CPATH="$HOME/.texlive/texmf-config/scripts/texcat/lib/?.so" CLUAINPUTS='$LUAINPUTS' lualatex --shell-escape test.tex

PDF

texrocks

Contents

Topics

Examples

Subprojects

Modules

Misc