astro-custom-toc 2.0.45 → 3.0.0

package/README.md

@@ -1,6 +1,6 @@
 # astro-custom-toc
 
-Astro Integration to generate a customizable table of contents.
+Astro Integration to generate a customizable table of contents. This is a convenient wrapper for [rehype-custom-toc](https://github.com/Robot-Inventor/rehype-custom-toc/). If you are not using Astro, you can directly use rehype-custom-toc instead.
 
 > [!WARNING]
 > This plugin uses [remark-comment](https://github.com/leebyron/remark-comment). It may break other plugins that use comments.
@@ -56,45 +56,7 @@ Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
 
 ## Options
 
-```typescript
-type RemarkCustomTocTemplate = (html: string) => string;
-
-interface RemarkCustomTocOptions {
-    template?: RemarkCustomTocTemplate;
-    maxDepth?: number;
-    ordered?: boolean;
-}
-```
-
-### `template`
-
-A function that takes the generated HTML and returns the final HTML. This can be used to wrap the generated HTML in a custom template.
-
-Default:
-
-```javascript
-const defaultTemplate = (html) => {
-    return `
-<aside class="toc">
-    <h2>Contents</h2>
-    <nav>
-        ${html}
-    </nav>
-</aside>`.trim();
-};
-```
-
-### `maxDepth`
-
-The maximum depth of headings to include in the table of contents.
-
-Default: `3`
-
-### `ordered`
-
-Whether to use an ordered list (`<ol>`) or an unordered list (`<ul>`).
-
-Default: `false`
+All options of rehype-custom-toc can be used in this plugin. Please refer to the [rehype-custom-toc documentation](https://github.com/Robot-Inventor/rehype-custom-toc/) for options.
 
 ## Development
 

package/dist/index.d.ts

@@ -1,5 +1,13 @@
 import type { AstroIntegration } from "astro";
-import { type RehypeCustomTocOptions } from "./rehype-custom-toc.js";
+import { type Comment, type RehypeCustomTocOptions, type RehypeCustomTocTemplate } from "./rehype-custom-toc.js";
+declare module "mdast" {
+    interface RootContentMap {
+        comment: Comment;
+    }
+    interface Data {
+        id: string;
+    }
+}
 /**
  * Create the astro-custom-toc integration.
  * @param options Options for the integration
@@ -7,3 +15,4 @@ import { type RehypeCustomTocOptions } from "./rehype-custom-toc.js";
  */
 declare const astroCustomToc: (options?: RehypeCustomTocOptions) => AstroIntegration;
 export default astroCustomToc;
+export type { RehypeCustomTocOptions, RehypeCustomTocTemplate };

package/dist/rehype-custom-toc.d.ts

@@ -1,6 +1,6 @@
-import type { Root } from "hast";
+import { type RehypeCustomTocOptions, type RehypeCustomTocTemplate } from "rehype-custom-toc";
 import type { Plugin } from "unified";
-import type { MarkdownHeading } from "@astrojs/markdown-remark";
+import type { Root } from "hast";
 /**
  * A comment node generated by the `remark-comment` plugin.
  */
@@ -9,57 +9,6 @@ interface Comment extends Node {
     value: "";
     commentValue: string;
 }
-declare module "mdast" {
-    interface RootContentMap {
-        comment: Comment;
-    }
-    interface Data {
-        id: string;
-    }
-}
-/**
- * Custom TOC template function.
- * @param html HTML content of the TOC list
- * @returns Wrapped HTML content
- */
-type RehypeCustomTocTemplate = (html: string) => string;
-/**
- * Options for the rehypeCustomToc plugin.
- */
-interface RehypeCustomTocOptions {
-    /**
-     * A function that takes the generated HTML and returns the final HTML.
-     * This can be used to wrap the generated HTML in a custom template.
-     * @default
-     * ```javascript
-     * const defaultTemplate = (html) => {
-     *     return `
-     * <aside class="toc">
-     *     <h2>Contents</h2>
-     *     <nav>
-     *         ${html}
-     *     </nav>
-     * </aside>`.trim();
-     * };
-     * ```
-     */
-    template?: RehypeCustomTocTemplate;
-    /**
-     * The maximum depth of headings to include in the table of contents.
-     * @default 3
-     */
-    maxDepth?: number;
-    /**
-     * Whether to use an ordered list (`<ol>`) or an unordered list (`<ul>`).
-     * @default false
-     */
-    ordered?: boolean;
-}
-declare module "vfile" {
-    interface DataMap {
-        __astroHeadings: MarkdownHeading[];
-    }
-}
 /**
  * Rehype plugin to generate a table of contents.
  * @param userOptions Options for the plugin

package/dist/rehype-custom-toc.js

@@ -1,117 +1,16 @@
-import { isNonEmptyArray } from "@robot-inventor/ts-utils";
-import { fromHtml } from "hast-util-from-html";
-import { h } from "hastscript";
-import { toHtml } from "hast-util-to-html";
-import { visit } from "unist-util-visit";
-/**
- * Default TOC template function for {@link RehypeCustomTocTemplate}.
- * @param html HTML content of the TOC list
- * @returns Wrapped HTML content
- */
-const defaultTemplate = (html) => `
-<aside class="toc">
-    <h2>Contents</h2>
-    <nav>
-        ${html}
-    </nav>
-</aside>`.trim();
-/**
- * Default options for the rehypeCustomToc plugin.
- */
-const DEFAULT_OPTIONS = {
-    maxDepth: 3,
-    ordered: false,
-    template: defaultTemplate
-};
-/**
- * Generate the table of contents from the headings data.
- * @param options Options for the plugin
- * @param headings Headings data
- * @returns The generated table of contents
- */
-// eslint-disable-next-line max-statements, max-lines-per-function
-const generateToc = (options, headings) => {
-    const toc = {
-        children: [],
-        properties: {},
-        tagName: options.ordered ? "ol" : "ul",
-        type: "element"
-    };
-    let currentDepth = headings[0].depth;
-    let currentParent = toc;
-    const parents = [toc];
-    for (const heading of headings) {
-        // eslint-disable-next-line no-continue
-        if (heading.depth > options.maxDepth)
-            continue;
-        const li = h("li", h("a", { href: `#${heading.slug}` }, heading.text));
-        if (heading.depth === currentDepth) {
-            // The current heading is at the same level as the previous one.
-            currentParent.children.push(li);
-            currentDepth = heading.depth;
-        }
-        else if (heading.depth > currentDepth) {
-            // The current heading is at a deeper level than the previous one.
-            const ul = h(options.ordered ? "ol" : "ul", li);
-            currentParent.children.push(ul);
-            currentParent = ul;
-            parents.push(currentParent);
-            currentDepth = heading.depth;
-        }
-        else {
-            // The current heading is at a shallower level than the previous one.
-            // eslint-disable-next-line id-length
-            for (let i = 0; i < currentDepth - heading.depth; i++) {
-                parents.pop();
-                // eslint-disable-next-line no-magic-numbers
-                const parentNode = parents[parents.length - 1];
-                if (!parentNode) {
-                    throw new Error("Parent node not found. Make sure the headings are sorted by depth.");
-                }
-                currentParent = parentNode;
-            }
-            currentParent.children.push(li);
-            currentDepth = heading.depth;
-        }
-    }
-    return fromHtml(options.template(toHtml(toc)), { fragment: true }).children;
-};
+import rehypeCustomTocBase, {} from "rehype-custom-toc";
 /**
  * Rehype plugin to generate a table of contents.
  * @param userOptions Options for the plugin
  * @returns The plugin
  */
 const rehypeCustomToc = (userOptions) => {
-    const options = { ...DEFAULT_OPTIONS, ...userOptions };
-    /**
-     * The transformer function for the plugin.
-     * @param tree The HAST tree
-     * @param vFile VFile data
-     * @param vFile.data The VFile data
-     */
-    const transformer = (tree, { data }) => {
-        if (!data.astro?.frontmatter || data.astro.frontmatter["showToc"] !== true)
-            return;
-        const { headings } = data.astro;
-        if (!headings)
-            throw new Error("Headings data not found in the file data.");
-        if (!isNonEmptyArray(headings))
+    const createBaseTransformer = rehypeCustomTocBase;
+    const transformer = createBaseTransformer(userOptions);
+    return (tree, file) => {
+        if (!file.data.astro?.frontmatter || file.data.astro.frontmatter["showToc"] !== true)
             return;
-        let tocIndex = 0;
-        visit(tree, "comment", (node, index) => {
-            if (node.type === "comment" && node.value.trim().toLowerCase() === "toc" && typeof index !== "undefined") {
-                tocIndex = index;
-            }
-        });
-        const toc = generateToc(options, headings);
-        if (tocIndex) {
-            // eslint-disable-next-line no-magic-numbers
-            tree.children.splice(tocIndex, 1, ...toc);
-        }
-        else {
-            tree.children.unshift(...toc);
-        }
+        void transformer(tree, file);
     };
-    return transformer;
 };
 export { rehypeCustomToc };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "astro-custom-toc",
-  "version": "2.0.45",
+  "version": "3.0.0",
   "description": "Astro Integration to generate a customizable table of contents",
   "publishConfig": {
     "provenance": true
@@ -9,7 +9,7 @@
     "build": "tsc",
     "format": "prettier ./src/ --write",
     "format:check": "prettier ./src/ --check",
-    "lint": "npx eslint ./src/**/*.ts",
+    "lint": "knip && npx eslint ./src/**/*.ts",
     "version": "npm run build && git add .",
     "changeset-version": "changeset version && npm run version",
     "changeset-publish": "npm run build && changeset publish"
@@ -40,23 +40,21 @@
   "homepage": "https://github.com/Robot-Inventor/astro-custom-toc#readme",
   "dependencies": {
     "@astrojs/markdown-remark": "^6.0.0",
-    "@robot-inventor/ts-utils": "^0.8.0",
     "@types/hast": "^3.0.4",
-    "hast-util-from-html": "^2.0.1",
-    "hast-util-to-html": "^9.0.1",
-    "hastscript": "^9.0.0",
+    "rehype-custom-toc": "^1.0.0",
     "remark-comment": "^1.0.0",
-    "unified": "^11.0.4",
-    "unist-util-visit": "^5.0.0"
+    "unified": "^11.0.4"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.1",
-    "@robot-inventor/eslint-config": "^10.0.0",
-    "@robot-inventor/tsconfig-base": "^6.0.0",
+    "@robot-inventor/eslint-config": "^11.0.0",
+    "@robot-inventor/tsconfig-base": "^7.0.0",
     "astro": "^5.1.1",
     "eslint": "^9.0.0",
+    "knip": "^5.80.2",
     "prettier": "^3.2.5",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.2",
+    "vfile": "^6.0.3"
   }
 }