feat: default twoslash to throw on errors

wevm · Sep 26, 2024 · 91640f9 · 91640f9
1 parent 6924717
commit 91640f9
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/.changeset/rich-eggs-look.md b/.changeset/rich-eggs-look.md
@@ -0,0 +1,5 @@
+---
+"vocs": patch
+---
+
+Defauled Twoslash to throw on syntax errors, and added a `// @noErrors` tag to disable this behavior.
diff --git a/site/pages/docs/guides/twoslash.mdx b/site/pages/docs/guides/twoslash.mdx
@@ -206,6 +206,7 @@ Taking this example:
 :::code-group
 
 ```ts [Output] twoslash
+// @allowErrors
 const a = "123"
 a = 132
 ```

diff --git a/src/vite/plugins/mdx.ts b/src/vite/plugins/mdx.ts
@@ -110,6 +110,7 @@ export const getRehypePlugins = ({
                 twoslashOptions: {
                   ...twoslash,
                   customTags: [
+                    'allowErrors',
                     ...(defaultTwoslashOptions.customTags ?? []),
                     ...(twoslash.customTags ?? []),
                   ],

diff --git a/src/vite/plugins/shiki/twoslasher.ts b/src/vite/plugins/shiki/twoslasher.ts
@@ -14,6 +14,7 @@ export function twoslasher(
     cache.twoslash.set(codeHash, twoslash)
     return twoslash
   } catch (e) {
+    if (!parameters[0].includes('@allowErrors')) throw e
     const error = e as Error
     const lines = parameters[0].split('\n')
     const line = lines.length - 1