@altano/remark-mdx-toc-with-slugs 0.0.1-alpha.1

package/README.md

@@ -0,0 +1,69 @@
+# remark-mdx-toc-with-slugs
+
+This is a [remark](https://remark.js.org/) preset that performs the same transform as [remark-mdx-toc](https://github.com/DCsunset/remark-mdx-toc) plugin but exports the table of contents with an additional `slug` property.
+
+So `remark-mdx-toc` exports this object:
+
+```javascript
+[
+  {
+    depth: 2,
+    value: "Resource Acquisition Is Initialization (RAII)",
+    attributes: {},
+    children: [
+      {
+        depth: 3,
+        value: "Is There a Problem?",
+        attributes: {},
+        children: [],
+      },
+      {
+        depth: 3,
+        value: "C++ Classes",
+        attributes: {},
+        children: [],
+      },
+    ],
+  },
+];
+```
+
+And `remark-mdx-toc-with-slugs` modifies it to export this instead:
+
+```javascript
+[
+  {
+    depth: 2,
+    value: "Resource Acquisition Is Initialization (RAII)",
+    attributes: {},
+    children: [
+      {
+        depth: 3,
+        value: "Is There a Problem?",
+        attributes: {},
+        children: [],
+        slug: "is-there-a-problem",
+      },
+      {
+        depth: 3,
+        value: "C++ Classes",
+        attributes: {},
+        children: [],
+        slug: "c-classes",
+      },
+      {
+        depth: 3,
+        value: "The Solution",
+        attributes: {},
+        children: [],
+        slug: "the-solution",
+      },
+    ],
+    slug: "resource-acquisition-is-initialization-raii",
+  },
+];
+```
+
+If you don't need the slug, continue using [remark-mdx-toc](https://github.com/DCsunset/remark-mdx-toc).
+
+Slugs are generated using [`github-slugger`](https://www.npmjs.com/package/github-slugger) and should therefore match the [`rehype-slug`](https://www.npmjs.com/package/rehype-slug) package

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import * as unist from 'unist';
+import { RemarkMdxTocOptions } from 'remark-mdx-toc';
+import { Plugin } from 'unified';
+
+declare type RemarkMdxTocWithSlugsOptions = RemarkMdxTocOptions;
+declare const preset: {
+    plugins: Plugin<[(RemarkMdxTocOptions | undefined)?], unist.Node<unist.Data>, unist.Node<unist.Data>>[];
+};
+
+export { RemarkMdxTocWithSlugsOptions, preset as default };

package/dist/index.js

@@ -0,0 +1,56 @@
+// src/index.ts
+import { generate } from "astring";
+import { valueToEstree } from "estree-util-value-to-estree";
+import { EXIT, visit as estreeVisit } from "estree-util-visit";
+import GithubSlugger from "github-slugger";
+import { remarkMdxToc } from "remark-mdx-toc";
+import { visit } from "unist-util-visit";
+function sluggifyTocEntries(entries, headingSlugger = new GithubSlugger()) {
+  return entries.map((entry) => sluggifyTocEntry(entry, headingSlugger));
+}
+function sluggifyTocEntry(entry, headingSlugger) {
+  return {
+    ...entry,
+    slug: headingSlugger.slug(entry.value),
+    children: sluggifyTocEntries(entry.children, headingSlugger)
+  };
+}
+function assertMdxjsEsmNode(node) {
+  if (node.type !== "mdxjsEsm") {
+    throw new Error(`Node was unexpected type: ${node.type}`);
+  }
+}
+var remarkMdxTocWithSlugs = (options = {}) => {
+  const name = options.name ?? "toc";
+  return function mdxTocWithSlugsTransformer(ast) {
+    const mdast = ast;
+    visit(mdast, ["mdxjsEsm"], (mdxNode) => {
+      assertMdxjsEsmNode(mdxNode);
+      const estree = mdxNode.data?.estree;
+      if (estree) {
+        estreeVisit(estree, (esNode) => {
+          if (esNode.type === "VariableDeclarator" && esNode.id.type === "Identifier" && esNode.id.name === name) {
+            if (esNode.init) {
+              const tocExportString = generate(esNode.init);
+              const toc = JSON.parse(tocExportString);
+              const tocWithSlugs = sluggifyTocEntries(toc);
+              const newTree = valueToEstree(tocWithSlugs);
+              if (newTree.type === "ArrayExpression") {
+                esNode.init = newTree;
+              }
+            }
+            return EXIT;
+          }
+          return;
+        });
+      }
+    });
+  };
+};
+var preset = {
+  plugins: [remarkMdxToc, remarkMdxTocWithSlugs]
+};
+var src_default = preset;
+export {
+  src_default as default
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@altano/remark-mdx-toc-with-slugs",
+  "version": "0.0.1-alpha.1",
+  "description": "A remark plugin to generate a table of contents (including slugs) and convert it into MDX export",
+  "type": "module",
+  "sideEffects": false,
+  "exports": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts",
+    "dev": "tsup src/index.ts --watch --format esm --dts",
+    "lint": "TIMING=1 eslint src/**/*.ts* --fix",
+    "format": "prettier --write src",
+    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist"
+  },
+  "author": {
+    "name": "Alan Norbauer",
+    "email": "altano@gmail.com",
+    "url": "https://alan.norbauer.com"
+  },
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/altano/npm-packages",
+    "directory": "packages/remark-mdx-toc-with-slugs"
+  },
+  "homepage": "https://github.com/altano/npm-packages/tree/main/packages/remark-mdx-toc-with-slugs",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "remark",
+    "mdx"
+  ],
+  "dependencies": {
+    "astring": "^1.8.6",
+    "estree-util-value-to-estree": "^3.0.1",
+    "estree-util-visit": "^1.2.1",
+    "github-slugger": "^2.0.0",
+    "mdast-util-mdxjs-esm": "^1.3.1",
+    "remark-mdx-toc": "^0.3.1",
+    "unist-util-visit": "^4.1.2"
+  },
+  "devDependencies": {
+    "@altano/tsconfig": "*",
+    "@types/node": "^18.15.13"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}