tinyhighlight

minimal fork of @babel/highlight 🌈

This is a lightweight fork of @babel/highlight that tries to be the most compact library for highlighting JS/TS/JSX/TSX syntax. It also doesn't depend on any Node.js API.

Usage

Changes made to @babel/highlight:

• Updated js-tokens (which adds more code, but it is up-to-date with the latest standards)
• chalk is replaced with picocolors
• Two methods from @babel/helper-validator-identifier are inlined to save space
• Introduced a token type for methods (IdentifierCallable/PrivateIdentifierCallable)
• This package is ESM-only

API is not compatible with @babel/highlight because we use the latest js-tokens version.

This package provides two entry points:

• The default module exposes highlight method without any styling.

import { highlight } from 'tinyhighlight'
highlight('const answer = 42', {
  jsx: false,
  colors: provideYourOwnColors(),
})

Tip

You can use colors option to define color providers. If you support JSX, make sure to provide JSX-named properties because they use a separate token identifier.

• The ./picocolors entry point exposes highlight method that uses picocolors for styling:

import { highlight } from 'tinyhighlight/picocolors'
highlight('const answer = 42', { jsx: false })

Warning

This package doesn't install picocolors automatically, you need to add it to your own dependencies if you use this option.

Token Types

You can look at js-tokens documentation to read about available tokens. On top of that, tinyhighlight also provides these tokens:

IdentifierCallable

This is an Identifier that has a bracket (() after it. someName is IdentifierCallable in all of these examples:

someName()
someName ()
someName
()
someName?.()
someName!()
property.someName()
function someName() {}
class Test {
  someName() {}
}

PrivateIdentifierCallable

This is a PrivateIdentifier that has a bracket (() after it. #someName (# is also part of the value) is PrivateIdentifierCallable in all of these examples:

this.#someName()
this.#someName ()
this.#someName
()
this.#someName?.()
this.#someName!()
class Test {
  #someName() {}
}

IdentifierCapitalized

This is an Identifier that starts with a capital letter. someName is Test in all of these examples:

Test
class Test {}
function Test() {}
function(Test) {}

Tip

If identifier is both callable and capitalized, IdentifierCapitalized will be used for coloring.

Keyword

This is a potential Identifier that uses a reserved name. For example (not a full list):

const
export
null
true
protected
public
void
this

Bracket

This is a Punctuator equal to one of [, ], {, }, (, ).