Skip to content

doc: update README with TailwindCSS v4 upgrade instructions #480

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

Merged
merged 1 commit into from
Jan 27, 2025

Conversation

EricGusmao
Copy link
Contributor

No description provided.

README.md Outdated
Comment on lines 100 to 108
```js
content: [
'../public/*.html',
'../app/helpers/**/*.rb',
'../app/javascript/**/*.js',
'../app/views/**/*.{erb,haml,html,slim}'
],
```
(Just add an additional ``.`` to all the paths referenced)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mentioned this in the Discussions thread, but I think this is a bug that should be reported upstream. If you have a clean repro, would you please report that the path is being interpreted as relative to the config file in the upgrade tool (and not CWD as the CLI correctly does)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry to have to ask, but I'm probably not going to have the time today to start to investigate and build a repro from scratch today.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll see what I can find

README.md Outdated
# Gemfile
gem "tailwindcss-rails", "~> 4.0" # which transitively pins tailwindcss-ruby to v4
```
To replace the class names accordingly for v4, go to ``config/tailwind.config.js`` update the ``content`` part to:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to call this section out as a separate section in the doc. Some people may not care about upgrading their class names, especially if it's difficult (which this process surely will be for a large number of people).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also if (when?) we automate this in the tailwindcss:upgrade task we can more easily remove the section later.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed at ffe7178

Co-authored-by: Mike Dalessio <mike.dalessio@gmail.com>
Copy link
Member

@flavorjones flavorjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rebased and restructured the headers slightly. Thank you so much!

@flavorjones flavorjones merged commit 773fedd into rails:main Jan 27, 2025
17 checks passed
@EricGusmao EricGusmao deleted the readme-update branch January 28, 2025 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants