TARTRAZINE

Tartrazine is a library to syntax-highlight code. It is a port of Pygments to Crystal. Kind of.

The CLI tool can be used to highlight many things in many styles.

A port of what? Why "kind of"?

Pygments is a staple of the Python ecosystem, and it's great. It lets you highlight code in many languages, and it has many themes. Chroma is "Pygments for Go", it's actually a port of Pygments to Go, and it's great too.

I wanted that in Crystal, so I started this project. But I did not read much of the Pygments code. Or much of Chroma's.

Chroma has taken most of the Pygments lexers and turned them into XML descriptions. What I did was take those XML files from Chroma and a pile of test cases from Pygments, and I slapped them together until the tests passed and my code produced the same output as Chroma. Think of it as extreme TDD.

Currently the pass rate for tests in the supported languages is 96.8%, which is not bad for a couple days hacking.

This only covers the RegexLexers, which are the most common ones, but it means the supported languages are a subset of Chroma's, which is a subset of Pygments'.

Currently Tartrazine supports ... 241 languages.

It has 331 themes (63 from Chroma, the rest are base16 themes via Sixteen

Installation

From prebuilt binaries:

Each release provides statically-linked binaries that should work on any Linux. Get them from the releases page and put them in your PATH.

To build from source:

Clone this repo
Run make to build the tartrazine binary
Copy the binary somewhere in your PATH.

Usage as a CLI tool

$ tartrazine whatever.c -l c -t catppuccin-macchiato --line-numbers \
  --standalone -o whatever.html

Usage as a Library

This works:

require "tartrazine"

lexer = Tartrazine.lexer("crystal")
theme = Tartrazine.theme("catppuccin-macchiato")
puts Tartrazine::Html.new.format(File.read(ARGV[0]), lexer, theme)

Contributing

Fork it (https://github.com/ralsina/tartrazine/fork)
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

Contributors

Roberto Alsina - creator and maintainer

2.4 KiB Raw Blame History