astro-custom-toc 1.0.4 → 1.1.1

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { AstroIntegration } from "astro";
+import { RemarkCustomTocOptions } from "./remark-custom-toc.js";
+declare const astroCustomToc: (options?: RemarkCustomTocOptions) => AstroIntegration;
+export default astroCustomToc;

package/{index.ts → dist/index.js}

@@ -1,9 +1,7 @@
-import type { AstroConfig, AstroIntegration } from "astro";
-import { remarkCustomToc, RemarkCustomTocOptions } from "./remark-custom-toc";
+import { remarkCustomToc } from "./remark-custom-toc.js";
 import remarkComment from "remark-comment";
-
-const astroCustomToc = (options?: RemarkCustomTocOptions) => {
-    const integration: AstroIntegration = {
+const astroCustomToc = (options) => {
+    const integration = {
         name: "astro-custom-toc",
         hooks: {
             "astro:config:setup": ({ config, updateConfig }) => {
@@ -24,21 +22,16 @@ const astroCustomToc = (options?: RemarkCustomTocOptions) => {
             }
         }
     };
-
     return integration;
 };
-
-const checkOrder = (config: AstroConfig) => {
+const checkOrder = (config) => {
     const customTocIndex = config.integrations.findIndex((i) => i.name === "astro-custom-toc");
     const mdxIndex = config.integrations.findIndex((i) => i.name === "@astrojs/mdx");
     if (mdxIndex > -1 && customTocIndex > mdxIndex) {
-        throw new Error(
-            `
-MDX integration configured before astro-custom-toc.
-\`astroCustomToc()\` must be loaded before \`mdx()\`.
-`.trim()
-        );
+        throw new Error(`
+MDX integration configured before astro-custom-toc.
+\`astroCustomToc()\` must be loaded before \`mdx()\`.
+`.trim());
     }
 };
-
 export default astroCustomToc;

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

@@ -0,0 +1,10 @@
+import type { AstroUserConfig } from "astro";
+export type RemarkCustomTocTemplate = (html: string) => string;
+export interface RemarkCustomTocOptions {
+    template?: RemarkCustomTocTemplate;
+    maxDepth?: number;
+    ordered?: boolean;
+}
+type RemarkPlugin = NonNullable<NonNullable<AstroUserConfig["markdown"]>["remarkPlugins"]>[number];
+export declare const remarkCustomToc: RemarkPlugin;
+export {};

package/{remark-custom-toc.ts → dist/remark-custom-toc.js}

@@ -1,39 +1,7 @@
-import type { AstroUserConfig } from "astro";
 import { visit } from "unist-util-visit";
 import Slugger from "github-slugger";
 import { JSDOM } from "jsdom";
-
-interface Heading {
-    slug: string;
-    text: string;
-    depth: number;
-}
-
-export type RemarkCustomTocTemplate = (html: string) => string;
-
-export interface RemarkCustomTocOptions {
-    template?: RemarkCustomTocTemplate;
-    maxDepth?: number;
-    ordered?: boolean;
-}
-
-type RemarkPlugin = NonNullable<NonNullable<AstroUserConfig["markdown"]>["remarkPlugins"]>[number];
-
-interface VFile {
-    data: {
-        astro?: {
-            frontmatter: Record<string, any>;
-        };
-    };
-}
-
-interface CommentNode {
-    type: "comment";
-    value: "";
-    commentValue: string;
-}
-
-const defaultTemplate = (html: string) => {
+const defaultTemplate = (html) => {
     return `
 <aside class="toc">
     <h2>Contents</h2>
@@ -42,63 +10,51 @@ const defaultTemplate = (html: string) => {
     </nav>
 </aside>`.trim();
 };
-
-export const remarkCustomToc: RemarkPlugin = ({
-    template = defaultTemplate,
-    maxDepth = 3,
-    ordered = false
-}: RemarkCustomTocOptions = {}) => {
-    return (tree, { data }: VFile) => {
-        if (data.astro && data.astro.frontmatter.showToc !== true) return;
-
+export const remarkCustomToc = ({ template = defaultTemplate, maxDepth = 3, ordered = false } = {}) => {
+    return (tree, { data }) => {
+        if (data.astro && data.astro.frontmatter.showToc !== true)
+            return;
         const slugs = new Slugger();
         slugs.reset();
-
-        const headings: Heading[] = [];
+        const headings = [];
         visit(tree, "heading", (node) => {
             const { depth } = node;
-            const textNode = node.children[0];
-            // @ts-ignore
-            const text = textNode ? textNode.value : "";
+            const text = node.children.map((n) => ("value" in n ? n.value : "")).join("");
             const slug = slugs.slug(text);
             // @ts-ignore
             node.data = { id: slug };
             headings.push({ slug, text, depth });
         });
-
         let tocIndex = 0;
-        visit(tree, "comment", (node: CommentNode, index) => {
+        visit(tree, "comment", (node, index) => {
             if (node.commentValue.trim().toLowerCase() === "toc" && index !== undefined) {
                 tocIndex = index;
             }
         });
-
         visit(tree, "html", (node, index) => {
             if (node.value.trim().toLowerCase() === "<!-- toc -->" && index !== undefined) {
                 tocIndex = index;
             }
         });
-
         const toc = generateToc(template, maxDepth, ordered, headings);
         if (tocIndex === 0) {
             // @ts-ignore
             tree.children.unshift(toc);
-        } else {
+        }
+        else {
             // @ts-ignore
             tree.children.splice(tocIndex, 1, toc);
         }
     };
 };
-
-const generateToc = (template: RemarkCustomTocTemplate, maxDepth: number, ordered: boolean, headings: Heading[]) => {
+const generateToc = (template, maxDepth, ordered, headings) => {
     const { document } = new JSDOM().window;
-
-    const toc: HTMLElement = document.createElement(ordered ? "ol" : "ul");
+    const toc = document.createElement(ordered ? "ol" : "ul");
     let currentDepth = headings[0].depth;
     let currentParent = toc;
     for (const heading of headings) {
-        if (heading.depth > maxDepth) continue;
-
+        if (heading.depth > maxDepth)
+            continue;
         if (heading.depth === currentDepth) {
             const li = document.createElement("li");
             const a = document.createElement("a");
@@ -107,7 +63,8 @@ const generateToc = (template: RemarkCustomTocTemplate, maxDepth: number, ordere
             li.appendChild(a);
             currentParent.appendChild(li);
             currentDepth = heading.depth;
-        } else if (heading.depth > currentDepth) {
+        }
+        else if (heading.depth > currentDepth) {
             const ul = document.createElement(ordered ? "ol" : "ul");
             const li = document.createElement("li");
             const a = document.createElement("a");
@@ -118,9 +75,10 @@ const generateToc = (template: RemarkCustomTocTemplate, maxDepth: number, ordere
             currentParent.appendChild(ul);
             currentParent = ul;
             currentDepth = heading.depth;
-        } else {
+        }
+        else {
             for (let i = 0; i < currentDepth - heading.depth; i++) {
-                currentParent = currentParent.parentElement!;
+                currentParent = currentParent.parentElement;
             }
             const li = document.createElement("li");
             const a = document.createElement("a");
@@ -131,7 +89,6 @@ const generateToc = (template: RemarkCustomTocTemplate, maxDepth: number, ordere
             currentDepth = heading.depth;
         }
     }
-
     return {
         type: "html",
         value: template(toc.outerHTML)

package/package.json

@@ -1,44 +1,49 @@
-{
-  "name": "astro-custom-toc",
-  "version": "1.0.4",
-  "description": "Astro Integration to generate a customizable table of contents",
-  "type": "module",
-  "exports": {
-    ".": "./index.ts"
-  },
-  "files": [
-    "index.ts",
-    "remark-custom-toc.ts"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Robot-Inventor/astro-custom-toc.git"
-  },
-  "keywords": [
-    "astro",
-    "withastro",
-    "ui",
-    "remark",
-    "markdown",
-    "astro-integration"
-  ],
-  "author": "Robot-Inventor",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Robot-Inventor/astro-custom-toc/issues"
-  },
-  "homepage": "https://github.com/Robot-Inventor/astro-custom-toc#readme",
-  "dependencies": {
-    "github-slugger": "^2.0.0",
-    "jsdom": "^24.0.0",
-    "remark-comment": "^1.0.0",
-    "typescript": "^5.3.3",
-    "unist-util-visit": "^5.0.0"
-  },
-  "peerDependencies": {
-    "astro": "^4.0.0"
-  },
-  "devDependencies": {
-    "@types/jsdom": "^21.1.6"
-  }
-}
+{
+  "name": "astro-custom-toc",
+  "version": "1.1.1",
+  "description": "Astro Integration to generate a customizable table of contents",
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier ./src/ --write",
+    "format:check": "prettier ./src/ --check",
+    "prepublishOnly": "npm run build"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Robot-Inventor/astro-custom-toc.git"
+  },
+  "keywords": [
+    "astro",
+    "withastro",
+    "ui",
+    "remark",
+    "markdown",
+    "astro-integration"
+  ],
+  "author": "Robot-Inventor",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Robot-Inventor/astro-custom-toc/issues"
+  },
+  "homepage": "https://github.com/Robot-Inventor/astro-custom-toc#readme",
+  "dependencies": {
+    "github-slugger": "^2.0.0",
+    "jsdom": "^24.0.0",
+    "remark-comment": "^1.0.0",
+    "typescript": "^5.3.3",
+    "unist-util-visit": "^5.0.0"
+  },
+  "peerDependencies": {
+    "astro": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/jsdom": "^21.1.6",
+    "prettier": "^3.2.5"
+  }
+}