@mehm8128/rehype-toc 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 mehm8128
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# rehype-toc
+
+## Development
+
+- Install dependencies:
+
+```bash
+pnpm install
+```
+
+- Run the unit tests:
+
+```bash
+pnpm run test
+```
+
+- Build the library:
+
+```bash
+pnpm run build
+```

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { Element, Root } from "hast";
+
+//#region src/index.d.ts
+declare const rehypeCollapsableToc: () => (tree: Root) => void;
+declare const visitorCallback: (node: Element, rootUlElement: Element) => void;
+//#endregion
+export { rehypeCollapsableToc, visitorCallback };

package/dist/index.js

@@ -0,0 +1,129 @@
+import { visit } from "unist-util-visit";
+
+//#region src/index.ts
+const rehypeCollapsableToc = () => {
+	return (tree) => {
+		const rootUlElement = {
+			type: "element",
+			tagName: "ol",
+			properties: {},
+			children: []
+		};
+		visit(tree, "element", (node) => {
+			visitorCallback(node, rootUlElement);
+		});
+		const detailsElement = createCollapsableToc(rootUlElement);
+		tree.children.unshift(detailsElement);
+	};
+};
+const visitorCallback = (node, rootUlElement) => {
+	if (!/^h[2-6]$/.test(node.tagName)) return;
+	const headingLevel = getHeadingLevelFromElement(node);
+	const liElement = createListItemElement(node);
+	const rootUlElementChildren = assertElementNodeList(rootUlElement.children);
+	if (headingLevel === 2) {
+		rootUlElement.children.push(liElement);
+		return;
+	}
+	const sameLevelUlElement = searchSameLevelUlElement(rootUlElementChildren, headingLevel);
+	if (sameLevelUlElement) {
+		sameLevelUlElement.children.push(liElement);
+		return;
+	}
+	const deepestLiElement = getDeepestLiElement(rootUlElementChildren);
+	const newUlElement = createUlElement();
+	newUlElement.children.push(liElement);
+	deepestLiElement.children.push(newUlElement);
+};
+/**
+* 引数のolに入っている一番新しいliの中で、levelと同じ見出しレベルのli要素を返す
+*/
+const searchSameLevelUlElement = (rootUlElement, level) => {
+	const rootLiElement = assertElementNode(rootUlElement[rootUlElement.length - 1]);
+	const headingAnchorElement = assertElementNode(rootLiElement.children[0]);
+	const headingTextElement = assertElementText(headingAnchorElement.children[0]);
+	const rootElementHeadingLevel = getHeadingLevelFromText(headingTextElement);
+	if (rootElementHeadingLevel === level) return rootLiElement;
+	if (rootLiElement.children[1] === void 0) return;
+	const childUlElement = assertElementNode(rootLiElement.children[1]);
+	return searchSameLevelUlElement(assertElementNodeList(childUlElement.children), level);
+};
+/**
+* 引数のolに入っている一番新しいliの中で、一番深いli要素を取得する
+*/
+const getDeepestLiElement = (rootUlElement) => {
+	const rootLiElement = assertElementNode(rootUlElement[rootUlElement.length - 1]);
+	if (!rootLiElement.children[1]) return rootLiElement;
+	const olElement = assertElementNode(rootLiElement.children[1]);
+	return getDeepestLiElement(assertElementNodeList(olElement.children));
+};
+const getHeadingLevelFromElement = (headingElement) => {
+	const headingLevel = Number(headingElement.tagName.charAt(1));
+	return headingLevel;
+};
+const getHeadingLevelFromText = (headingElement) => {
+	const headingLevel = Number(headingElement.value.charAt(1));
+	return headingLevel;
+};
+const createUlElement = () => {
+	return {
+		type: "element",
+		tagName: "ol",
+		properties: {},
+		children: []
+	};
+};
+const createListItemElement = (node) => {
+	const headingChildren = node.children.flatMap((child) => child.type === "element" ? child.children : []);
+	const headingTextElement = headingChildren.find((child) => child.type === "text");
+	if (!headingTextElement) throw new Error("見出しにテキストがありません");
+	const headingText = headingTextElement.value;
+	const anchorElement = {
+		type: "element",
+		tagName: "a",
+		properties: { href: `#${headingText}` },
+		children: [{
+			type: "text",
+			value: headingText
+		}]
+	};
+	return {
+		type: "element",
+		tagName: "li",
+		properties: {},
+		children: [anchorElement]
+	};
+};
+const createCollapsableToc = (rootUlElement) => {
+	const summaryElement = {
+		type: "element",
+		tagName: "summary",
+		properties: {},
+		children: [{
+			type: "text",
+			value: "目次"
+		}]
+	};
+	const detailsElement = {
+		type: "element",
+		tagName: "details",
+		properties: {},
+		children: [summaryElement, rootUlElement]
+	};
+	return detailsElement;
+};
+const assertElementNode = (node) => {
+	if (node.type !== "element") throw new Error("Elementノードではありません");
+	return node;
+};
+const assertElementNodeList = (nodeList) => {
+	if (nodeList.some((node) => node.type !== "element")) throw new Error("Elementノードではありません");
+	return nodeList;
+};
+const assertElementText = (node) => {
+	if (node.type !== "text") throw new Error("Textノードではありません");
+	return node;
+};
+
+//#endregion
+export { rehypeCollapsableToc, visitorCallback };

package/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "@mehm8128/rehype-toc",
+	"version": "1.0.0",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "git+ssh://git@github.com/mehm8128/rehype-toc.git"
+	},
+	"homepage": "https://github.com/mehm8128/rehype-toc",
+	"license": "MIT",
+	"description": "rehype plugin to generate a collapsable table of contents",
+	"keywords": [
+		"rehype",
+		"toc",
+		"table of contents"
+	],
+	"author": "mehm8128 <mehm8128@mail.com>",
+	"files": [
+		"dist",
+		"README.md",
+		"LICENSE",
+		"package.json"
+	],
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": "./dist/index.js",
+		"./package.json": "./package.json"
+	},
+	"scripts": {
+		"build": "tsdown",
+		"dev": "tsdown --watch",
+		"test": "vitest",
+		"typecheck": "tsc --noEmit"
+	},
+	"devDependencies": {
+		"@biomejs/biome": "^2.2.4",
+		"@types/hast": "^3.0.4",
+		"rehype": "^13.0.2",
+		"tsdown": "^0.11.9",
+		"typescript": "^5.8.3",
+		"vitest": "^3.1.3"
+	},
+	"dependencies": {
+		"unist-util-visit": "^5.0.0"
+	}
+}