tailwindcss-rails 2.2.1-x86_64-linux → 2.4.0-x86_64-linux

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: 8c229e1a8d973f606179204d10edfd982dd74f8e12cd1b1ffe5acb943d7a5bf6
4
- data.tar.gz: 40fd46f5fd7bcd54f17b99f07d29fb1a0c288d4133da325f782ef8bda55bf984
3
+ metadata.gz: c4e697666ed8ab17e915f8fabde1d62fef07122493b61277dbc363e0c2818d5e
4
+ data.tar.gz: 6bea597750ba3c89ea1e61d39a9494f0cb2f0f980a97fe4f35ae378f06be02fc
5
5
  SHA512:
6
- metadata.gz: 0a4ff6d5824bfd52111c56f3415a6645a5279cfb157b7907d9e99da54d0200b7df917a36664e19ae91025f976ff75cd2a454bc14d6cd82baa94ea1ffef4f9b94
7
- data.tar.gz: 993ee186ed9075fbba8ec68d88da543ffecdd5e17cb11d2478f4adab50f64e8746933c6495f33e0b91903762978783887c8531649e55110cb7df90ec36de33ef
6
+ metadata.gz: fe00cfeedf3c088e829e9e173a11802a45aa91fef056cbfd9097af4637b06535001ef9b38cce76e4eebd27e29da46a510aaac55370db1aa67bd9ea146a4c17f1
7
+ data.tar.gz: 314732cfe0de085e529bc1edd5b5fbc612959e201b8ed5f0d63cccc63c1e0574144126cc61f88ed2fe0b6784dc7009d1b39d7d640df58927e7f49cfe270f201a
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,15 +49,15 @@ 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
@@ -41,11 +66,39 @@ TAILWINDCSS_INSTALL_DIR=node_modules/.bin
41
66
 
42
67
  ## Developing with Tailwindcss
43
68
 
44
- ### Configuration
69
+ ### Configuration and commands
70
+
71
+ #### Configuration file: `config/tailwind.config.js`
45
72
 
46
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.
47
74
 
48
- 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).
49
102
 
50
103
 
51
104
  ### Building for production
@@ -58,17 +111,23 @@ The `tailwindcss:build` is automatically attached to `assets:precompile`, so bef
58
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.
59
112
 
60
113
 
61
- ### 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
62
120
 
63
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:
64
122
 
65
- - use the [Puma](https://puma.io/) plugin to integrate "watch" with `rails server`, or
66
- - run `rails tailwindcss:watch` as a separate process, or
67
- - 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
+
68
127
 
69
128
  #### Puma plugin
70
129
 
71
- 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:
72
131
 
73
132
  ```ruby
74
133
  plugin :tailwindcss if ENV.fetch("RAILS_ENV", "development") == "development"
@@ -81,7 +140,13 @@ and then running `rails server` will run the Tailwind watch process in the backg
81
140
 
82
141
  This is a flexible command, which can be run with a few different options.
83
142
 
84
- 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.)
85
150
 
86
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.
87
152
 
@@ -93,12 +158,23 @@ If you are running `rails tailwindcss:watch` in a docker container without a tty
93
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.
94
159
 
95
160
 
96
- ### Debugging with unminified assets
161
+ ### Using with PostCSS
97
162
 
98
- 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]`.
163
+ If you want to use PostCSS as a preprocessor, create a custom `config/postcss.config.js` and it will be loaded automatically.
99
164
 
100
- Note that you can combine task options, e.g. `rails tailwindcss:watch[debug,poll]`.
165
+ For example, to enable nesting:
101
166
 
167
+ ```js
168
+ // config/postcss.config.js
169
+ module.exports = {
170
+ plugins: {
171
+ 'postcss-import': {},
172
+ 'tailwindcss/nesting': {},
173
+ tailwindcss: {},
174
+ autoprefixer: {},
175
+ },
176
+ }
177
+ ```
102
178
 
103
179
  ### Custom inputs or outputs
104
180
 
@@ -109,6 +185,12 @@ If you need to use a custom input or output file, you can run `bundle exec tailw
109
185
 
110
186
  Some common problems experienced by users ...
111
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
+
112
194
  ### Conflict with sassc-rails
113
195
 
114
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.
@@ -117,7 +199,7 @@ Tailwind uses modern CSS features that are not recognized by the `sassc-rails` e
117
199
 
118
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).
119
201
 
120
- ### ERROR: Cannot find the tailwindcss executable for &lt;supported platform&gt;
202
+ ### `ERROR: Cannot find the tailwindcss executable` for supported platform
121
203
 
122
204
  Some users are reporting this error even when running on one of the supported native platforms:
123
205
 
@@ -155,24 +237,11 @@ and re-bundle.
155
237
  See https://bundler.io/man/bundle-config.1.html for more information.
156
238
 
157
239
 
158
- ### "No such file or directory" running on Alpine (musl)
159
-
160
- When running `tailwindcss` on an Alpine system, some users report a "No such file or directory" error message.
161
-
162
-
163
- #### Install gnu libc compatibility
164
-
165
- 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.
166
-
167
- 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:
168
-
169
- ``` sh
170
- apk add build-base gcompat
171
- ```
172
-
173
240
  ### Using asset-pipeline assets
174
241
 
175
- 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.
176
245
 
177
246
  ```js
178
247
  module.exports = {
@@ -194,9 +263,14 @@ The inline version also works:
194
263
 
195
264
  ### Conflict with pre-existing asset pipeline stylesheets
196
265
 
197
- 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`.
198
273
 
199
- 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`.
200
274
 
201
275
  ## License
202
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
Binary file
@@ -3,7 +3,8 @@ require "rails/generators/erb/controller/controller_generator"
3
3
  module Tailwindcss
4
4
  module Generators
5
5
  class ControllerGenerator < Erb::Generators::ControllerGenerator
6
- source_root File.expand_path("../templates", __FILE__)
6
+ source_root File.expand_path("templates", __dir__)
7
+ source_paths << "lib/templates/erb/controller"
7
8
  end
8
9
  end
9
10
  end
@@ -3,7 +3,8 @@ require "rails/generators/erb/mailer/mailer_generator"
3
3
  module Tailwindcss
4
4
  module Generators
5
5
  class MailerGenerator < Erb::Generators::MailerGenerator
6
- source_root File.expand_path("../templates", __FILE__)
6
+ source_root File.expand_path("templates", __dir__)
7
+ source_paths << "lib/templates/erb/mailer"
7
8
  end
8
9
  end
9
10
  end
@@ -6,7 +6,8 @@ module Tailwindcss
6
6
  class ScaffoldGenerator < Erb::Generators::ScaffoldGenerator
7
7
  include Rails::Generators::ResourceHelpers
8
8
 
9
- source_root File.expand_path("../templates", __FILE__)
9
+ source_root File.expand_path("templates", __dir__)
10
+ source_paths << "lib/templates/erb/scaffold"
10
11
 
11
12
  argument :attributes, type: :array, default: [], banner: "field:type field:type"
12
13
 
@@ -74,14 +74,19 @@ module Tailwindcss
74
74
  end
75
75
 
76
76
  def compile_command(debug: false, **kwargs)
77
- [
77
+ command = [
78
78
  executable(**kwargs),
79
79
  "-i", Rails.root.join("app/assets/stylesheets/application.tailwind.css").to_s,
80
80
  "-o", Rails.root.join("app/assets/builds/tailwind.css").to_s,
81
81
  "-c", Rails.root.join("config/tailwind.config.js").to_s,
82
- ].tap do |command|
83
- command << "--minify" unless (debug || rails_css_compressor?)
84
- end
82
+ ]
83
+
84
+ command << "--minify" unless (debug || rails_css_compressor?)
85
+
86
+ postcss_path = Rails.root.join("config/postcss.config.js")
87
+ command += ["--postcss", postcss_path.to_s] if File.exist?(postcss_path)
88
+
89
+ command
85
90
  end
86
91
 
87
92
  def watch_command(always: false, poll: false, **kwargs)
@@ -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.2.1"
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.2.1
4
+ version: 2.4.0
5
5
  platform: x86_64-linux
6
6
  authors:
7
7
  - David Heinemeier Hansson
8
- autorequire:
8
+ autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2024-01-08 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
@@ -89,7 +89,7 @@ licenses:
89
89
  metadata:
90
90
  homepage_uri: https://github.com/rails/tailwindcss-rails
91
91
  rubygems_mfa_required: 'true'
92
- post_install_message:
92
+ post_install_message:
93
93
  rdoc_options: []
94
94
  require_paths:
95
95
  - lib
@@ -105,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
105
105
  version: 3.2.0
106
106
  requirements: []
107
107
  rubygems_version: 3.4.19
108
- signing_key:
108
+ signing_key:
109
109
  specification_version: 4
110
110
  summary: Integrate Tailwind CSS with the asset pipeline in Rails.
111
111
  test_files: []