michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix: don't throw when Shiki doesn't recognize a language (#3911)

Browse source 
* Don't throw when Shiki doesn't recognise a language

* Changeset
This commit is contained in:
Juan Martín Seery 2022-07-13 16:31:59 -03:00 committed by GitHub
parent d8af02a944
commit ca45c0c270
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 34 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/healthy-donuts-dream.md Normal file
View file

@ -0,0 +1,5 @@
---
'@astrojs/markdown-remark': patch
---
Don't throw when Shiki doesn't recognize a language

6
packages/astro/test/astro-markdown-shiki.test.js
View file

@ -119,6 +119,9 @@ describe('Astro Markdown Shiki', () => {
expect(segments[0].attribs.style).to.be.equal('color: #C9D1D9');
expect(segments[1].attribs.style).to.be.equal('color: #79C0FF');
expect(segments[2].attribs.style).to.be.equal('color: #C9D1D9');
const unknownLang = $('.line').last().html();
expect(unknownLang).to.be.equal('<span style="color: #c9d1d9">This language does not exist</span>')
});
it('<Markdown /> component', async () => {
@ -129,6 +132,9 @@ describe('Astro Markdown Shiki', () => {
expect(segments).to.have.lengthOf(3);
expect(segments[0].attribs.style).to.be.equal('color: #C9D1D9');
expect(segments[1].attribs.style).to.be.equal('color: #79C0FF');
const unknownLang = $('.line').last().html();
expect(unknownLang).to.be.equal('<span style="color: #c9d1d9">This language does not exist</span>')
});
});

4
packages/astro/test/fixtures/astro-markdown-shiki/langs/src/pages/astro.astro vendored
View file

@ -23,5 +23,9 @@ import Layout from '../layouts/content.astro';
Iniciar(Rinfo, 1, 1)
fin
```
```unknown
This language does not exist
```
</Markdown>
</Layout>

4
packages/astro/test/fixtures/astro-markdown-shiki/langs/src/pages/index.md vendored
View file

@ -20,3 +20,7 @@ comenzar
Iniciar(Rinfo, 1, 1)
fin
```
```unknown
This language does not exist
```

16
packages/markdown/remark/src/remark-shiki.ts
View file

@ -30,7 +30,21 @@ const remarkShiki = async (
return () => (tree: any) => {
visit(tree, 'code', (node) => {
let html = highlighter!.codeToHtml(node.value, { lang: node.lang ?? 'plaintext' });
let lang: string;
if (typeof node.lang === 'string') {
const langExists = highlighter.getLoadedLanguages().includes(node.lang);
if (langExists) {
lang = node.lang;
} else {
console.warn(`The language "${node.lang}" doesn't exist, falling back to plaintext.`);
lang = 'plaintext';
}
} else {
lang = 'plaintext';
}
let html = highlighter!.codeToHtml(node.value, { lang });
// Q: Couldn't these regexes match on a user's inputted code blocks?
// A: Nope! All rendered HTML is properly escaped.