cli-highlighter

This package is a fork of felixfbecker's amazing cli-highlight package which seems to be unmaintained.

Syntax highlighting in your terminal

Example

CLI Usage

Output a file

1highlight package.json

Color output of another program with piping. Example: A database migration script that logs SQL Queries

1db-migrate --dry-run | highlight

Command line options:

1Usage: highlight [options] [file] Outputs a file or STDIN input with syntax
2highlighting Options: --language, -l Set the langugage explicitely If omitted
3will try to auto-detect --theme, -t Use a theme defined in a JSON file --help,
4-h Show help

Programmatic Usage

You can use this module programmatically to highlight logs of your Node app. Example:

1import highlight from 'cli-highlighter';
2import Sequelize from 'sequalize';
3
4const db = new Sequelize(process.env.DB, {
5  logging(log) {
6    console.log(highlight(log, { language: 'sql', ignoreIllegals: true }));
7  },
8});

Detailed API documentation can be found here.

Themes

You can write your own theme in a JSON file and pass it with --theme. The key must be one of the highlight.js CSS class names or "default", and the value must be one or an array of Chalk styles to be applied to that token.

1{
2  "keyword": "blue",
3  "built_in": ["cyan", "dim"],
4  "string": "red",
5  "default": "gray"
6}

The style for "default" will be applied to any substrings not handled by highlight.js. The specifics depend on the language but this typically includes things like commas in parameter lists, semicolons at the end of lines, etc.

The theme is combined with the default theme. The default theme is still not colored a lot or optimized for many languages, PRs welcome!

Supported Languages

All languages of highlight.js are supported.

Contributing

The module is written in TypeScript and can be compiled with pnpm build. Tests are written with vitest.

Improving language support is done by adding more colors to the tokens in the default theme and writing more tests.