-
-
Notifications
You must be signed in to change notification settings - Fork 200
feat(plugin-twoslash): Make it possible to configure compilerOptions for TypeScript in twoslash #2773
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(plugin-twoslash): Make it possible to configure compilerOptions for TypeScript in twoslash #2773
Conversation
✅ Deploy Preview for rspress-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job!
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