README.md

pyranine

_{Built with 🦀 + 🕸}

About

This is a simple library publishing a WASM module that can be used to highlight code in JavaScript, through the use of syntect.

The name pyranine comes from the dye commonly used in commercial yellow (paper) highlighters (and also in soup lol).

Usage

I've created this for my personal project RepoExplorer, so I've only tested it with Vite. I'm currently using vite-plugin-wasm-pack for that.

// vite.config.ts
import wasmPack from "vite-plugin-wasm-pack";

export default defineConfig({
  // ...
  plugins: [
    // ...
    wasmPack([], ["pyranine"]),
  ],
});

import initHighlighter, * as wasm from "pyranine";

const code = "const foo = 'bar';";

/* The following themes are available:
"base16-ocean.dark",
"base16-eighties.dark",
"base16-mocha.dark",
"base16-ocean.light",
"InspiredGitHub",
"Solarized (dark)",
"Solarized (light)",
*/

function tryHighlightStringAsHTML(
  code: string,
  language: string,
  theme: string
) {
  return new Promise()<string>((resolve) => {
    initHighlighter().then(() =>
      resolve(wasm.highlight(code, language, theme))
    );
  });
}

tryHighlightStringAsHTML(code, "javascript", "base16-ocean.dark").then((c) =>
  console.log(c)
);

Note

You may get an warning saying "pyranine doesn't appear to be written in CJS...". This is because the library is written in Rust and compiled to WASM, and the tooling around that is still being developed. I may also be doing something wrong, but I'm not sure what. If you know, please let me know, or feel free to open a PR.

The important thing is that the library seems to work fine, and the warning can be safely ignored.