@altano/remark-mdx-toc-with-slugs 1.0.0 → 1.0.2

package/README.md

@@ -1,40 +1,29 @@
 # 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.
+## Summary
 
-So `remark-mdx-toc` exports this object:
+This is a [remark](https://remark.js.org/) plugin that exports a table of contents. It is similar to the [remark-mdx-toc](https://github.com/DCsunset/remark-mdx-toc) plugin but has an additional `slug` property.
 
-```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: [],
-      },
-    ],
-  },
-];
+Given this mdx:
+
+```markdown
+## Resource Acquisition Is Initialization (RAII)
+
+### Is There a Problem?
+
+### C++ Classes
+
+### The Solution
 ```
 
-And `remark-mdx-toc-with-slugs` modifies it to export this instead:
+`remark-mdx-toc-with-slugs` exports this object on the `toc` field:
 
 ```javascript
-[
+export const toc = [
   {
     depth: 2,
     value: "Resource Acquisition Is Initialization (RAII)",
+    slug: "resource-acquisition-is-initialization-raii",
     attributes: {},
     children: [
       {
@@ -59,11 +48,15 @@ And `remark-mdx-toc-with-slugs` modifies it to export this instead:
         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).
+## Options
+
+- `name`: The exported variable name of the table of contents. By default, it's `toc`.
+
+## Misc
 
-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
+- If you don't need the slug, consider 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

@@ -1,10 +1,16 @@
-import * as unist from 'unist';
-import { RemarkMdxTocOptions } from 'remark-mdx-toc';
+import { TocEntry, 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>>[];
+declare type TableOfContentsEntry = TocEntry & {
+    slug: string;
+    children: TableOfContentsEntry[];
 };
+declare type RemarkMdxTocWithSlugsOptions = RemarkMdxTocOptions;
+/**
+ * Remark plugin that, given a tree that has had remark-mdx-toc run over it
+ * already, the toc data will be enhanced to have auto-generated slugs for every
+ * heading. This uses github-slugger
+ */
+declare const remarkMdxTocWithSlugs: Plugin<[RemarkMdxTocWithSlugsOptions?]>;
 
-export { RemarkMdxTocWithSlugsOptions, preset as default };
+export { RemarkMdxTocWithSlugsOptions, TableOfContentsEntry, remarkMdxTocWithSlugs as default };

package/dist/index.js

@@ -20,9 +20,17 @@ function assertMdxjsEsmNode(node) {
     throw new Error(`Node was unexpected type: ${node.type}`);
   }
 }
-var remarkMdxTocWithSlugs = (options = {}) => {
+var remarkMdxTocWithSlugs = function(options = {}) {
+  const mdxTocTransformer = remarkMdxToc.call(this, options);
+  if (mdxTocTransformer == null) {
+    throw new Error(`Couldn't create mdxTocTransformer function`);
+  }
   const name = options.name ?? "toc";
-  return function mdxTocWithSlugsTransformer(ast) {
+  return function mdxTocWithSlugsTransformer(ast, ...args) {
+    const result = mdxTocTransformer(ast, ...args);
+    if (result instanceof Promise) {
+      throw new Error(`Wasn't expected remark-mdx-toc to be an async plugin`);
+    }
     const mdast = ast;
     visit(mdast, ["mdxjsEsm"], (mdxNode) => {
       assertMdxjsEsmNode(mdxNode);
@@ -45,10 +53,7 @@ var remarkMdxTocWithSlugs = (options = {}) => {
     });
   };
 };
-var preset = {
-  plugins: [remarkMdxToc, remarkMdxTocWithSlugs]
-};
-var src_default = preset;
+var src_default = remarkMdxTocWithSlugs;
 export {
   src_default as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@altano/remark-mdx-toc-with-slugs",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A remark plugin to generate a table of contents (including slugs) and convert it into MDX export",
   "type": "module",
   "sideEffects": false,
@@ -11,7 +11,9 @@
     "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"
+    "clean": "rm -rf .turbo && rm -rf .tsbuildinfo && rm -rf node_modules && rm -rf dist",
+    "test": "vitest --run",
+    "test:watch": "vitest"
   },
   "author": {
     "name": "Alan Norbauer",
@@ -30,6 +32,7 @@
   ],
   "keywords": [
     "remark",
+    "remark-plugin",
     "mdx"
   ],
   "dependencies": {
@@ -42,8 +45,10 @@
     "unist-util-visit": "^4.1.2"
   },
   "devDependencies": {
+    "@altano/remark-plugin-test-util": "*",
     "@altano/tsconfig": "*",
-    "@types/node": "^18.15.13"
+    "@types/node": "^18.15.13",
+    "vitest": "^0.30.1"
   },
   "publishConfig": {
     "access": "public"