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

Encode ampersands in markdown code blocks (#3630)

Browse source 
* encode ampersands in markdown code blocks

* chore: add changeset

* nit: fixing test case description
This commit is contained in:
Tony Sullivan 2022-06-20 19:09:35 +00:00 committed by GitHub
parent 509b4f122f
commit 48e67fe053
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 34 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/pink-pugs-beg.md Normal file
View file

@ -0,0 +1,5 @@
---
'@astrojs/markdown-remark': patch
---
Encodes ampersand characters in code blocks

2
packages/markdown/remark/src/rehype-escape.ts
View file

@ -8,7 +8,7 @@ export default function rehypeEscape(): any {
// Visit all raw children and escape HTML tags to prevent Markdown code
// like "This is a `<script>` tag" from actually opening a script tag
visit(el, 'raw', (raw) => {
raw.value = raw.value.replace(/</g, '&lt;').replace(/>/g, '&gt;');
raw.value = raw.value.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;');
});
}
return el;

29
packages/markdown/remark/test/expressions.test.js
View file

@ -1,5 +1,5 @@
import { renderMarkdown } from '../dist/index.js';
import chai from 'chai';
import chai, { expect } from 'chai';
describe('expressions', () => {
it('should be able to serialize bare expression', async () => {
@ -71,6 +71,33 @@ describe('expressions', () => {
);
});
it('should be able to encode ampersand characters in code blocks', async () => {
const { code } = await renderMarkdown(
'The ampersand in `&nbsp;` must be encoded in code blocks.',
{}
);
chai
.expect(code)
.to.equal(
'<p>The ampersand in <code is:raw>&amp;nbsp;</code> must be encoded in code blocks.</p>'
)
});
it('should be able to encode ampersand characters in fenced code blocks', async () => {
const { code } = await renderMarkdown(`
\`\`\`md
The ampersand in \`&nbsp;\` must be encoded in code blocks.
\`\`\`
`);
chai
.expect(code)
.to.match(
/^<pre is:raw.*<code>.*The ampersand in `&amp;nbsp;`/
);
})
it('should be able to serialize function expression', async () => {
const { code } = await renderMarkdown(
`{frontmatter.list.map(item => <p id={item}>{item}</p>)}`,