@scalar/code-highlight 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @scalar/code-highlight
+
+## 0.0.2
+
+### Patch Changes
+
+- 8494349: Migrate to highlightjs based syntax highlighting
+- 6fbb57e: feat: release all the packages

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Scalar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/code/highlight.d.ts

@@ -0,0 +1,8 @@
+import type { LanguageFn } from 'highlight.js';
+export declare function syntaxHighlight(codeString: string, options: {
+    lang: string;
+    languages: Record<string, LanguageFn>;
+    lineNumbers?: boolean;
+    maskCredentials?: string | string[];
+}): string;
+//# sourceMappingURL=highlight.d.ts.map

package/dist/code/highlight.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"highlight.d.ts","sourceRoot":"","sources":["../../src/code/highlight.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAQ9C,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE;IACP,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACrC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACpC,UA+CF"}

package/dist/code/highlight.js

@@ -0,0 +1,61 @@
+import { lowlightLanguageMappings } from '../constants.js';
+import rehypeParse from 'rehype-parse';
+import rehypeStringify from 'rehype-stringify';
+import { unified } from 'unified';
+import { visit } from 'unist-util-visit';
+import { codeBlockLinesPlugin } from './line-numbers.js';
+import { rehypeHighlight } from '../rehype-highlight/rehype-highlight.js';
+
+function syntaxHighlight(codeString, options) {
+    // Simple restriction on credentials to prevent unexpected behavior
+    const credentials = (typeof options?.maskCredentials === 'string'
+        ? [options.maskCredentials]
+        : options?.maskCredentials ?? []).filter((c) => {
+        if (c.length < 3) {
+            console.error(`Codeblock credentials must be at least 3 characters to mask. Will not mask "${c}"`);
+            return false;
+        }
+        return true;
+    });
+    // Classname is used by lowlight to select the language model
+    const className = `language-${lowlightLanguageMappings[options.lang] ?? options.lang}`;
+    const nullPlugin = (() => { });
+    const html = unified()
+        // Parses markdown
+        .use(rehypeParse, { fragment: true })
+        // Raw code string must be injected after initial hast parsing
+        // so that HTML code is not parsed into the hast tree
+        .use(injectRawCodeStringPlugin(codeString))
+        // Syntax highlighting
+        .use(rehypeHighlight, {
+        languages: options.languages,
+    })
+        .use(options?.lineNumbers ? codeBlockLinesPlugin : nullPlugin)
+        // Converts the HTML AST to a string
+        .use(rehypeStringify)
+        // Run the pipeline
+        .processSync(`<pre><code class="${className}"></code></pre>`);
+    const htmlString = html.toString();
+    // Replace any credentials with a wrapper element
+    return credentials.length
+        ? htmlString.replace(new RegExp(credentials.join('|'), 'g'), (m) => `<span class="credentials">${m}</span>`)
+        : htmlString;
+}
+/**
+ * To prevent unified from parsing any content of the code string we inject
+ * it as a raw text node into the AST tree as a child of the code element
+ */
+function injectRawCodeStringPlugin(rawCodeString) {
+    return () => (tree) => {
+        visit(tree, 'element', (node) => {
+            if (node.tagName === 'code') {
+                node.children.push({
+                    type: 'text',
+                    value: rawCodeString,
+                });
+            }
+        });
+    };
+}
+
+export { syntaxHighlight };

package/dist/code/index.d.ts

@@ -0,0 +1,2 @@
+export { syntaxHighlight } from './highlight.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/code/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/code/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA"}

package/dist/code/index.js

@@ -0,0 +1 @@
+export { syntaxHighlight } from './highlight.js';

package/dist/code/line-numbers.d.ts

@@ -0,0 +1,10 @@
+import type { Element, ElementContent, Root, Text } from 'hast';
+export declare function isText(element?: ElementContent): element is Text;
+export declare function isElement(node?: ElementContent): node is Element;
+export declare function textElement(value: string): Text;
+export declare function lineBreak(): Text;
+/**
+ * Adds lines to code blocks
+ */
+export declare function codeBlockLinesPlugin(): (tree: Root) => void;
+//# sourceMappingURL=line-numbers.d.ts.map

package/dist/code/line-numbers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"line-numbers.d.ts","sourceRoot":"","sources":["../../src/code/line-numbers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAM/D,wBAAgB,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,IAAI,IAAI,CAEhE;AAED,wBAAgB,SAAS,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,IAAI,IAAI,OAAO,CAEhE;AAED,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAE/C;AAED,wBAAgB,SAAS,IAAI,IAAI,CAEhC;AAED;;GAEG;AACH,wBAAgB,oBAAoB,WACpB,IAAI,UA0CnB"}

package/dist/code/line-numbers.js

@@ -0,0 +1,102 @@
+import { visit } from 'unist-util-visit';
+
+// ---------------------------------------------------------------------------
+// Line Numbering plugin
+function isText(element) {
+    return element?.type === 'text';
+}
+function isElement(node) {
+    return node?.type === 'element';
+}
+function textElement(value) {
+    return { type: 'text', value };
+}
+function lineBreak() {
+    return { type: 'text', value: '\n' };
+}
+/**
+ * Adds lines to code blocks
+ */
+function codeBlockLinesPlugin() {
+    return (tree) => {
+        visit(tree, 'element', (node, _i, parent) => {
+            if (parent?.type === 'element' &&
+                parent.tagName === 'pre' &&
+                node.tagName === 'code') {
+                let numLines = 0;
+                // Wraps each line in a span
+                node.children = addLines(node);
+                // Adds a line break to the end of each line
+                node.children.forEach((child) => {
+                    if (child.type === 'element' && child.tagName === 'span') {
+                        const lastChild = child.children[child.children.length - 1];
+                        if (!isText(lastChild) ||
+                            (isText(lastChild) && !hasLineBreak(lastChild))) {
+                            child.children.push(lineBreak());
+                            numLines++;
+                        }
+                    }
+                });
+                // We need to maintain a count of the total lines to allow space for the labels
+                node.properties.style = [
+                    `--line-count: ${numLines};`,
+                    `--line-digits: ${numLines.toString().length};`,
+                ];
+            }
+        });
+        // console.log('NUMBER OF LINES IS: ', numLines)
+    };
+}
+/**
+ * Adds lines to a node recursively and returns them
+ *
+ * @param node - The node to add lines to
+ * @param lines - The current lines
+ * @param copyParent - Whether to copy the parent node to save the original node styles
+ */
+function addLines(node, lines = [], copyParent) {
+    const line = () => lines[lines.length - 1] ??
+        (lines.push(createLine()) && lines[lines.length - 1]);
+    node.children.forEach((child) => {
+        if (isText(child) && hasLineBreak(child)) {
+            const split = child.value.split(/\n/);
+            split.forEach((content, i) => {
+                copyParent
+                    ? line().children.push({ ...node, children: [textElement(content)] })
+                    : line().children.push(textElement(content));
+                i !== split.length - 1 && lines.push(createLine());
+            });
+        }
+        else if (isElement(child) && child.children.some(hasLineBreak)) {
+            addLines(child, lines, true);
+        }
+        else {
+            line().children.push(child);
+        }
+    });
+    return lines;
+}
+/**
+ * Creates a new line element
+ *
+ * @param children - The children the line should have initially
+ */
+function createLine(...children) {
+    return {
+        type: 'element',
+        tagName: 'span',
+        properties: { class: ['line'] },
+        children,
+    };
+}
+/**
+ * Checks if a node has a line break
+ *
+ * @param node - The node to check
+ */
+function hasLineBreak(node) {
+    return ((isText(node) && /\r?\n/.test(node.value)) ||
+        (isElement(node) && node.children.some(hasLineBreak)));
+}
+
+export { codeBlockLinesPlugin, isElement, isText, lineBreak, textElement };

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+/** Map common markdown language shortcuts to lowlight languages */
+export declare const lowlightLanguageMappings: Record<string, string>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAQ3D,CAAA"}

package/dist/constants.js

@@ -0,0 +1,13 @@
+/** Map common markdown language shortcuts to lowlight languages */
+const lowlightLanguageMappings = {
+    'ts': 'typescript',
+    'js': 'javascript',
+    'py': 'python',
+    'py3': 'python',
+    'c#': 'csharp',
+    'c++': 'cpp',
+    'node': 'javascript',
+};
+//
+
+export { lowlightLanguageMappings };

package/dist/css/code.css

@@ -0,0 +1,202 @@
+@layer scalar-base {
+  code.hljs * {
+    font-size: var(--scalar-small);
+    font-family: var(--scalar-font-code);
+    text-align: left;
+    white-space: pre;
+    word-spacing: normal;
+    word-break: normal;
+    word-wrap: normal;
+    line-height: 1.4;
+    tab-size: 4;
+  }
+  code.hljs {
+    font-size: var(--scalar-small);
+    font-family: var(--scalar-font-code);
+    display: inline-block;
+    counter-reset: linenumber;
+  }
+  .hljs {
+    background: transparent;
+    color: var(--scalar-color-2);
+  }
+
+  .hljs .line::before {
+    color: var(--scalar-color-3);
+    display: inline-block;
+    counter-increment: linenumber;
+    content: counter(linenumber);
+    margin-right: 0.7em;
+    /* Variable is set on the code element by the plugin when line numbers are used */
+    min-width: calc(var(--line-digits) * 1ch);
+    text-align: right;
+  }
+  /* ------------------------------------------------------------- */
+  /* Data types */
+  .hljs-comment,
+  .hljs-quote {
+    color: var(--scalar-color-3);
+    font-style: italic;
+  }
+
+  .hljs-number {
+    color: var(--scalar-color-orange);
+  }
+
+  .hljs-regexp,
+  .hljs-string {
+    color: var(--scalar-color-blue);
+  }
+
+  /** Globals such as `var()` and `!important` */
+  .hljs-built_in {
+    color: var(--scalar-color-blue);
+  }
+
+  /** Class initializers such as `Array` or `Date` */
+  /** Type declarations such as `Record` */
+  .hljs-title.class_ {
+    color: var(--scalar-color-1);
+  }
+
+  /** Language indicators such as `new`, `const`, or `function` in JS  */
+  .hljs-keyword {
+    color: var(--scalar-color-purple);
+  }
+
+  /** Function names when declaring and calling */
+  .hljs-title.function_ {
+    color: var(--scalar-color-orange);
+  }
+
+  /** Template substitution */
+  .hljs-subst {
+    color: var(--scalar-color-blue);
+  }
+
+  /** HTML Tag name */
+  .hljs-name {
+    color: var(--scalar-color-blue);
+  }
+
+  /** Attribute name (ex. `class`, `id`) */
+  .hljs-attr,
+  .hljs-attribute {
+    color: var(--scalar-color-1);
+  }
+
+  .hljs-addition,
+  .hljs-literal,
+  .hljs-selector-tag,
+  .hljs-type {
+    color: var(--scalar-color-green);
+  }
+
+  .hljs-selector-attr,
+  .hljs-selector-pseudo {
+    color: var(--scalar-color-orange);
+  }
+  .hljs-doctag {
+    color: var(--scalar-color-blue);
+  }
+
+  .hljs-section,
+  .hljs-title {
+    color: var(--scalar-color-blue);
+  }
+
+  .hljs-selector-id,
+  .hljs-template-variable,
+  .hljs-variable {
+    color: var(--scalar-color-1);
+  }
+
+  .hljs-name,
+  .hljs-section,
+  .hljs-strong {
+    font-weight: var(--scalar-semibold);
+  }
+
+  .hljs-bullet,
+  .hljs-link,
+  .hljs-meta,
+  .hljs-symbol {
+    color: var(--scalar-color-blue);
+  }
+
+  .hljs-deletion {
+    color: var(--scalar-color-red);
+  }
+
+  .hljs-formula {
+    background: var(--scalar-color-1);
+  }
+
+  .hljs-emphasis {
+    font-style: italic;
+  }
+
+  /** Hide credentials */
+  .credentials {
+    font-size: 0 !important;
+    color: transparent;
+  }
+
+  /** Show a few dots instead */
+  .credentials::after {
+    content: '·····';
+    font-size: var(--scalar-small);
+    color: var(--scalar-color-3);
+    user-select: none;
+  }
+}
+
+/* -------------------------------------------------------------- */
+/* Language specific overrides */
+
+/** For HTML we leave the content strings brighter */
+.hljs.language-html {
+  color: var(--scalar-color-1);
+}
+
+/** For HTML make the attr text different than the content */
+.hljs.language-html .hljs-attr {
+  color: var(--scalar-color-2);
+}
+
+.hljs.language-curl .hljs-keyword {
+  color: var(--scalar-color-orange);
+}
+
+.hljs.language-curl .hljs-string {
+  color: var(--scalar-color-1);
+}
+
+.hljs.language-curl .hljs-literal {
+  color: var(--scalar-color-blue);
+}
+
+.hljs.language-curl .hljs-literal {
+  color: var(--scalar-color-blue);
+}
+
+/** Compromise here */
+.hljs.language-cpp .hljs-built_in {
+  /* color: var(--scalar-color-1); */
+}
+
+.hljs.language-php .hljs-variable {
+  color: var(--scalar-color-blue);
+}
+
+.hljs.language-objectivec .hljs-meta {
+  color: var(--scalar-color-1);
+}
+
+.hljs.language-objectivec .hljs-built_in {
+  color: var(--scalar-color-orange);
+}
+
+.hljs-built_in {
+  color: var(--scalar-color-orange);
+}

package/dist/css/markdown.css

@@ -0,0 +1,291 @@
+@import url('./code.css');
+
+@layer scalar-base {
+  .markdown {
+    font-family: var(--scalar-font);
+    color: var(--scalar-color-1);
+    word-break: break-word;
+  }
+
+  /* Apply base padding for all block elements */
+  .markdown h1,
+  .markdown h2,
+  .markdown h3,
+  .markdown h4,
+  .markdown h5,
+  .markdown h6,
+  .markdown p,
+  .markdown div,
+  .markdown img,
+  .markdown details,
+  .markdown summary,
+  .markdown ul,
+  .markdown ol,
+  .markdown table,
+  .markdown blockquote,
+  .markdown code {
+    margin: 12px 0;
+  }
+
+  .markdown details {
+    margin: 12px 0;
+    color: var(--scalar-color-1);
+  }
+  .markdown summary {
+    display: block;
+    margin: 12px 0;
+    padding-left: 20px;
+    position: relative;
+    font-weight: var(--scalar-semibold);
+    cursor: pointer;
+    user-select: none;
+  }
+
+  .markdown summary::after {
+    display: block;
+    content: '';
+
+    position: absolute;
+    top: 1px;
+    left: 1px;
+
+    width: 16px;
+    height: 16px;
+
+    background-color: var(--scalar-color-3);
+    mask-image: url('data:image/svg+xml,<svg viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M8.25 19.5L15.75 12L8.25 4.5" stroke="black" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/></svg>');
+  }
+
+  .markdown summary:hover::after {
+    background-color: var(--scalar-color-1);
+  }
+
+  .markdown details[open] summary::after {
+    transform: rotate(90deg);
+  }
+
+  /* Fix for Safari displaying default caret next to `<summary>` */
+  .markdown summary::-webkit-details-marker {
+    display: none;
+  }
+
+  .markdown img {
+    overflow: hidden;
+    border-radius: var(--scalar-radius);
+    max-width: 100%;
+  }
+  /* Don't add margin to the first block */
+  .markdown > :first-child {
+    margin-top: 0;
+  }
+
+  .markdown h1 {
+    --font-size: 1.4em;
+  }
+
+  .markdown h2 {
+    --font-size: 1.25em;
+  }
+
+  .markdown h3 {
+    --font-size: 1.1em;
+  }
+
+  .markdown h4 {
+    --font-size: 1em;
+  }
+
+  .markdown h6 {
+    --font-size: 1em;
+  }
+  .markdown h1,
+  .markdown h2,
+  .markdown h3,
+  .markdown h4,
+  .markdown h5,
+  .markdown h6 {
+    font-size: var(--font-size);
+    margin: 18px 0 6px;
+    font-weight: var(--scalar-bold);
+    display: block;
+    line-height: 1.45;
+  }
+  .markdown b,
+  .markdown strong {
+    font-weight: var(--scalar-bold);
+  }
+  .markdown p {
+    color: var(--scalar-color-1);
+    font-weight: var(--font-weight, var(--scalar-regular));
+    line-height: 1.5;
+    margin-bottom: 0;
+    display: block;
+  }
+
+  .markdown ul,
+  .markdown ol {
+    padding-left: 24px;
+    line-height: 1.5;
+    margin: 12px 0;
+    display: block;
+  }
+
+  .markdown ul {
+    list-style: disc;
+  }
+
+  .markdown ol {
+    list-style: decimal;
+  }
+
+  .markdown ul.contains-task-list {
+    list-style: none;
+    padding-left: 0;
+  }
+
+  .markdown li {
+    margin: 6px 0;
+    display: list-item;
+  }
+  .markdown a {
+    color: var(--scalar-color-accent);
+    text-decoration: var(--scalar-text-decoration);
+    cursor: pointer;
+  }
+  .markdown a:hover {
+    text-decoration: var(--scalar-text-decoration-hover);
+  }
+  .markdown em {
+    font-style: italic;
+  }
+  .markdown sup {
+    font-size: var(--scalar-micro);
+    vertical-align: super;
+    font-weight: 450;
+  }
+  .markdown sub {
+    font-size: var(--scalar-micro);
+    vertical-align: sub;
+    font-weight: 450;
+  }
+  .markdown del {
+    text-decoration: line-through;
+  }
+  .markdown code {
+    font-family: var(--scalar-font-code);
+    background-color: var(--scalar-background-2);
+    box-shadow: 0 0 0 1px var(--scalar-border-color);
+    font-size: var(--scalar-micro);
+    border-radius: 2px;
+    padding: 0 3px;
+  }
+
+  .markdown pre code {
+    display: block;
+    white-space: pre;
+    padding: 12px;
+    line-height: 1.5;
+    margin: 12px 0;
+    -webkit-overflow-scrolling: touch;
+    overflow-x: auto;
+    max-width: 100%;
+    min-width: 100px;
+  }
+
+  .markdown hr {
+    border: none;
+    border-bottom: 1px solid var(--scalar-border-color);
+  }
+
+  .markdown img {
+    max-height: 150px;
+    border-radius: var(--scalar-radius);
+  }
+
+  .markdown blockquote {
+    border-left: 3px solid var(--scalar-border-color);
+    padding-left: 12px;
+    margin: 0;
+    display: block;
+  }
+
+  .markdown table {
+    display: block;
+    overflow-x: auto;
+    position: relative;
+    border-collapse: collapse;
+    width: max-content;
+    max-width: 100%;
+    margin: 1em 0;
+    box-shadow: 0 0 0 1px var(--scalar-border-color);
+    border-radius: var(--scalar-radius-lg);
+  }
+  .markdown tbody {
+    display: table-row-group;
+    vertical-align: middle;
+  }
+  .markdown thead {
+    display: table-header-group;
+    vertical-align: middle;
+  }
+
+  .markdown tr {
+    display: table-row;
+    border-color: inherit;
+    vertical-align: inherit;
+  }
+  .markdown td,
+  .markdown th {
+    display: table-cell;
+    vertical-align: inherit;
+    min-width: 1em;
+    padding: 6px 9px;
+    vertical-align: top;
+    line-height: 1.5;
+    position: relative;
+    word-break: initial;
+    font-size: var(--scalar-small);
+    color: var(--scalar-color-1);
+    font-weight: var(--font-weight, var(--scalar-regular));
+    border-right: 1px solid var(--scalar-border-color);
+    border-bottom: 1px solid var(--scalar-border-color);
+  }
+
+  .markdown td > *,
+  .markdown th > * {
+    margin-bottom: 0;
+  }
+  .markdown th:empty {
+    display: none;
+  }
+  .markdown td:first-of-type,
+  .markdown th:first-of-type {
+    border-left: none;
+  }
+
+  .markdown td:last-of-type,
+  .markdown th:last-of-type {
+    border-right: none;
+  }
+
+  .markdown tr:last-of-type td {
+    border-bottom: none;
+  }
+
+  .markdown th {
+    font-weight: var(--scalar-semibold) !important;
+    text-align: left;
+    border-left-color: transparent;
+    background: var(--scalar-background-2);
+  }
+
+  .markdown tr > [align='left'] {
+    text-align: left;
+  }
+  .markdown tr > [align='right'] {
+    text-align: right;
+  }
+  .markdown tr > [align='center'] {
+    text-align: center;
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { rehypeHighlight } from './rehype-highlight/index.js';
+export { lowlightLanguageMappings } from './constants.js';
+export { htmlFromMarkdown } from './markdown/index.js';
+export { syntaxHighlight } from './code/index.js';
+export * from './languages/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAA;AACxC,cAAc,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,7 @@
+export { lowlightLanguageMappings } from './constants.js';
+export { rehypeHighlight } from './rehype-highlight/rehype-highlight.js';
+export { htmlFromMarkdown } from './markdown/markdown.js';
+export { syntaxHighlight } from './code/highlight.js';
+export { jsonYamlLanguages } from './languages/json-yaml.js';
+export { standardLanguages } from './languages/standard.js';
+export { basicLanguages } from './languages/basic.js';

package/dist/languages/basic.d.ts

@@ -0,0 +1,4 @@
+import type { LanguageFn } from 'highlight.js';
+declare const basicLanguages: Record<string, LanguageFn>;
+export { basicLanguages };
+//# sourceMappingURL=basic.d.ts.map

package/dist/languages/basic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"basic.d.ts","sourceRoot":"","sources":["../../src/languages/basic.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAe9C,QAAA,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAe9C,CAAA;AAED,OAAO,EAAE,cAAc,EAAE,CAAA"}

package/dist/languages/basic.js

@@ -0,0 +1,32 @@
+import bash from 'highlight.js/lib/languages/bash';
+import css from 'highlight.js/lib/languages/css';
+import javascript from 'highlight.js/lib/languages/javascript';
+import json from 'highlight.js/lib/languages/json';
+import less from 'highlight.js/lib/languages/less';
+import markdown from 'highlight.js/lib/languages/markdown';
+import plaintext from 'highlight.js/lib/languages/plaintext';
+import python from 'highlight.js/lib/languages/python';
+import scss from 'highlight.js/lib/languages/scss';
+import shell from 'highlight.js/lib/languages/shell';
+import typescript from 'highlight.js/lib/languages/typescript';
+import xml from 'highlight.js/lib/languages/xml';
+import yaml from 'highlight.js/lib/languages/yaml';
+
+const basicLanguages = {
+    bash,
+    css,
+    javascript,
+    json,
+    html: xml,
+    less,
+    markdown,
+    plaintext,
+    python,
+    scss,
+    shell,
+    typescript,
+    yaml,
+    xml,
+};
+
+export { basicLanguages };

package/dist/languages/index.d.ts

@@ -0,0 +1,4 @@
+export { jsonYamlLanguages } from './json-yaml.js';
+export { standardLanguages } from './standard.js';
+export { basicLanguages } from './basic.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/languages/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/languages/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA"}

package/dist/languages/index.js

@@ -0,0 +1,3 @@
+export { jsonYamlLanguages } from './json-yaml.js';
+export { standardLanguages } from './standard.js';
+export { basicLanguages } from './basic.js';

package/dist/languages/json-yaml.d.ts

@@ -0,0 +1,4 @@
+import type { LanguageFn } from 'highlight.js';
+declare const jsonYamlLanguages: Record<string, LanguageFn>;
+export { jsonYamlLanguages };
+//# sourceMappingURL=json-yaml.d.ts.map

package/dist/languages/json-yaml.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-yaml.d.ts","sourceRoot":"","sources":["../../src/languages/json-yaml.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAK9C,QAAA,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAIjD,CAAA;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAA"}

package/dist/languages/json-yaml.js

@@ -0,0 +1,11 @@
+import json from 'highlight.js/lib/languages/json';
+import plaintext from 'highlight.js/lib/languages/plaintext';
+import yaml from 'highlight.js/lib/languages/yaml';
+
+const jsonYamlLanguages = {
+    json,
+    plaintext,
+    yaml,
+};
+
+export { jsonYamlLanguages };

package/dist/languages/standard.d.ts

@@ -0,0 +1,4 @@
+import type { LanguageFn } from 'highlight.js';
+declare const standardLanguages: Record<string, LanguageFn>;
+export { standardLanguages };
+//# sourceMappingURL=standard.d.ts.map

package/dist/languages/standard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../src/languages/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAsC9C,QAAA,MAAM,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAqCjD,CAAA;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAA"}

package/dist/languages/standard.js

@@ -0,0 +1,76 @@
+import bash from 'highlight.js/lib/languages/bash';
+import c from 'highlight.js/lib/languages/c';
+import clojure from 'highlight.js/lib/languages/clojure';
+import cpp from 'highlight.js/lib/languages/cpp';
+import csharp from 'highlight.js/lib/languages/csharp';
+import css from 'highlight.js/lib/languages/css';
+import elixir from 'highlight.js/lib/languages/elixir';
+import go from 'highlight.js/lib/languages/go';
+import graphql from 'highlight.js/lib/languages/graphql';
+import java from 'highlight.js/lib/languages/java';
+import javascript from 'highlight.js/lib/languages/javascript';
+import json from 'highlight.js/lib/languages/json';
+import kotlin from 'highlight.js/lib/languages/kotlin';
+import less from 'highlight.js/lib/languages/less';
+import makefile from 'highlight.js/lib/languages/makefile';
+import markdown from 'highlight.js/lib/languages/markdown';
+import matlab from 'highlight.js/lib/languages/matlab';
+import nginx from 'highlight.js/lib/languages/nginx';
+import objectivec from 'highlight.js/lib/languages/objectivec';
+import ocaml from 'highlight.js/lib/languages/ocaml';
+import php from 'highlight.js/lib/languages/php';
+import plaintext from 'highlight.js/lib/languages/plaintext';
+import powershell from 'highlight.js/lib/languages/powershell';
+import python from 'highlight.js/lib/languages/python';
+import r from 'highlight.js/lib/languages/r';
+import ruby from 'highlight.js/lib/languages/ruby';
+import rust from 'highlight.js/lib/languages/rust';
+import scss from 'highlight.js/lib/languages/scss';
+import shell from 'highlight.js/lib/languages/shell';
+import sql from 'highlight.js/lib/languages/sql';
+import swift from 'highlight.js/lib/languages/swift';
+import typescript from 'highlight.js/lib/languages/typescript';
+import xml from 'highlight.js/lib/languages/xml';
+import yaml from 'highlight.js/lib/languages/yaml';
+import curl from 'highlightjs-curl';
+
+const standardLanguages = {
+    bash,
+    c,
+    clojure,
+    cpp,
+    css,
+    curl,
+    csharp,
+    elixir,
+    go,
+    graphql,
+    html: xml,
+    java,
+    javascript,
+    json,
+    kotlin,
+    less,
+    makefile,
+    markdown,
+    matlab,
+    nginx,
+    objectivec,
+    ocaml,
+    php,
+    plaintext,
+    powershell,
+    python,
+    r,
+    ruby,
+    rust,
+    scss,
+    shell,
+    sql,
+    swift,
+    typescript,
+    xml,
+    yaml,
+};
+
+export { standardLanguages };

package/dist/markdown/index.d.ts

@@ -0,0 +1,2 @@
+export { htmlFromMarkdown } from './markdown.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/markdown/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA"}

package/dist/markdown/index.js

@@ -0,0 +1 @@
+export { htmlFromMarkdown } from './markdown.js';

package/dist/markdown/markdown.d.ts

@@ -0,0 +1,6 @@
+/** Take a markdown string and generate a raw HTML string */
+export declare function htmlFromMarkdown(markdownString: string, options?: {
+    removeTags?: string[];
+    allowTags?: string[];
+}): string;
+//# sourceMappingURL=markdown.d.ts.map

package/dist/markdown/markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown/markdown.ts"],"names":[],"mappings":"AAYA,4DAA4D;AAC5D,wBAAgB,gBAAgB,CAC9B,cAAc,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;CACrB,UA4CF"}

package/dist/markdown/markdown.js

@@ -0,0 +1,57 @@
+import rehypeExternalLinks from 'rehype-external-links';
+import rehypeFormat from 'rehype-format';
+import rehypeRaw from 'rehype-raw';
+import rehypeSanitize, { defaultSchema } from 'rehype-sanitize';
+import rehypeStringify from 'rehype-stringify';
+import remarkGfm from 'remark-gfm';
+import remarkParse from 'remark-parse';
+import remarkRehype from 'remark-rehype';
+import { unified } from 'unified';
+import { rehypeHighlight } from '../rehype-highlight/rehype-highlight.js';
+import { standardLanguages } from '../languages/standard.js';
+
+/** Take a markdown string and generate a raw HTML string */
+function htmlFromMarkdown(markdownString, options) {
+    // Add permitted tags and remove stripped ones
+    const removeTags = options?.removeTags ?? [];
+    const tagNames = [
+        ...(defaultSchema.tagNames ?? []),
+        ...(options?.allowTags ?? []),
+    ].filter((t) => !removeTags.includes(t));
+    const html = unified()
+        // Parses markdown
+        .use(remarkParse)
+        // Support autolink literals, footnotes, strikethrough, tables and tasklists
+        .use(remarkGfm)
+        // Allows any HTML tags
+        .use(remarkRehype, { allowDangerousHtml: true })
+        // Creates a HTML AST
+        .use(rehypeRaw)
+        // Removes disallowed tags
+        .use(rehypeSanitize, {
+        ...defaultSchema,
+        // Makes it even more strict
+        tagNames,
+        attributes: {
+            ...defaultSchema.attributes,
+            abbr: ['title'],
+        },
+    })
+        // Syntax highlighting
+        .use(rehypeHighlight, {
+        languages: standardLanguages,
+        // Enable auto detection
+        detect: true,
+    })
+        // Adds target="_blank" to external links
+        .use(rehypeExternalLinks, { target: '_blank' })
+        // Formats the HTML
+        .use(rehypeFormat)
+        // Converts the HTML AST to a string
+        .use(rehypeStringify)
+        // Run the pipeline
+        .processSync(markdownString);
+    return html.toString();
+}
+
+export { htmlFromMarkdown };

package/dist/rehype-highlight/index.d.ts

@@ -0,0 +1,2 @@
+export { rehypeHighlight } from './rehype-highlight.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/rehype-highlight/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/rehype-highlight/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA"}

package/dist/rehype-highlight/index.js

@@ -0,0 +1 @@
+export { rehypeHighlight } from './rehype-highlight.js';

package/dist/rehype-highlight/rehype-highlight.d.ts

@@ -0,0 +1,27 @@
+import type { Root } from 'hast';
+import { type LanguageFn, createLowlight } from 'lowlight';
+import type { VFile } from 'vfile';
+type HighlightOptions = {
+    /** Optional existing lowlight instance to use */
+    lowlight?: ReturnType<typeof createLowlight> | undefined;
+    /** Register more aliases (optional); passed to `lowlight.registerAlias` */
+    aliases?: Readonly<Record<string, ReadonlyArray<string> | string>> | null | undefined;
+    /** Register languages (default: `common`) passed to `lowlight.register` */
+    languages?: Readonly<Record<string, LanguageFn>> | null | undefined;
+    /** List of language names to not highlight (optional). Note: you can also add `no-highlight` classes. */
+    plainText?: ReadonlyArray<string> | null | undefined;
+    /** Class prefix (default: `'hljs-'`) */
+    prefix?: string | null | undefined;
+    /** Names of languages to check when detecting (default: all registered languages) */
+    subset?: ReadonlyArray<string> | null | undefined;
+    /** Option to autodetect languages */
+    detect?: boolean;
+};
+/**
+ * Lowlight syntax highlighting plugin for rehype pipelines
+ *
+ * Derived from: @url https://github.com/rehypejs/rehype-highlight/blob/main/lib/index.js
+ */
+export declare function rehypeHighlight(options?: Readonly<HighlightOptions> | null | undefined): (tree: Root, file: VFile) => void;
+export {};
+//# sourceMappingURL=rehype-highlight.d.ts.map

package/dist/rehype-highlight/rehype-highlight.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rehype-highlight.d.ts","sourceRoot":"","sources":["../../src/rehype-highlight/rehype-highlight.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAA2B,IAAI,EAAE,MAAM,MAAM,CAAA;AAEzD,OAAO,EAAE,KAAK,UAAU,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAE1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAIlC,KAAK,gBAAgB,GAAG;IACtB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,UAAU,CAAC,OAAO,cAAc,CAAC,GAAG,SAAS,CAAA;IACxD,2EAA2E;IAC3E,OAAO,CAAC,EACJ,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,GACxD,IAAI,GACJ,SAAS,CAAA;IACb,2EAA2E;IAC3E,SAAS,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;IACnE,yGAAyG;IACzG,SAAS,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;IACpD,wCAAwC;IACxC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAClC,qFAAqF;IACrF,MAAM,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,IAAI,GAAG,SAAS,CAAA;IACjD,qCAAqC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAID;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,OAAO,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,GAAG,IAAI,GAAG,SAAS,UAsBhC,IAAI,QAAQ,KAAK,UAkEzC"}

package/dist/rehype-highlight/rehype-highlight.js

@@ -0,0 +1,100 @@
+import { toText } from 'hast-util-to-text';
+import { createLowlight } from 'lowlight';
+import { visit } from 'unist-util-visit';
+import { lowlightLanguageMappings } from '../constants.js';
+
+const emptyOptions = {};
+/**
+ * Lowlight syntax highlighting plugin for rehype pipelines
+ *
+ * Derived from: @url https://github.com/rehypejs/rehype-highlight/blob/main/lib/index.js
+ */
+function rehypeHighlight(options) {
+    const settings = options || emptyOptions;
+    const aliases = settings.aliases;
+    const detect = options?.detect ?? false;
+    const languages = settings.languages;
+    const plainText = settings.plainText;
+    const prefix = settings.prefix;
+    const subset = settings.subset;
+    let name = 'hljs';
+    // Create a lowlight instance if not provided
+    const lowlight = options?.lowlight ?? createLowlight(languages);
+    if (aliases)
+        lowlight.registerAlias(aliases);
+    if (prefix) {
+        const pos = prefix.indexOf('-');
+        name = pos > -1 ? prefix.slice(0, pos) : prefix;
+    }
+    /** Transform.*/
+    return function (tree, file) {
+        visit(tree, 'element', function (node, _, parent) {
+            if (node.tagName !== 'code' ||
+                !parent ||
+                parent.type !== 'element' ||
+                parent.tagName !== 'pre') {
+                return;
+            }
+            const lang = language(node);
+            if (lang === 'no-highlight' ||
+                (!lang && !detect) ||
+                (lang && plainText?.includes(lang))) {
+                return;
+            }
+            if (!Array.isArray(node.properties.className)) {
+                node.properties.className = [];
+            }
+            if (!node.properties.className.includes(name)) {
+                node.properties.className.unshift(name);
+            }
+            let result;
+            try {
+                result = lang
+                    ? lowlight.highlight(lang, toText(parent), { prefix })
+                    : lowlight.highlightAuto(toText(parent), { prefix, subset });
+            }
+            catch (error) {
+                const cause = error;
+                if (lang && /Unknown language/.test(cause.message)) {
+                    file.message('Cannot highlight as `' + lang + '`, it’s not registered', {
+                        ancestors: [parent, node],
+                        cause,
+                        place: node.position,
+                        ruleId: 'missing-language',
+                        source: 'rehype-highlight',
+                    });
+                    /* c8 ignore next 5 -- throw arbitrary hljs errors */
+                    return;
+                }
+                throw cause;
+            }
+            if (!lang && result.data?.language) {
+                node.properties.className.push('language-' + result.data.language);
+            }
+            if (result.children.length > 0) {
+                node.children = result.children;
+            }
+        });
+    };
+}
+/** Get the programming language of `node` or an empty string */
+function language(node) {
+    const list = node.properties.className;
+    if (!Array.isArray(list))
+        return '';
+    const name = list.reduce((result, _item) => {
+        if (result)
+            return result;
+        const item = String(_item);
+        if (item === 'no-highlight' || item === 'nohighlight')
+            return 'no-highlight';
+        if (item.slice(0, 5) === 'lang-')
+            return item.slice(5);
+        if (item.slice(0, 9) === 'language-')
+            return item.slice(9);
+        return result;
+    }, '');
+    return lowlightLanguageMappings[name || ''] || name;
+}
+
+export { rehypeHighlight };

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@scalar/code-highlight",
+  "description": "Central methods and themes for code highlighting in Scalar projects",
+  "license": "MIT",
+  "author": "Scalar (https://github.com/scalar)",
+  "homepage": "https://github.com/scalar/scalar",
+  "bugs": "https://github.com/scalar/scalar/issues/new/choose",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scalar/scalar.git",
+    "directory": "packages/code-highlight"
+  },
+  "keywords": [
+    "syntax",
+    "highlight",
+    "lowlight",
+    "highlightjs"
+  ],
+  "version": "0.0.2",
+  "engines": {
+    "node": ">=18"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./rehype-highlight": {
+      "import": "./dist/rehype-highlight/index.js",
+      "types": "./dist/rehype-highlight/index.d.ts"
+    },
+    "./markdown": {
+      "import": "./dist/markdown/index.js",
+      "types": "./dist/markdown/index.d.ts"
+    },
+    "./languages": {
+      "import": "./dist/languages/index.js",
+      "types": "./dist/languages/index.d.ts"
+    },
+    "./code": {
+      "import": "./dist/code/index.js",
+      "types": "./dist/code/index.d.ts"
+    },
+    "./css/*.css": {
+      "import": "./dist/css/*.css",
+      "require": "./dist/css/*.css"
+    },
+    "./*.css": {
+      "import": "./dist/*.css",
+      "require": "./dist/*.css"
+    }
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "module": "dist/index.js",
+  "sideEffects": false,
+  "dependencies": {
+    "hast-util-to-text": "^4.0.2",
+    "highlight.js": "^11.9.0",
+    "highlightjs-curl": "^1.3.0",
+    "highlightjs-vue": "^1.0.0",
+    "lowlight": "^3.1.0",
+    "rehype-external-links": "^3.0.0",
+    "rehype-format": "^5.0.0",
+    "rehype-highlight": "^7.0.0",
+    "rehype-parse": "^9.0.0",
+    "rehype-raw": "^7.0.0",
+    "rehype-sanitize": "^6.0.0",
+    "rehype-stringify": "^10.0.0",
+    "remark-gfm": "^4.0.0",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.0",
+    "unified": "^11.0.4",
+    "unist-util-visit": "^5.0.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/hast": "^3.0.4",
+    "rollup": "^4.16.4",
+    "tsc-alias": "^1.8.8",
+    "vfile": "^6.0.1",
+    "vite": "^5.2.10",
+    "vue": "^3.4.22",
+    "@scalar/themes": "0.9.0",
+    "@scalar/build-tooling": "0.1.5"
+  },
+  "scripts": {
+    "build": "scalar-build-rollup",
+    "dev": "vite",
+    "format": "scalar-format-js",
+    "lint:check": "eslint .",
+    "lint:fix": "eslint .  --fix",
+    "test": "vitest",
+    "types:build": "scalar-types-build",
+    "types:check": "scalar-types-check"
+  }
+}