@temelj/mdx 0.1.8 → 0.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Flinect
+Copyright (c) 2025 Flinect
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/esm/plugins/syntax-highlight/plugin.js

@@ -1,5 +1,5 @@
 import { toString as hastToString } from "hast-util-to-string";
-import { codeToHast, } from "shiki";
+import { codeToHast, ShikiError, } from "shiki";
 import { visit } from "unist-util-visit";
 import { transformerNotationHighlight, } from "@shikijs/transformers";
 import { numericRangeContains } from "@temelj/iterator";
@@ -42,11 +42,9 @@ export function syntaxHighlightPlugin(options = {}) {
             if (options.highlight) {
                 hastOptions.transformers.push(transformerNotationHighlight(options.highlight.transformer));
             }
+            let lineCount = 0;
             hastOptions.transformers.push({
                 code(node) {
-                    if (options.languageClassNamePrefix) {
-                        this.addClassToHast(node, `${options.languageClassNamePrefix}${lang}`);
-                    }
                     let lineIndex = 0;
                     for (const line of node.children.filter((node) => node.type === "element")) {
                         line.properties["data-line"] = lineIndex + 1;
@@ -71,6 +69,7 @@ export function syntaxHighlightPlugin(options = {}) {
                         }
                         lineIndex++;
                     }
+                    lineCount = lineIndex;
                     if (meta.showLineNumbers) {
                         if (typeof node.properties.style !== "string") {
                             node.properties.style = "";
@@ -79,16 +78,39 @@ export function syntaxHighlightPlugin(options = {}) {
                     }
                 },
             });
-            const hast = await codeToHast(sourceCode, hastOptions);
-            // Insert highlighted code into parent
-            const hastPre = hast.children[0];
-            parent.children.splice(index, 1, {
-                ...hastPre,
-                properties: {
+            try {
+                const hast = await codeToHast(sourceCode, hastOptions);
+                // Insert highlighted code into parent
+                const hastPre = hast.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")) {
+                        // Skip if the block is math block.
+                        return;
+                    }
+                }
+                throw error;
+            }
         }
         visit(tree, "element", (node, index, parent) => {
             promises.push(visitor(node, index, parent));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temelj/mdx",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "description": "Utilities for working with MDX.",
   "keywords": [
     "mdx"
@@ -26,20 +26,20 @@
   "dependencies": {
     "@temelj/iterator": "^0.2.0",
     "@mdx-js/mdx": "^3.1.0",
-    "@shikijs/transformers": "^1.23.1",
+    "@shikijs/transformers": "^1.27.2",
     "@types/hast": "^3.0.4",
     "github-slugger": "^2.0.0",
     "hast": "^1.0.0",
     "hast-util-to-string": "^3.0.1",
     "remark-frontmatter": "^5.0.0",
     "remark-gfm": "^4.0.0",
-    "shiki": "^1.23.1",
+    "shiki": "^1.27.2",
     "unified": "^11.0.5",
     "unist-util-remove": "^4.0.0",
     "unist-util-visit": "^5.0.0",
     "vfile": "^6.0.3",
     "vfile-matter": "^5.0.0",
-    "zod": "^3.23.8"
+    "zod": "^3.24.1"
   },
   "devDependencies": {
     "@types/node": "^20.9.0"

package/types/plugins/syntax-highlight/plugin.d.ts

@@ -2,14 +2,16 @@ import { type BundledLanguage, type BundledTheme, type CodeToHastOptions } from
 import { type TransformerNotationHighlightOptions } from "@shikijs/transformers";
 import type { PluginFactory } from "../../types.js";
 type ShikiHastOptions = Partial<CodeToHastOptions<BundledLanguage, BundledTheme>>;
+type SyntaxDataAttribute = "source-code" | "language" | "line-count";
 /**
  * Options for {@linkcode syntaxHighlightPlugin}.
  */
 export interface SyntaxHighlightPluginOptions {
     /**
-     * A prefix for the language class name on the code tag.
+     * Include these data attributes on the `<pre>` element.
+     * These might be useful to have when building custom code components.
      */
-    languageClassNamePrefix?: string;
+    includeDataAttributes?: SyntaxDataAttribute[];
     /**
      * Options for the highlight transformer.
      */

package/types/plugins/syntax-highlight/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/syntax-highlight/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EACvB,MAAM,OAAO,CAAC;AAEf,OAAO,EAEL,KAAK,mCAAmC,EACzC,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EAAyB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAG3E,KAAK,gBAAgB,GAAG,OAAO,CAC7B,iBAAiB,CAAC,eAAe,EAAE,YAAY,CAAC,CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,WAAW,CAAC,EAAE,mCAAmC,CAAC;KACnD,CAAC;IACF;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,GAAE,4BAAiC,GACzC,aAAa,CAsJf"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/syntax-highlight/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EAEvB,MAAM,OAAO,CAAC;AAEf,OAAO,EAEL,KAAK,mCAAmC,EACzC,MAAM,uBAAuB,CAAC;AAG/B,OAAO,KAAK,EAAyB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAG3E,KAAK,gBAAgB,GAAG,OAAO,CAC7B,iBAAiB,CAAC,eAAe,EAAE,YAAY,CAAC,CACjD,CAAC;AAEF,KAAK,mBAAmB,GAAG,aAAa,GAAG,UAAU,GAAG,YAAY,CAAC;AAErE;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,qBAAqB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE9C;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,WAAW,CAAC,EAAE,mCAAmC,CAAC;KACnD,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QACZ;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IAEF;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,GAAE,4BAAiC,GACzC,aAAa,CAwKf"}