feat(vitepress-twoslash): cache type informations to improve performance

[nakasyou]

Description

VitePress Twoslash takes a long time to render large Types.
This PR solves part of this.

This PR can cache type information with the following code:

export default defineConfig({
  markdown: {
    codeTransformers: [
      transformerTwoslash({
        typesCacheDir: './my-custom-cache-dir'
      })
    ]
  }
})

This will cache the type information in the specified directory.
Use a cache such as GitHub Actions with this to speed up your builds

Linked Issues

Nothing

Additional context

ElysiaJS appears to have cut back on Twoslash because it took 30 minutes to build the documentation. This PR may resolve it.
https://x.com/saltyAom/status/1842140132897615963

[netlify]

✅ Deploy Preview for shiki-matsu ready!

Name	Link
🔨 Latest commit	d38338d
🔍 Latest deploy log	https://app.netlify.com/sites/shiki-matsu/deploys/6736ddc0d6357300081bb249
😎 Deploy Preview	https://deploy-preview-798--shiki-matsu.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ Deploy Preview for shiki-next ready!

Name	Link
🔨 Latest commit	d38338d
🔍 Latest deploy log	https://app.netlify.com/sites/shiki-next/deploys/6736ddc0d6a7de00084e9b6b
😎 Deploy Preview	https://deploy-preview-798--shiki-next.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[antfu]

Sorry it might take a bit longer for me to refactor it a bit to make the logic a bit decoupled - if you want to help with that, could you make typesCacheDir a generic map like typesCache where users could provide their own implementation of how to handle the cache, and then refactor the current logic to a standalone createFilesystemTypesCache(options) factory? Thanks

[nakasyou]

Hi @antfu, thank you for commenting.

You mean

const typesCache = createFileSystemTypesCache(options)

transformerTwoslash({
  typesCache
})

, right?

[antfu]

Yes, something like that

[nakasyou]

@antfu could you check this?

[kravetsone]

Great
this really interesting

[jasonkuhrt]

This is exciting! I made an issue for Graffle to look more into this when I have time.

When it comes to Vitepress, in my mind it feels like this caching stuff should be the default, and presumably almost no one will need to opt out of it, but if they need to then sure it should be possible. My experience is that local development, not just CI builds, is very slow.

So, in other words I'm hoping that a future vitepress release will just make everything faster without any effort from user needed by default. Curious to see how it will actually land.

Thanks all!