tailwindcss-rails 2.3.0 → 2.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f14bac83bc6a8df8bba207524b748c4f9a1a7689b012b3495814af1276e51172
4
- data.tar.gz: 5714edc137dee618ea34462f1c0033d2bf6cafda8180e0448a6a15aea9ae3ab9
3
+ metadata.gz: c6885977e39ac7e28580dc7296ff7eb89ae593ef5cce846a631b9f90c845f3d7
4
+ data.tar.gz: 6e5ddea98ed66a41d8c3c0575c5015f5cfa44703b8c91019831ac14ce04e4acb
5
5
  SHA512:
6
- metadata.gz: 8b8e7c71d76761ca29c57bdcfee4d41c585ce8b8fef60186e251689999a93354b2b9603bb9b3f0c6ec796f2478fbe1fcff172014793772e8f46628976c0b535f
7
- data.tar.gz: 1a68c451d9f716e7788ec72d9dc726383d9b9f3bd7a5b261997cf5ef60b75fe75632113f4cb549dbc699e053f24999f49056091ac7709f9890da6024f3495134
6
+ metadata.gz: 538f8be7ff95b436605a828170ea87bba9629a3dfe4fe58598b420e1c4e816fbc768db2e3180c6a03e597b491439b8371e00a7792c096c48b41cf24740054d0e
7
+ data.tar.gz: ead1e73f8ae4bbfc3391be7a858f4c3c181780237eb78f56dae514c3c13590eedb01b7a04d55ce5efafcb33c3ae7ce8c992696919c3b9cec05c77d78c8a77879
data/README.md CHANGED
@@ -2,6 +2,31 @@
2
2
 
3
3
  [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.
4
4
 
5
+ <!-- regenerate TOC with `rake format:toc` -->
6
+
7
+ <!-- toc -->
8
+
9
+ - [Installation](#installation)
10
+ * [Using a local installation of `tailwindcss`](#using-a-local-installation-of-tailwindcss)
11
+ - [Developing with Tailwindcss](#developing-with-tailwindcss)
12
+ * [Configuration and commands](#configuration-and-commands)
13
+ * [Building for production](#building-for-production)
14
+ * [Building for testing](#building-for-testing)
15
+ * [Building unminified assets](#building-unminified-assets)
16
+ * [Live rebuild](#live-rebuild)
17
+ * [Using with PostCSS](#using-with-postcss)
18
+ * [Custom inputs or outputs](#custom-inputs-or-outputs)
19
+ - [Troubleshooting](#troubleshooting)
20
+ * [Running in a docker container exits prematurely](#running-in-a-docker-container-exits-prematurely)
21
+ * [Conflict with sassc-rails](#conflict-with-sassc-rails)
22
+ * [Class names must be spelled out](#class-names-must-be-spelled-out)
23
+ * [`ERROR: Cannot find the tailwindcss executable` for supported platform](#error-cannot-find-the-tailwindcss-executable-for-supported-platform)
24
+ * [Using asset-pipeline assets](#using-asset-pipeline-assets)
25
+ * [Conflict with pre-existing asset pipeline stylesheets](#conflict-with-pre-existing-asset-pipeline-stylesheets)
26
+ - [License](#license)
27
+
28
+ <!-- tocstop -->
29
+
5
30
  ## Installation
6
31
 
7
32
  With Rails 7 you can generate a new application preconfigured with Tailwind by using `--css tailwind`. If you're adding Tailwind later, you need to:
@@ -24,27 +49,56 @@ Supported platforms are:
24
49
 
25
50
  ### Using a local installation of `tailwindcss`
26
51
 
27
- If you are not able to use the vendored standalone executables (for example, if you're on an unsupported platform), you can use a local installation of the `tailwindcss` executable by setting an environment variable named `TAILWINDCSS_INSTALL_DIR` to the directory containing the executable.
52
+ If you are not able to use the vendored standalone executables (for example, if you're on an unsupported platform), you can use a local installation of the `tailwindcss` executable by setting an environment variable named `TAILWINDCSS_INSTALL_DIR` to the directory path containing the executable.
28
53
 
29
- For example, if you've installed `tailwindcss` so that the executable is found at `/node_modules/bin/tailwindcss`, then you should set your environment variable like so:
54
+ For example, if you've installed `tailwindcss` so that the executable is found at `/path/to/node_modules/bin/tailwindcss`, then you should set your environment variable like so:
30
55
 
31
56
  ``` sh
32
57
  TAILWINDCSS_INSTALL_DIR=/path/to/node_modules/bin
33
58
  ```
34
59
 
35
- This also works with relative paths. If you've installed into your app's directory at `./node_modules/.bin/tailwindcss`:
60
+ or, for relative paths like `./node_modules/.bin/tailwindcss`:
36
61
 
37
62
  ``` sh
38
63
  TAILWINDCSS_INSTALL_DIR=node_modules/.bin
39
64
  ```
40
65
 
66
+
41
67
  ## Developing with Tailwindcss
42
68
 
43
- ### Configuration
69
+ ### Configuration and commands
70
+
71
+ #### Configuration file: `config/tailwind.config.js`
44
72
 
45
73
  You can customize the Tailwind build through the `config/tailwind.config.js` file, just like you would if Tailwind was running in a traditional node installation. All the first-party plugins are supported.
46
74
 
47
- The installer will create your Tailwind input file in `app/assets/stylesheets/application.tailwind.css`. This is where you import the plugins you want to use, and where you can setup your custom `@apply` rules. When you run `rails tailwindcss:build`, this input file will be used to generate the output in `app/assets/builds/tailwind.css`. That's the output CSS that you'll include in your app (the installer automatically configures this, alongside the Inter font as well).
75
+ #### Input file: `app/assets/stylesheets/application.tailwind.css`
76
+
77
+ The installer will generate a Tailwind input file in `app/assets/stylesheets/application.tailwind.css`. This is where you import the plugins you want to use, and where you can setup your custom `@apply` rules.
78
+
79
+ #### Output file: `app/assets/builds/tailwind.css`
80
+
81
+ When you run `rails tailwindcss:build`, the input file will be used to generate the output in `app/assets/builds/tailwind.css`. That's the output CSS that you'll include in your app (the installer automatically configures this, alongside the Inter font as well).
82
+
83
+ #### Commands
84
+
85
+ This gem makes several Rails tasks available, some of which have multiple options which can be combined.
86
+
87
+ Synopsis:
88
+
89
+ - `bin/rails tailwindcss:install` - installs the configuration file, output file, and `Procfile.dev`
90
+ - `bin/rails tailwindcss:build` - generate the output file
91
+ - `bin/rails tailwindcss:build[debug]` - generate unminimized output
92
+ - `bin/rails tailwindcss:watch` - start live rebuilds, generating output on file changes
93
+ - `bin/rails tailwindcss:watch[debug]` - generate unminimized output
94
+ - `bin/rails tailwindcss:watch[poll]` - for systems without file system events
95
+ - `bin/rails tailwindcss:watch[always]` - for systems without TTY (e.g., some docker containers)
96
+
97
+ Note that you can combine task options, e.g. `rails tailwindcss:watch[debug,poll]`.
98
+
99
+ This gem also makes available a Puma plugin to manage a live rebuild process when you run `rails server` (see "Live Rebuild" section below).
100
+
101
+ This gem also generates a `Procfile.dev` file which will run both the rails server and a live rebuild process (see "Live Rebuild" section below).
48
102
 
49
103
 
50
104
  ### Building for production
@@ -57,17 +111,23 @@ The `tailwindcss:build` is automatically attached to `assets:precompile`, so bef
57
111
  The `tailwindcss:build` task is automatically attached to the `test:prepare` Rake task. This task runs before test commands. If you run `bin/rails test` in your CI environment, your Tailwind output will be generated before tests run.
58
112
 
59
113
 
60
- ### Update assets automatically
114
+ ### Building unminified assets
115
+
116
+ If you want unminified assets, you can pass a `debug` argument to the rake task, i.e. `rails tailwindcss:build[debug]` or `rails tailwindcss:watch[debug]`.
117
+
118
+
119
+ ### Live rebuild
61
120
 
62
121
  While you're developing your application, you want to run Tailwind in "watch" mode, so changes are automatically reflected in the generated CSS output. You can do this in a few different ways:
63
122
 
64
- - use the [Puma](https://puma.io/) plugin to integrate "watch" with `rails server`, or
65
- - run `rails tailwindcss:watch` as a separate process, or
66
- - run `bin/dev` which uses [Foreman](https://github.com/ddollar/foreman)
123
+ - use this gem's [Puma](https://puma.io/) plugin to integrate "watch" with `rails server`,
124
+ - or run `rails tailwindcss:watch` as a separate process,
125
+ - or run `bin/dev` which uses [Foreman](https://github.com/ddollar/foreman)
126
+
67
127
 
68
128
  #### Puma plugin
69
129
 
70
- The Puma plugin requires you to add this line to your `puma.rb` configuration:
130
+ This gem ships with a Puma plugin. To use it, add this line to your `puma.rb` configuration:
71
131
 
72
132
  ```ruby
73
133
  plugin :tailwindcss if ENV.fetch("RAILS_ENV", "development") == "development"
@@ -80,7 +140,13 @@ and then running `rails server` will run the Tailwind watch process in the backg
80
140
 
81
141
  This is a flexible command, which can be run with a few different options.
82
142
 
83
- 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`.
143
+ 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:
144
+
145
+ ```
146
+ rails tailwindcss:watch[poll]
147
+ ```
148
+
149
+ (If you use `bin/dev` then you should modify your `Procfile.dev` to use the `poll` option.)
84
150
 
85
151
  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.
86
152
 
@@ -92,13 +158,6 @@ If you are running `rails tailwindcss:watch` in a docker container without a tty
92
158
  Running `bin/dev` invokes Foreman to start both the Tailwind watch process and the rails server in development mode based on your `Procfile.dev` file.
93
159
 
94
160
 
95
- ### Debugging with unminified assets
96
-
97
- If you want unminified assets, you can pass a `debug` argument to the rake task, i.e. `rails tailwindcss:build[debug]` or `rails tailwindcss:watch[debug]`.
98
-
99
- Note that you can combine task options, e.g. `rails tailwindcss:watch[debug,poll]`.
100
-
101
-
102
161
  ### Using with PostCSS
103
162
 
104
163
  If you want to use PostCSS as a preprocessor, create a custom `config/postcss.config.js` and it will be loaded automatically.
@@ -126,6 +185,12 @@ If you need to use a custom input or output file, you can run `bundle exec tailw
126
185
 
127
186
  Some common problems experienced by users ...
128
187
 
188
+ ### Running in a docker container exits prematurely
189
+
190
+ 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.
191
+
192
+ 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`.
193
+
129
194
  ### Conflict with sassc-rails
130
195
 
131
196
  Tailwind uses modern CSS features that are not recognized by the `sassc-rails` extension that was included by default in the Gemfile for Rails 6. In order to avoid any errors like `SassC::SyntaxError`, you must remove that gem from your Gemfile.
@@ -134,7 +199,7 @@ Tailwind uses modern CSS features that are not recognized by the `sassc-rails` e
134
199
 
135
200
  For Tailwind to work, your class names need to be spelled out. If you need to make sure Tailwind generates class names that don't exist in your content files or that are programmatically composed, use the [safelist option](https://tailwindcss.com/docs/content-configuration#safelisting-classes).
136
201
 
137
- ### ERROR: Cannot find the tailwindcss executable for &lt;supported platform&gt;
202
+ ### `ERROR: Cannot find the tailwindcss executable` for supported platform
138
203
 
139
204
  Some users are reporting this error even when running on one of the supported native platforms:
140
205
 
@@ -172,24 +237,11 @@ and re-bundle.
172
237
  See https://bundler.io/man/bundle-config.1.html for more information.
173
238
 
174
239
 
175
- ### "No such file or directory" running on Alpine (musl)
176
-
177
- When running `tailwindcss` on an Alpine system, some users report a "No such file or directory" error message.
178
-
179
-
180
- #### Install gnu libc compatibility
181
-
182
- The cause of this is the upstream `tailwindcss` binary executables being built on a gnu libc system, making them incompatible with standard musl libc systems.
183
-
184
- A fix for this has been proposed upstream at https://github.com/tailwindlabs/tailwindcss/discussions/6785, but in the meantime a workaround is to install compatibility libraries:
185
-
186
- ``` sh
187
- apk add build-base gcompat
188
- ```
189
-
190
240
  ### Using asset-pipeline assets
191
241
 
192
- In Rails, you want to use [assets from the asset pipeline to get fingerprinting](https://guides.rubyonrails.org/asset_pipeline.html#what-is-fingerprinting-and-why-should-i-care-questionmark). However, Tailwind isn't aware of those assets. To use assets from the pipeline, use `url(image.svg)`. [Since Sprockets v3.3.0](https://github.com/rails/sprockets-rails/pull/476) `url(image.svg)` will then automatically be rewritten to `/path/to/assets/image-7801e7538c6f1cc57aa75a5876ab0cac.svg`. So the output CSS will have the correct path to those assets.
242
+ In Rails, you want to use [assets from the asset pipeline to get fingerprinting](https://guides.rubyonrails.org/asset_pipeline.html#what-is-fingerprinting-and-why-should-i-care-questionmark). However, Tailwind isn't aware of those assets.
243
+
244
+ To use assets from the pipeline, use `url(image.svg)`. [Since Sprockets v3.3.0](https://github.com/rails/sprockets-rails/pull/476) `url(image.svg)` is rewritten to `/path/to/assets/image-7801e7538c6f1cc57aa75a5876ab0cac.svg` so output CSS will have the correct path to those assets.
193
245
 
194
246
  ```js
195
247
  module.exports = {
@@ -211,9 +263,14 @@ The inline version also works:
211
263
 
212
264
  ### Conflict with pre-existing asset pipeline stylesheets
213
265
 
214
- If you get a warning `Unrecognized at-rule or error parsing at-rule ‘@tailwind’.` in the browser console after installation, you incorrectly double-process `application.tailwind.css`. This is a misconfiguration, even though the styles will be fully effective in many cases. The file `application.tailwind.css` is installed when running `rails tailwindcss:install` and is placed alongside the common `application.css` in `app/assets/stylesheets`. Because the `application.css` in a newly generated Rails app includes a `require_tree .` directive, the asset pipeline incorrectly processes `application.tailwind.css`, where it should be taken care of by `tailwindcss`. The asset pipeline ignores TailwindCSS's at-directives, and the browser can't process them.
266
+ If you get a warning `Unrecognized at-rule or error parsing at-rule ‘@tailwind’.` in the browser console after installation, you are incorrectly double-processing `application.tailwind.css`. This is a misconfiguration, even though the styles will be fully effective in many cases.
267
+
268
+ The file `application.tailwind.css` is installed when running `rails tailwindcss:install` and is placed alongside the common `application.css` in `app/assets/stylesheets`. Because the `application.css` in a newly generated Rails app includes a `require_tree .` directive, the asset pipeline incorrectly processes `application.tailwind.css`, where it should be taken care of by `tailwindcss`. The asset pipeline ignores TailwindCSS's at-directives, and the browser can't process them.
269
+
270
+ To fix the warning, you can either remove the `application.css`, if you don't plan to use the asset pipeline for stylesheets, and instead rely on TailwindCSS completely for styles. This is what this installer assumes.
271
+
272
+ Or, if you do want to keep using the asset pipeline in parallel, make sure to remove the `require_tree .` line from the `application.css`.
215
273
 
216
- To fix the warning, you can either remove the `application.css`, if you don't plan to use the asset pipeline for stylesheets, and instead rely on TailwindCSS completely for styles. This is what this installer assumes. Else, if you do want to keep using the asset pipeline in parallel, make sure to remove the `require_tree .` line from the `application.css`.
217
274
 
218
275
  ## License
219
276
 
data/Rakefile CHANGED
@@ -12,3 +12,15 @@ Rake::TestTask.new(:test) do |t|
12
12
  end
13
13
 
14
14
  task default: :test
15
+
16
+ namespace "format" do
17
+ desc "Regenerate table of contents in README"
18
+ task "toc" do
19
+ require "mkmf"
20
+ if find_executable0("markdown-toc")
21
+ sh "markdown-toc --maxdepth=3 -i README.md"
22
+ else
23
+ puts "WARN: cannot find markdown-toc, skipping. install with 'npm install markdown-toc'"
24
+ end
25
+ end
26
+ end
@@ -1,7 +1,7 @@
1
1
  module Tailwindcss
2
2
  # constants describing the upstream tailwindcss project
3
3
  module Upstream
4
- VERSION = "v3.4.1"
4
+ VERSION = "v3.4.3"
5
5
 
6
6
  # rubygems platform name => upstream release filename
7
7
  NATIVE_PLATFORMS = {
@@ -1,3 +1,3 @@
1
1
  module Tailwindcss
2
- VERSION = "2.3.0"
2
+ VERSION = "2.4.0"
3
3
  end
data/lib/tasks/build.rake CHANGED
@@ -15,6 +15,8 @@ namespace :tailwindcss do
15
15
  command = Tailwindcss::Commands.watch_command(always: always, debug: debug, poll: poll)
16
16
  puts command.inspect if args.extras.include?("verbose")
17
17
  system(*command)
18
+ rescue Interrupt
19
+ puts "Received interrupt, exiting tailwindcss:watch" if args.extras.include?("verbose")
18
20
  end
19
21
  end
20
22
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tailwindcss-rails
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.3.0
4
+ version: 2.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Heinemeier Hansson
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2024-01-10 00:00:00.000000000 Z
11
+ date: 2024-04-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: railties
@@ -25,7 +25,7 @@ dependencies:
25
25
  - !ruby/object:Gem::Version
26
26
  version: 6.0.0
27
27
  force_ruby_platform: false
28
- description:
28
+ description:
29
29
  email: david@loudthinking.com
30
30
  executables:
31
31
  - tailwindcss
@@ -87,7 +87,7 @@ licenses:
87
87
  metadata:
88
88
  homepage_uri: https://github.com/rails/tailwindcss-rails
89
89
  rubygems_mfa_required: 'true'
90
- post_install_message:
90
+ post_install_message:
91
91
  rdoc_options: []
92
92
  require_paths:
93
93
  - lib
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
103
103
  version: 3.2.0
104
104
  requirements: []
105
105
  rubygems_version: 3.4.19
106
- signing_key:
106
+ signing_key:
107
107
  specification_version: 4
108
108
  summary: Integrate Tailwind CSS with the asset pipeline in Rails.
109
109
  test_files: []