@scalar/code-highlight 0.3.4 → 0.3.6

package/package.json

@@ -16,7 +16,7 @@
     "lowlight",
     "highlightjs"
   ],
-  "version": "0.3.4",
+  "version": "0.3.6",
   "engines": {
     "node": ">=22"
   },
@@ -92,12 +92,12 @@
     "@types/mdast": "^4.0.4",
     "vfile": "^6.0.3",
     "vite": "8.0.0",
-    "@scalar/themes": "0.15.3"
+    "@scalar/themes": "0.16.0"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json && shx cp -r src/css dist/css",
+    "build": "vite build && tsc -p tsconfig.build.json --emitDeclarationOnly && tsc-alias -p tsconfig.build.json && shx cp -r src/css dist/css",
     "dev": "vite",
     "test": "vitest --run",
-    "types:check": "tsc --noEmit"
+    "types:check": "tsgo --noEmit"
   }
 }

package/dist/code/highlight.js

@@ -1,62 +0,0 @@
-import rehypeParse from 'rehype-parse';
-import rehypeStringify from 'rehype-stringify';
-import { unified } from 'unified';
-import { visit } from 'unist-util-visit';
-import { lowlightLanguageMappings } from '../constants.js';
-import { rehypeHighlight } from '../rehype-highlight/index.js';
-import { codeBlockLinesPlugin } from './line-numbers.js';
-/**
- * Syntax highlights a code string using the `rehype-highlight` library.
- */
-export function syntaxHighlight(codeString, options) {
-    // Simple restriction on credentials to prevent unexpected behavior
-    const credentials = (typeof options?.maskCredentials === 'string' ? [options.maskCredentials] : (options?.maskCredentials ?? [])).filter((c) => {
-        // Credentials must be at least 3 characters to mask.
-        if (c.length < 3) {
-            return false;
-        }
-        return true;
-    });
-    // Classname is used by lowlight to select the language model
-    const className = `language-${lowlightLanguageMappings[options.lang] ?? options.lang}`;
-    // biome-ignore lint/suspicious/noEmptyBlockStatements: empty plugin
-    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
-        ? credentials.reduce((acc, credential) => acc
-            .split(credential)
-            .join(`<span class="credential"><span class="credential-value">${credential}</span></span>`), htmlString)
-        : 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,
-                });
-            }
-        });
-    };
-}

package/dist/code/line-numbers.js

@@ -1,94 +0,0 @@
-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
- */
-export 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 (lastChild && (!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]) || undefined);
-    node.children.forEach((child) => {
-        if (isText(child) && hasLineBreak(child)) {
-            const split = child.value.split(/\n/);
-            split.forEach((content, i) => {
-                if (copyParent) {
-                    line()?.children.push({ ...node, children: [textElement(content)] });
-                }
-                else {
-                    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));
-}

package/dist/constants.js

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

package/dist/languages/basic.js

@@ -1,30 +0,0 @@
-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,
-    html: xml,
-    javascript,
-    json,
-    less,
-    markdown,
-    plaintext,
-    python,
-    scss,
-    shell,
-    typescript,
-    xml,
-    yaml,
-};
-export { basicLanguages };

package/dist/languages/curl.js

@@ -1,86 +0,0 @@
-/**
- * cURL grammar adapted from highlightjs-curl to avoid a CJS dependency.
- */
-const curlLanguage = (hljs) => {
-    const quoteString = {
-        className: 'string',
-        begin: /"/,
-        end: /"/,
-        contains: [
-            hljs.BACKSLASH_ESCAPE,
-            {
-                className: 'variable',
-                begin: /\$\(/,
-                end: /\)/,
-                contains: [hljs.BACKSLASH_ESCAPE],
-            },
-        ],
-        relevance: 0,
-    };
-    const optionRequest = {
-        className: 'literal',
-        begin: /(--request|-X)\s/,
-        contains: [
-            {
-                className: 'symbol',
-                begin: /(get|post|delete|options|head|put|patch|trace|connect)/,
-                end: /\s/,
-                returnEnd: true,
-            },
-        ],
-        returnEnd: true,
-        relevance: 10,
-    };
-    const option = {
-        className: 'literal',
-        begin: /--/,
-        end: /[\s"]/,
-        returnEnd: true,
-        relevance: 0,
-    };
-    const optionSingle = {
-        className: 'literal',
-        begin: /-\w/,
-        end: /[\s"]/,
-        returnEnd: true,
-        relevance: 0,
-    };
-    const escapedQuote = {
-        className: 'string',
-        begin: /\\"/,
-        relevance: 0,
-    };
-    const aposString = {
-        className: 'string',
-        begin: /'/,
-        end: /'/,
-        relevance: 0,
-    };
-    const number = {
-        className: 'number',
-        variants: [{ begin: hljs.C_NUMBER_RE }],
-        relevance: 0,
-    };
-    const pathMode = {
-        match: /(\/[a-z._-]+)+/,
-    };
-    return {
-        name: 'curl',
-        aliases: ['curl'],
-        keywords: 'curl',
-        case_insensitive: true,
-        contains: [
-            optionRequest,
-            option,
-            optionSingle,
-            quoteString,
-            escapedQuote,
-            aposString,
-            hljs.APOS_STRING_MODE,
-            hljs.QUOTE_STRING_MODE,
-            number,
-            pathMode,
-        ],
-    };
-};
-export default curlLanguage;

package/dist/languages/json-yaml.js

@@ -1,9 +0,0 @@
-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.js

@@ -1,115 +0,0 @@
-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 dart from 'highlight.js/lib/languages/dart';
-import diff from 'highlight.js/lib/languages/diff';
-import dockerfile from 'highlight.js/lib/languages/dockerfile';
-import elixir from 'highlight.js/lib/languages/elixir';
-import fsharp from 'highlight.js/lib/languages/fsharp';
-import go from 'highlight.js/lib/languages/go';
-import graphql from 'highlight.js/lib/languages/graphql';
-import haskell from 'highlight.js/lib/languages/haskell';
-import http from 'highlight.js/lib/languages/http';
-import ini from 'highlight.js/lib/languages/ini';
-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 lua from 'highlight.js/lib/languages/lua';
-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 perl from 'highlight.js/lib/languages/perl';
-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 properties from 'highlight.js/lib/languages/properties';
-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 scala from 'highlight.js/lib/languages/scala';
-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 './curl.js';
-/**
- * We group languages into three categories based on their popularity and usage.
- * This helps in optimizing the bundle size by allowing users to include only
- * the languages they need.
- *
- * 1. Standard Languages: These are the most popular languages that cover the
- *    majority of use cases.
- * 2. Medium Languages: These languages are not as popular as the ones in
- *    `standardLanguages`, but still have a decent amount of users.
- * 3. Specialized Languages: These languages are more specialized and have a
- *    smaller user base.
- *
- * Each category is represented as a separate object, making it easy to import
- * only the languages you need.
- */
-/**
- * These are the most popular languages that cover the majority of use cases.
- */
-export const standardLanguages = {
-    bash,
-    c,
-    clojure,
-    cpp,
-    csharp,
-    css,
-    curl,
-    dart,
-    diff,
-    docker: dockerfile,
-    dockerfile,
-    elixir,
-    fsharp,
-    go,
-    graphql,
-    haskell,
-    html: xml,
-    http,
-    ini,
-    java,
-    javascript,
-    json,
-    kotlin,
-    less,
-    lua,
-    makefile,
-    markdown,
-    matlab,
-    nginx,
-    objectivec,
-    ocaml,
-    perl,
-    php,
-    plaintext,
-    powershell,
-    properties,
-    python,
-    r,
-    ruby,
-    rust,
-    scala,
-    scss,
-    shell,
-    sql,
-    swift,
-    toml: ini,
-    typescript,
-    xml,
-    yaml,
-};

package/dist/markdown/markdown.js

@@ -1,228 +0,0 @@
-import rehypeExternalLinks from 'rehype-external-links';
-import rehypeFormat from 'rehype-format';
-import rehypeParse from 'rehype-parse';
-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 remarkStringify from 'remark-stringify';
-import { unified } from 'unified';
-import { SKIP, visit } from 'unist-util-visit';
-import { standardLanguages } from '../languages/index.js';
-import { rehypeAlert } from '../rehype-alert/index.js';
-import { rehypeHighlight } from '../rehype-highlight/index.js';
-/**
- * Type-guard to check if a node is a heading.
- */
-export const isHeading = (node) => {
-    return node.type === 'heading' && 'depth' in node && 'children' in node;
-};
-/**
- * Plugin to transform nodes in a Markdown AST
- */
-const transformNodes = (options, ..._ignored) => (tree) => {
-    if (!options?.transform || !options?.type) {
-        return;
-    }
-    visit(tree, options?.type, (node) => {
-        options?.transform ? options?.transform(node) : node;
-        return SKIP;
-    });
-    return;
-};
-const TAGS_WITH_INLINE_MARKDOWN = new Set(['dd', 'dt', 'li', 'p', 'summary', 'td', 'th']);
-const MAY_CONTAIN_INLINE_MARKDOWN = /[`*_\[~]/;
-/**
- * Preserve HTML-like text in inline markdown by turning mdast `html` nodes into text nodes.
- */
-const preserveHtmlLikeText = () => (tree) => {
-    visit(tree, 'html', (node, index, parent) => {
-        if (typeof index !== 'number' || !parent || !('children' in parent) || !Array.isArray(parent.children)) {
-            return;
-        }
-        parent.children[index] = {
-            type: 'text',
-            value: node.value ?? '',
-        };
-    });
-};
-const inlineMarkdownProcessor = unified().use(remarkParse).use(remarkGfm).use(preserveHtmlLikeText).use(remarkRehype);
-const htmlFragmentParser = unified().use(rehypeParse, { fragment: true });
-const htmlFragmentStringifier = unified().use(rehypeStringify);
-/**
- * Parse inline markdown and return children from the generated paragraph.
- */
-const extractInlineChildrenFromMarkdown = (value) => {
-    const tree = inlineMarkdownProcessor.runSync(inlineMarkdownProcessor.parse(value));
-    if (tree.children.length !== 1) {
-        return [];
-    }
-    const paragraph = tree.children.at(0);
-    if (!paragraph || paragraph.type !== 'element' || paragraph.tagName !== 'p') {
-        return [];
-    }
-    return paragraph.children;
-};
-/**
- * Re-parses text nodes in selected HTML tags so inline markdown works in tags like <p>.
- */
-const transformInlineMarkdownInHtml = () => (tree) => {
-    visit(tree, 'element', (node) => {
-        if (!TAGS_WITH_INLINE_MARKDOWN.has(node.tagName)) {
-            return;
-        }
-        node.children = node.children.flatMap((child) => {
-            if (child.type !== 'text' || !MAY_CONTAIN_INLINE_MARKDOWN.test(child.value)) {
-                return [child];
-            }
-            const markdownChildren = extractInlineChildrenFromMarkdown(child.value);
-            return markdownChildren.length ? markdownChildren : [child];
-        });
-    });
-};
-/**
- * Rewrites raw HTML strings so inline markdown parsing is only applied to raw HTML input.
- */
-const transformInlineMarkdownInRawHtml = () => (tree) => {
-    visit(tree, 'raw', (node) => {
-        if (typeof node.value !== 'string' || !MAY_CONTAIN_INLINE_MARKDOWN.test(node.value)) {
-            return;
-        }
-        const htmlFragmentTree = htmlFragmentParser.parse(node.value);
-        transformInlineMarkdownInHtml()(htmlFragmentTree);
-        node.value = htmlFragmentStringifier.stringify(htmlFragmentTree);
-    });
-};
-/**
- * Take a Markdown string and generate HTML from it
- */
-export function htmlFromMarkdown(markdown, 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)
-        .use(transformNodes, {
-        transform: options?.transform,
-        type: options?.transformType,
-    })
-        // Allows any HTML tags
-        .use(remarkRehype, { allowDangerousHtml: true })
-        // Adds GitHub alerts
-        .use(rehypeAlert)
-        // Parse inline markdown only inside raw HTML fragments, not normal markdown output
-        .use(transformInlineMarkdownInRawHtml)
-        // Creates an HTML AST
-        .use(rehypeRaw)
-        // Removes disallowed tags
-        .use(rehypeSanitize, {
-        ...defaultSchema,
-        // Don't prefix the heading ids
-        clobberPrefix: '',
-        // Makes it even more strict
-        tagNames,
-        attributes: {
-            ...defaultSchema.attributes,
-            abbr: ['title'],
-            // Allow all class names while preserving the existing default attributes
-            '*': [...(defaultSchema.attributes?.['*'] ?? []), 'className'],
-        },
-        // Strip content of dangerous elements, not just the tags
-        strip: ['script', 'style', 'object', 'embed', 'form'],
-    })
-        // 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(markdown);
-    return html.toString();
-}
-/**
- * Create a Markdown AST from a string.
- */
-function getMarkdownAst(markdown) {
-    return unified().use(remarkParse).use(remarkGfm).parse(markdown);
-}
-/**
- * Find all headings of a specific type in a Markdown AST.
- */
-export function getHeadings(markdown, depth = 1) {
-    const tree = getMarkdownAst(markdown);
-    const nodes = [];
-    visit(tree, 'heading', (node) => {
-        const text = textFromNode(node);
-        if (text) {
-            nodes.push({ depth: node.depth ?? depth, value: text });
-        }
-    });
-    return nodes;
-}
-/**
- * Extract plain text from a Markdown AST node (recursively).
- *
- * Handles headings with nested phrasing content such as links.
- */
-export function textFromNode(node) {
-    if (node.type === 'text') {
-        return node.value ?? '';
-    }
-    if ('children' in node && Array.isArray(node.children)) {
-        return node.children.map((child) => textFromNode(child)).join('');
-    }
-    return '';
-}
-/**
- * Return multiple Markdown documents. Every heading should be its own document.
- */
-export function splitContent(markdown) {
-    const tree = getMarkdownAst(markdown);
-    /** Sections */
-    const sections = [];
-    /** Nodes inside a section */
-    let nodes = [];
-    tree.children?.forEach((node) => {
-        // If the node is a heading, start a new section
-        if (node.type === 'heading') {
-            if (nodes.length) {
-                sections.push(nodes);
-            }
-            sections.push([node]);
-            nodes = [];
-        }
-        // Otherwise, add the node to the current section
-        else {
-            nodes.push(node);
-        }
-    });
-    // Add any remaining nodes
-    if (nodes.length) {
-        sections.push(nodes);
-    }
-    return sections.map((section) => createDocument(section));
-}
-/**
- * Use remark to create a Markdown document from a list of nodes.
- */
-function createDocument(nodes) {
-    // Create the Markdown string
-    const markdown = unified().use(remarkStringify).use(remarkGfm).stringify({
-        type: 'root',
-        children: nodes,
-    });
-    // Remove the whitespace
-    return markdown.trim();
-}