@temelj/mdx 0.1.9 → 0.3.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/compiler.js

@@ -49,7 +49,7 @@ export class MdxCompiler {
         }
         return this;
     }
-    async compile(source, { frontmatterOnly = false, frontmatterSchema, mdxOptions } = {}) {
+    async compile(source, { frontmatterOnly = false, frontmatterSchema, mdxOptions, } = {}) {
         const vfile = new VFile({
             value: source,
             // Needed so vfile doesn't need to access fs.
@@ -59,14 +59,16 @@ export class MdxCompiler {
             messages: {},
         });
         matter(vfile, { strip: true });
-        const remarkPlugins = this.mdxOptions.remarkPlugins ?? this.remarkPlugins;
-        const rehypePlugins = this.mdxOptions.rehypePlugins ?? this.rehypePlugins;
-        if (mdxOptions?.remarkPlugins) {
-            remarkPlugins.push(...mdxOptions.remarkPlugins);
-        }
-        if (mdxOptions?.rehypePlugins) {
-            rehypePlugins.push(...mdxOptions.rehypePlugins);
-        }
+        const remarkPlugins = [
+            ...this.remarkPlugins,
+            ...(this.mdxOptions?.remarkPlugins ?? []),
+            ...(mdxOptions?.remarkPlugins ?? []),
+        ];
+        const rehypePlugins = [
+            ...this.rehypePlugins,
+            ...(this.mdxOptions?.rehypePlugins ?? []),
+            ...(mdxOptions?.rehypePlugins ?? []),
+        ];
         let compiled;
         if (!frontmatterOnly) {
             const compiledFile = await compileMdxJs(vfile, {

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

@@ -40,13 +40,14 @@ export function syntaxHighlightPlugin(options = {}) {
                 hastOptions.transformers = [];
             }
             if (options.highlight) {
-                hastOptions.transformers.push(transformerNotationHighlight(options.highlight.transformer));
+                hastOptions.transformers.push(transformerNotationHighlight({
+                    ...(options.highlight.transformer ?? {}),
+                    matchAlgorithm: "v3",
+                }));
             }
+            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 +72,7 @@ export function syntaxHighlightPlugin(options = {}) {
                         }
                         lineIndex++;
                     }
+                    lineCount = lineIndex;
                     if (meta.showLineNumbers) {
                         if (typeof node.properties.style !== "string") {
                             node.properties.style = "";
@@ -83,12 +85,24 @@ export function syntaxHighlightPlugin(options = {}) {
                 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: {
-                        ...hastPre.properties,
-                        dataFileName: meta.fileName,
-                    },
+                    properties,
                 });
             }
             catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temelj/mdx",
-  "version": "0.1.9",
+  "version": "0.3.0",
   "description": "Utilities for working with MDX.",
   "keywords": [
     "mdx"
@@ -24,22 +24,22 @@
     }
   },
   "dependencies": {
-    "@temelj/iterator": "^0.2.0",
+    "@temelj/iterator": "^0.2.1",
     "@mdx-js/mdx": "^3.1.0",
-    "@shikijs/transformers": "^1.23.1",
+    "@shikijs/transformers": "^2.3.0",
     "@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": "^2.3.0",
     "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/compiler.d.ts

@@ -34,6 +34,6 @@ export declare class MdxCompiler {
     constructor(mdxOptions?: MdxJsCompileOptions);
     withRemarkPlugin<TOptions>(plugin: (options?: TOptions) => PluginFactory, options?: TOptions): MdxCompiler;
     withRehypePlugin<TOptions>(plugin: (options?: TOptions) => PluginFactory, options?: TOptions): MdxCompiler;
-    compile<TFrontmatterSchema extends z.ZodSchema>(source: MdxSource, { frontmatterOnly, frontmatterSchema, mdxOptions }?: MdxCompileOptions<TFrontmatterSchema>): Promise<MdxArtifact<z.output<TFrontmatterSchema>>>;
+    compile<TFrontmatterSchema extends z.ZodSchema>(source: MdxSource, { frontmatterOnly, frontmatterSchema, mdxOptions, }?: MdxCompileOptions<TFrontmatterSchema>): Promise<MdxArtifact<z.output<TFrontmatterSchema>>>;
 }
 //# sourceMappingURL=compiler.d.ts.map

package/types/compiler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compiler.d.ts","sourceRoot":"","sources":["../src/compiler.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,IAAI,mBAAmB,EAC3C,MAAM,aAAa,CAAC;AACrB,OAAO,uBAAuB,MAAM,oBAAoB,CAAC;AACzD,OAAO,eAAe,MAAM,YAAY,CAAC;AAIzC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAChC,YAAY,SAAS,CAAC,CAAC,SAAS;IAEhC,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAEtC,iBAAiB,CAAC,EAAE,YAAY,CAAC;IACjC,UAAU,CAAC,EAAE,mBAAmB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;gBAG5C,UAAU,GAAE,mBAAwB;IAO/B,gBAAgB,CAAC,QAAQ,EAC9B,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,KAAK,aAAa,EAC7C,OAAO,CAAC,EAAE,QAAQ,GACjB,WAAW;IASP,gBAAgB,CAAC,QAAQ,EAC9B,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,KAAK,aAAa,EAC7C,OAAO,CAAC,EAAE,QAAQ,GACjB,WAAW;IASD,OAAO,CAClB,kBAAkB,SAAS,CAAC,CAAC,SAAS,EAEtC,MAAM,EAAE,SAAS,EACjB,EAAE,eAAuB,EAAE,iBAAiB,EAAE,UAAU,EAAE,GACxD,iBAAiB,CAAC,kBAAkB,CAAM,GAC3C,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;CA0CtD"}
+{"version":3,"file":"compiler.d.ts","sourceRoot":"","sources":["../src/compiler.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,cAAc,IAAI,mBAAmB,EAC3C,MAAM,aAAa,CAAC;AACrB,OAAO,uBAAuB,MAAM,oBAAoB,CAAC;AACzD,OAAO,eAAe,MAAM,YAAY,CAAC;AAIzC,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAE5C;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,YAAY,SAAS,CAAC,CAAC,SAAS;IACjE,eAAe,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACtC,iBAAiB,CAAC,EAAE,YAAY,CAAC;IACjC,UAAU,CAAC,EAAE,mBAAmB,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACjE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAsB;IACjD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;gBAE3B,UAAU,GAAE,mBAAwB;IAMhD,gBAAgB,CAAC,QAAQ,EAC9B,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,KAAK,aAAa,EAC7C,OAAO,CAAC,EAAE,QAAQ,GACjB,WAAW;IASP,gBAAgB,CAAC,QAAQ,EAC9B,MAAM,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,KAAK,aAAa,EAC7C,OAAO,CAAC,EAAE,QAAQ,GACjB,WAAW;IASD,OAAO,CAAC,kBAAkB,SAAS,CAAC,CAAC,SAAS,EACzD,MAAM,EAAE,SAAS,EACjB,EACE,eAAuB,EACvB,iBAAiB,EACjB,UAAU,GACX,GAAE,iBAAiB,CAAC,kBAAkB,CAAM,GAC5C,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC;CA2CtD"}

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,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;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;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,CA8Jf"}
+{"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,CA2Kf"}