@scalar/code-highlight 0.0.7 → 0.0.8

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scalar/code-highlight
 
+## 0.0.8
+
+### Patch Changes
+
+- b910fc1: feat: new Markdown helper methods splitContent and getHeadings
+
 ## 0.0.7
 
 ### Patch Changes

package/dist/markdown/index.d.ts

@@ -1,2 +1,2 @@
-export { htmlFromMarkdown } from './markdown.js';
+export * 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,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/markdown/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA"}

package/dist/markdown/index.js

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

package/dist/markdown/markdown.d.ts

@@ -1,6 +1,21 @@
-/** Take a markdown string and generate a raw HTML string */
-export declare function htmlFromMarkdown(markdownString: string, options?: {
+/**
+ * Take a Markdown string and generate HTML from it
+ */
+export declare function htmlFromMarkdown(markdown: string, options?: {
     removeTags?: string[];
     allowTags?: string[];
+    transform?: (node: Record<string, any>) => Record<string, any>;
+    transformType?: string;
 }): string;
+/**
+ * Find all headings of a specific type in a Markdown AST.
+ */
+export declare function getHeadings(markdown: string, depth?: number): {
+    depth: number;
+    value: string;
+}[];
+/**
+ * Return multiple Markdown documents. Every heading should be its own document.
+ */
+export declare function splitContent(markdown: string): string[];
 //# sourceMappingURL=markdown.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/markdown/markdown.ts"],"names":[],"mappings":"AA4CA;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;IACR,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC9D,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,UAkDF;AASD;;GAEG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,KAAK,GAAE,MAAU,GAChB;IACD,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd,EAAE,CAiBF;AAuBD;;GAEG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,YAgC5C"}

package/dist/markdown/markdown.js

@@ -6,12 +6,33 @@ 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 { visit, SKIP } from 'unist-util-visit';
 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) {
+/**
+ * Plugin to transform nodes in a Markdown AST
+ */
+const transformNodes = function (options, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+..._ignored) {
+    return (tree) => {
+        if (!options?.transform || !options?.type) {
+            return;
+        }
+        visit(tree, options?.type, (node) => {
+            options?.transform ? options?.transform(node) : node;
+            return SKIP;
+        });
+        return;
+    };
+};
+/**
+ * Take a Markdown string and generate HTML from it
+ */
+function htmlFromMarkdown(markdown, options) {
     // Add permitted tags and remove stripped ones
     const removeTags = options?.removeTags ?? [];
     const tagNames = [
@@ -23,6 +44,10 @@ function htmlFromMarkdown(markdownString, options) {
         .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 })
         // Creates a HTML AST
@@ -30,6 +55,8 @@ function htmlFromMarkdown(markdownString, options) {
         // Removes disallowed tags
         .use(rehypeSanitize, {
         ...defaultSchema,
+        // Don’t prefix the heading ids
+        clobberPrefix: '',
         // Makes it even more strict
         tagNames,
         attributes: {
@@ -50,8 +77,86 @@ function htmlFromMarkdown(markdownString, options) {
         // Converts the HTML AST to a string
         .use(rehypeStringify)
         // Run the pipeline
-        .processSync(markdownString);
+        .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.
+ */
+function getHeadings(markdown, depth = 1) {
+    const tree = getMarkdownAst(markdown);
+    const nodes = [];
+    visit(tree, 'heading', (node) => {
+        const text = findTextInHeading(node);
+        if (text) {
+            nodes.push({ depth: node.depth ?? depth, value: text.value });
+        }
+    });
+    return nodes;
+}
+/**
+ * Find the text in a Markdown node (recursively).
+ */
+function findTextInHeading(node) {
+    if (node.type === 'text') {
+        return node;
+    }
+    if ('children' in node && node.children) {
+        for (const child of node.children) {
+            const text = findTextInHeading(child);
+            if (text) {
+                return text;
+            }
+        }
+    }
+    return null;
+}
+/**
+ * Return multiple Markdown documents. Every heading should be its own document.
+ */
+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();
+}
 
-export { htmlFromMarkdown };
+export { getHeadings, htmlFromMarkdown, splitContent };

package/package.json

@@ -16,7 +16,7 @@
     "lowlight",
     "highlightjs"
   ],
-  "version": "0.0.7",
+  "version": "0.0.8",
   "engines": {
     "node": ">=18"
   },
@@ -73,19 +73,21 @@
     "remark-gfm": "^4.0.0",
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.0",
+    "remark-stringify": "^11.0.0",
     "unified": "^11.0.4",
     "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/hast": "^3.0.4",
+    "@types/mdast": "^4.0.4",
+    "@types/unist": "^3.0.2",
     "rollup": "^4.16.4",
-    "tsc-alias": "^1.8.8",
     "vfile": "^6.0.1",
     "vite": "^5.2.10",
-    "vue": "^3.4.22",
-    "@scalar/build-tooling": "0.1.9",
-    "@scalar/themes": "0.9.13"
+    "vue": "^3.4.29",
+    "@scalar/build-tooling": "0.1.10",
+    "@scalar/themes": "0.9.22"
   },
   "scripts": {
     "build": "scalar-build-rollup",