react-codemirror-runmode 2.0.2 → 2.1.0

package/README.md

@@ -39,14 +39,18 @@ Props:
 - `lang`: `string` - The name of the language
 - `theme`: [`Highlighter`](https://lezer.codemirror.net/docs/ref/#highlight.Highlighter) - The highlight style
 - `children`: `string` - The code to highlight
+- `fallbackLanguage`: `Language` - Optional fallback language to use if the specified language isn't found
+- `languages`: `LanguageDescription[]` - Optional custom list of language descriptions
 
-### `highlightCode<Output>(languageName, input, highlightStyle, callback): Promise<Output[]>`
+### `highlightCode<o>(languageName, input, highlightStyle, fallbackLanguage?, languages?, callback): Promise<Output[]>`
 
 Parameters:
 
 - `languageName`: `string` - The name of the language
 - `input`: `string` - The code to highlight
 - `highlighter`: [`Highlighter`](https://lezer.codemirror.net/docs/ref/#highlight.Highlighter) - The highlight style
+- `fallbackLanguage`: `Language` - Optional fallback language to use if the specified language isn't found
+- `languages`: `LanguageDescription[]` - Optional custom list of language descriptions
 - `callback`: `(text: string, style: string | null, from: number, to: number) => Output)` - A callback function that converts the parsed tokens
 
 ### `getCodeParser(languageName, defaultLanguage?): Promise<Parser | null>`

package/dist/highlight.d.ts

@@ -1,5 +1,5 @@
 import { Parser } from '@lezer/common';
-import { Language } from '@codemirror/language';
+import { Language, LanguageDescription } from '@codemirror/language';
 import { Highlighter } from '@lezer/highlight';
-export declare function getCodeParser(languageName: string, defaultLanguage?: Language): Promise<Parser | null>;
-export declare function highlightCode<Output>(languageName: string, input: string, highlighter: Highlighter, callback: (text: string, style: string | null, from: number, to: number) => Output): Promise<Output[]>;
+export declare function getCodeParser(languageName: string, fallbackLanguage?: Language, languages?: LanguageDescription[]): Promise<Parser | null>;
+export declare function highlightCode<Output>(languageName: string, input: string, highlighter: Highlighter, fallbackLanguage: Language | undefined, languages: LanguageDescription[] | undefined, callback: (text: string, style: string | null, from: number, to: number) => Output): Promise<Output[]>;

package/dist/highlight.js

@@ -1,8 +1,8 @@
 import { LanguageDescription } from '@codemirror/language';
 import { highlightTree } from '@lezer/highlight';
-import { languages } from '@codemirror/language-data';
-export async function getCodeParser(languageName, defaultLanguage) {
-    if (languageName && languages) {
+import { languages as builtinLanguages } from '@codemirror/language-data';
+export async function getCodeParser(languageName, fallbackLanguage, languages = builtinLanguages) {
+    if (languageName) {
         const found = LanguageDescription.matchLanguageName(languages, languageName, true);
         if (found instanceof LanguageDescription) {
             if (!found.support)
@@ -12,10 +12,10 @@ export async function getCodeParser(languageName, defaultLanguage) {
         else if (found)
             return found.parser;
     }
-    return defaultLanguage ? defaultLanguage.parser : null;
+    return fallbackLanguage ? fallbackLanguage.parser : null;
 }
-export async function highlightCode(languageName, input, highlighter, callback) {
-    const parser = await getCodeParser(languageName);
+export async function highlightCode(languageName, input, highlighter, fallbackLanguage, languages, callback) {
+    const parser = await getCodeParser(languageName, fallbackLanguage, languages);
     if (parser) {
         const tree = parser.parse(input);
         const output = [];

package/dist/react-highlighter.d.ts

@@ -1,8 +1,11 @@
 import React from 'react';
 import type { Highlighter as LezerHighlighter } from '@lezer/highlight';
+import type { Language, LanguageDescription } from '@codemirror/language';
 export type HighlighterProps = {
     lang: string;
     children: string;
     theme: LezerHighlighter;
+    fallbackLanguage?: Language;
+    languages?: LanguageDescription[];
 };
 export declare const Highlighter: React.NamedExoticComponent<HighlighterProps>;

package/dist/react-highlighter.js

@@ -2,10 +2,10 @@ import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
 import { memo, useEffect, useState } from 'react';
 import { highlightCode } from './highlight.js';
 export const Highlighter = memo((props) => {
-    const { lang, children: code, theme } = props;
+    const { lang, children: code, theme, fallbackLanguage, languages } = props;
     const [highlightedCode, setHighlightedCode] = useState(null);
     useEffect(() => {
-        highlightCode(lang, code, theme, (text, style, from) => {
+        highlightCode(lang, code, theme, fallbackLanguage, languages, (text, style, from) => {
             return (_jsx("span", { className: style || '', children: text }, from));
         }).then(setHighlightedCode);
     }, [lang, code, theme]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-codemirror-runmode",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Syntax highlighting for react, utilizing CodeMirror's parser",
   "type": "module",
   "main": "dist/index.js",

package/src/highlight.ts

@@ -1,13 +1,14 @@
 import { Parser } from '@lezer/common'
 import { Language, LanguageDescription } from '@codemirror/language'
 import { Highlighter, highlightTree } from '@lezer/highlight'
-import { languages } from '@codemirror/language-data'
+import { languages as builtinLanguages } from '@codemirror/language-data'
 
 export async function getCodeParser(
   languageName: string,
-  defaultLanguage?: Language
+  fallbackLanguage?: Language,
+  languages: LanguageDescription[] = builtinLanguages
 ): Promise<Parser | null> {
-  if (languageName && languages) {
+  if (languageName) {
     const found = LanguageDescription.matchLanguageName(
       languages,
       languageName,
@@ -18,13 +19,15 @@ export async function getCodeParser(
       return found.support ? found.support.language.parser : null
     } else if (found) return (found as any).parser
   }
-  return defaultLanguage ? defaultLanguage.parser : null
+  return fallbackLanguage ? fallbackLanguage.parser : null
 }
 
 export async function highlightCode<Output>(
   languageName: string,
   input: string,
   highlighter: Highlighter,
+  fallbackLanguage: Language | undefined,
+  languages: LanguageDescription[] | undefined,
   callback: (
     text: string,
     style: string | null,
@@ -32,7 +35,7 @@ export async function highlightCode<Output>(
     to: number
   ) => Output
 ): Promise<Output[]> {
-  const parser = await getCodeParser(languageName)
+  const parser = await getCodeParser(languageName, fallbackLanguage, languages)
   if (parser) {
     const tree = parser.parse(input)
     const output: Array<Output> = []

package/src/react-highlighter.tsx

@@ -1,15 +1,18 @@
 import React, { memo, useEffect, useState } from 'react'
 import { highlightCode } from './highlight.js'
 import type { Highlighter as LezerHighlighter } from '@lezer/highlight'
+import type { Language, LanguageDescription } from '@codemirror/language'
 
 export type HighlighterProps = {
   lang: string
   children: string
   theme: LezerHighlighter
+  fallbackLanguage?: Language
+  languages?: LanguageDescription[]
 }
 
 export const Highlighter = memo<HighlighterProps>((props: HighlighterProps) => {
-  const { lang, children: code, theme } = props
+  const { lang, children: code, theme, fallbackLanguage, languages } = props
   const [highlightedCode, setHighlightedCode] = useState<
     React.ReactNode[] | null
   >(null)
@@ -19,6 +22,8 @@ export const Highlighter = memo<HighlighterProps>((props: HighlighterProps) => {
       lang,
       code,
       theme,
+      fallbackLanguage,
+      languages,
       (text: string, style: string | null, from: number) => {
         return (
           <span key={from} className={style || ''}>

package/test/index.spec.tsx

@@ -29,6 +29,8 @@ describe('highlightCode', () => {
       'js',
       'const x = 123',
       oneDarkHighlightStyle,
+      undefined,
+      undefined,
       (text, style, from, to) => ({ text, style, from, to })
     )
     expect(highlighted).toHaveLength(7)