Remove shiki lang path property support (#9196)

withastro · Nov 27, 2023 · 37697a2 · 37697a2
1 parent 153a5ab
commit 37697a2
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 427 deletions.
diff --git a/.changeset/plenty-candles-help.md b/.changeset/plenty-candles-help.md
@@ -0,0 +1,21 @@
+---
+'astro': major
+---
+
+Removes support for Shiki custom language's `path` property. The language JSON file should be imported and passed to the option instead.
+
+```diff
+// astro.config.js
++ import customLang from './custom.tmLanguage.json'
+
+export default defineConfig({
+  markdown: {
+    shikiConfig: {
+      langs: [
+-       { path: './custom.tmLanguage.json' },
++       customLang,
+      ],
+    },
+  },
+})
+```
diff --git a/packages/astro/components/Code.astro b/packages/astro/components/Code.astro
@@ -1,7 +1,4 @@
 ---
-import path from 'node:path';
-import fs from 'node:fs';
-import { fileURLToPath } from 'node:url';
 import type {
 	BuiltinLanguage,
 	BuiltinTheme,
@@ -64,23 +61,6 @@ const {
 
 // shiki -> shikiji compat
 if (typeof lang === 'object') {
-	// 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;

diff --git a/packages/astro/src/core/config/schema.ts b/packages/astro/src/core/config/schema.ts
@@ -8,10 +8,9 @@ import { markdownConfigDefaults } from '@astrojs/markdown-remark';
 import { bundledThemes, type BuiltinTheme } from 'shikiji';
 import type { AstroUserConfig, ViteUserConfig } from '../../@types/astro.js';
 
-import fs from 'node:fs';
 import type { OutgoingHttpHeaders } from 'node:http';
 import path from 'node:path';
-import { fileURLToPath, pathToFileURL } from 'node:url';
+import { pathToFileURL } from 'node:url';
 import { z } from 'zod';
 import { appendForwardSlash, prependForwardSlash, removeTrailingForwardSlash } from '../path.js';
 
@@ -238,25 +237,6 @@ export const AstroConfigSchema = z.object({
 							for (const lang of langs) {
 								// shiki -> shikiji compat
 								if (typeof lang === 'object') {
-									// 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;

diff --git a/packages/astro/test/astro-markdown-shiki.test.js b/packages/astro/test/astro-markdown-shiki.test.js
@@ -95,10 +95,6 @@ describe('Astro Markdown Shiki', () => {
 
 			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,14 +13,6 @@ 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',
-				},
 			],
 		},
 	},