A Crystal reimplementation of the Pygments/Chroma syntax highlighters
Go to file
2024-08-04 20:36:35 -03:00
lexers Initial dumb stuff 2024-08-02 17:03:49 -03:00
spec refactor 2024-08-04 20:00:48 -03:00
src lint 2024-08-04 20:25:12 -03:00
.ameba.yml lint 2024-08-04 20:09:15 -03:00
.editorconfig Initial dumb stuff 2024-08-02 17:03:39 -03:00
.gitignore lint 2024-08-04 20:09:54 -03:00
LICENSE Initial dumb stuff 2024-08-02 17:03:39 -03:00
README.md readme 2024-08-04 20:36:35 -03:00
shard.yml Implement 'combined' emitter 2024-08-03 19:25:09 -03:00

tartrazine

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

It's not currently usable unless what you need is a way to turn your files into a pile of json describing its constituent tokens, because I have not implemented any formatters, yet, only the part that parses the code (the lexers).

TO make this even more "not there yet", Crystal doesn't allow for creating regular expressions that are MULTILINE but not DOT_ALL, whcih means I can't reproduce the behaviour of the golang (or Python's) regular expressions, so that causes issues unless you go and patch Crystal itself (don't patch Crystal itself, please)

A port of what? Why "kind of"?

Because I did not read the Pygments code. And this is actually based on Chroma ... although I did not read that code either.

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.

With a patched Crystal regex engine see here 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.

Installation

If you need to ask how to install this, it's not ready for you yet.

Usage

If you need to ask how to use this, it's not ready for you yet.

Development

TODO: Write development instructions here

Contributing

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

Contributors