@astrojs/starlight 0.41.6 → 0.41.7

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @astrojs/starlight
 
+## 0.41.7
+
+### Patch Changes
+
+- [#4114](https://github.com/withastro/starlight/pull/4114) [`3e486fb`](https://github.com/withastro/starlight/commit/3e486fba2015589c55aa452746eb17b407a4716e) Thanks [@delucis](https://github.com/delucis)! - Fixes processing of code examples in RTL languages when using Astro’s Sätteri Markdown processor
+
 ## 0.41.6
 
 ### Patch Changes

package/integrations/satteri.ts

@@ -1,12 +1,13 @@
 import { fileURLToPath } from 'node:url';
 import { satteriHeadingIdsPlugin } from '@astrojs/markdown-satteri';
-import type { Element, Properties } from 'hast';
+import type { Parents, Properties } from 'hast';
 import type { Paragraph } from 'mdast';
 import { directiveToMarkdown } from 'mdast-util-directive';
 import { toMarkdown } from 'mdast-util-to-markdown';
 import type {
 	HastPluginDefinition,
 	HastPluginInput,
+	HastVisitorContext,
 	MdastPluginInput,
 	MdastPluginDefinition,
 } from 'satteri';
@@ -136,59 +137,52 @@ function serializeDirective(node: Parameters<typeof toMarkdown>[0]): string {
 	return md.at(-1) === '\n' ? md.slice(0, -1) : md;
 }
 
-function satteriRtlCodeSupportPlugin(allowedPaths: string[]): () => HastPluginDefinition {
-	return () => {
-		// HACK: Sätteri currently does not expose a way to either know the parent of a node, or
-		// skipping a subtree visit. To work around this, we manually track the source spans of `<pre>`
-		// elements and skip applying `dir="auto"` to `<code>` elements inside those spans. This is:
-		// bad, because it means that it won't work for nodes without positions (e.g. generated nodes),
-		// but it's as good as it gets right now.
-		const preSpans: Array<[number, number]> = [];
-		return {
-			name: 'starlight-rtl-code-support',
-			element: [
-				{
-					filter: ['pre'],
-					visit(node, ctx) {
-						if (!shouldTransformPath(ctx.fileURL, allowedPaths)) return;
-						const span = nodeSpan(node);
-						if (span) preSpans.push(span);
-						if (node.properties && 'dir' in node.properties) return;
-						ctx.setProperty(node, 'dir', 'ltr');
-					},
+function satteriRtlCodeSupportPlugin(allowedPaths: string[]): HastPluginDefinition {
+	return {
+		name: 'starlight-rtl-code-support',
+		element: [
+			{
+				filter: ['pre'],
+				visit(node, ctx) {
+					if (!shouldTransformPath(ctx.fileURL, allowedPaths)) return;
+					if (node.properties && 'dir' in node.properties) return;
+					ctx.setProperty(node, 'dir', 'ltr');
 				},
-				{
-					filter: ['code'],
-					visit(node, ctx) {
-						if (!shouldTransformPath(ctx.fileURL, allowedPaths)) return;
-						if (isInsideSpan(nodeSpan(node), preSpans)) return;
-						if (node.properties && 'dir' in node.properties) return;
+			},
+			{
+				filter: ['code'],
+				visit(node, ctx) {
+					if (
+						shouldTransformPath(ctx.fileURL, allowedPaths) &&
+						!(node.properties && 'dir' in node.properties) &&
+						!hasPreParent(node, ctx)
+					) {
 						ctx.setProperty(node, 'dir', 'auto');
-					},
+					}
 				},
-			],
-			// Shiki runs ahead of us and replaces the highlighted `<pre>` element with a raw HTML
-			// node, so the `pre` element visitor above never sees it. Patch the raw markup instead.
-			raw(node, ctx) {
-				if (!shouldTransformPath(ctx.fileURL, allowedPaths)) return undefined;
-				const value = ltrRawPre(node.value);
-				if (value === null) return undefined;
-				return { type: 'raw', value };
 			},
-		};
+		],
+		// Shiki runs ahead of us and replaces the highlighted `<pre>` element with a raw HTML
+		// node, so the `pre` element visitor above never sees it. Patch the raw markup instead.
+		raw(node, ctx) {
+			if (!shouldTransformPath(ctx.fileURL, allowedPaths)) return undefined;
+			const value = ltrRawPre(node.value);
+			if (value === null) return undefined;
+			return { type: 'raw', value };
+		},
 	};
 }
 
-/** The source byte span of a node, or `null` when it carries no position (e.g. a generated node). */
-function nodeSpan(node: { position?: Element['position'] }): [number, number] | null {
-	const start = node.position?.start.offset;
-	const end = node.position?.end.offset;
-	return typeof start === 'number' && typeof end === 'number' ? [start, end] : null;
-}
-
-function isInsideSpan(span: [number, number] | null, spans: Array<[number, number]>): boolean {
-	if (!span) return false;
-	return spans.some(([start, end]) => span[0] >= start && span[1] <= end);
+/**
+ * Check if any parent of `child` is a `<pre>` element by walking up the tree.
+ */
+function hasPreParent(child: Readonly<Parents> | undefined, ctx: HastVisitorContext): boolean {
+	while (child) {
+		const parent: Readonly<Parents> | undefined = ctx.parent(child);
+		if (parent?.type === 'element' && parent.tagName === 'pre') return true;
+		child = parent;
+	}
+	return false;
 }
 
 const rawPreOpenTag = /<pre(?=[\s>])[^>]*>/;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astrojs/starlight",
-  "version": "0.41.6",
+  "version": "0.41.7",
   "description": "Build beautiful, high-performance documentation websites with Astro",
   "keywords": [
     "docs",
@@ -51,18 +51,18 @@
     }
   },
   "devDependencies": {
-    "@astrojs/markdown-remark": "^7.2.0",
+    "@astrojs/markdown-remark": "^7.2.2",
     "@playwright/test": "^1.61.1",
     "@types/node": "^22.19.17",
     "@vitest/coverage-v8": "^4.1.5",
-    "astro": "^7.0.2",
+    "astro": "^7.1.6",
     "linkedom": "^0.18.12",
     "vitest": "^4.1.5"
   },
   "dependencies": {
-    "@astrojs/markdown-satteri": "^0.3.2",
-    "@astrojs/mdx": "^7.0.0",
-    "@astrojs/sitemap": "^3.7.2",
+    "@astrojs/markdown-satteri": "^0.3.5",
+    "@astrojs/mdx": "^7.0.5",
+    "@astrojs/sitemap": "^3.7.3",
     "@pagefind/default-ui": "^1.3.0",
     "@types/hast": "^3.0.4",
     "@types/js-yaml": "^4.0.9",