summaryrefslogtreecommitdiff
path: root/packages/markdown-support/src/rehype-collect-headers.ts
diff options
context:
space:
mode:
authorGravatar Robin Métral <robin@metral.ch> 2021-08-25 14:17:45 +0200
committerGravatar GitHub <noreply@github.com> 2021-08-25 08:17:45 -0400
commit397d8f3d842e7e17d29c4f7862b6639f34f6a2e4 (patch)
tree3b7c98e31719d7116aa37052dee37acf8178b760 /packages/markdown-support/src/rehype-collect-headers.ts
parent3bfd8c125e57879f6d0d3a828943a16199c8fb9c (diff)
downloadastro-397d8f3d842e7e17d29c4f7862b6639f34f6a2e4.tar.gz
astro-397d8f3d842e7e17d29c4f7862b6639f34f6a2e4.tar.zst
astro-397d8f3d842e7e17d29c4f7862b6639f34f6a2e4.zip
Upgrade unified deps and improve unified plugins types (#1200)
* Upgrade @astrojs/markdown-support deps and update types * Add changeset * Update changeset * Switch astro-markdown-plugins example to use rehype-autolink-headings Usage of remark-autolink-headings is discouraged in favor of the rehype counterpart: https://github.com/remarkjs/remark-autolink-headings\#remark-autolink-headings * Add stricter types for unified plugins This includes a few suggestions from a code review: - use vfile.toString instead of vfile.value.toString - refactor plugins to follow unified best practices instead of returning functions that return a plugin - use any instead of any[] for plugin options types * Narrow down types to more specific hast or mdast typings
Diffstat (limited to 'packages/markdown-support/src/rehype-collect-headers.ts')
-rw-r--r--packages/markdown-support/src/rehype-collect-headers.ts53
1 files changed, 30 insertions, 23 deletions
diff --git a/packages/markdown-support/src/rehype-collect-headers.ts b/packages/markdown-support/src/rehype-collect-headers.ts
index 78774e494..211b7177c 100644
--- a/packages/markdown-support/src/rehype-collect-headers.ts
+++ b/packages/markdown-support/src/rehype-collect-headers.ts
@@ -1,32 +1,39 @@
import { visit } from 'unist-util-visit';
+import type { Root, Properties } from 'hast';
import slugger from 'github-slugger';
/** */
export default function createCollectHeaders() {
const headers: any[] = [];
- const visitor = (node: any) => {
- if (node.type !== 'element') return;
- const { tagName, children } = node;
- if (tagName[0] !== 'h') return;
- let [_, depth] = tagName.match(/h([0-6])/) ?? [];
- if (!depth) return;
- depth = Number.parseInt(depth);
-
- let text = '';
-
- visit(node, 'text', (child) => {
- text += (child as any).value;
- });
-
- let slug = node.properties.id || slugger.slug(text);
-
- node.properties = node.properties || {};
- node.properties.id = slug;
- headers.push({ depth, slug, text });
-
- return node;
+ function rehypeCollectHeaders() {
+ return function (tree: Root) {
+ visit(tree, (node) => {
+ if (node.type !== 'element') return;
+ const { tagName } = node;
+ if (tagName[0] !== 'h') return;
+ const [_, level] = tagName.match(/h([0-6])/) ?? [];
+ if (!level) return;
+ const depth = Number.parseInt(level);
+
+ let text = '';
+
+ visit(node, 'text', (child) => {
+ text += child.value;
+ });
+
+ let slug = node?.data?.id || slugger.slug(text);
+
+ node.data = node.data || {};
+ node.data.properties = node.data.properties || {};
+ node.data.properties = { ...(node.data.properties as Properties), slug };
+ headers.push({ depth, slug, text });
+ });
+ };
+ }
+
+ return {
+ headers,
+ rehypeCollectHeaders,
};
-
- return { headers, rehypeCollectHeaders: () => (tree: any) => visit(tree, visitor) };
}