Fix docs type-checking for the Tailwind plugin#29
Merged
Conversation
commit: |
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.
Type checking the
docspackage currently fails when Tailwind is included.The underlying problem appears to be the Vite version. VitePress is still using Vite 5, whereas everything else is using Vite 7. The return value for the Tailwind plugin is
Plugin, withimport { Plugin } from 'vite', but that is currently resolving from Vite 7, which doesn't match the Vite 5Plugintype needed by the VitePress config.Tailwind itself is compatible with Vite 5.2.0+.
The solution is to make Vite an explicit dependency in the
package.jsonfor thedocspackage. This leads topnpminstalling two copies of Tailwind innode_modules, one for Vite 7 and one for Vite 5. Tailwind itself is the same in both cases, but the nestednode_modulescontains different version of Vite, allowing the types to resolve correctly.This should benefit any other plugins that rely on Vite's
Plugintype too.