Skip to content

Commit 828eacc

Browse files
committed
doc: add note about debug and reline to Troubleshooting
Related to #346 [skip ci]
1 parent fe5a6f7 commit 828eacc

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
* [Using with PostCSS](#using-with-postcss)
1818
* [Custom inputs or outputs](#custom-inputs-or-outputs)
1919
- [Troubleshooting](#troubleshooting)
20+
* [Lost keystrokes or hanging when using `ruby/debug` with the Puma plugin](#lost-keystrokes-or-hanging-when-using-rubydebug-with-the-puma-plugin)
2021
* [Running in a docker container exits prematurely](#running-in-a-docker-container-exits-prematurely)
2122
* [Conflict with sassc-rails](#conflict-with-sassc-rails)
2223
* [Class names must be spelled out](#class-names-must-be-spelled-out)
@@ -185,6 +186,17 @@ If you need to use a custom input or output file, you can run `bundle exec tailw
185186

186187
Some common problems experienced by users ...
187188

189+
### Lost keystrokes or hanging when using `ruby/debug` with the Puma plugin
190+
191+
If you are using the `ruby/debug` debugger while using the Puma plugin from this gem, and you're experiencing what looks like hanging or lost keystrokes, then you'll need to disable Reline.
192+
193+
You can read the [`debug` documentation](https://github.com/ruby/debug?tab=readme-ov-file#configuration) for more information, but the easiest thing to do is to set the environment variable `RUBY_DEBUG_NO_RELINE`:
194+
195+
``` sh
196+
RUBY_DEBUG_NO_RELINE=1 rails server
197+
```
198+
199+
188200
### Running in a docker container exits prematurely
189201

190202
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.

0 commit comments

Comments
 (0)