feat(twoslash): introduce disableTriggers, close #780

antfu · antfu · commit dca6a4885b72 · 2024-09-19T15:09:57.000+02:00
diff --git a/packages/twoslash/src/core.ts b/packages/twoslash/src/core.ts
@@ -38,6 +38,7 @@ export function createTransformerFactory(
       },
       twoslasher = defaultTwoslasher,
       explicitTrigger = false,
+      disableTriggers = ['notwoslash', 'no-twoslash'],
       renderer = defaultRenderer,
       throws = true,
       includesMap = new Map(),
@@ -67,7 +68,13 @@ export function createTransformerFactory(
 
     const map = new WeakMap<ShikiTransformerContextMeta, TwoslashShikiReturn>()
 
-    const filter = options.filter || ((lang, _, options) => langs.includes(lang) && (!explicitTrigger || trigger.test(options.meta?.__raw || '')))
+    const {
+      filter = (lang, _, options) => {
+        return langs.includes(lang)
+          && (!explicitTrigger || trigger.test(options.meta?.__raw || ''))
+          && !disableTriggers.some(i => typeof i === 'string' ? options.meta?.__raw?.includes(i) : i.test(options.meta?.__raw || ''))
+      },
+    } = options
 
     const includes = new TwoslashIncludesManager(includesMap)
 
diff --git a/packages/twoslash/src/types.ts b/packages/twoslash/src/types.ts
@@ -38,13 +38,19 @@ export interface TransformerTwoslashOptions {
    * @default false
    */
   explicitTrigger?: boolean | RegExp
+  /**
+   * Triggers that skip Twoslash transformation on the code block meta
+   *
+   * @default ['notwoslash', 'no-twoslash']
+   */
+  disableTriggers?: (string | RegExp)[]
   /**
    * Mapping from language alias to language name
    */
   langAlias?: Record<string, string>
   /**
    * Custom filter function to apply this transformer to
-   * When specified, `langs` and `explicitTrigger` will be ignored
+   * When specified, `langs`, `explicitTrigger`, and `disableTriggers` will be ignored
    */
   filter?: (lang: string, code: string, options: CodeToHastOptions) => boolean
   /**
diff --git a/packages/twoslash/test/markdown-it.test.ts b/packages/twoslash/test/markdown-it.test.ts
@@ -102,4 +102,44 @@ const v = 123
 
     expect(styleTag + html).toMatchFileSnapshot('./out/markdown-it/highlight-lines.html')
   })
+
+  it('with disable triggers', async () => {
+    const md = MarkdownIt()
+
+    md.use(await Shiki({
+      langs: ['ts'],
+      themes: {
+        light: 'vitesse-light',
+        dark: 'vitesse-dark',
+      },
+      defaultColor: false,
+      transformers: [
+        transformerMetaHighlight(),
+        transformerTwoslash({
+          explicitTrigger: false,
+          renderer: rendererRich(),
+        }),
+      ],
+    }))
+
+    const html = md.render(`
+# Hello
+
+\`\`\`ts {1,3}
+const a = 123
+const b = 123
+const v = 123
+//    ^?
+\`\`\`
+
+\`\`\`ts no-twoslash {2}
+const a = 123
+const b = 123
+const v = 123
+//    ^?
+\`\`\`
+    `.trim())
+
+    expect(styleTag + html).toMatchFileSnapshot('./out/markdown-it/highlight-disable-triggers.html')
+  })
 })
diff --git a/packages/twoslash/test/out/markdown-it/highlight-disable-triggers.html b/packages/twoslash/test/out/markdown-it/highlight-disable-triggers.html
