@babel/highlight

What is @babel/highlight?

The @babel/highlight package is a syntax highlighter for JavaScript code. It can be used to highlight JavaScript syntax with themes for readability, often for displaying code in documentation or web applications.

What are @babel/highlight's main functionalities?

Syntax highlighting

This feature allows you to highlight JavaScript code. You can pass in a string of code and an options object to specify the theme, and it returns an object with a 'value' property containing the highlighted code.

const { highlight } = require('@babel/highlight');
const code = 'const x = 1;';
const highlightedCode = highlight(code, { theme: 'default' }).value;

Other packages similar to @babel/highlight

prismjs

Prism is a lightweight, extensible syntax highlighter, built with modern web standards in mind. It's used in thousands of websites, including some of those made by big companies like USA Today and The Washington Post. It is similar to @babel/highlight but supports a wider range of languages and has a plugin system for extending functionality.

highlight.js

Highlight.js is a syntax highlighter written in JavaScript. It works in the browser as well as on the server. It works with many languages and has a number of different styles. It is similar to @babel/highlight in that it highlights code syntax, but it has a broader language support and different themes.

shiki

Shiki is a beautiful syntax highlighter powered by the same syntax engine that powers VS Code. It offers a high level of accuracy and a wide range of themes from VS Code. It is similar to @babel/highlight in providing syntax highlighting, but it uses TextMate grammars for language definitions and has VS Code's themes.

README

@babel/highlight

Syntax highlight JavaScript strings for output in terminals.

Install

npm install --save @babel/highlight

Usage

import highlight from "@babel/highlight";

const code = `class Foo {
  constructor()
}`;

const result = highlight(code);

console.log(result);

class Foo {
  constructor()
}

By default, highlight will not highlight your code if your terminal does not support color. To force colors, pass { forceColor: true } as the second argument to highlight.

import highlight from "@babel/highlight";

const code = `class Foo {
  constructor()
}`;

const result = highlight(code, { forceColor: true });