docs: add @shikiji/vitepress-twoslash

[btea]

Description

refer to vitejs/vite#16168

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

• It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
• Ideally, include a test that fails without this PR but passes with it.
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

• Run the tests with pnpm test:ci.

Documentation

• If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

[netlify]

✅ Deploy Preview for fastidious-cascaron-4ded94 ready!

Name	Link
🔨 Latest commit	694c2be
🔍 Latest deploy log	https://app.netlify.com/sites/fastidious-cascaron-4ded94/deploys/6613dca0ba4b720008966a2b
😎 Deploy Preview	https://deploy-preview-5483--fastidious-cascaron-4ded94.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.

[AriPerkkio]

Do these two lines need changes as well?

vitest/netlify.toml

Lines 3 to 4 in d400388

	command = "pnpm docs:build"
	ignore = "git diff --quiet $COMMIT_REF $CACHED_COMMIT_REF -- docs/ package.json pnpm-lock.yaml"

• Before pnpm docs:build we need pnpm build so that types are available on file system, right?
• The ignore part may now skip builds when types are changed

There's also plenty of errors on Netlify's logs. Likely related to these issues.

[btea]

Do these two lines need changes as well?

vitest/netlify.toml

Lines 3 to 4 in d400388

	command = "pnpm docs:build"
	ignore = "git diff --quiet $COMMIT_REF $CACHED_COMMIT_REF -- docs/ package.json pnpm-lock.yaml"

• Before pnpm docs:build we need pnpm build so that types are available on file system, right?

Yes, I tweaked the command a bit.

• The ignore part may now skip builds when types are changed

I'm not sure and don't know exactly how to change this, can you give me some tips?

[AriPerkkio]

I'm not sure and don't know exactly how to change this, can you give me some tips?

I guess right now it's checking whether there are changes in docs package.json pnpm-lock.yaml. In future we would want to rebuild docs if any public types changes. I don't think this is possible with the git diff command that is currently being used there. We would need to always check whether packages/*/dist/**.d.ts have changed, but those are not tracked in git.

Maybe it's fine to just remove the ignore condition there.

[btea]

Maybe it's fine to just remove the ignore condition there.

OK, I removed it.

[sheremet-va]

Maybe it's fine to just remove the ignore condition there.

I don't think it should be removed. For new releases, this line doesn't matter because the version in package.json is always updated. For new PRs it's generally meaningless to build new documentation unless there is a change inside the docs themselves - otherwise, it will just create a lot of noise.

[AriPerkkio]

For new PRs it's generally meaningless to build new documentation unless there is a change inside the docs themselves - otherwise, it will just create a lot of noise.

With the current docs/ package.json pnpm-lock.yaml pattern there's no way to rebuild the documentation when an error in typings is fixed, e.g. change in packages/vitest/src/types/config.ts or some other files that ends up creating types or JSDoc in packages/*/dist/**.d.ts.

What pattern should we use in there?

[sheremet-va]

With the current docs/ package.json pnpm-lock.yaml pattern there's no way to rebuild the documentation when an error in typings is fixed, e.g. change in packages/vitest/src/types/config.ts or some other files that ends up creating types or JSDoc in packages/*/dist/**.d.ts.

There is no way to rebuild documentation even now because it depends on the release cycle. If we need to rebuild it, we can always do so manually. Building documentation for every single PR sounds ridiculous to me. We added this line for a reason, and I'm not going back to times when we didn't have it.

[hi-ogawa]

Thanks!

[sheremet-va]

Can you resolve conflicts, please? 👀

[btea]

Can you resolve conflicts, please? 👀

It has been solved, but it seems to cause some ci to fail.

[sheremet-va]

Thank you ❤️