Improve robustness when upgrading #15038
Merged
Conversation
This file contains 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
Instead of logging the full error when trying to resolve imports, just log the error message and where it's being imported.
Moving the `error(…)` logic to where we are migrating the stylesheet allows us to use the `sheet` available in the current scope to improve the error messages.
If we are printing a message with some prefix, then we do want to add the prefix to the first line, and indent the subsequent lines (in case we need to wrap) with the same width as the prefix. This means that if we had an error message that looked like this: ``` │ ↳ Cannot find any CSS files that reference Tailwind CSS. │ Before your project can be upgraded you need to create a CSS file that imports Tailwind CSS │ or uses `@tailwind`. ``` Now prints as: ``` │ ↳ Cannot find any CSS files that reference Tailwind CSS. │ Before your project can be upgraded you need to create a CSS file that imports Tailwind CSS │ or uses `@tailwind`. ```
philipp-spiess
approved these changes
Nov 19, 2024
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.
This PR improves the robustness when running the upgrade script.
Right now when you run it and if you run into issues, it could be that an error with stack trace is printed in the terminal. This PR improves most of the cases where this happens to ensure the output is easier to parse as a human.
Test plan:
Used SourceGraph to find some popular open source repositories that use Tailwind and tried to run the upgrade tool on those repositories. If a repository fails to upgrade, then that's a good candidate for this PR to showcase the improved error messages.
github.com/docker/docs
github.com/parcel-bundler/parcel
github.com/vercel/next.js