feat: check code examples syntax #7396
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
why didn't this catch #7402 ? that seems like a pretty great test case for this... |
Yep, I will investigate this. |
I looked into it, and it turns out this is somewhat expected—the code syntax is correct. |
| @@ -168,6 +192,11 @@ export default function rehypeShikiji() { | |||
| // Grabs the relevant alias/name of the language | |||
| const languageId = codeLanguage.slice(languagePrefix.length); | |||
|
|
|||
| // Check code for syntax errors | |||
| if (!checkCodeSyntax(preElementContents, languageId)) { | |||
There was a problem hiding this comment.
Is this a good idea? I would rather have a separate CI process that verifies this rather than Acorn right here. Otherwise it will just dramatically slow down the build process.
I agree, I will create this script |
|
Closing this PR, I will create another one when the script is ready. |
Description
Check if JavaScript code blocks have valid syntax using the acorn parser. We could use Node's vm module to execute the code, but I feel it would be slower and wouldn't work with incomplete code examples.
Validation
Manually edit any code example to broken code
Related Issues
Fixes #7293
Check List
npm run formatto ensure the code follows the style guide.npm run testto check if all tests are passing.npx turbo buildto check if the website builds without errors.