feat(plugin-twoslash): Make it possible to configure compilerOptions for TypeScript in twoslash#2773
Merged
SoonIter merged 2 commits intoweb-infra-dev:mainfrom Nov 19, 2025
Conversation
✅ Deploy Preview for rspress-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for customizing TypeScript compiler options in the Twoslash plugin through a new compilerOptions configuration option. This enables users to apply project-specific TypeScript settings when displaying type information in documentation code blocks.
- Added
compilerOptionsoption toPluginTwoslashOptionsinterface - Configured the option to be passed through to the underlying
transformerTwoslashfunction - Updated documentation in both English and Chinese to describe the new option
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/plugin-twoslash/src/index.ts | Added CompilerOptions type import and new compilerOptions property to plugin options, passing it to transformerTwoslash |
| packages/plugin-twoslash/package.json | Added TypeScript as a peer dependency to support the CompilerOptions type |
| website/docs/en/plugin/official-plugins/twoslash.mdx | Added English documentation for the new compilerOptions configuration option |
| website/docs/zh/plugin/official-plugins/twoslash.mdx | Added Chinese documentation for the new compilerOptions configuration option |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…for TypeScript in twoslash
dd012d0 to
c59814e
Compare
SoonIter
reviewed
Nov 18, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added
compilerOptionsoption to@rspress/plugin-twoslashto allow customization of TypeScript compiler options used by Twoslash.When displaying type information in code blocks with Twoslash, there are cases where you want to apply project-specific TypeScript compiler options. This feature allows you to flexibly customize the TypeScript environment used in code blocks within documentation.
Usage Example
Checklist