@temelj/mdx 0.14.0 → 0.15.0

package/dist/plugins/syntax-highlight/plugin.d.mts

@@ -1,57 +0,0 @@
-import { HastNode as Node } from "../../types.mjs";
-import { TransformerNotationHighlightOptions } from "@shikijs/transformers";
-import { BundledLanguage, BundledTheme, CodeToHastOptions } from "shiki";
-import { Plugin } from "unified";
-//#region src/plugins/syntax-highlight/plugin.d.ts
-type ShikiHastOptions = Partial<CodeToHastOptions<BundledLanguage, BundledTheme>>;
-type SyntaxDataAttribute = "source-code" | "language" | "line-count";
-/**
- * Options for {@linkcode syntaxHighlightPlugin}.
- */
-interface SyntaxHighlightPluginOptions {
-  /**
-   * Include these data attributes on the `<pre>` element.
-   * These might be useful to have when building custom code components.
-   */
-  includeDataAttributes?: SyntaxDataAttribute[];
-  /**
-   * Options for the highlight transformer.
-   */
-  highlight?: {
-    transformer?: TransformerNotationHighlightOptions;
-  };
-  /**
-   * Options for line numbers.
-   */
-  lineNumbers?: {
-    /**
-     * The name of the variable that contains the line number width.
-     * This is used for padding the line numbers so that they align.
-     */
-    widthVariableName?: string;
-    /**
-     * A class name to be added to the line numbers.
-     */
-    className?: string;
-  };
-  /**
-   * Options for command line.
-   */
-  commandLine?: {
-    /**
-     * A class name to be added to the prompt line.
-     */
-    className?: string;
-  };
-  /**
-   * Extra options for the Shiki hast transformer.
-   */
-  shikiHastOptions?: ShikiHastOptions;
-}
-/**
- * A plugin that highlights code blocks using Shiki.
- */
-declare const syntaxHighlightPlugin: Plugin<[SyntaxHighlightPluginOptions?], Node, Node>;
-//#endregion
-export { SyntaxHighlightPluginOptions, syntaxHighlightPlugin };
-//# sourceMappingURL=plugin.d.mts.map

package/dist/plugins/syntax-highlight/plugin.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../../src/plugins/syntax-highlight/plugin.ts"],"mappings":";;;;;KAsBK,mBAAmB,QAAQ,kBAAkB,iBAAiB;KAE9D;;;;UAKY;;;;;EAKf,wBAAwB;;;;EAKxB;IACE,cAAc;;;;;EAMhB;;;;;IAKE;;;;IAIA;;;;;EAMF;;;;IAIE;;;;;EAMF,mBAAmB;;;;;cAMR,uBAAuB,QAAQ,gCAAgC,MAAU"}

package/dist/plugins/syntax-highlight/plugin.mjs

@@ -1,93 +0,0 @@
-import { extractCodeMeta } from "./code-meta.mjs";
-import { toString } from "hast-util-to-string";
-import { visit } from "unist-util-visit";
-import { transformerNotationHighlight } from "@shikijs/transformers";
-import { numericRangeContains } from "@temelj/iterator";
-import { ShikiError, codeToHast } from "shiki";
-//#region src/plugins/syntax-highlight/plugin.ts
-/**
-* A plugin that highlights code blocks using Shiki.
-*/
-const syntaxHighlightPlugin = (options = {}) => {
-	return async (tree) => {
-		const promises = [];
-		async function visitor(node, index, parent) {
-			if (!parent || index === null || node.tagName !== "pre") return;
-			const codeNode = node.children[0];
-			if (!codeNode || codeNode.type !== "element" || codeNode.tagName !== "code" || !codeNode.properties) return;
-			const lang = getNodeLanguage(codeNode);
-			if (typeof lang !== "string") return;
-			const meta = extractCodeMeta(codeNode);
-			const sourceCode = toString(codeNode).trim();
-			const hastOptions = {
-				tokenizeTimeLimit: 1e4,
-				lang,
-				themes: {
-					light: "github-light-default",
-					dark: "github-dark-default"
-				},
-				...options.shikiHastOptions
-			};
-			if (hastOptions.transformers === void 0) hastOptions.transformers = [];
-			if (options.highlight) hastOptions.transformers.push(transformerNotationHighlight({
-				...options.highlight.transformer,
-				matchAlgorithm: "v3"
-			}));
-			let lineCount = 0;
-			hastOptions.transformers.push({ code(node) {
-				let lineIndex = 0;
-				for (const line of node.children.filter((node) => node.type === "element")) {
-					line.properties["data-line"] = lineIndex + 1;
-					if (options.highlight) {
-						if (meta.highlight && numericRangeContains(meta.highlight.lineRange, lineIndex)) this.addClassToHast(line, options.highlight.transformer?.classActiveLine ?? "highlighted");
-					}
-					if (options.lineNumbers && meta.showLineNumbers && (meta.showLineNumbers.lineRange.length === 0 || numericRangeContains(meta.showLineNumbers.lineRange, lineIndex))) this.addClassToHast(line, options.lineNumbers.className ?? "line-number");
-					if (options.commandLine && meta.commandLine && (meta.commandLine.commandRange.length === 0 || numericRangeContains(meta.commandLine.commandRange, lineIndex))) this.addClassToHast(line, options.commandLine.className ?? "line-command");
-					lineIndex++;
-				}
-				lineCount = lineIndex;
-				if (meta.showLineNumbers) {
-					if (typeof node.properties.style !== "string") node.properties.style = "";
-					node.properties.style += `--${options.lineNumbers?.widthVariableName ?? "line-number-width"}:${1 + Math.floor(Math.log10(this.lines.length))}ch;`;
-				}
-			} });
-			try {
-				const hastPre = (await codeToHast(sourceCode, hastOptions)).children[0];
-				const properties = {
-					...hastPre.properties,
-					dataFileName: meta.fileName
-				};
-				if (options.includeDataAttributes) {
-					if (options.includeDataAttributes.includes("language")) properties.dataLanguage = lang;
-					if (options.includeDataAttributes.includes("source-code")) properties.dataSourceCode = sourceCode;
-					if (options.includeDataAttributes.includes("line-count")) properties.dataLineCount = lineCount;
-				}
-				parent.children.splice(index, 1, {
-					...hastPre,
-					properties
-				});
-			} catch (error) {
-				if (error instanceof ShikiError) {
-					if (error.message.includes("Language `math` is not included in this bundle")) return;
-				}
-				throw error;
-			}
-		}
-		visit(tree, "element", (node, index, parent) => {
-			promises.push(visitor(node, index, parent));
-		});
-		await Promise.all(promises);
-		return tree;
-	};
-};
-function getNodeLanguage(node) {
-	if (!Array.isArray(node.properties.className)) return;
-	const prefix = "language-";
-	const language = node.properties.className.find((name) => typeof name === "string" && name.startsWith(prefix));
-	if (typeof language === "string") return language.slice(9);
-	return language;
-}
-//#endregion
-export { syntaxHighlightPlugin };
-
-//# sourceMappingURL=plugin.mjs.map

package/dist/plugins/syntax-highlight/plugin.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.mjs","names":["hastToString"],"sources":["../../../src/plugins/syntax-highlight/plugin.ts"],"sourcesContent":["import type { Properties } from \"hast\";\nimport type { Plugin } from \"unified\";\n\nimport {\n  type TransformerNotationHighlightOptions,\n  transformerNotationHighlight,\n} from \"@shikijs/transformers\";\nimport { numericRangeContains } from \"@temelj/iterator\";\nimport { toString as hastToString } from \"hast-util-to-string\";\nimport {\n  type BundledLanguage,\n  type BundledTheme,\n  type CodeToHastOptions,\n  codeToHast,\n  ShikiError,\n} from \"shiki\";\nimport { visit } from \"unist-util-visit\";\n\nimport type { HastElement, HastNode } from \"../../types\";\n\nimport { extractCodeMeta } from \"./code-meta\";\n\ntype ShikiHastOptions = Partial<CodeToHastOptions<BundledLanguage, BundledTheme>>;\n\ntype SyntaxDataAttribute = \"source-code\" | \"language\" | \"line-count\";\n\n/**\n * Options for {@linkcode syntaxHighlightPlugin}.\n */\nexport interface SyntaxHighlightPluginOptions {\n  /**\n   * Include these data attributes on the `<pre>` element.\n   * These might be useful to have when building custom code components.\n   */\n  includeDataAttributes?: SyntaxDataAttribute[];\n\n  /**\n   * Options for the highlight transformer.\n   */\n  highlight?: {\n    transformer?: TransformerNotationHighlightOptions;\n  };\n\n  /**\n   * Options for line numbers.\n   */\n  lineNumbers?: {\n    /**\n     * The name of the variable that contains the line number width.\n     * This is used for padding the line numbers so that they align.\n     */\n    widthVariableName?: string;\n    /**\n     * A class name to be added to the line numbers.\n     */\n    className?: string;\n  };\n\n  /**\n   * Options for command line.\n   */\n  commandLine?: {\n    /**\n     * A class name to be added to the prompt line.\n     */\n    className?: string;\n  };\n\n  /**\n   * Extra options for the Shiki hast transformer.\n   */\n  shikiHastOptions?: ShikiHastOptions;\n}\n\n/**\n * A plugin that highlights code blocks using Shiki.\n */\nexport const syntaxHighlightPlugin: Plugin<[SyntaxHighlightPluginOptions?], HastNode, HastNode> = (\n  options: SyntaxHighlightPluginOptions = {},\n) => {\n  return async (tree) => {\n    const promises: Promise<void>[] = [];\n\n    async function visitor(node: HastElement, index: number, parent: HastElement): Promise<void> {\n      if (!parent || index === null || node.tagName !== \"pre\") {\n        return;\n      }\n\n      const codeNode = node.children[0];\n      if (\n        !codeNode ||\n        codeNode.type !== \"element\" ||\n        codeNode.tagName !== \"code\" ||\n        !codeNode.properties\n      ) {\n        return;\n      }\n\n      const lang = getNodeLanguage(codeNode);\n      if (typeof lang !== \"string\") {\n        return;\n      }\n\n      const meta = extractCodeMeta(codeNode);\n\n      const sourceCode = hastToString(codeNode).trim();\n\n      const hastOptions: CodeToHastOptions<BundledLanguage, BundledTheme> = {\n        tokenizeTimeLimit: 10_000,\n        lang,\n        themes: {\n          light: \"github-light-default\",\n          dark: \"github-dark-default\",\n        },\n        ...options.shikiHastOptions,\n      };\n      if (hastOptions.transformers === undefined) {\n        hastOptions.transformers = [];\n      }\n\n      if (options.highlight) {\n        hastOptions.transformers.push(\n          transformerNotationHighlight({\n            ...options.highlight.transformer,\n            matchAlgorithm: \"v3\",\n          }),\n        );\n      }\n\n      let lineCount = 0;\n      hastOptions.transformers.push({\n        code(node): void {\n          let lineIndex = 0;\n          for (const line of node.children.filter(\n            (node: HastNode) => node.type === \"element\",\n          ) as HastElement[]) {\n            line.properties[\"data-line\"] = lineIndex + 1;\n\n            if (options.highlight) {\n              if (meta.highlight && numericRangeContains(meta.highlight.lineRange, lineIndex)) {\n                this.addClassToHast(\n                  line,\n                  options.highlight.transformer?.classActiveLine ?? \"highlighted\",\n                );\n              }\n            }\n\n            if (\n              options.lineNumbers &&\n              meta.showLineNumbers &&\n              (meta.showLineNumbers.lineRange.length === 0 ||\n                numericRangeContains(meta.showLineNumbers.lineRange, lineIndex))\n            ) {\n              this.addClassToHast(line, options.lineNumbers.className ?? \"line-number\");\n            }\n\n            if (\n              options.commandLine &&\n              meta.commandLine &&\n              (meta.commandLine.commandRange.length === 0 ||\n                numericRangeContains(meta.commandLine.commandRange, lineIndex))\n            ) {\n              this.addClassToHast(line, options.commandLine.className ?? \"line-command\");\n            }\n\n            lineIndex++;\n          }\n\n          lineCount = lineIndex;\n\n          if (meta.showLineNumbers) {\n            if (typeof node.properties.style !== \"string\") {\n              node.properties.style = \"\";\n            }\n            node.properties.style += `--${\n              options.lineNumbers?.widthVariableName ?? \"line-number-width\"\n            }:${1 + Math.floor(Math.log10(this.lines.length))}ch;`;\n          }\n        },\n      });\n\n      try {\n        const hast = await codeToHast(sourceCode, hastOptions);\n\n        // Insert highlighted code into parent\n        const hastPre = hast.children[0] as HastElement;\n\n        const properties: Properties = {\n          ...hastPre.properties,\n          dataFileName: meta.fileName,\n        };\n        if (options.includeDataAttributes) {\n          if (options.includeDataAttributes.includes(\"language\")) {\n            properties.dataLanguage = lang;\n          }\n          if (options.includeDataAttributes.includes(\"source-code\")) {\n            properties.dataSourceCode = sourceCode;\n          }\n          if (options.includeDataAttributes.includes(\"line-count\")) {\n            properties.dataLineCount = lineCount;\n          }\n        }\n\n        parent.children.splice(index, 1, {\n          ...hastPre,\n          properties,\n        });\n      } catch (error) {\n        if (error instanceof ShikiError) {\n          if (error.message.includes(\"Language `math` is not included in this bundle\")) {\n            // Skip if the block is math block.\n            return;\n          }\n        }\n        throw error;\n      }\n    }\n\n    visit(tree, \"element\", (node: HastElement, index: number, parent: HastElement) => {\n      promises.push(visitor(node, index, parent));\n    });\n\n    await Promise.all(promises);\n\n    return tree;\n  };\n};\n\nfunction getNodeLanguage(node: HastElement): string | undefined {\n  if (!Array.isArray(node.properties.className)) {\n    return undefined;\n  }\n  const prefix = \"language-\";\n  const language = node.properties.className.find(\n    (name) => typeof name === \"string\" && name.startsWith(prefix),\n  ) as string | undefined;\n  if (typeof language === \"string\") {\n    return language.slice(prefix.length);\n  }\n  return language;\n}\n"],"mappings":";;;;;;;;;;AA6EA,MAAa,yBACX,UAAwC,CAAC,MACtC;CACH,OAAO,OAAO,SAAS;EACrB,MAAM,WAA4B,CAAC;EAEnC,eAAe,QAAQ,MAAmB,OAAe,QAAoC;GAC3F,IAAI,CAAC,UAAU,UAAU,QAAQ,KAAK,YAAY,OAChD;GAGF,MAAM,WAAW,KAAK,SAAS;GAC/B,IACE,CAAC,YACD,SAAS,SAAS,aAClB,SAAS,YAAY,UACrB,CAAC,SAAS,YAEV;GAGF,MAAM,OAAO,gBAAgB,QAAQ;GACrC,IAAI,OAAO,SAAS,UAClB;GAGF,MAAM,OAAO,gBAAgB,QAAQ;GAErC,MAAM,aAAaA,SAAa,QAAQ,CAAC,CAAC,KAAK;GAE/C,MAAM,cAAgE;IACpE,mBAAmB;IACnB;IACA,QAAQ;KACN,OAAO;KACP,MAAM;IACR;IACA,GAAG,QAAQ;GACb;GACA,IAAI,YAAY,iBAAiB,KAAA,GAC/B,YAAY,eAAe,CAAC;GAG9B,IAAI,QAAQ,WACV,YAAY,aAAa,KACvB,6BAA6B;IAC3B,GAAG,QAAQ,UAAU;IACrB,gBAAgB;GAClB,CAAC,CACH;GAGF,IAAI,YAAY;GAChB,YAAY,aAAa,KAAK,EAC5B,KAAK,MAAY;IACf,IAAI,YAAY;IAChB,KAAK,MAAM,QAAQ,KAAK,SAAS,QAC9B,SAAmB,KAAK,SAAS,SACpC,GAAoB;KAClB,KAAK,WAAW,eAAe,YAAY;KAE3C,IAAI,QAAQ,WACN;UAAA,KAAK,aAAa,qBAAqB,KAAK,UAAU,WAAW,SAAS,GAC5E,KAAK,eACH,MACA,QAAQ,UAAU,aAAa,mBAAmB,aACpD;KAAA;KAIJ,IACE,QAAQ,eACR,KAAK,oBACJ,KAAK,gBAAgB,UAAU,WAAW,KACzC,qBAAqB,KAAK,gBAAgB,WAAW,SAAS,IAEhE,KAAK,eAAe,MAAM,QAAQ,YAAY,aAAa,aAAa;KAG1E,IACE,QAAQ,eACR,KAAK,gBACJ,KAAK,YAAY,aAAa,WAAW,KACxC,qBAAqB,KAAK,YAAY,cAAc,SAAS,IAE/D,KAAK,eAAe,MAAM,QAAQ,YAAY,aAAa,cAAc;KAG3E;IACF;IAEA,YAAY;IAEZ,IAAI,KAAK,iBAAiB;KACxB,IAAI,OAAO,KAAK,WAAW,UAAU,UACnC,KAAK,WAAW,QAAQ;KAE1B,KAAK,WAAW,SAAS,KACvB,QAAQ,aAAa,qBAAqB,oBAC3C,GAAG,IAAI,KAAK,MAAM,KAAK,MAAM,KAAK,MAAM,MAAM,CAAC,EAAE;IACpD;GACF,EACF,CAAC;GAED,IAAI;IAIF,MAAM,WAAU,MAHG,WAAW,YAAY,WAAW,EAAA,CAGhC,SAAS;IAE9B,MAAM,aAAyB;KAC7B,GAAG,QAAQ;KACX,cAAc,KAAK;IACrB;IACA,IAAI,QAAQ,uBAAuB;KACjC,IAAI,QAAQ,sBAAsB,SAAS,UAAU,GACnD,WAAW,eAAe;KAE5B,IAAI,QAAQ,sBAAsB,SAAS,aAAa,GACtD,WAAW,iBAAiB;KAE9B,IAAI,QAAQ,sBAAsB,SAAS,YAAY,GACrD,WAAW,gBAAgB;IAE/B;IAEA,OAAO,SAAS,OAAO,OAAO,GAAG;KAC/B,GAAG;KACH;IACF,CAAC;GACH,SAAS,OAAO;IACd,IAAI,iBAAiB,YACf;SAAA,MAAM,QAAQ,SAAS,gDAAgD,GAEzE;IAAA;IAGJ,MAAM;GACR;EACF;EAEA,MAAM,MAAM,YAAY,MAAmB,OAAe,WAAwB;GAChF,SAAS,KAAK,QAAQ,MAAM,OAAO,MAAM,CAAC;EAC5C,CAAC;EAED,MAAM,QAAQ,IAAI,QAAQ;EAE1B,OAAO;CACT;AACF;AAEA,SAAS,gBAAgB,MAAuC;CAC9D,IAAI,CAAC,MAAM,QAAQ,KAAK,WAAW,SAAS,GAC1C;CAEF,MAAM,SAAS;CACf,MAAM,WAAW,KAAK,WAAW,UAAU,MACxC,SAAS,OAAO,SAAS,YAAY,KAAK,WAAW,MAAM,CAC9D;CACA,IAAI,OAAO,aAAa,UACtB,OAAO,SAAS,MAAM,CAAa;CAErC,OAAO;AACT"}

package/dist/plugins/tree-processor/plugin.d.mts

@@ -1,19 +0,0 @@
-import { HastElement as Element, HastNode as Node } from "../../types.mjs";
-import { Plugin } from "unified";
-//#region src/plugins/tree-processor/plugin.d.ts
-type MdxTreeProcessor = (node: Element, index: number, parent: Element) => void | Promise<void>;
-/**
- * Options for {@linkcode treeProcessorPlugin}.
- */
-type TreeProcessorPluginOptions = {
-  /** The processor. */
-  process: MdxTreeProcessor;
-};
-/**
- * A plugin that allows to process MDX tree nodes.
- * It can be async or sync.
- */
-declare const treeProcessorPlugin: Plugin<[TreeProcessorPluginOptions?], Node, Node>;
-//#endregion
-export { MdxTreeProcessor, treeProcessorPlugin };
-//# sourceMappingURL=plugin.d.mts.map

package/dist/plugins/tree-processor/plugin.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../../src/plugins/tree-processor/plugin.ts"],"mappings":";;;KAMY,oBACV,MAAM,SACN,eACA,QAAQ,mBACE;;;;KAKP;;EAEH,SAAS;;;;;;cAOE,qBAAqB,QAAQ,8BAA8B,MAAU"}

package/dist/plugins/tree-processor/plugin.mjs

@@ -1,21 +0,0 @@
-import { visit } from "unist-util-visit";
-//#region src/plugins/tree-processor/plugin.ts
-/**
-* A plugin that allows to process MDX tree nodes.
-* It can be async or sync.
-*/
-const treeProcessorPlugin = ({ process } = { process: () => {} }) => {
-	return async (tree) => {
-		const promises = [];
-		visit(tree, "element", function visitor(node, index, parent) {
-			const p = process(node, index, parent);
-			if (p instanceof Promise || Object.prototype.toString.call(p) === "[object Promise]") promises.push(p);
-		});
-		await Promise.allSettled(promises);
-		return tree;
-	};
-};
-//#endregion
-export { treeProcessorPlugin };
-
-//# sourceMappingURL=plugin.mjs.map

package/dist/plugins/tree-processor/plugin.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.mjs","names":[],"sources":["../../../src/plugins/tree-processor/plugin.ts"],"sourcesContent":["import type { Plugin } from \"unified\";\n\nimport { visit } from \"unist-util-visit\";\n\nimport type { HastElement, HastNode } from \"../../types\";\n\nexport type MdxTreeProcessor = (\n  node: HastElement,\n  index: number,\n  parent: HastElement,\n) => void | Promise<void>;\n\n/**\n * Options for {@linkcode treeProcessorPlugin}.\n */\ntype TreeProcessorPluginOptions = {\n  /** The processor. */\n  process: MdxTreeProcessor;\n};\n\n/**\n * A plugin that allows to process MDX tree nodes.\n * It can be async or sync.\n */\nexport const treeProcessorPlugin: Plugin<[TreeProcessorPluginOptions?], HastNode, HastNode> = (\n  { process } = { process: () => {} },\n) => {\n  return async (tree) => {\n    const promises: Promise<void>[] = [];\n\n    visit(\n      tree,\n      \"element\",\n      function visitor(node: HastElement, index: number, parent: HastElement): void {\n        const p = process(node, index, parent);\n        if (p instanceof Promise || Object.prototype.toString.call(p) === \"[object Promise]\") {\n          promises.push(p as Promise<void>);\n        }\n      },\n    );\n\n    await Promise.allSettled(promises);\n\n    return tree;\n  };\n};\n"],"mappings":";;;;;;AAwBA,MAAa,uBACX,EAAE,YAAY,EAAE,eAAe,CAAC,EAAE,MAC/B;CACH,OAAO,OAAO,SAAS;EACrB,MAAM,WAA4B,CAAC;EAEnC,MACE,MACA,WACA,SAAS,QAAQ,MAAmB,OAAe,QAA2B;GAC5E,MAAM,IAAI,QAAQ,MAAM,OAAO,MAAM;GACrC,IAAI,aAAa,WAAW,OAAO,UAAU,SAAS,KAAK,CAAC,MAAM,oBAChE,SAAS,KAAK,CAAkB;EAEpC,CACF;EAEA,MAAM,QAAQ,WAAW,QAAQ;EAEjC,OAAO;CACT;AACF"}

package/dist/types.d.mts

@@ -1,2 +0,0 @@
-import { Element, Node } from "hast";
-export type { Element as HastElement, Node as HastNode };