tailwindcss-rails 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2520a011b4bef6255ee93a06b90ca76482ac3cf38236f6031226336033794220
-  data.tar.gz: 89df63d397c8ebaf774129cc9cda90291d1cff0f7bcc29ff55230925c697f7aa
+  metadata.gz: 286396c8100fdd62be9b92948d5ca9d7fa08f8b5747451f40f24405018ffe047
+  data.tar.gz: 937b6afa7441d470d2a0d8f10a21a409eff863d82f6c723ebe07a52d6d4ec462
 SHA512:
-  metadata.gz: fff813245fc1a40d53f4a14e264dbd50a7c6312be4507e60d334d8da8da38e3f67bdf258a642db045e56847bd71cb114680b81bf3925995ae03157db51e36f53
-  data.tar.gz: 750be07cbd111aae1c7f2746f58c3b3ec9db86812eb06099130e279bd10f92897e201caed26c44597280d9c64942465f7822f56897fbe2bcc3235b2a82a04369
+  metadata.gz: b1e3c2e086f51999a4541aba0de0a125c052e730a2fb13d302e00f4e688444abbb4bb1ba0858b4e6267951e8be70e7d37060558a6100c2fed37b71d399e23bb0
+  data.tar.gz: 6e1f8a07ec3502513a9cbadf05e5f2e51ffcd0d23415a3c1ff3d129994e43ffd21994194c84d0730fe93bac2c9e9a41cc34f1f282a085aca9dddd95abd09ad0c

data/README.md

@@ -1,6 +1,10 @@
 # Tailwind CSS for Rails
 
-[Tailwind CSS](https://tailwindcss.com) is a utility-first CSS framework packed with classes like flex, pt-4, text-center and rotate-90 that can be composed to build any design, directly in your markup.
+[Tailwind CSS](https://tailwindcss.com) is a utility-first CSS framework packed with classes like `flex`, `pt-4`, `text-center` and `rotate-90` that can be composed to build any design, directly in your markup.
+
+> [!NOTE]
+> This document is specific to Tailwind v4, corresponding to v4 of this gem. If you are looking for documentation for v3, please visit to the [tailwindcss-rails v3
+README](https://github.com/rails/tailwindcss-rails/tree/v3-stable?tab=readme-ov-file).
 
 <!-- regenerate TOC with `rake format:toc` -->
 
@@ -14,7 +18,7 @@
   * [Upgrade steps](#upgrade-steps)
   * [Troubleshooting a v4 upgrade](#troubleshooting-a-v4-upgrade)
   * [Updating CSS class names for v4](#updating-css-class-names-for-v4)
-- [Developing with Tailwindcss](#developing-with-tailwindcss)
+- [Developing with TailwindCSS](#developing-with-tailwindcss)
   * [Configuration and commands](#configuration-and-commands)
   * [Building for production](#building-for-production)
   * [Building for testing](#building-for-testing)
@@ -26,6 +30,7 @@
   * [Rails Engines support (Experimental)](#rails-engines-support-experimental)
 - [Troubleshooting](#troubleshooting)
   * [The `watch` command is hanging](#the-watch-command-is-hanging)
+  * [The `build` command (or `bin/rails assets:precompile`) is hanging inside a docker container](#the-build-command-or-binrails-assetsprecompile-is-hanging-inside-a-docker-container)
   * [Lost keystrokes or hanging when using terminal-based debugging tools (e.g. IRB, Pry, `ruby/debug`...etc.) with the Puma plugin](#lost-keystrokes-or-hanging-when-using-terminal-based-debugging-tools-eg-irb-pry-rubydebugetc-with-the-puma-plugin)
   * [Running in a docker container exits prematurely](#running-in-a-docker-container-exits-prematurely)
   * [Conflict with sassc-rails](#conflict-with-sassc-rails)
@@ -43,7 +48,7 @@ With Rails 7 you can generate a new application preconfigured with Tailwind CSS
 1. Run `./bin/bundle add tailwindcss-rails`
 2. Run `./bin/rails tailwindcss:install`
 
-This gem depends on the `tailwindcss-ruby` gem to install a working Tailwind CLI executable.
+This gem depends on the `tailwindcss-ruby` gem to install a working TailwindCSS CLI executable.
 
 ### Choosing a specific version of `tailwindcss`
 
@@ -238,7 +243,7 @@ Then, once you've run that successfully, clean up:
   ```
 - **Revert** the changes to `config/tailwind.config.js` so that paths are once again relative to the application root.
 
-## Developing with Tailwindcss
+## Developing with TailwindCSS
 
 ### Configuration and commands
 
@@ -261,12 +266,15 @@ Synopsis:
 - `bin/rails tailwindcss:install` - installs the configuration file, output file, and `Procfile.dev`
 - `bin/rails tailwindcss:build` - generate the output file
   - `bin/rails tailwindcss:build[debug]` - generate unminimized output
+  - `bin/rails tailwindcss:build[silent]` - suppress non-error output from tailwindcss (requires Tailwind CSS v4.3.1)
+  - `bin/rails tailwindcss:build[verbose]` - emit the commands being run
 - `bin/rails tailwindcss:watch` - start live rebuilds, generating output on file changes
   - `bin/rails tailwindcss:watch[debug]` - generate unminimized output
-  - `bin/rails tailwindcss:watch[poll]` - for systems without file system events
   - `bin/rails tailwindcss:watch[always]` - for systems without TTY (e.g., some docker containers)
+  - `bin/rails tailwindcss:watch[silent]` - suppress non-error output from tailwindcss (requires Tailwind CSS v4.3.1)
+  - `bin/rails tailwindcss:watch[verbose]` - emit the commands being run
 
-Note that you can combine task options, e.g. `rails tailwindcss:watch[debug,poll]`.
+Note that you can combine task options, e.g. `rails tailwindcss:watch[debug,always]`.
 
 This gem also makes available a Puma plugin to manage a live rebuild process when you run `rails server` (see "Live Rebuild" section below).
 
@@ -311,14 +319,6 @@ and then running `rails server` (or just `puma`) will run the Tailwind watch pro
 
 This is a flexible command, which can be run with a few different options.
 
-If you are running `rails tailwindcss:watch` on a system that doesn't fully support file system events, pass a `poll` argument to the task to instruct tailwindcss to instead use polling:
-
-```
-rails tailwindcss:watch[poll]
-```
-
-(If you use `bin/dev` then you should modify your `Procfile.dev` to use the `poll` option.)
-
 If you are running `rails tailwindcss:watch` as a process in a Docker container, set `tty: true` in `docker-compose.yml` for the appropriate container to keep the watch process running.
 
 If you are running `rails tailwindcss:watch` in a docker container without a tty, pass the `always` argument to the task to instruct tailwindcss to keep the watcher alive even when `stdin` is closed: `rails tailwindcss:watch[always]`. If you use `bin/dev` then you should modify your `Procfile.dev`.
@@ -354,35 +354,12 @@ Than use `@plugin` annotation in `app/assets/tailwind/application.css`:
 
 ### Using with PostCSS
 
-If you want to use PostCSS as a preprocessor, create a custom `postcss.config.js` in your project root directory, and that file will be loaded by Tailwind automatically.
-
-For example, to enable nesting:
-
-```js
-// postcss.config.js
-export default {
-  plugins: {
-    "@tailwindcss/postcss": {},
-  },
-};
-```
-
-⚠ Note that PostCSS is a JavaScript tool with its own prerequisites! By default `tailwindcss-rails` does not require any JavaScript tooling, so in order to use PostCSS, a `package.json` with dependencies for your plugins and a package manager like `yarn` or `npm` is required, for example:
-
-```json
-// package.json
-{
-  "name": "my app",
-  "private": true,
-  "dependencies": {
-    "@tailwindcss/postcss": "^4.0.0",
-    "tailwindcss": "^4.0.0",
-    "postcss": "^8.5.1"
-  }
-}
-```
+> [!NOTE]
+> Starting with Tailwind v4, the upstream CLI tool no longer supports PostCSS, and the `--postcss` option has
+been removed. If you want to leverage PostCSS with Tailwind 3, please reference the [tailwindcss-rails v3
+README](https://github.com/rails/tailwindcss-rails/tree/v3-stable?tab=readme-ov-file#using-with-postcss).
 
-Then you can use yarn or npm to install the dependencies.
+To leverage PostCSS with Tailwind 4, please reference [The official Tailwind 4 PostCSS docs](https://tailwindcss.com/docs/installation/using-postcss), and leverage [cssbundling-rails](https://github.com/rails/cssbundling-rails).
 
 ### Custom inputs or outputs
 
@@ -428,6 +405,10 @@ There is a [known issue](https://github.com/tailwindlabs/tailwindcss/issues/1724
 
 Please try uninstalling `watchman` and try running the watch task again.
 
+### The `build` command (or `bin/rails assets:precompile`) is hanging inside a docker container
+
+Without a `WORKDIR`, tailwind may search the entire filesystem for files with CSS class names. So, please make sure your Dockerfile uses a `WORKDIR`.
+
 ### Lost keystrokes or hanging when using terminal-based debugging tools (e.g. IRB, Pry, `ruby/debug`...etc.) with the Puma plugin
 
 We've addressed the issue and you can avoid the problem by upgrading `tailwindcss-rails` to [v2.4.1](https://github.com/rails/tailwindcss-rails/releases/tag/v2.4.1) or later versions.

data/lib/generators/test_unit/scaffold/scaffold_generator.rb

@@ -4,10 +4,9 @@ module TestUnit # :nodoc:
   module Generators # :nodoc:
     class ScaffoldGenerator < Base # :nodoc:
       def fix_system_test
-        if turbo_defined? && options[:system_tests]
-          gsub_file File.join("test/system", class_path, "#{file_name.pluralize}_test.rb"),
-                    /(click_on.*Destroy this.*)$/,
-                    "accept_confirm { \\1 }"
+        system_test_file = File.join("test/system", class_path, "#{file_name.pluralize}_test.rb")
+        if turbo_defined? && options[:system_tests] && File.exist?(system_test_file)
+          gsub_file(system_test_file, /(click_on.*Destroy this.*)$/, "accept_confirm { \\1 }")
         end
       end
 

data/lib/puma/plugin/tailwindcss.rb

@@ -13,14 +13,18 @@ Puma::Plugin.create do
       # If we use system(*command) instead, IRB and Debug can't read from $stdin
       # correctly bacause some keystrokes will be taken by watch_command.
       begin
-        IO.popen(Tailwindcss::Commands.watch_command, 'r+') do |io|
+        IO.popen(['bin/rails', 'tailwindcss:watch'], 'r+') do |io|
           IO.copy_stream(io, $stdout)
         end
       rescue Interrupt
       end
     end
 
-    launcher.events.on_stopped { stop_tailwind }
+    if Gem::Version.new(Puma::Const::PUMA_VERSION) >= Gem::Version.new("7")
+      launcher.events.after_stopped { stop_tailwind }
+    else
+      launcher.events.on_stopped { stop_tailwind }
+    end
 
     in_background do
       monitor_tailwind

data/lib/tailwindcss/commands.rb

@@ -3,7 +3,7 @@ require "tailwindcss/ruby"
 module Tailwindcss
   module Commands
     class << self
-      def compile_command(debug: false, **kwargs)
+      def compile_command(debug: false, silent: false, **kwargs)
         debug = ENV["TAILWINDCSS_DEBUG"].present? if ENV.key?("TAILWINDCSS_DEBUG")
         rails_root = defined?(Rails) ? Rails.root : Pathname.new(Dir.pwd)
 
@@ -14,6 +14,7 @@ module Tailwindcss
         ]
 
         command << "--minify" unless (debug || rails_css_compressor?)
+        command << "--silent" if silent
 
         postcss_path = rails_root.join("postcss.config.js")
         command += ["--postcss", postcss_path.to_s] if File.exist?(postcss_path)
@@ -21,11 +22,10 @@ module Tailwindcss
         command
       end
 
-      def watch_command(always: false, poll: false, **kwargs)
+      def watch_command(always: false, **kwargs)
         compile_command(**kwargs).tap do |command|
           command << "-w"
           command << "always" if always
-          command << "-p" if poll
         end
       end
 

data/lib/tailwindcss/engines.rb

@@ -1,6 +1,6 @@
 module Tailwindcss
   module Engines
-     class << self
+    class << self
       def bundle
         FileUtils.mkdir_p(Rails.root.join("app/assets/builds/tailwind"))
         Rails::Engine.subclasses.select do |engine|

data/lib/tailwindcss/version.rb

@@ -1,3 +1,3 @@
 module Tailwindcss
-  VERSION = "4.3.0"
+  VERSION = "4.5.0"
 end

data/lib/tasks/build.rake

@@ -2,9 +2,10 @@ namespace :tailwindcss do
   desc "Build your Tailwind CSS"
   task build: [:environment, :engines] do |_, args|
     debug = args.extras.include?("debug")
+    silent = args.extras.include?("silent")
     verbose = args.extras.include?("verbose")
 
-    command = Tailwindcss::Commands.compile_command(debug: debug)
+    command = Tailwindcss::Commands.compile_command(debug: debug, silent: silent)
     env = Tailwindcss::Commands.command_env(verbose: verbose)
     puts "Running: #{Shellwords.join(command)}" if verbose
 
@@ -14,11 +15,11 @@ namespace :tailwindcss do
   desc "Watch and build your Tailwind CSS on file changes"
   task watch: [:environment, :engines] do |_, args|
     debug = args.extras.include?("debug")
-    poll = args.extras.include?("poll")
     always = args.extras.include?("always")
+    silent = args.extras.include?("silent")
     verbose = args.extras.include?("verbose")
 
-    command = Tailwindcss::Commands.watch_command(always: always, debug: debug, poll: poll)
+    command = Tailwindcss::Commands.watch_command(always: always, debug: debug, silent: silent)
     env = Tailwindcss::Commands.command_env(verbose: verbose)
     puts "Running: #{Shellwords.join(command)}" if verbose
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tailwindcss-rails
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.2.0
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Integrate Tailwind CSS with the asset pipeline in Rails.
 test_files: []