Add shiki lang path compat (#8996)

withastro · Nov 6, 2023 · 3988bbc · 3988bbc
1 parent 910eb00
commit 3988bbc
Show file tree

Hide file tree

Showing 7 changed files with 438 additions and 7 deletions.
diff --git a/.changeset/strange-toes-remain.md b/.changeset/strange-toes-remain.md
@@ -0,0 +1,5 @@
+---
+'astro': patch
+---
+
+Adds compatibility for shiki languages with the `path` property
diff --git a/packages/astro/components/Code.astro b/packages/astro/components/Code.astro
@@ -1,4 +1,7 @@
 ---
+import path from 'node:path';
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
 import type {
 	BuiltinLanguage,
 	BuiltinTheme,
@@ -56,8 +59,25 @@ const {
 
 // shiki -> shikiji compat
 if (typeof lang === 'object') {
-	// `id` renamed to `name
-	if ((lang as any).id && !lang.name) {
+	// shikiji does not support `path`
+	// https://github.com/shikijs/shiki/blob/facb6ff37996129626f8066a5dccb4608e45f649/packages/shiki/src/loader.ts#L98
+	const langPath = (lang as any).path;
+	if (langPath) {
+		// shiki resolves path from within its package directory :shrug:
+		const astroRoot = fileURLToPath(new URL('../', import.meta.url));
+		const normalizedPath = path.isAbsolute(langPath) ? langPath : path.resolve(astroRoot, langPath);
+		try {
+			const content = fs.readFileSync(normalizedPath, 'utf-8');
+			const parsed = JSON.parse(content);
+			Object.assign(lang, parsed);
+		} catch (e) {
+			throw new Error(`Unable to find language file at ${normalizedPath}`, {
+				cause: e,
+			});
+		}
+	}
+	// `id` renamed to `name` (always override)
+	if ((lang as any).id) {
 		lang.name = (lang as any).id;
 	}
 	// `grammar` flattened to lang itself

diff --git a/packages/astro/src/core/config/schema.ts b/packages/astro/src/core/config/schema.ts
@@ -10,7 +10,8 @@ import type { AstroUserConfig, ViteUserConfig } from '../../@types/astro.js';
 
 import type { OutgoingHttpHeaders } from 'node:http';
 import path from 'node:path';
-import { pathToFileURL } from 'node:url';
+import fs from 'node:fs';
+import { fileURLToPath, pathToFileURL } from 'node:url';
 import { z } from 'zod';
 import { appendForwardSlash, prependForwardSlash, removeTrailingForwardSlash } from '../path.js';
 
@@ -247,8 +248,27 @@ export const AstroConfigSchema = z.object({
 							for (const lang of langs) {
 								// shiki -> shikiji compat
 								if (typeof lang === 'object') {
-									// `id` renamed to `name
-									if ((lang as any).id && !lang.name) {
+									// shikiji does not support `path`
+									// https://github.com/shikijs/shiki/blob/facb6ff37996129626f8066a5dccb4608e45f649/packages/shiki/src/loader.ts#L98
+									const langPath = (lang as any).path;
+									if (langPath) {
+										// shiki resolves path from within its package directory :shrug:
+										const astroRoot = fileURLToPath(new URL('../../../', import.meta.url));
+										const normalizedPath = path.isAbsolute(langPath)
+											? langPath
+											: path.resolve(astroRoot, langPath);
+										try {
+											const content = fs.readFileSync(normalizedPath, 'utf-8');
+											const parsed = JSON.parse(content);
+											Object.assign(lang, parsed);
+										} catch (e) {
+											throw new Error(`Unable to find language file at ${normalizedPath}`, {
+												cause: e,
+											});
+										}
+									}
+									// `id` renamed to `name` (always override)
+									if ((lang as any).id) {
 										lang.name = (lang as any).id;
 									}
 									// `grammar` flattened to lang itself

diff --git a/packages/astro/test/astro-markdown-shiki.test.js b/packages/astro/test/astro-markdown-shiki.test.js
@@ -93,8 +93,12 @@ describe('Astro Markdown Shiki', () => {
 			expect(segments[0].attribs.style).to.be.equal('color:#79B8FF');
 			expect(segments[1].attribs.style).to.be.equal('color:#E1E4E8');
 
-			const unknownLang = $('.astro-code').last();
-			expect(unknownLang.attr('style')).to.contain('background-color:#24292e;color:#e1e4e8;');
+			const unknownLang = $('.astro-code').get(1);
+			expect(unknownLang.attribs.style).to.contain('background-color:#24292e;color:#e1e4e8;');
+
+			const caddyLang = $('.astro-code').last();
+			const caddySegments = caddyLang.find('.line');
+			expect(caddySegments.get(1).children[0].attribs.style).to.contain('color:#B392F0');
 		});
 	});
 

diff --git a/packages/astro/test/fixtures/astro-markdown-shiki/langs/astro.config.mjs b/packages/astro/test/fixtures/astro-markdown-shiki/langs/astro.config.mjs
@@ -13,6 +13,14 @@ export default {
 					grammar: riGrammar,
 					aliases: ['ri'],
 				},
+				{
+					id: 'caddy',
+					scopeName: 'source.Caddyfile',
+					// shiki compat: resolves from astro package directory.
+					// careful as astro is linked, this relative path is based on astro/packages/astro.
+					// it's weird but we're testing to prevent regressions.
+					path: './test/fixtures/astro-markdown-shiki/langs/src/caddyfile.tmLanguage.json',
+				},
 			],
 		},
 	},