remark-flexible-toc 1.2.6 → 1.2.8

package/README.md

@@ -3,7 +3,10 @@
 **A robust Next.js newsletter `Next.js Weekly` is sponsoring me** 💖
 [![NextjsWeekly banner](./assets/next-js-weekly.png)](https://nextjsweekly.com/)
 
-A warm thanks 🙌 to [@ErfanEbrahimnia](https://github.com/ErfanEbrahimnia), [@recepkyk](https://github.com/recepkyk), and [@LSeaburg](https://github.com/LSeaburg) for the [support](https://github.com/sponsors/ipikuka) 💖
+**An outstanding Git-based CMS `Outstatic` is also sponsoring me** 💖
+[![Outstatic banner](./assets/outstatic-banner-dark.jpg)](https://outstatic.com/?utm_source=github&utm_medium=readme&utm_campaign=next-mdx-remote-client)
+
+A warm thanks 🙌 to [@ErfanEbrahimnia](https://github.com/ErfanEbrahimnia), [@avitorio](https://github.com/avitorio), [@recepkyk](https://github.com/recepkyk), and [@LSeaburg](https://github.com/LSeaburg) for the [support](https://github.com/sponsors/ipikuka) 💖
 
 ---
 
@@ -17,6 +20,8 @@ A warm thanks 🙌 to [@ErfanEbrahimnia](https://github.com/ErfanEbrahimnia), [@
 
 This package is a [**unified**][unified] ([**remark**][remark]) plugin **to expose the table of contents via `Vfile.data` or via an option reference in markdown.**
 
+**`remark-flexible-toc`** also exports `generateTocItemsFromMdast` to generate the table of contents items directly from an MDAST tree without requiring a unified processor or a VFile.
+
 [**unified**][unified] is a project that transforms content with abstract syntax trees (ASTs) using the new parser [**micromark**][micromark]. [**remark**][remark] adds support for markdown to unified. [**mdast**][mdast] is the Markdown Abstract Syntax Tree (AST) which is a specification for representing markdown in a syntax tree.
 
 **This plugin is a remark plugin that doesn't transform the MDAST but gets info from the MDAST.**
@@ -26,6 +31,7 @@ This package is a [**unified**][unified] ([**remark**][remark]) plugin **to expo
 **`remark-flexible-toc`** is useful if you want to get the table of contents (TOC) from the markdown/MDX document. It exposes the table of contents (TOC) in two ways:
 + by adding a `toc` object into `Vfile.data`
 + by mutating a reference array if provided in the options
++ by generating `TocItem[]` directly from an MDAST tree with `generateTocItemsFromMdast`
 
 ## Installation
 
@@ -137,6 +143,24 @@ Now, running both `node example.js` you will see that the same table of contents
 
 Without **`remark-flexible-toc`**, there wouldn't be any `toc` key in the `file.data`:
 
+#### Generating TOC items directly from MDAST
+
+If you already have an MDAST tree, you can generate the table of contents items directly without using the remark plugin, a unified processor, or a VFile.
+
+```js
+import { generateTocItemsFromMdast } from "remark-flexible-toc";
+
+const tocItems = generateTocItemsFromMdast(tree, {
+  maxDepth: 4,
+});
+
+console.log(tocItems);
+```
+
+The function returns `TocItem[]` and does not modify the MDAST tree.
+
+The available options are `maxDepth`, `skipLevels`, `skipParents`, `exclude`, and `prefix`.
+
 ## Options
 
 All options are **optional**.
@@ -164,6 +188,16 @@ use(remarkFlexibleToc, {
 } as FlexibleTocOptions);
 ```
 
+`generateTocItemsFromMdast` accepts only the options related to generating the TOC items. The plugin-specific `tocName`, `tocRef`, and `callback` options are not applicable.
+
+```ts
+type GenerateTocItemsOptions = Pick<
+  FlexibleTocOptions,
+  "maxDepth" | "skipLevels" | "skipParents" | "exclude" | "prefix"
+>;
+
+```
+
 #### `tocName`
 
 It is a **string** option in which the table of contents (TOC) is placed in the `vfile.data`. 
@@ -379,9 +413,13 @@ tocItem.numbering.join("-");
 
 This plugin does not modify the `mdast` (markdown abstract syntax tree), collects data from the `mdast` and adds information into the `vfile.data` if required.
 
+`generateTocItemsFromMdast` also does not modify the provided MDAST tree.
+
 ## Types
 
-This package is fully typed with [TypeScript][url-typescript]. The plugin exports the types `FlexibleTocOptions`, `HeadingParent`, `HeadingDepth`, `TocItem`.
+This package is fully typed with [TypeScript][url-typescript] and also exports the `generateTocItemsFromMdast` utility function.
+
+The plugin exports the types `FlexibleTocOptions`, `HeadingParent`, `HeadingDepth`, `TocItem` and `GenerateTocItemsOptions`.
 
 ## Compatibility
 

package/dist/index.d.ts

@@ -36,6 +36,8 @@ export type FlexibleTocOptions = {
     prefix?: string;
     callback?: (toc: TocItem[]) => undefined;
 };
+export type GenerateTocItemsOptions = Pick<FlexibleTocOptions, "maxDepth" | "skipLevels" | "skipParents" | "exclude" | "prefix">;
+export declare function generateTocItemsFromMdast(tree: Root, options?: GenerateTocItemsOptions): TocItem[];
 declare const RemarkFlexibleToc: Plugin<[FlexibleTocOptions?], Root>;
 export default RemarkFlexibleToc;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAKlC,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAExD,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAExF,MAAM,MAAM,aAAa,GACrB,MAAM,GACN,YAAY,GACZ,oBAAoB,GACpB,UAAU,GACV,WAAW,GACX,mBAAmB,CAAC;AAExB,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,YAAY,CAAC;IACpB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE;QACL,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;KAC5F,CAAC;CACH,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC;IAC/C,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,SAAS,CAAC;CAC1C,CAAC;AA4DF,QAAA,MAAM,iBAAiB,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,EAAE,IAAI,CAmF1D,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAKlC,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,EAAE,CAAC;AAExD,MAAM,MAAM,iBAAiB,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAExF,MAAM,MAAM,aAAa,GACvB,MAAM,GAAG,YAAY,GAAG,oBAAoB,GAAG,UAAU,GAAG,WAAW,GAAG,mBAAmB,CAAC;AAEhG,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEjD,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,YAAY,CAAC;IACpB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,IAAI,CAAC,EAAE;QACL,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;KAC5F,CAAC;CACH,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,UAAU,CAAC,EAAE,YAAY,EAAE,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,CAAC;IAC/C,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,SAAS,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,IAAI,CACxC,kBAAkB,EAClB,UAAU,GAAG,YAAY,GAAG,aAAa,GAAG,SAAS,GAAG,QAAQ,CACjE,CAAC;AA4DF,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,IAAI,EACV,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,EAAE,CA8DX;AAED,QAAA,MAAM,iBAAiB,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,EAAE,IAAI,CA+B1D,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/index.js

@@ -47,54 +47,59 @@ function addNumbering(arr) {
         tocItem.numbering = numbering;
     }
 }
-const RemarkFlexibleToc = (options) => {
+export function generateTocItemsFromMdast(tree, options) {
     const settings = Object.assign({}, DEFAULT_SETTINGS, options);
     const exludeRegexFilter = settings.exclude &&
         (Array.isArray(settings.exclude)
             ? new RegExp("^(" + settings.exclude.join("|") + ")$", "i")
             : new RegExp("^(" + settings.exclude + ")$", "i"));
-    return (tree, file) => {
-        const slugger = new GithubSlugger();
-        const tocItems = [];
-        visit(tree, "heading", (_node, _index, _parent) => {
-            /* v8 ignore next -- @preserve */
-            if (!_parent || typeof _index === "undefined")
-                return;
-            const depth = _node.depth;
-            const value = toString(_node, { includeImageAlt: false });
-            let href = `#${settings.prefix ?? ""}${slugger.slug(value)}`;
-            const parent = _parent.type;
-            // maxDepth check
-            if (depth > settings.maxDepth)
-                return CONTINUE;
-            // skipLevels check
-            if (settings.skipLevels.includes(depth))
-                return CONTINUE;
-            // skipParents check
-            if (parent !== "root" && settings.skipParents.includes(parent))
-                return CONTINUE;
-            // exclude check
-            if (exludeRegexFilter && exludeRegexFilter.test(value))
-                return CONTINUE;
-            // Other remark plugins can store custom data in node.data.hProperties
-            // I omitted node.data.hName and node.data.hChildren since not related with toc
-            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-            // @ts-ignore, vscode resolves the type but tsc build raises an error awkwardly, saying "hProperties" does not exist in "HeadingData".
-            const hProperties = _node.data?.hProperties;
-            const data = hProperties ? { ...hProperties } : undefined;
-            if (data?.["id"])
-                href = `#${data["id"]}`;
-            tocItems.push({
-                value,
-                href,
-                depth,
-                numbering: [],
-                parent,
-                ...(data && { data }),
-            });
+    const slugger = new GithubSlugger();
+    const tocItems = [];
+    visit(tree, "heading", (_node, _index, _parent) => {
+        /* v8 ignore next -- @preserve */
+        if (!_parent || typeof _index === "undefined")
+            return;
+        const depth = _node.depth;
+        const value = toString(_node, { includeImageAlt: false });
+        let href = `#${settings.prefix ?? ""}${slugger.slug(value)}`;
+        const parent = _parent.type;
+        // maxDepth check
+        if (depth > settings.maxDepth)
+            return CONTINUE;
+        // skipLevels check
+        if (settings.skipLevels.includes(depth))
+            return CONTINUE;
+        // skipParents check
+        if (parent !== "root" && settings.skipParents.includes(parent))
             return CONTINUE;
+        // exclude check
+        if (exludeRegexFilter && exludeRegexFilter.test(value))
+            return CONTINUE;
+        // Other remark plugins can store custom data in node.data.hProperties
+        // I omitted node.data.hName and node.data.hChildren since not related with toc
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore, vscode resolves the type but tsc build raises an error awkwardly, saying "hProperties" does not exist in "HeadingData".
+        const hProperties = _node.data?.hProperties;
+        const data = hProperties ? { ...hProperties } : undefined;
+        if (data?.["id"])
+            href = `#${data["id"]}`;
+        tocItems.push({
+            value,
+            href,
+            depth,
+            numbering: [],
+            parent,
+            ...(data && { data }),
         });
-        addNumbering(tocItems);
+        return CONTINUE;
+    });
+    addNumbering(tocItems);
+    return tocItems;
+}
+const RemarkFlexibleToc = (options) => {
+    const settings = Object.assign({}, DEFAULT_SETTINGS, options);
+    return (tree, file) => {
+        const tocItems = generateTocItemsFromMdast(tree, options);
         // it is allowed to modify the TOC in the callback
         settings.callback?.(tocItems);
         // method - 1 for exposing the data via vfile.data **************************

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,aAAa,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAuDhD,MAAM,gBAAgB,GAAuB;IAC3C,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,CAAC;IACf,WAAW,EAAE,EAAE;CAChB,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAS,YAAY,CAAC,GAAc;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE5B,IAAI,SAAmB,CAAC;QAExB,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/C,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QACtD,MAAM,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAE9D,IAAI,CAAC,aAAa,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;aAAM,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,SAAS,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC;YAC/B,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACzB,CAAC;aAAM,IAAI,KAAK,GAAG,SAAS,EAAE,CAAC;YAC7B,SAAS,GAAG;gBACV,GAAG,aAAa;gBAChB,GAAI,KAAK,CAAC,IAAI,CACZ,EAAE,MAAM,EAAE,KAAK,GAAG,SAAS,EAAE,EAAE,wEAAwE;gBACvG,GAAG,EAAE,CAAC,CAAC,CACW;aACrB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,yBAAyB;YACzB,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC1C,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACzB,CAAC;QAED,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAChC,CAAC;AACH,CAAC;AAED,MAAM,iBAAiB,GAAwC,CAAC,OAAO,EAAE,EAAE;IACzE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC5B,EAAE,EACF,gBAAgB,EAChB,OAAO,CAC+B,CAAC;IAEzC,MAAM,iBAAiB,GACrB,QAAQ,CAAC,OAAO;QAChB,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC9B,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC;YAC3D,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,OAAO,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAEvD,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAc,EAAE,CAAC;QAE/B,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;YAChD,iCAAiC;YACjC,IAAI,CAAC,OAAO,IAAI,OAAO,MAAM,KAAK,WAAW;gBAAE,OAAO;YAEtD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;YAC1B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;YAC1D,IAAI,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;YAE5B,iBAAiB;YACjB,IAAI,KAAK,GAAG,QAAQ,CAAC,QAAQ;gBAAE,OAAO,QAAQ,CAAC;YAE/C,mBAAmB;YACnB,IAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,OAAO,QAAQ,CAAC;YAEzD,oBAAoB;YACpB,IAAI,MAAM,KAAK,MAAM,IAAI,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAAE,OAAO,QAAQ,CAAC;YAEhF,gBAAgB;YAChB,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;gBAAE,OAAO,QAAQ,CAAC;YAExE,sEAAsE;YACtE,+EAA+E;YAE/E,6DAA6D;YAC7D,sIAAsI;YACtI,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC;YAC5C,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;YAE1D,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC;gBAAE,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAE1C,QAAQ,CAAC,IAAI,CAAC;gBACZ,KAAK;gBACL,IAAI;gBACJ,KAAK;gBACL,SAAS,EAAE,EAAE;gBACb,MAAM;gBACN,GAAG,CAAC,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC;aACtB,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,QAAQ,CAAC,CAAC;QAEvB,kDAAkD;QAClD,QAAQ,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC;QAE9B,6EAA6E;QAE7E,0DAA0D;QAC1D,2DAA2D;QAC3D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;QAE5C,6EAA6E;QAE7E,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,6DAA6D;YAC7D,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YAE3B,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,yDAAyD;gBACzD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC","sourcesContent":["import type { Plugin } from \"unified\";\nimport type { Root } from \"mdast\";\nimport { visit, CONTINUE } from \"unist-util-visit\";\nimport GithubSlugger from \"github-slugger\";\nimport { toString } from \"mdast-util-to-string\";\n\nexport type Prettify<T> = { [K in keyof T]: T[K] } & {};\n\nexport type PartiallyRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;\n\nexport type HeadingParent =\n  | \"root\"\n  | \"blockquote\"\n  | \"footnoteDefinition\"\n  | \"listItem\"\n  | \"container\"\n  | \"mdxJsxFlowElement\";\n\nexport type HeadingDepth = 1 | 2 | 3 | 4 | 5 | 6;\n\nexport type TocItem = {\n  value: string;\n  href: string;\n  depth: HeadingDepth;\n  numbering: number[];\n  parent: HeadingParent;\n  data?: {\n    [PropertyName: string]: string | number | boolean | (string | number)[] | null | undefined;\n  };\n};\n\n/**\n * tocName (default: \"toc\") - the key name which is attached into vfile.data\n * tocRef (default: []) — another way of exposing the tocItems\n * maxDepth (default: 6) — max heading depth to include in the table of contents; this is inclusive: when set to 3, level three headings are included\n * skipLevels (default: [1]) — disallowed heading levels, by default the article h1 is not expected to be in the TOC\n * skipParents (default: []) — disallow headings to be children of certain node types, (the \"root\" can not be skipped)\n * exclude — headings to skip, wrapped in new RegExp('^(' + value + ')$', 'i'); any heading matching this expression will not be present in the table of contents\n * prefix - the text that will be attached to headings as prefix, like \"text-prefix-\"\n * callback - It is a callback function to take the array of toc items as an argument\n */\nexport type FlexibleTocOptions = {\n  tocName?: string;\n  tocRef?: TocItem[];\n  maxDepth?: HeadingDepth;\n  skipLevels?: HeadingDepth[];\n  skipParents?: Exclude<HeadingParent, \"root\">[];\n  exclude?: string | string[];\n  prefix?: string;\n  callback?: (toc: TocItem[]) => undefined;\n};\n\ntype PartiallyRequiredFlexibleTocOptions = Prettify<\n  PartiallyRequired<\n    FlexibleTocOptions,\n    \"tocName\" | \"tocRef\" | \"maxDepth\" | \"skipLevels\" | \"skipParents\"\n  >\n>;\n\nconst DEFAULT_SETTINGS: FlexibleTocOptions = {\n  tocName: \"toc\",\n  tocRef: [],\n  maxDepth: 6,\n  skipLevels: [1],\n  skipParents: [],\n};\n\n/**\n * adds numberings to the TOC items.\n * why \"number[]\"? It is because up to you joining with dot or dash or slicing the first number (reserved for h1)\n *\n * [1]\n * [1,1]\n * [1,2]\n * [1,2,1]\n */\nfunction addNumbering(arr: TocItem[]) {\n  for (let i = 0; i < arr.length; i++) {\n    const tocItem = arr[i];\n    const depth = tocItem.depth;\n\n    let numbering: number[];\n\n    const prevObj = i > 0 ? arr[i - 1] : undefined;\n    const prevDepth = prevObj ? prevObj.depth : undefined;\n    const prevNumbering = prevObj ? prevObj.numbering : undefined;\n\n    if (!prevNumbering || !prevDepth) {\n      numbering = Array.from({ length: depth }, () => 1);\n    } else if (depth === prevDepth) {\n      numbering = [...prevNumbering];\n      numbering[depth - 1]++;\n    } else if (depth > prevDepth) {\n      numbering = [\n        ...prevNumbering,\n        ...(Array.from(\n          { length: depth - prevDepth }, // if depth is more bigger than prevDepth, put more \"1\" inside the array\n          () => 1,\n        ) as HeadingDepth[]),\n      ];\n    } else {\n      // if (depth < prevDepth)\n      numbering = prevNumbering.slice(0, depth);\n      numbering[depth - 1]++;\n    }\n\n    tocItem.numbering = numbering;\n  }\n}\n\nconst RemarkFlexibleToc: Plugin<[FlexibleTocOptions?], Root> = (options) => {\n  const settings = Object.assign(\n    {},\n    DEFAULT_SETTINGS,\n    options,\n  ) as PartiallyRequiredFlexibleTocOptions;\n\n  const exludeRegexFilter =\n    settings.exclude &&\n    (Array.isArray(settings.exclude)\n      ? new RegExp(\"^(\" + settings.exclude.join(\"|\") + \")$\", \"i\")\n      : new RegExp(\"^(\" + settings.exclude + \")$\", \"i\"));\n\n  return (tree, file) => {\n    const slugger = new GithubSlugger();\n    const tocItems: TocItem[] = [];\n\n    visit(tree, \"heading\", (_node, _index, _parent) => {\n      /* v8 ignore next -- @preserve */\n      if (!_parent || typeof _index === \"undefined\") return;\n\n      const depth = _node.depth;\n      const value = toString(_node, { includeImageAlt: false });\n      let href = `#${settings.prefix ?? \"\"}${slugger.slug(value)}`;\n      const parent = _parent.type;\n\n      // maxDepth check\n      if (depth > settings.maxDepth) return CONTINUE;\n\n      // skipLevels check\n      if (settings.skipLevels.includes(depth)) return CONTINUE;\n\n      // skipParents check\n      if (parent !== \"root\" && settings.skipParents.includes(parent)) return CONTINUE;\n\n      // exclude check\n      if (exludeRegexFilter && exludeRegexFilter.test(value)) return CONTINUE;\n\n      // Other remark plugins can store custom data in node.data.hProperties\n      // I omitted node.data.hName and node.data.hChildren since not related with toc\n\n      // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n      // @ts-ignore, vscode resolves the type but tsc build raises an error awkwardly, saying \"hProperties\" does not exist in \"HeadingData\".\n      const hProperties = _node.data?.hProperties;\n      const data = hProperties ? { ...hProperties } : undefined;\n\n      if (data?.[\"id\"]) href = `#${data[\"id\"]}`;\n\n      tocItems.push({\n        value,\n        href,\n        depth,\n        numbering: [],\n        parent,\n        ...(data && { data }),\n      });\n\n      return CONTINUE;\n    });\n\n    addNumbering(tocItems);\n\n    // it is allowed to modify the TOC in the callback\n    settings.callback?.(tocItems);\n\n    // method - 1 for exposing the data via vfile.data **************************\n\n    // other plugins are not allowed to mutate the exposed TOC\n    // The spreading is slower than push but need to fresh copy\n    file.data[settings.tocName] = [...tocItems];\n\n    // method - 2 for exposing the data via reference array *********************\n\n    if (options?.tocRef) {\n      // prevent dublication if the plugin is called more than once\n      settings.tocRef.length = 0;\n\n      tocItems.forEach((tocItem) => {\n        // the tocRef is not allowed to mutate the vfile.data.toc\n        settings.tocRef.push(tocItem);\n      });\n    }\n  };\n};\n\nexport default RemarkFlexibleToc;\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,aAAa,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAuDhD,MAAM,gBAAgB,GAAuB;IAC3C,OAAO,EAAE,KAAK;IACd,MAAM,EAAE,EAAE;IACV,QAAQ,EAAE,CAAC;IACX,UAAU,EAAE,CAAC,CAAC,CAAC;IACf,WAAW,EAAE,EAAE;CAChB,CAAC;AAEF;;;;;;;;GAQG;AACH,SAAS,YAAY,CAAC,GAAc;IAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAE5B,IAAI,SAAmB,CAAC;QAExB,MAAM,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/C,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QACtD,MAAM,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAE9D,IAAI,CAAC,aAAa,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QACrD,CAAC;aAAM,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,SAAS,GAAG,CAAC,GAAG,aAAa,CAAC,CAAC;YAC/B,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACzB,CAAC;aAAM,IAAI,KAAK,GAAG,SAAS,EAAE,CAAC;YAC7B,SAAS,GAAG;gBACV,GAAG,aAAa;gBAChB,GAAI,KAAK,CAAC,IAAI,CACZ,EAAE,MAAM,EAAE,KAAK,GAAG,SAAS,EAAE,EAAE,wEAAwE;gBACvG,GAAG,EAAE,CAAC,CAAC,CACW;aACrB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,yBAAyB;YACzB,SAAS,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC1C,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;QACzB,CAAC;QAED,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAChC,CAAC;AACH,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,IAAU,EACV,OAAiC;IAEjC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC5B,EAAE,EACF,gBAAgB,EAChB,OAAO,CAC+B,CAAC;IAEzC,MAAM,iBAAiB,GACrB,QAAQ,CAAC,OAAO;QAChB,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC9B,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,CAAC;YAC3D,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,QAAQ,CAAC,OAAO,GAAG,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAEvD,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;IACpC,MAAM,QAAQ,GAAc,EAAE,CAAC;IAE/B,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;QAChD,iCAAiC;QACjC,IAAI,CAAC,OAAO,IAAI,OAAO,MAAM,KAAK,WAAW;YAAE,OAAO;QAEtD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC,CAAC;QAC1D,IAAI,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;QAE5B,iBAAiB;QACjB,IAAI,KAAK,GAAG,QAAQ,CAAC,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAE/C,mBAAmB;QACnB,IAAI,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,QAAQ,CAAC;QAEzD,oBAAoB;QACpB,IAAI,MAAM,KAAK,MAAM,IAAI,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,QAAQ,CAAC;QAEhF,gBAAgB;QAChB,IAAI,iBAAiB,IAAI,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,QAAQ,CAAC;QAExE,sEAAsE;QACtE,+EAA+E;QAE/E,6DAA6D;QAC7D,sIAAsI;QACtI,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC;QAC5C,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1D,IAAI,IAAI,EAAE,CAAC,IAAI,CAAC;YAAE,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAE1C,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK;YACL,IAAI;YACJ,KAAK;YACL,SAAS,EAAE,EAAE;YACb,MAAM;YACN,GAAG,CAAC,IAAI,IAAI,EAAE,IAAI,EAAE,CAAC;SACtB,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,QAAQ,CAAC,CAAC;IAEvB,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,iBAAiB,GAAwC,CAAC,OAAO,EAAE,EAAE;IACzE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAC5B,EAAE,EACF,gBAAgB,EAChB,OAAO,CAC+B,CAAC;IAEzC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACpB,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAE1D,kDAAkD;QAClD,QAAQ,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC;QAE9B,6EAA6E;QAE7E,0DAA0D;QAC1D,2DAA2D;QAC3D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;QAE5C,6EAA6E;QAE7E,IAAI,OAAO,EAAE,MAAM,EAAE,CAAC;YACpB,6DAA6D;YAC7D,QAAQ,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;YAE3B,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,yDAAyD;gBACzD,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC","sourcesContent":["import type { Plugin } from \"unified\";\nimport type { Root } from \"mdast\";\nimport { visit, CONTINUE } from \"unist-util-visit\";\nimport GithubSlugger from \"github-slugger\";\nimport { toString } from \"mdast-util-to-string\";\n\nexport type Prettify<T> = { [K in keyof T]: T[K] } & {};\n\nexport type PartiallyRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;\n\nexport type HeadingParent =\n  \"root\" | \"blockquote\" | \"footnoteDefinition\" | \"listItem\" | \"container\" | \"mdxJsxFlowElement\";\n\nexport type HeadingDepth = 1 | 2 | 3 | 4 | 5 | 6;\n\nexport type TocItem = {\n  value: string;\n  href: string;\n  depth: HeadingDepth;\n  numbering: number[];\n  parent: HeadingParent;\n  data?: {\n    [PropertyName: string]: string | number | boolean | (string | number)[] | null | undefined;\n  };\n};\n\n/**\n * tocName (default: \"toc\") - the key name which is attached into vfile.data\n * tocRef (default: []) — another way of exposing the tocItems\n * maxDepth (default: 6) — max heading depth to include in the table of contents; this is inclusive: when set to 3, level three headings are included\n * skipLevels (default: [1]) — disallowed heading levels, by default the article h1 is not expected to be in the TOC\n * skipParents (default: []) — disallow headings to be children of certain node types, (the \"root\" can not be skipped)\n * exclude — headings to skip, wrapped in new RegExp('^(' + value + ')$', 'i'); any heading matching this expression will not be present in the table of contents\n * prefix - the text that will be attached to headings as prefix, like \"text-prefix-\"\n * callback - It is a callback function to take the array of toc items as an argument\n */\nexport type FlexibleTocOptions = {\n  tocName?: string;\n  tocRef?: TocItem[];\n  maxDepth?: HeadingDepth;\n  skipLevels?: HeadingDepth[];\n  skipParents?: Exclude<HeadingParent, \"root\">[];\n  exclude?: string | string[];\n  prefix?: string;\n  callback?: (toc: TocItem[]) => undefined;\n};\n\nexport type GenerateTocItemsOptions = Pick<\n  FlexibleTocOptions,\n  \"maxDepth\" | \"skipLevels\" | \"skipParents\" | \"exclude\" | \"prefix\"\n>;\n\ntype PartiallyRequiredFlexibleTocOptions = Prettify<\n  PartiallyRequired<\n    FlexibleTocOptions,\n    \"tocName\" | \"tocRef\" | \"maxDepth\" | \"skipLevels\" | \"skipParents\"\n  >\n>;\n\nconst DEFAULT_SETTINGS: FlexibleTocOptions = {\n  tocName: \"toc\",\n  tocRef: [],\n  maxDepth: 6,\n  skipLevels: [1],\n  skipParents: [],\n};\n\n/**\n * adds numberings to the TOC items.\n * why \"number[]\"? It is because up to you joining with dot or dash or slicing the first number (reserved for h1)\n *\n * [1]\n * [1,1]\n * [1,2]\n * [1,2,1]\n */\nfunction addNumbering(arr: TocItem[]) {\n  for (let i = 0; i < arr.length; i++) {\n    const tocItem = arr[i];\n    const depth = tocItem.depth;\n\n    let numbering: number[];\n\n    const prevObj = i > 0 ? arr[i - 1] : undefined;\n    const prevDepth = prevObj ? prevObj.depth : undefined;\n    const prevNumbering = prevObj ? prevObj.numbering : undefined;\n\n    if (!prevNumbering || !prevDepth) {\n      numbering = Array.from({ length: depth }, () => 1);\n    } else if (depth === prevDepth) {\n      numbering = [...prevNumbering];\n      numbering[depth - 1]++;\n    } else if (depth > prevDepth) {\n      numbering = [\n        ...prevNumbering,\n        ...(Array.from(\n          { length: depth - prevDepth }, // if depth is more bigger than prevDepth, put more \"1\" inside the array\n          () => 1,\n        ) as HeadingDepth[]),\n      ];\n    } else {\n      // if (depth < prevDepth)\n      numbering = prevNumbering.slice(0, depth);\n      numbering[depth - 1]++;\n    }\n\n    tocItem.numbering = numbering;\n  }\n}\n\nexport function generateTocItemsFromMdast(\n  tree: Root,\n  options?: GenerateTocItemsOptions,\n): TocItem[] {\n  const settings = Object.assign(\n    {},\n    DEFAULT_SETTINGS,\n    options,\n  ) as PartiallyRequiredFlexibleTocOptions;\n\n  const exludeRegexFilter =\n    settings.exclude &&\n    (Array.isArray(settings.exclude)\n      ? new RegExp(\"^(\" + settings.exclude.join(\"|\") + \")$\", \"i\")\n      : new RegExp(\"^(\" + settings.exclude + \")$\", \"i\"));\n\n  const slugger = new GithubSlugger();\n  const tocItems: TocItem[] = [];\n\n  visit(tree, \"heading\", (_node, _index, _parent) => {\n    /* v8 ignore next -- @preserve */\n    if (!_parent || typeof _index === \"undefined\") return;\n\n    const depth = _node.depth;\n    const value = toString(_node, { includeImageAlt: false });\n    let href = `#${settings.prefix ?? \"\"}${slugger.slug(value)}`;\n    const parent = _parent.type;\n\n    // maxDepth check\n    if (depth > settings.maxDepth) return CONTINUE;\n\n    // skipLevels check\n    if (settings.skipLevels.includes(depth)) return CONTINUE;\n\n    // skipParents check\n    if (parent !== \"root\" && settings.skipParents.includes(parent)) return CONTINUE;\n\n    // exclude check\n    if (exludeRegexFilter && exludeRegexFilter.test(value)) return CONTINUE;\n\n    // Other remark plugins can store custom data in node.data.hProperties\n    // I omitted node.data.hName and node.data.hChildren since not related with toc\n\n    // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n    // @ts-ignore, vscode resolves the type but tsc build raises an error awkwardly, saying \"hProperties\" does not exist in \"HeadingData\".\n    const hProperties = _node.data?.hProperties;\n    const data = hProperties ? { ...hProperties } : undefined;\n\n    if (data?.[\"id\"]) href = `#${data[\"id\"]}`;\n\n    tocItems.push({\n      value,\n      href,\n      depth,\n      numbering: [],\n      parent,\n      ...(data && { data }),\n    });\n\n    return CONTINUE;\n  });\n\n  addNumbering(tocItems);\n\n  return tocItems;\n}\n\nconst RemarkFlexibleToc: Plugin<[FlexibleTocOptions?], Root> = (options) => {\n  const settings = Object.assign(\n    {},\n    DEFAULT_SETTINGS,\n    options,\n  ) as PartiallyRequiredFlexibleTocOptions;\n\n  return (tree, file) => {\n    const tocItems = generateTocItemsFromMdast(tree, options);\n\n    // it is allowed to modify the TOC in the callback\n    settings.callback?.(tocItems);\n\n    // method - 1 for exposing the data via vfile.data **************************\n\n    // other plugins are not allowed to mutate the exposed TOC\n    // The spreading is slower than push but need to fresh copy\n    file.data[settings.tocName] = [...tocItems];\n\n    // method - 2 for exposing the data via reference array *********************\n\n    if (options?.tocRef) {\n      // prevent dublication if the plugin is called more than once\n      settings.tocRef.length = 0;\n\n      tocItems.forEach((tocItem) => {\n        // the tocRef is not allowed to mutate the vfile.data.toc\n        settings.tocRef.push(tocItem);\n      });\n    }\n  };\n};\n\nexport default RemarkFlexibleToc;\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-flexible-toc",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "Remark plugin to expose the table of contents via Vfile.data or via an option reference",
   "type": "module",
   "main": "./dist/index.js",
@@ -54,15 +54,16 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@types/node": "^24.12.4",
-    "@vitest/coverage-v8": "^4.1.7",
-    "@vitest/eslint-plugin": "^1.6.18",
+    "@types/node": "^26.6.5",
+    "@vitest/coverage-v8": "^4.1.12",
+    "@vitest/eslint-plugin": "^1.6.27",
     "dedent": "^1.7.2",
-    "eslint": "^10.4.0",
+    "eslint": "^10.13.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.5",
-    "globals": "^17.6.0",
-    "prettier": "^3.8.3",
+    "eslint-plugin-prettier": "^5.5.7",
+    "globals": "^17.13.0",
+    "mdast-util-from-markdown": "^2.1.0",
+    "prettier": "^3.9.10",
     "rehype-format": "^5.0.1",
     "rehype-stringify": "^10.0.1",
     "remark-custom-header-id": "^1.0.0",
@@ -70,11 +71,11 @@
     "remark-parse": "^11.0.0",
     "remark-rehype": "^11.1.2",
     "rimraf": "^6.1.3",
-    "type-coverage": "^2.29.7",
+    "type-coverage": "^2.30.4",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.60.0",
+    "typescript-eslint": "^8.71.2",
     "unified": "^11.0.5",
-    "vitest": "^4.1.7"
+    "vitest": "^4.1.12"
   },
   "dependencies": {
     "@types/mdast": "^4.0.4",