@scalar/code-highlight 0.3.0 → 0.3.2

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.d.ts

@@ -1,2 +1,2 @@
-export * from './markdown.js';
+export { getHeadings, htmlFromMarkdown, isHeading, splitContent, textFromNode, type Node } from './markdown.js';
 //# sourceMappingURL=index.d.ts.map

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

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

package/dist/markdown/index.js

@@ -1,2 +1 @@
-export * from "./markdown.js";
-//# sourceMappingURL=index.js.map
+export { getHeadings, htmlFromMarkdown, isHeading, splitContent, textFromNode } from './markdown.js';

package/dist/markdown/markdown.js

@@ -1,114 +1,162 @@
-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 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";
-const isHeading = (node) => {
-  return node.type === "heading" && "depth" in node && "children" in node;
+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 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) {
+    if (!options?.transform || !options?.type) {
+        return;
+    }
+    visit(tree, options?.type, (node) => {
+        options?.transform ? options?.transform(node) : node;
+        return SKIP;
+    });
     return;
-  }
-  visit(tree, options?.type, (node) => {
-    options?.transform ? options?.transform(node) : node;
-    return SKIP;
-  });
-  return;
 };
-function htmlFromMarkdown(markdown, options) {
-  const removeTags = options?.removeTags ?? [];
-  const tagNames = [...defaultSchema.tagNames ?? [], ...options?.allowTags ?? []].filter(
-    (t) => !removeTags.includes(t)
-  );
-  const html = unified().use(remarkParse).use(remarkGfm).use(transformNodes, {
-    transform: options?.transform,
-    type: options?.transformType
-  }).use(remarkRehype, { allowDangerousHtml: true }).use(rehypeAlert).use(rehypeRaw).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"]
-  }).use(rehypeHighlight, {
-    languages: standardLanguages,
-    // Enable auto detection
-    detect: true
-  }).use(rehypeExternalLinks, { target: "_blank" }).use(rehypeFormat).use(rehypeStringify).processSync(markdown);
-  return html.toString();
+/**
+ * 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)
+        // Creates a 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);
+    return unified().use(remarkParse).use(remarkGfm).parse(markdown);
 }
-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;
+/**
+ * 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;
 }
-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 "";
+/**
+ * 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 '';
 }
-function splitContent(markdown) {
-  const tree = getMarkdownAst(markdown);
-  const sections = [];
-  let nodes = [];
-  tree.children?.forEach((node) => {
-    if (node.type === "heading") {
-      if (nodes.length) {
+/**
+ * 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);
-      }
-      sections.push([node]);
-      nodes = [];
-    } else {
-      nodes.push(node);
     }
-  });
-  if (nodes.length) {
-    sections.push(nodes);
-  }
-  return sections.map((section) => createDocument(section));
+    return sections.map((section) => createDocument(section));
 }
+/**
+ * Use remark to create a Markdown document from a list of nodes.
+ */
 function createDocument(nodes) {
-  const markdown = unified().use(remarkStringify).use(remarkGfm).stringify({
-    type: "root",
-    children: nodes
-  });
-  return markdown.trim();
+    // Create the Markdown string
+    const markdown = unified().use(remarkStringify).use(remarkGfm).stringify({
+        type: 'root',
+        children: nodes,
+    });
+    // Remove the whitespace
+    return markdown.trim();
 }
-export {
-  getHeadings,
-  htmlFromMarkdown,
-  isHeading,
-  splitContent,
-  textFromNode
-};
-//# sourceMappingURL=markdown.js.map

package/dist/rehype-alert/index.js

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