@shikijs/engine-oniguruma

What is @shikijs/engine-oniguruma?

@shikijs/engine-oniguruma is an npm package that provides Oniguruma regular expression engine support for the Shiki syntax highlighter. It allows for advanced syntax highlighting by leveraging the Oniguruma regex engine, which is known for its powerful and efficient pattern matching capabilities.

What are @shikijs/engine-oniguruma's main functionalities?

Syntax Highlighting

This feature allows you to perform syntax highlighting on code snippets using the Oniguruma regex engine. The code sample demonstrates how to load the Oniguruma WASM module and use the Shiki highlighter to highlight a JavaScript code snippet.

const { getHighlighter } = require('shiki');
const { loadWASM } = require('@shikijs/engine-oniguruma');

async function highlightCode() {
  await loadWASM();
  const highlighter = await getHighlighter({
    theme: 'nord',
    langs: ['javascript']
  });
  const code = `const x = 10;`;
  const highlightedCode = highlighter.codeToHtml(code, { lang: 'javascript' });
  console.log(highlightedCode);
}

highlightCode();

Other packages similar to @shikijs/engine-oniguruma

highlight.js

highlight.js is a popular syntax highlighting library that supports a wide range of languages and themes. Unlike @shikijs/engine-oniguruma, which uses the Oniguruma regex engine, highlight.js uses its own regex-based engine for pattern matching. It is easy to use and integrates well with various web frameworks.

prismjs

Prism is a lightweight, extensible syntax highlighter that is used by many websites and applications. It offers a wide range of plugins and themes, and it is known for its performance and ease of use. Unlike @shikijs/engine-oniguruma, Prism does not use the Oniguruma regex engine but instead relies on its own pattern matching techniques.

codemirror

CodeMirror is a versatile text editor implemented in JavaScript for the browser. It provides syntax highlighting, code folding, and many other features. While it is more of a full-fledged code editor than just a syntax highlighter, it can be compared to @shikijs/engine-oniguruma in terms of its ability to highlight code using various modes and themes.

README

@shikijs/engine-oniguruma

Engine for Shiki using Oniguruma RegExp engine in WebAssembly.

Documentation

License

MIT