@scalar/code-highlight 0.4.6 → 0.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/dist/chunks/code.js +3 -3
- package/dist/chunks/code.js.map +1 -1
- package/dist/chunks/lib.js +609 -13596
- package/dist/chunks/lib.js.map +1 -1
- package/dist/chunks/markdown.js +4 -17
- package/dist/chunks/markdown.js.map +1 -1
- package/dist/chunks/rehype-alert.js +1 -1
- package/dist/chunks/rehype-highlight.js +1 -1
- package/dist/chunks/shared-lowlight.js +13798 -0
- package/dist/chunks/shared-lowlight.js.map +1 -0
- package/dist/code/highlight.d.ts.map +1 -1
- package/dist/markdown/markdown.d.ts.map +1 -1
- package/dist/rehype-highlight/shared-lowlight.d.ts +18 -0
- package/dist/rehype-highlight/shared-lowlight.d.ts.map +1 -0
- package/package.json +3 -3
- package/dist/chunks/lib2.js +0 -736
- package/dist/chunks/lib2.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @scalar/code-highlight
|
|
2
2
|
|
|
3
|
+
## 0.4.8
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#10459](https://github.com/scalar/scalar/pull/10459): Share one lowlight instance per language registry between `syntaxHighlight` and `htmlFromMarkdown` instead of registering and compiling every grammar for each code block, and replace it after a grammar fails to compile so later blocks that embed that grammar keep their text
|
|
8
|
+
|
|
9
|
+
## 0.4.7
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [#10212](https://github.com/scalar/scalar/pull/10212): Improve type safety for schema display metadata, schema property merging, deprecated configuration migration, and cyclic test fixtures. Load Vite declarations for raw playground imports.
|
|
14
|
+
|
|
3
15
|
## 0.4.6
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/dist/chunks/code.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { a as lowlightLanguageMappings, t as rehypeHighlight } from "./rehype-highlight.js";
|
|
2
|
-
import { n as
|
|
3
|
-
import { t as visit } from "./
|
|
2
|
+
import { c as rehypeParse, n as unified, r as rehypeStringify, t as getSharedLowlight } from "./shared-lowlight.js";
|
|
3
|
+
import { t as visit } from "./lib.js";
|
|
4
4
|
//#region src/code/line-numbers.ts
|
|
5
5
|
function isText(element) {
|
|
6
6
|
return element?.type === "text";
|
|
@@ -101,7 +101,7 @@ function syntaxHighlight(codeString, options) {
|
|
|
101
101
|
});
|
|
102
102
|
const className = `language-${lowlightLanguageMappings[options.lang] ?? options.lang}`;
|
|
103
103
|
const nullPlugin = (() => {});
|
|
104
|
-
const htmlString = unified().use(rehypeParse, { fragment: true }).use(injectRawCodeStringPlugin(codeString)).use(rehypeHighlight, {
|
|
104
|
+
const htmlString = unified().use(rehypeParse, { fragment: true }).use(injectRawCodeStringPlugin(codeString)).use(rehypeHighlight, { lowlight: options.languages ? getSharedLowlight(options.languages) : void 0 }).use(options?.lineNumbers ? codeBlockLinesPlugin : nullPlugin).use(rehypeStringify).processSync(`<pre><code class="${className}"></code></pre>`).toString();
|
|
105
105
|
return credentials.length ? credentials.reduce((acc, credential) => acc.split(credential).join(`<span class="credential"><span class="credential-value">${credential}</span></span>`), htmlString) : htmlString;
|
|
106
106
|
}
|
|
107
107
|
/**
|
package/dist/chunks/code.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"code.js","names":[],"sources":["../../src/code/line-numbers.ts","../../src/code/highlight.ts"],"sourcesContent":["import type { Element, ElementContent, Root, Text } from 'hast'\nimport { visit } from 'unist-util-visit'\n\n// ---------------------------------------------------------------------------\n// Line Numbering plugin\n\nfunction isText(element?: ElementContent): element is Text {\n return element?.type === 'text'\n}\n\nfunction isElement(node?: ElementContent): node is Element {\n return node?.type === 'element'\n}\n\nfunction textElement(value: string): Text {\n return { type: 'text', value }\n}\n\nfunction lineBreak(): Text {\n return { type: 'text', value: '\\n' }\n}\n\n/**\n * Adds lines to code blocks\n */\nexport function codeBlockLinesPlugin() {\n return (tree: Root) => {\n visit(tree, 'element', (node: Element, _i, parent: Root | Element | null) => {\n if (parent?.type === 'element' && parent.tagName === 'pre' && node.tagName === 'code') {\n let numLines = 0\n\n // Wraps each line in a span\n node.children = addLines(node)\n\n // Adds a line break to the end of each line\n node.children.forEach((child: ElementContent) => {\n if (child.type === 'element' && child.tagName === 'span') {\n const lastChild: ElementContent | undefined = child.children[child.children.length - 1]\n\n if (lastChild && (!isText(lastChild) || (isText(lastChild) && !hasLineBreak(lastChild)))) {\n child.children.push(lineBreak())\n numLines++\n }\n }\n })\n\n // We need to maintain a count of the total lines to allow space for the labels\n node.properties.style = [`--line-count: ${numLines};`, `--line-digits: ${numLines.toString().length};`]\n }\n })\n\n // console.log('NUMBER OF LINES IS: ', numLines)\n }\n}\n\n/**\n * Adds lines to a node recursively and returns them\n *\n * @param node - The node to add lines to\n * @param lines - The current lines\n * @param copyParent - Whether to copy the parent node to save the original node styles\n */\nfunction addLines(node: Element, lines: Element[] = [], copyParent?: boolean): Element[] {\n const line = () => lines[lines.length - 1] ?? ((lines.push(createLine()) && lines[lines.length - 1]) || undefined)\n\n node.children.forEach((child: ElementContent) => {\n if (isText(child) && hasLineBreak(child)) {\n const split: string[] = child.value.split(/\\n/)\n\n split.forEach((content: string, i: number) => {\n if (copyParent) {\n line()?.children.push({ ...node, children: [textElement(content)] })\n } else {\n line()?.children.push(textElement(content))\n }\n\n i !== split.length - 1 && lines.push(createLine())\n })\n } else if (isElement(child) && child.children.some(hasLineBreak)) {\n addLines(child, lines, true)\n } else {\n line()?.children.push(child)\n }\n })\n\n return lines\n}\n\n/**\n * Creates a new line element\n *\n * @param children - The children the line should have initially\n */\nfunction createLine(...children: ElementContent[]): Element {\n return {\n type: 'element',\n tagName: 'span',\n properties: { class: ['line'] },\n children,\n }\n}\n\n/**\n * Checks if a node has a line break\n *\n * @param node - The node to check\n */\nfunction hasLineBreak(node: ElementContent): boolean {\n return (isText(node) && /\\r?\\n/.test(node.value)) || (isElement(node) && node.children.some(hasLineBreak))\n}\n","import type { Element, Root } from 'hast'\nimport type { LanguageFn } from 'highlight.js'\nimport rehypeParse from 'rehype-parse'\nimport rehypeStringify from 'rehype-stringify'\nimport { type Plugin, unified } from 'unified'\nimport { visit } from 'unist-util-visit'\n\nimport { lowlightLanguageMappings } from '@/constants'\nimport { rehypeHighlight } from '@/rehype-highlight'\n\nimport { codeBlockLinesPlugin } from './line-numbers'\n\n/**\n * Syntax highlights a code string using the `rehype-highlight` library.\n */\nexport function syntaxHighlight(\n codeString: string,\n options: {\n lang: string\n languages: Record<string, LanguageFn>\n lineNumbers?: boolean\n maskCredentials?: string | string[]\n },\n) {\n // Simple restriction on credentials to prevent unexpected behavior\n const credentials = (\n typeof options?.maskCredentials === 'string' ? [options.maskCredentials] : (options?.maskCredentials ?? [])\n ).filter((c) => {\n // Credentials must be at least 3 characters to mask.\n if (c.length < 3) {\n return false\n }\n\n return true\n })\n\n // Classname is used by lowlight to select the language model\n const className = `language-${lowlightLanguageMappings[options.lang] ?? options.lang}`\n\n // biome-ignore lint/suspicious/noEmptyBlockStatements: empty plugin\n const nullPlugin = (() => {}) satisfies Plugin\n\n const html = unified()\n // Parses markdown\n .use(rehypeParse, { fragment: true })\n // Raw code string must be injected after initial hast parsing\n // so that HTML code is not parsed into the hast tree\n .use(injectRawCodeStringPlugin(codeString))\n // Syntax highlighting\n .use(rehypeHighlight, {\n
|
|
1
|
+
{"version":3,"file":"code.js","names":[],"sources":["../../src/code/line-numbers.ts","../../src/code/highlight.ts"],"sourcesContent":["import type { Element, ElementContent, Root, Text } from 'hast'\nimport { visit } from 'unist-util-visit'\n\n// ---------------------------------------------------------------------------\n// Line Numbering plugin\n\nfunction isText(element?: ElementContent): element is Text {\n return element?.type === 'text'\n}\n\nfunction isElement(node?: ElementContent): node is Element {\n return node?.type === 'element'\n}\n\nfunction textElement(value: string): Text {\n return { type: 'text', value }\n}\n\nfunction lineBreak(): Text {\n return { type: 'text', value: '\\n' }\n}\n\n/**\n * Adds lines to code blocks\n */\nexport function codeBlockLinesPlugin() {\n return (tree: Root) => {\n visit(tree, 'element', (node: Element, _i, parent: Root | Element | null) => {\n if (parent?.type === 'element' && parent.tagName === 'pre' && node.tagName === 'code') {\n let numLines = 0\n\n // Wraps each line in a span\n node.children = addLines(node)\n\n // Adds a line break to the end of each line\n node.children.forEach((child: ElementContent) => {\n if (child.type === 'element' && child.tagName === 'span') {\n const lastChild: ElementContent | undefined = child.children[child.children.length - 1]\n\n if (lastChild && (!isText(lastChild) || (isText(lastChild) && !hasLineBreak(lastChild)))) {\n child.children.push(lineBreak())\n numLines++\n }\n }\n })\n\n // We need to maintain a count of the total lines to allow space for the labels\n node.properties.style = [`--line-count: ${numLines};`, `--line-digits: ${numLines.toString().length};`]\n }\n })\n\n // console.log('NUMBER OF LINES IS: ', numLines)\n }\n}\n\n/**\n * Adds lines to a node recursively and returns them\n *\n * @param node - The node to add lines to\n * @param lines - The current lines\n * @param copyParent - Whether to copy the parent node to save the original node styles\n */\nfunction addLines(node: Element, lines: Element[] = [], copyParent?: boolean): Element[] {\n const line = () => lines[lines.length - 1] ?? ((lines.push(createLine()) && lines[lines.length - 1]) || undefined)\n\n node.children.forEach((child: ElementContent) => {\n if (isText(child) && hasLineBreak(child)) {\n const split: string[] = child.value.split(/\\n/)\n\n split.forEach((content: string, i: number) => {\n if (copyParent) {\n line()?.children.push({ ...node, children: [textElement(content)] })\n } else {\n line()?.children.push(textElement(content))\n }\n\n i !== split.length - 1 && lines.push(createLine())\n })\n } else if (isElement(child) && child.children.some(hasLineBreak)) {\n addLines(child, lines, true)\n } else {\n line()?.children.push(child)\n }\n })\n\n return lines\n}\n\n/**\n * Creates a new line element\n *\n * @param children - The children the line should have initially\n */\nfunction createLine(...children: ElementContent[]): Element {\n return {\n type: 'element',\n tagName: 'span',\n properties: { class: ['line'] },\n children,\n }\n}\n\n/**\n * Checks if a node has a line break\n *\n * @param node - The node to check\n */\nfunction hasLineBreak(node: ElementContent): boolean {\n return (isText(node) && /\\r?\\n/.test(node.value)) || (isElement(node) && node.children.some(hasLineBreak))\n}\n","import type { Element, Root } from 'hast'\nimport type { LanguageFn } from 'highlight.js'\nimport rehypeParse from 'rehype-parse'\nimport rehypeStringify from 'rehype-stringify'\nimport { type Plugin, unified } from 'unified'\nimport { visit } from 'unist-util-visit'\n\nimport { lowlightLanguageMappings } from '@/constants'\nimport { rehypeHighlight } from '@/rehype-highlight'\nimport { getSharedLowlight } from '@/rehype-highlight/shared-lowlight'\n\nimport { codeBlockLinesPlugin } from './line-numbers'\n\n/**\n * Syntax highlights a code string using the `rehype-highlight` library.\n */\nexport function syntaxHighlight(\n codeString: string,\n options: {\n lang: string\n languages: Record<string, LanguageFn>\n lineNumbers?: boolean\n maskCredentials?: string | string[]\n },\n) {\n // Simple restriction on credentials to prevent unexpected behavior\n const credentials = (\n typeof options?.maskCredentials === 'string' ? [options.maskCredentials] : (options?.maskCredentials ?? [])\n ).filter((c) => {\n // Credentials must be at least 3 characters to mask.\n if (c.length < 3) {\n return false\n }\n\n return true\n })\n\n // Classname is used by lowlight to select the language model\n const className = `language-${lowlightLanguageMappings[options.lang] ?? options.lang}`\n\n // biome-ignore lint/suspicious/noEmptyBlockStatements: empty plugin\n const nullPlugin = (() => {}) satisfies Plugin\n\n const html = unified()\n // Parses markdown\n .use(rehypeParse, { fragment: true })\n // Raw code string must be injected after initial hast parsing\n // so that HTML code is not parsed into the hast tree\n .use(injectRawCodeStringPlugin(codeString))\n // Syntax highlighting\n .use(rehypeHighlight, {\n lowlight: options.languages ? getSharedLowlight(options.languages) : undefined,\n })\n .use(options?.lineNumbers ? codeBlockLinesPlugin : nullPlugin)\n // Converts the HTML AST to a string\n .use(rehypeStringify)\n // Run the pipeline\n .processSync(`<pre><code class=\"${className}\"></code></pre>`)\n\n const htmlString = html.toString()\n\n // Replace any credentials with a wrapper element\n return credentials.length\n ? credentials.reduce(\n (acc, credential) =>\n acc\n .split(credential)\n .join(`<span class=\"credential\"><span class=\"credential-value\">${credential}</span></span>`),\n htmlString,\n )\n : htmlString\n}\n\n/**\n * To prevent unified from parsing any content of the code string we inject\n * it as a raw text node into the AST tree as a child of the code element\n */\nfunction injectRawCodeStringPlugin(rawCodeString: string) {\n return () => (tree: Root) => {\n visit(tree, 'element', (node: Element) => {\n if (node.tagName === 'code') {\n node.children.push({\n type: 'text',\n value: rawCodeString,\n })\n }\n })\n }\n}\n"],"mappings":";;;;AAMA,SAAS,OAAO,SAA2C;CACzD,OAAO,SAAS,SAAS;AAC3B;AAEA,SAAS,UAAU,MAAwC;CACzD,OAAO,MAAM,SAAS;AACxB;AAEA,SAAS,YAAY,OAAqB;CACxC,OAAO;EAAE,MAAM;EAAQ;CAAM;AAC/B;AAEA,SAAS,YAAkB;CACzB,OAAO;EAAE,MAAM;EAAQ,OAAO;CAAK;AACrC;;;;AAKA,SAAgB,uBAAuB;CACrC,QAAQ,SAAe;EACrB,MAAM,MAAM,YAAY,MAAe,IAAI,WAAkC;GAC3E,IAAI,QAAQ,SAAS,aAAa,OAAO,YAAY,SAAS,KAAK,YAAY,QAAQ;IACrF,IAAI,WAAW;IAGf,KAAK,WAAW,SAAS,IAAI;IAG7B,KAAK,SAAS,SAAS,UAA0B;KAC/C,IAAI,MAAM,SAAS,aAAa,MAAM,YAAY,QAAQ;MACxD,MAAM,YAAwC,MAAM,SAAS,MAAM,SAAS,SAAS;MAErF,IAAI,cAAc,CAAC,OAAO,SAAS,KAAM,OAAO,SAAS,KAAK,CAAC,aAAa,SAAS,IAAK;OACxF,MAAM,SAAS,KAAK,UAAU,CAAC;OAC/B;MACF;KACF;IACF,CAAC;IAGD,KAAK,WAAW,QAAQ,CAAC,iBAAiB,SAAS,IAAI,kBAAkB,SAAS,SAAS,CAAC,CAAC,OAAO,EAAE;GACxG;EACF,CAAC;CAGH;AACF;;;;;;;;AASA,SAAS,SAAS,MAAe,QAAmB,CAAC,GAAG,YAAiC;CACvF,MAAM,aAAa,MAAM,MAAM,SAAS,OAAQ,MAAM,KAAK,WAAW,CAAC,KAAK,MAAM,MAAM,SAAS,MAAO,KAAA;CAExG,KAAK,SAAS,SAAS,UAA0B;EAC/C,IAAI,OAAO,KAAK,KAAK,aAAa,KAAK,GAAG;GACxC,MAAM,QAAkB,MAAM,MAAM,MAAM,IAAI;GAE9C,MAAM,SAAS,SAAiB,MAAc;IAC5C,IAAI,YACF,KAAK,CAAC,EAAE,SAAS,KAAK;KAAE,GAAG;KAAM,UAAU,CAAC,YAAY,OAAO,CAAC;IAAE,CAAC;SAEnE,KAAK,CAAC,EAAE,SAAS,KAAK,YAAY,OAAO,CAAC;IAG5C,MAAM,MAAM,SAAS,KAAK,MAAM,KAAK,WAAW,CAAC;GACnD,CAAC;EACH,OAAO,IAAI,UAAU,KAAK,KAAK,MAAM,SAAS,KAAK,YAAY,GAC7D,SAAS,OAAO,OAAO,IAAI;OAE3B,KAAK,CAAC,EAAE,SAAS,KAAK,KAAK;CAE/B,CAAC;CAED,OAAO;AACT;;;;;;AAOA,SAAS,WAAW,GAAG,UAAqC;CAC1D,OAAO;EACL,MAAM;EACN,SAAS;EACT,YAAY,EAAE,OAAO,CAAC,MAAM,EAAE;EAC9B;CACF;AACF;;;;;;AAOA,SAAS,aAAa,MAA+B;CACnD,OAAQ,OAAO,IAAI,KAAK,QAAQ,KAAK,KAAK,KAAK,KAAO,UAAU,IAAI,KAAK,KAAK,SAAS,KAAK,YAAY;AAC1G;;;;;;AC7FA,SAAgB,gBACd,YACA,SAMA;CAEA,MAAM,eACJ,OAAO,SAAS,oBAAoB,WAAW,CAAC,QAAQ,eAAe,IAAK,SAAS,mBAAmB,CAAC,EAAA,CACzG,QAAQ,MAAM;EAEd,IAAI,EAAE,SAAS,GACb,OAAO;EAGT,OAAO;CACT,CAAC;CAGD,MAAM,YAAY,YAAY,yBAAyB,QAAQ,SAAS,QAAQ;CAGhF,MAAM,oBAAoB,CAAC;CAkB3B,MAAM,aAhBO,QAAQ,CAAC,CAEnB,IAAI,aAAa,EAAE,UAAU,KAAK,CAAC,CAAC,CAGpC,IAAI,0BAA0B,UAAU,CAAC,CAAC,CAE1C,IAAI,iBAAiB,EACpB,UAAU,QAAQ,YAAY,kBAAkB,QAAQ,SAAS,IAAI,KAAA,EACvE,CAAC,CAAC,CACD,IAAI,SAAS,cAAc,uBAAuB,UAAU,CAAC,CAE7D,IAAI,eAAe,CAAC,CAEpB,YAAY,qBAAqB,UAAU,gBAE3B,CAAA,CAAK,SAAS;CAGjC,OAAO,YAAY,SACf,YAAY,QACT,KAAK,eACJ,IACG,MAAM,UAAU,CAAC,CACjB,KAAK,2DAA2D,WAAW,eAAe,GAC/F,UACF,IACA;AACN;;;;;AAMA,SAAS,0BAA0B,eAAuB;CACxD,cAAc,SAAe;EAC3B,MAAM,MAAM,YAAY,SAAkB;GACxC,IAAI,KAAK,YAAY,QACnB,KAAK,SAAS,KAAK;IACjB,MAAM;IACN,OAAO;GACT,CAAC;EAEL,CAAC;CACH;AACF"}
|