@scalar/code-highlight 0.2.4 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @scalar/code-highlight
 
+## 0.3.1
+
+### Patch Changes
+
+- [#8466](https://github.com/scalar/scalar/pull/8466): chore: new build pipeline
+
+## 0.3.0
+
+### Minor Changes
+
+- [#8322](https://github.com/scalar/scalar/pull/8322): chore: bump required node version to >=22 (LTS)
+
 ## 0.2.4
 
 ### Patch Changes

package/dist/code/highlight.js

@@ -1,42 +1,62 @@
-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";
-function syntaxHighlight(codeString, options) {
-  const credentials = (typeof options?.maskCredentials === "string" ? [options.maskCredentials] : options?.maskCredentials ?? []).filter((c) => {
-    if (c.length < 3) {
-      return false;
-    }
-    return true;
-  });
-  const className = `language-${lowlightLanguageMappings[options.lang] ?? options.lang}`;
-  const nullPlugin = () => {
-  };
-  const html = unified().use(rehypeParse, { fragment: true }).use(injectRawCodeStringPlugin(codeString)).use(rehypeHighlight, {
-    languages: options.languages
-  }).use(options?.lineNumbers ? codeBlockLinesPlugin : nullPlugin).use(rehypeStringify).processSync(`<pre><code class="${className}"></code></pre>`);
-  const htmlString = html.toString();
-  return credentials.length ? credentials.reduce(
-    (acc, credential) => acc.split(credential).join(`<span class="credential"><span class="credential-value">${credential}</span></span>`),
-    htmlString
-  ) : htmlString;
+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
+    return () => (tree) => {
+        visit(tree, 'element', (node) => {
+            if (node.tagName === 'code') {
+                node.children.push({
+                    type: 'text',
+                    value: rawCodeString,
+                });
+            }
         });
-      }
-    });
-  };
+    };
 }
-export {
-  syntaxHighlight
-};
-//# sourceMappingURL=highlight.js.map

package/dist/code/index.js

@@ -1,5 +1 @@
-import { syntaxHighlight } from "./highlight.js";
-export {
-  syntaxHighlight
-};
-//# sourceMappingURL=index.js.map
+export { syntaxHighlight } from './highlight.js';

package/dist/code/line-numbers.js

@@ -1,69 +1,94 @@
-import { visit } from "unist-util-visit";
+import { visit } from 'unist-util-visit';
+// ---------------------------------------------------------------------------
+// Line Numbering plugin
 function isText(element) {
-  return element?.type === "text";
+    return element?.type === 'text';
 }
 function isElement(node) {
-  return node?.type === "element";
+    return node?.type === 'element';
 }
 function textElement(value) {
-  return { type: "text", value };
+    return { type: 'text', value };
 }
 function lineBreak() {
-  return { type: "text", value: "\n" };
+    return { type: 'text', value: '\n' };
 }
-function codeBlockLinesPlugin() {
-  return (tree) => {
-    visit(tree, "element", (node, _i, parent) => {
-      if (parent?.type === "element" && parent.tagName === "pre" && node.tagName === "code") {
-        let numLines = 0;
-        node.children = addLines(node);
-        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++;
+/**
+ * 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};`];
             }
-          }
         });
-        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] || void 0);
-  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));
+    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);
         }
-        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;
+        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
-  };
+    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);
+    return (isText(node) && /\r?\n/.test(node.value)) || (isElement(node) && node.children.some(hasLineBreak));
 }
-export {
-  codeBlockLinesPlugin
-};
-//# sourceMappingURL=line-numbers.js.map

package/dist/constants.js

@@ -1,13 +1,11 @@
-const lowlightLanguageMappings = {
-  "ts": "typescript",
-  "js": "javascript",
-  "py": "python",
-  "py3": "python",
-  "c#": "csharp",
-  "c++": "cpp",
-  "node": "javascript"
+/** 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',
 };
-export {
-  lowlightLanguageMappings
-};
-//# sourceMappingURL=constants.js.map
+//

package/dist/index.js

@@ -1,14 +1,5 @@
-import { syntaxHighlight } from "./code/index.js";
-import { lowlightLanguageMappings } from "./constants.js";
-export * from "./languages/index.js";
-import { htmlFromMarkdown, isHeading, textFromNode } from "./markdown/index.js";
-import { rehypeHighlight } from "./rehype-highlight/index.js";
-export {
-  htmlFromMarkdown,
-  isHeading,
-  lowlightLanguageMappings,
-  rehypeHighlight,
-  syntaxHighlight,
-  textFromNode
-};
-//# sourceMappingURL=index.js.map
+export { syntaxHighlight } from './code/index.js';
+export { lowlightLanguageMappings } from './constants.js';
+export * from './languages/index.js';
+export { htmlFromMarkdown, isHeading, textFromNode } from './markdown/index.js';
+export { rehypeHighlight } from './rehype-highlight/index.js';

package/dist/languages/basic.js

@@ -1,33 +1,30 @@
-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";
+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
+    bash,
+    css,
+    html: xml,
+    javascript,
+    json,
+    less,
+    markdown,
+    plaintext,
+    python,
+    scss,
+    shell,
+    typescript,
+    xml,
+    yaml,
 };
-export {
-  basicLanguages
-};
-//# sourceMappingURL=basic.js.map
+export { basicLanguages };

package/dist/languages/index.js

@@ -1,9 +1,3 @@
-import { basicLanguages } from "./basic.js";
-import { jsonYamlLanguages } from "./json-yaml.js";
-import { standardLanguages } from "./standard.js";
-export {
-  basicLanguages,
-  jsonYamlLanguages,
-  standardLanguages
-};
-//# sourceMappingURL=index.js.map
+export { basicLanguages } from './basic.js';
+export { jsonYamlLanguages } from './json-yaml.js';
+export { standardLanguages } from './standard.js';

package/dist/languages/json-yaml.js

@@ -1,12 +1,9 @@
-import json from "highlight.js/lib/languages/json";
-import plaintext from "highlight.js/lib/languages/plaintext";
-import yaml from "highlight.js/lib/languages/yaml";
+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
+    json,
+    plaintext,
+    yaml,
 };
-export {
-  jsonYamlLanguages
-};
-//# sourceMappingURL=json-yaml.js.map
+export { jsonYamlLanguages };

package/dist/languages/standard.js

@@ -1,101 +1,116 @@
-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 "highlightjs-curl";
-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
+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';
+// @ts-expect-error No types available
+import curl from 'highlightjs-curl';
+/**
+ * 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,
 };
-export {
-  standardLanguages
-};
-//# sourceMappingURL=standard.js.map

package/dist/markdown/index.js

@@ -1,2 +1 @@
-export * from "./markdown.js";
-//# sourceMappingURL=index.js.map
+export * from './markdown.js';