@astrojs/markdown-remark 0.9.2 → 0.9.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @astrojs/markdown-remark
 
+## 0.9.3
+
+### Patch Changes
+
+- [#3234](https://github.com/withastro/astro/pull/3234) [`de123b28`](https://github.com/withastro/astro/commit/de123b28b3ff398b800cb598f20326ca85a0fb60) Thanks [@JuanM04](https://github.com/JuanM04)! - Removed `rehype-slug` in favor of our own implementation. The behavior of the slugging should remain the same
+
+* [#3234](https://github.com/withastro/astro/pull/3234) [`de123b28`](https://github.com/withastro/astro/commit/de123b28b3ff398b800cb598f20326ca85a0fb60) Thanks [@JuanM04](https://github.com/JuanM04)! - Moved some type from `astro` to `@astrojs/markdown-remark`
+
 ## 0.9.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,13 +1,6 @@
-import type { MarkdownRenderingOptions } from './types';
+import type { MarkdownRenderingOptions, MarkdownRenderingResult } from './types';
 export * from './types.js';
 export declare const DEFAULT_REMARK_PLUGINS: string[];
-export declare const DEFAULT_REHYPE_PLUGINS: string[];
+export declare const DEFAULT_REHYPE_PLUGINS: never[];
 /** Shared utility for rendering markdown */
-export declare function renderMarkdown(content: string, opts: MarkdownRenderingOptions): Promise<{
-    metadata: {
-        headers: any[];
-        source: string;
-        html: string;
-    };
-    code: string;
-}>;
+export declare function renderMarkdown(content: string, opts: MarkdownRenderingOptions): Promise<MarkdownRenderingResult>;

package/dist/index.js

@@ -17,7 +17,7 @@ import rehypeStringify from "rehype-stringify";
 import rehypeRaw from "rehype-raw";
 export * from "./types.js";
 const DEFAULT_REMARK_PLUGINS = ["remark-gfm", "remark-smartypants"];
-const DEFAULT_REHYPE_PLUGINS = ["rehype-slug"];
+const DEFAULT_REHYPE_PLUGINS = [];
 async function renderMarkdown(content, opts) {
   var _a;
   let { mode, syntaxHighlight, shikiConfig, remarkPlugins, rehypePlugins } = opts;

package/dist/rehype-collect-headers.d.ts

@@ -1,5 +1,5 @@
-/**  */
+import type { MarkdownHeader, RehypePlugin } from './types.js';
 export default function createCollectHeaders(): {
-    headers: any[];
-    rehypeCollectHeaders: () => (tree: any) => void;
+    headers: MarkdownHeader[];
+    rehypeCollectHeaders: () => ReturnType<RehypePlugin>;
 };

package/dist/rehype-collect-headers.js

@@ -1,11 +1,11 @@
 import { visit } from "unist-util-visit";
-import slugger from "github-slugger";
+import Slugger from "github-slugger";
 function createCollectHeaders() {
   const headers = [];
+  const slugger = new Slugger();
   function rehypeCollectHeaders() {
     return function(tree) {
       visit(tree, (node) => {
-        var _a;
         if (node.type !== "element")
           return;
         const { tagName } = node;
@@ -19,10 +19,11 @@ function createCollectHeaders() {
         visit(node, "text", (child) => {
           text += child.value;
         });
-        let slug = ((_a = node == null ? void 0 : node.properties) == null ? void 0 : _a.id) || slugger.slug(text);
         node.properties = node.properties || {};
-        node.properties.id = slug;
-        headers.push({ depth, slug, text });
+        if (typeof node.properties.id !== "string") {
+          node.properties.id = slugger.slug(text);
+        }
+        headers.push({ depth, slug: node.properties.id, text });
       });
     };
   }

package/dist/rehype-islands.js

@@ -22,7 +22,7 @@ const visit = _visit;
 function rehypeIslands() {
   return function(node) {
     return visit(node, "element", (el) => {
-      if (el.tagName == "astro-root") {
+      if (el.tagName == "astro-island") {
         visit(el, "text", (child, index, parent) => {
           if (child.type === "text") {
             if (parent && child.value.indexOf("<!--") > -1 && index != null) {

package/dist/remark-unwrap.js

@@ -7,10 +7,10 @@ function remarkUnwrap() {
     insideAstroRoot = false;
     astroRootNodes.clear();
     visit(tree, "html", (node) => {
-      if (node.value.indexOf("<astro-root") > -1 && !insideAstroRoot) {
+      if (node.value.indexOf("<astro-island") > -1 && !insideAstroRoot) {
         insideAstroRoot = true;
       }
-      if (node.value.indexOf("</astro-root") > -1 && insideAstroRoot) {
+      if (node.value.indexOf("</astro-island") > -1 && insideAstroRoot) {
         insideAstroRoot = false;
       }
       astroRootNodes.add(node);

package/dist/types.d.ts

@@ -26,3 +26,17 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
         scopedClassName: string | null;
     };
 }
+export interface MarkdownHeader {
+    depth: number;
+    slug: string;
+    text: string;
+}
+export interface MarkdownMetadata {
+    headers: MarkdownHeader[];
+    source: string;
+    html: string;
+}
+export interface MarkdownRenderingResult {
+    metadata: MarkdownMetadata;
+    code: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/markdown-remark",
-  "version": "0.9.2",
+  "version": "0.9.3",
   "type": "module",
   "author": "withastro",
   "license": "MIT",
@@ -30,9 +30,8 @@
     "mdast-util-mdx-jsx": "^1.2.0",
     "mdast-util-to-string": "^3.1.0",
     "micromark-extension-mdx-jsx": "^1.0.3",
-    "prismjs": "^1.27.0",
+    "prismjs": "^1.28.0",
     "rehype-raw": "^6.1.1",
-    "rehype-slug": "^5.0.1",
     "rehype-stringify": "^9.0.3",
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",

package/src/index.ts

@@ -1,4 +1,4 @@
-import type { MarkdownRenderingOptions } from './types';
+import type { MarkdownRenderingOptions, MarkdownRenderingResult } from './types';
 
 import createCollectHeaders from './rehype-collect-headers.js';
 import scopedStyles from './remark-scoped-styles.js';
@@ -22,11 +22,13 @@ import rehypeRaw from 'rehype-raw';
 export * from './types.js';
 
 export const DEFAULT_REMARK_PLUGINS = ['remark-gfm', 'remark-smartypants'];
-
-export const DEFAULT_REHYPE_PLUGINS = ['rehype-slug'];
+export const DEFAULT_REHYPE_PLUGINS = [];
 
 /** Shared utility for rendering markdown */
-export async function renderMarkdown(content: string, opts: MarkdownRenderingOptions) {
+export async function renderMarkdown(
+	content: string,
+	opts: MarkdownRenderingOptions
+): Promise<MarkdownRenderingResult> {
 	let { mode, syntaxHighlight, shikiConfig, remarkPlugins, rehypePlugins } = opts;
 	const scopedClassName = opts.$?.scopedClassName;
 	const isMDX = mode === 'mdx';

package/src/rehype-collect-headers.ts

@@ -1,12 +1,14 @@
 import { visit } from 'unist-util-visit';
-import slugger from 'github-slugger';
+import Slugger from 'github-slugger';
+
+import type { MarkdownHeader, RehypePlugin } from './types.js';
 
-/**  */
 export default function createCollectHeaders() {
-	const headers: any[] = [];
+	const headers: MarkdownHeader[] = [];
+	const slugger = new Slugger();
 
-	function rehypeCollectHeaders() {
-		return function (tree: any) {
+	function rehypeCollectHeaders(): ReturnType<RehypePlugin> {
+		return function (tree) {
 			visit(tree, (node) => {
 				if (node.type !== 'element') return;
 				const { tagName } = node;
@@ -21,11 +23,12 @@ export default function createCollectHeaders() {
 					text += child.value;
 				});
 
-				let slug = node?.properties?.id || slugger.slug(text);
-
 				node.properties = node.properties || {};
-				node.properties.id = slug;
-				headers.push({ depth, slug, text });
+				if (typeof node.properties.id !== 'string') {
+					node.properties.id = slugger.slug(text);
+				}
+
+				headers.push({ depth, slug: node.properties.id, text });
 			});
 		};
 	}

package/src/rehype-islands.ts

@@ -9,14 +9,14 @@ const visit = _visit as (
 ) => any;
 
 // This fixes some confusing bugs coming from somewhere inside of our Markdown pipeline.
-// `unist`/`remark`/`rehype` (not sure) often generate malformed HTML inside of <astro-root>
+// `unist`/`remark`/`rehype` (not sure) often generate malformed HTML inside of <astro-island>
 // For hydration to work properly, frameworks need the DOM to be the exact same on server/client.
 // This reverts some "helpful corrections" that are applied to our perfectly valid HTML!
 export default function rehypeIslands(): any {
 	return function (node: any): any {
 		return visit(node, 'element', (el) => {
-			// Bugs only happen inside of <astro-root> islands
-			if (el.tagName == 'astro-root') {
+			// Bugs only happen inside of <astro-island> islands
+			if (el.tagName == 'astro-island') {
 				visit(el, 'text', (child, index, parent) => {
 					if (child.type === 'text') {
 						// Sometimes comments can be trapped as text, which causes them to be escaped

package/src/remark-unwrap.ts

@@ -8,7 +8,7 @@ const visit = _visit as (
 	callback?: (node: any, index: number, parent: any) => any
 ) => any;
 
-// Remove the wrapping paragraph for <astro-root> islands
+// Remove the wrapping paragraph for <astro-island> islands
 export default function remarkUnwrap() {
 	const astroRootNodes = new Set();
 	let insideAstroRoot = false;
@@ -19,10 +19,10 @@ export default function remarkUnwrap() {
 		astroRootNodes.clear();
 
 		visit(tree, 'html', (node) => {
-			if (node.value.indexOf('<astro-root') > -1 && !insideAstroRoot) {
+			if (node.value.indexOf('<astro-island') > -1 && !insideAstroRoot) {
 				insideAstroRoot = true;
 			}
-			if (node.value.indexOf('</astro-root') > -1 && insideAstroRoot) {
+			if (node.value.indexOf('</astro-island') > -1 && insideAstroRoot) {
 				insideAstroRoot = false;
 			}
 			astroRootNodes.add(node);

package/src/types.ts

@@ -40,3 +40,20 @@ export interface MarkdownRenderingOptions extends AstroMarkdownOptions {
 		scopedClassName: string | null;
 	};
 }
+
+export interface MarkdownHeader {
+	depth: number;
+	slug: string;
+	text: string;
+}
+
+export interface MarkdownMetadata {
+	headers: MarkdownHeader[];
+	source: string;
+	html: string;
+}
+
+export interface MarkdownRenderingResult {
+	metadata: MarkdownMetadata;
+	code: string;
+}

package/dist/remark-slug.d.ts

@@ -1,10 +0,0 @@
-/**
- * @typedef {import('mdast').Root} Root
- * @typedef {import('hast').Properties} Properties
- */
-/**
- * Plugin to add anchors headings using GitHub’s algorithm.
- *
- * @type {import('unified').Plugin<void[], Root>}
- */
-export default function remarkSlug(): (tree: any) => void;

package/dist/remark-slug.js

@@ -1,23 +0,0 @@
-import { toString } from "mdast-util-to-string";
-import { visit } from "unist-util-visit";
-import BananaSlug from "github-slugger";
-const slugs = new BananaSlug();
-function remarkSlug() {
-  return (tree) => {
-    slugs.reset();
-    visit(tree, (node) => {
-      console.log(node);
-    });
-    visit(tree, "heading", (node) => {
-      const data = node.data || (node.data = {});
-      const props = data.hProperties || (data.hProperties = {});
-      let id = props.id;
-      id = id ? slugs.slug(String(id), true) : slugs.slug(toString(node));
-      data.id = id;
-      props.id = id;
-    });
-  };
-}
-export {
-  remarkSlug as default
-};

package/src/remark-slug.ts

@@ -1,32 +0,0 @@
-/**
- * @typedef {import('mdast').Root} Root
- * @typedef {import('hast').Properties} Properties
- */
-
-import { toString } from 'mdast-util-to-string';
-import { visit } from 'unist-util-visit';
-import BananaSlug from 'github-slugger';
-
-const slugs = new BananaSlug();
-
-/**
- * Plugin to add anchors headings using GitHub’s algorithm.
- *
- * @type {import('unified').Plugin<void[], Root>}
- */
-export default function remarkSlug() {
-	return (tree: any) => {
-		slugs.reset();
-		visit(tree, (node) => {
-			console.log(node);
-		});
-		visit(tree, 'heading', (node) => {
-			const data = node.data || (node.data = {});
-			const props = /** @type {Properties} */ data.hProperties || (data.hProperties = {});
-			let id = props.id;
-			id = id ? slugs.slug(String(id), true) : slugs.slug(toString(node));
-			data.id = id;
-			props.id = id;
-		});
-	};
-}