Top Related Projects
Pygments is a generic syntax highlighter written in Python
A cat(1) clone with wings.
A pure Ruby code highlighter that is compatible with Pygments
Lightweight, robust, elegant syntax highlighting.
JavaScript syntax highlighter with language auto-detection and zero dependencies.
In-browser code editor (version 5, legacy)
Quick Overview
Chroma is a general-purpose syntax highlighter written in Go. It's designed to be fast, easy to use, and capable of highlighting a wide range of programming languages. Chroma can be used as a library in Go applications or as a command-line tool for syntax highlighting.
Pros
- Fast and efficient syntax highlighting
- Supports a wide range of programming languages and file formats
- Easily extensible with custom lexers and styles
- Can be used as both a library and a command-line tool
Cons
- Documentation could be more comprehensive
- Some less common languages may have limited support
- Customizing styles can be complex for beginners
- Limited built-in output formats compared to some alternatives
Code Examples
- Basic usage as a library:
package main
import (
"fmt"
"os"
"github.com/alecthomas/chroma/quick"
)
func main() {
code := `package main
import "fmt"
func main() {
fmt.Println("Hello, World!")
}`
err := quick.Highlight(os.Stdout, code, "go", "terminal", "monokai")
if err != nil {
fmt.Println("Error:", err)
}
}
This example demonstrates how to use Chroma to highlight Go code and output it to the terminal using the Monokai style.
- Custom lexer and formatter:
package main
import (
"fmt"
"github.com/alecthomas/chroma"
"github.com/alecthomas/chroma/formatters"
"github.com/alecthomas/chroma/lexers"
"github.com/alecthomas/chroma/styles"
)
func main() {
code := `SELECT * FROM users WHERE age > 18;`
lexer := lexers.Get("sql")
style := styles.Get("github")
formatter := formatters.Get("html")
iterator, err := lexer.Tokenise(nil, code)
if err != nil {
fmt.Println("Error:", err)
return
}
err = formatter.Format(os.Stdout, style, iterator)
if err != nil {
fmt.Println("Error:", err)
}
}
This example shows how to use a custom lexer, style, and formatter to highlight SQL code and output it as HTML.
Getting Started
To use Chroma in your Go project, first install it:
go get github.com/alecthomas/chroma
Then, import and use it in your code:
import (
"github.com/alecthomas/chroma/quick"
)
// ...
err := quick.Highlight(os.Stdout, code, "go", "terminal", "monokai")
if err != nil {
// Handle error
}
For more advanced usage, refer to the examples above and the project's documentation.
Competitor Comparisons
Pygments is a generic syntax highlighter written in Python
Pros of Pygments
- Extensive language support with over 500 lexers
- Well-established and widely used in various projects and platforms
- Highly customizable with numerous output formats and styles
Cons of Pygments
- Written in Python, which may be slower compared to Go-based Chroma
- Can be more complex to set up and use, especially for non-Python projects
Code Comparison
Pygments:
from pygments import highlight
from pygments.lexers import PythonLexer
from pygments.formatters import HtmlFormatter
code = 'print("Hello, World!")'
print(highlight(code, PythonLexer(), HtmlFormatter()))
Chroma:
import (
"github.com/alecthomas/chroma"
"github.com/alecthomas/chroma/formatters/html"
"github.com/alecthomas/chroma/lexers"
)
lexer := lexers.Get("python")
formatter := html.New()
iterator, _ := lexer.Tokenise(nil, `print("Hello, World!")`)
formatter.Format(os.Stdout, styles.Get("monokai"), iterator)
Both Pygments and Chroma are powerful syntax highlighting libraries, each with its own strengths. Pygments offers broader language support and is more established, while Chroma provides potentially better performance for Go-based projects and simpler integration for non-Python environments.
A cat(1) clone with wings.
Pros of bat
- Standalone command-line tool for syntax highlighting and file viewing
- Integrates with Git for showing file changes
- Supports automatic paging for large files
Cons of bat
- Limited to command-line usage, not easily integrated into other applications
- Fewer supported languages compared to Chroma
- Requires installation as a separate tool
Code Comparison
bat (Rust):
pub fn highlight_file(path: &Path) -> Result<()> {
let mut highlighter = Highlighter::new();
highlighter.load_syntax_set();
highlighter.highlight_file(path)?;
Ok(())
}
Chroma (Go):
func Highlight(source, lexer, formatter string) (string, error) {
l := lexers.Get(lexer)
f := formatters.Get(formatter)
return f.Format(l.Tokenise(nil, source))
}
bat is a command-line tool focused on file viewing with syntax highlighting, while Chroma is a library for syntax highlighting that can be integrated into various applications. bat offers features like Git integration and automatic paging, making it more suitable for direct file viewing. Chroma, on the other hand, provides a more flexible API for syntax highlighting that can be used in different contexts, supporting a wider range of programming languages. The code comparison shows that bat uses a more object-oriented approach with a Highlighter struct, while Chroma employs a functional style with separate lexer and formatter components.
A pure Ruby code highlighter that is compatible with Pygments
Pros of Rouge
- Written in Ruby, making it a natural choice for Ruby-based projects
- Extensive language support with over 100 lexers
- Well-established and widely used in the Ruby ecosystem
Cons of Rouge
- Generally slower performance compared to Chroma
- Less flexible API for customization and extension
- Limited support for non-Ruby environments
Code Comparison
Rouge:
require 'rouge'
source = 'puts "Hello, world!"'
formatter = Rouge::Formatters::HTML.new
lexer = Rouge::Lexers::Ruby.new
formatter.format(lexer.lex(source))
Chroma:
import "github.com/alecthomas/chroma"
source := `fmt.Println("Hello, world!")`
lexer := lexers.Get("go")
formatter := formatters.HTML()
iterator, _ := lexer.Tokenise(nil, source)
formatter.Format(os.Stdout, styles.GitHub, iterator)
Both libraries provide syntax highlighting capabilities, but Chroma offers a more performant and flexible solution, especially for non-Ruby projects. Rouge excels in Ruby-centric environments and has broader language support, while Chroma provides better performance and easier integration with various programming languages.
Lightweight, robust, elegant syntax highlighting.
Pros of Prism
- Widely adopted and well-established in the web development community
- Extensive language support with a large number of available plugins
- Easy integration with various web frameworks and build tools
Cons of Prism
- JavaScript-based, which may not be suitable for server-side or non-web applications
- Can be relatively heavy for simple syntax highlighting needs
- Requires additional setup for server-side rendering scenarios
Code Comparison
Prism (JavaScript):
Prism.highlightAll();
Chroma (Go):
lexer := lexers.Get("go")
formatter := formatters.Get("html")
iterator, _ := lexer.Tokenise(nil, sourceCode)
formatter.Format(w, style, iterator)
Key Differences
- Chroma is written in Go, making it more suitable for server-side applications and command-line tools
- Prism is primarily designed for client-side web use, with a focus on ease of integration in web projects
- Chroma offers more flexibility in terms of output formats and customization options
- Prism has a larger ecosystem of plugins and themes due to its widespread adoption in web development
Both libraries provide syntax highlighting capabilities, but they cater to different use cases and environments. The choice between them depends on the specific requirements of your project and the target platform.
JavaScript syntax highlighter with language auto-detection and zero dependencies.
Pros of highlight.js
- Wider language support with 189+ languages and 94 styles
- Extensive browser compatibility, including older versions
- Large community and ecosystem with numerous plugins and integrations
Cons of highlight.js
- Larger file size, which may impact page load times
- JavaScript-based, potentially less performant for server-side rendering
- More complex setup for advanced customization
Code Comparison
highlight.js:
<pre><code class="language-python">
def greet(name):
print(f"Hello, {name}!")
</code></pre>
<script>hljs.highlightAll();</script>
Chroma:
lexer := lexers.Get("python")
iterator, _ := lexer.Tokenise(nil, sourceCode)
formatter := formatters.Get("html")
formatter.Format(os.Stdout, styles.Get("monokai"), iterator)
Key Differences
- Language: highlight.js is written in JavaScript, while Chroma is written in Go
- Usage: highlight.js is primarily client-side, Chroma is server-side
- Performance: Chroma may offer better performance for server-side rendering
- Customization: Chroma provides more fine-grained control over highlighting
- Integration: highlight.js is easier to integrate into web projects
Both libraries are popular choices for syntax highlighting, with highlight.js being more widely used in web development and Chroma offering advantages for server-side applications and performance-critical scenarios.
In-browser code editor (version 5, legacy)
Pros of CodeMirror 5
- More feature-rich and mature, with a wide range of built-in modes and addons
- Designed specifically for in-browser code editing, offering a complete solution
- Extensive documentation and large community support
Cons of CodeMirror 5
- Larger file size and potentially higher resource usage
- More complex setup and configuration compared to Chroma
- JavaScript-based, which may not be ideal for all use cases
Code Comparison
Chroma (Go):
lexer := lexers.Get("go")
iterator, _ := lexer.Tokenise(nil, sourceCode)
CodeMirror 5 (JavaScript):
var editor = CodeMirror.fromTextArea(document.getElementById("code"), {
mode: "javascript",
lineNumbers: true
});
Summary
CodeMirror 5 is a comprehensive in-browser code editor with extensive features and community support, while Chroma is a lightweight syntax highlighter written in Go. CodeMirror 5 offers a complete editing solution but may be overkill for simple highlighting tasks. Chroma is more focused on syntax highlighting and can be easily integrated into various applications, especially those written in Go.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Chroma â A general purpose syntax highlighter in pure Go
Chroma takes source code and other structured text and converts it into syntax highlighted HTML, ANSI-coloured text, etc.
Chroma is based heavily on Pygments, and includes translators for Pygments lexers and styles.
Table of Contents
- Supported languages
- Try it
- Using the library
- More detail
- Command-line interface
- Testing lexers
- What's missing compared to Pygments?
Supported languages
Prefix | Language |
---|---|
A | ABAP, ABNF, ActionScript, ActionScript 3, Ada, Agda, AL, Alloy, Angular2, ANTLR, ApacheConf, APL, AppleScript, ArangoDB AQL, Arduino, ArmAsm, AutoHotkey, AutoIt, Awk |
B | Ballerina, Bash, Bash Session, Batchfile, BibTeX, Bicep, BlitzBasic, BNF, BQN, Brainfuck |
C | C, C#, C++, Caddyfile, Caddyfile Directives, Cap'n Proto, Cassandra CQL, Ceylon, CFEngine3, cfstatement, ChaiScript, Chapel, Cheetah, Clojure, CMake, COBOL, CoffeeScript, Common Lisp, Coq, Crystal, CSS, Cython |
D | D, Dart, Dax, Desktop Entry, Diff, Django/Jinja, dns, Docker, DTD, Dylan |
E | EBNF, Elixir, Elm, EmacsLisp, Erlang |
F | Factor, Fennel, Fish, Forth, Fortran, FortranFixed, FSharp |
G | GAS, GDScript, Genshi, Genshi HTML, Genshi Text, Gherkin, Gleam, GLSL, Gnuplot, Go, Go HTML Template, Go Text Template, GraphQL, Groff, Groovy |
H | Handlebars, Hare, Haskell, Haxe, HCL, Hexdump, HLB, HLSL, HolyC, HTML, HTTP, Hy |
I | Idris, Igor, INI, Io, ISCdhcpd |
J | J, Java, JavaScript, JSON, Julia, Jungle |
K | Kotlin |
L | Lighttpd configuration file, LLVM, Lua |
M | Makefile, Mako, markdown, Mason, Materialize SQL dialect, Mathematica, Matlab, MCFunction, Meson, Metal, MiniZinc, MLIR, Modula-2, MonkeyC, MorrowindScript, Myghty, MySQL |
N | NASM, Natural, Newspeak, Nginx configuration file, Nim, Nix |
O | Objective-C, OCaml, Octave, Odin, OnesEnterprise, OpenEdge ABL, OpenSCAD, Org Mode |
P | PacmanConf, Perl, PHP, PHTML, Pig, PkgConfig, PL/pgSQL, plaintext, Plutus Core, Pony, PostgreSQL SQL dialect, PostScript, POVRay, PowerQuery, PowerShell, Prolog, PromQL, Promela, properties, Protocol Buffer, PRQL, PSL, Puppet, Python, Python 2 |
Q | QBasic, QML |
R | R, Racket, Ragel, Raku, react, ReasonML, reg, Rego, reStructuredText, Rexx, RPMSpec, Ruby, Rust |
S | SAS, Sass, Scala, Scheme, Scilab, SCSS, Sed, Sieve, Smali, Smalltalk, Smarty, SNBT, Snobol, Solidity, SourcePawn, SPARQL, SQL, SquidConf, Standard ML, stas, Stylus, Svelte, Swift, SYSTEMD, systemverilog |
T | TableGen, Tal, TASM, Tcl, Tcsh, Termcap, Terminfo, Terraform, TeX, Thrift, TOML, TradingView, Transact-SQL, Turing, Turtle, Twig, TypeScript, TypoScript, TypoScriptCssData, TypoScriptHtmlData |
V | V, V shell, Vala, VB.net, verilog, VHDL, VHS, VimL, vue |
W | WDTE, WebGPU Shading Language, Whiley |
X | XML, Xorg |
Y | YAML, YANG |
Z | Z80 Assembly, Zed, Zig |
I will attempt to keep this section up to date, but an authoritative list can be
displayed with chroma --list
.
Try it
Try out various languages and styles on the Chroma Playground.
Using the library
This is version 2 of Chroma, use the import path:
import "github.com/alecthomas/chroma/v2"
Chroma, like Pygments, has the concepts of lexers, formatters and styles.
Lexers convert source text into a stream of tokens, styles specify how token types are mapped to colours, and formatters convert tokens and styles into formatted output.
A package exists for each of these, containing a global Registry
variable
with all of the registered implementations. There are also helper functions
for using the registry in each package, such as looking up lexers by name or
matching filenames, etc.
In all cases, if a lexer, formatter or style can not be determined, nil
will
be returned. In this situation you may want to default to the Fallback
value in each respective package, which provides sane defaults.
Quick start
A convenience function exists that can be used to simply format some source text, without any effort:
err := quick.Highlight(os.Stdout, someSourceCode, "go", "html", "monokai")
Identifying the language
To highlight code, you'll first have to identify what language the code is written in. There are three primary ways to do that:
-
Detect the language from its filename.
lexer := lexers.Match("foo.go")
-
Explicitly specify the language by its Chroma syntax ID (a full list is available from
lexers.Names()
).lexer := lexers.Get("go")
-
Detect the language from its content.
lexer := lexers.Analyse("package main\n\nfunc main()\n{\n}\n")
In all cases, nil
will be returned if the language can not be identified.
if lexer == nil {
lexer = lexers.Fallback
}
At this point, it should be noted that some lexers can be extremely chatty. To mitigate this, you can use the coalescing lexer to coalesce runs of identical token types into a single token:
lexer = chroma.Coalesce(lexer)
Formatting the output
Once a language is identified you will need to pick a formatter and a style (theme).
style := styles.Get("swapoff")
if style == nil {
style = styles.Fallback
}
formatter := formatters.Get("html")
if formatter == nil {
formatter = formatters.Fallback
}
Then obtain an iterator over the tokens:
contents, err := ioutil.ReadAll(r)
iterator, err := lexer.Tokenise(nil, string(contents))
And finally, format the tokens from the iterator:
err := formatter.Format(w, style, iterator)
The HTML formatter
By default the html
registered formatter generates standalone HTML with
embedded CSS. More flexibility is available through the formatters/html
package.
Firstly, the output generated by the formatter can be customised with the following constructor options:
Standalone()
- generate standalone HTML with embedded CSS.WithClasses()
- use classes rather than inlined style attributes.ClassPrefix(prefix)
- prefix each generated CSS class.TabWidth(width)
- Set the rendered tab width, in characters.WithLineNumbers()
- Render line numbers (style withLineNumbers
).WithLinkableLineNumbers()
- Make the line numbers linkable and be a link to themselves.HighlightLines(ranges)
- Highlight lines in these ranges (style withLineHighlight
).LineNumbersInTable()
- Use a table for formatting line numbers and code, rather than spans.
If WithClasses()
is used, the corresponding CSS can be obtained from the formatter with:
formatter := html.New(html.WithClasses(true))
err := formatter.WriteCSS(w, style)
More detail
Lexers
See the Pygments documentation for details on implementing lexers. Most concepts apply directly to Chroma, but see existing lexer implementations for real examples.
In many cases lexers can be automatically converted directly from Pygments by
using the included Python 3 script pygments2chroma_xml.py
. I use something like
the following:
python3 _tools/pygments2chroma_xml.py \
pygments.lexers.jvm.KotlinLexer \
> lexers/embedded/kotlin.xml
See notes in pygments-lexers.txt for a list of lexers, and notes on some of the issues importing them.
Formatters
Chroma supports HTML output, as well as terminal output in 8 colour, 256 colour, and true-colour.
A noop
formatter is included that outputs the token text only, and a tokens
formatter outputs raw tokens. The latter is useful for debugging lexers.
Styles
Chroma styles are defined in XML. The style entries use the same syntax as Pygments.
All Pygments styles have been converted to Chroma using the _tools/style.py
script.
When you work with one of Chroma's styles,
know that the Background
token type provides the default style for tokens. It does so
by defining a foreground color and background color.
For example, this gives each token name not defined in the style a default color
of #f8f8f8
and uses #000000
for the highlighted code block's background:
<entry type="Background" style="#f8f8f2 bg:#000000"/>
Also, token types in a style file are hierarchical. For instance, when CommentSpecial
is not defined, Chroma uses the token style from Comment
. So when several comment tokens use the same color, you'll only need to define Comment
and override the one that has a different color.
For a quick overview of the available styles and how they look, check out the Chroma Style Gallery.
Command-line interface
A command-line interface to Chroma is included.
Binaries are available to install from the releases page.
The CLI can be used as a preprocessor to colorise output of less(1)
,
see documentation for the LESSOPEN
environment variable.
The --fail
flag can be used to suppress output and return with exit status
1 to facilitate falling back to some other preprocessor in case chroma
does not resolve a specific lexer to use for the given file. For example:
export LESSOPEN='| p() { chroma --fail "$1" || cat "$1"; }; p "%s"'
Replace cat
with your favourite fallback preprocessor.
When invoked as .lessfilter
, the --fail
flag is automatically turned
on under the hood for easy integration with lesspipe shipping with
Debian and derivatives;
for that setup the chroma
executable can be just symlinked to ~/.lessfilter
.
Testing lexers
If you edit some lexers and want to try it, open a shell in cmd/chromad
and run:
go run . --csrf-key=securekey
A Link will be printed. Open it in your Browser. Now you can test on the Playground with your local changes.
If you want to run the tests and the lexers, open a shell in the root directory and run:
go test ./lexers
When updating or adding a lexer, please add tests. See lexers/README.md for more.
What's missing compared to Pygments?
- Quite a few lexers, for various reasons (pull-requests welcome):
- Pygments lexers for complex languages often include custom code to handle certain aspects, such as Raku's ability to nest code inside regular expressions. These require time and effort to convert.
- I mostly only converted languages I had heard of, to reduce the porting cost.
- Some more esoteric features of Pygments are omitted for simplicity.
- Though the Chroma API supports content detection, very few languages support them. I have plans to implement a statistical analyser at some point, but not enough time.
Top Related Projects
Pygments is a generic syntax highlighter written in Python
A cat(1) clone with wings.
A pure Ruby code highlighter that is compatible with Pygments
Lightweight, robust, elegant syntax highlighting.
JavaScript syntax highlighter with language auto-detection and zero dependencies.
In-browser code editor (version 5, legacy)
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot