Add customized prompt for Rails console #50796

st0012 · 2024-01-18T23:00:43Z

Update

There were 2 more follow up PRs on this:

So the resulted prompt now looks like this instead:

Motivation / Background

As discussed in #50770, Rails console's prompt is not easily distinguishable from normal IRB console. It also doesn't provide Rails-specific information to assist developers.

Closes #50770

Detail

A new IRB prompt called RAILS_PROMPT is added, which looks like:
- dev:001> in development
- prod:001> in production
- test:001> in test
The RAILS_PROMPT is only selected when the user doesn't specify another custom prompt.

Additional information

Checklist

Before submitting the PR make sure the following are checked:

This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
Tests are added or updated if you fix a bug or add a feature.
CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

railties/lib/rails/commands/console/console_command.rb

railties/test/isolation/abstract_unit.rb

jonathanhefner

A nitpick for the CHANGELOG entry, but otherwise looks good to me! 👍

railties/CHANGELOG.md

byroot

One last question, other than that LGTM.

Also please squash your commits into one.

byroot · 2024-01-19T18:24:04Z

railties/lib/rails/commands/console/console_command.rb

+
+        if !Rails.env.local?
+          # Use env var here so users can override them with env var too
+          ENV["IRB_USE_AUTOCOMPLETE"] ||= "false"


Any way we could set this on the IRB config rather than in ENV? Not a big deal, but it's best not to mutate ENV if we can.

If we set it with IRB.conf, users can't override it with IRB_USE_AUTOCOMPLETE=true due to IRB's initialization order. This probably won't affect many users, but because I mentioned it was overridable in the original changelog I think it'd be a breaking-change.

Can't you set it in IRB.conf under a unless ENV["IRB_USE_AUTOCOMPLETE"]. Reading the env is fine, it's changing it that I think would be best avoided.

That's a good point. But for that change I want to convert related unit tests into integration (application) tests too, which is a bit out of scope for this PR IMO. Do you mind if I open another PR for it?

Yeah, it's a pre-existing issue, so I don't mind. I'll merge once you squash.

Follow up PR: #50814

Add Rails-specific IRB prompt Update changelog

The combination of red and blue is more color-blind friendly than red and green. Discussion: rails#50796 (comment)

shloch · 2024-01-26T14:08:55Z

very useful feature thanks

dorianmariecom · 2024-01-26T14:17:48Z

railties/lib/rails/commands/console/console_command.rb

+        when "test"
+          IRB::Color.colorize("test", [:GREEN])
+        when "production"
+          IRB::Color.colorize("prod", [:RED])


Shouldn't this be production?

seems prod is intended

The original discussion in #50770 decided to use abbreviations for development and production environments.

Yeah, same for dev, it should be development I think

I disagree, but you can raise that in the original issue.

dorianmariecom · 2024-01-26T14:18:27Z

railties/lib/rails/commands/console/console_command.rb

+          PROMPT_I: "#{env}:%03n> ",
+          PROMPT_S: "#{env}:%03n%l ",
+          PROMPT_C: "#{env}:%03n* ",


I don't think we need line numbers

It's removed in #50814

The combination of red and blue is more color-blind friendly than red and green. Discussion: rails#50796 (comment)

rails-bot bot added the railties label Jan 18, 2024

st0012 force-pushed the implement-#50770 branch from 62158d1 to 8324fbb Compare January 18, 2024 23:07

jonathanhefner reviewed Jan 19, 2024

View reviewed changes

railties/lib/rails/commands/console/console_command.rb Outdated Show resolved Hide resolved

railties/lib/rails/commands/console/console_command.rb Show resolved Hide resolved

railties/lib/rails/commands/console/console_command.rb Outdated Show resolved Hide resolved

byroot reviewed Jan 19, 2024

View reviewed changes

railties/lib/rails/commands/console/console_command.rb Outdated Show resolved Hide resolved

byroot changed the title ~~Implement #50770~~ Add customized prompt for Rails console Jan 19, 2024

st0012 force-pushed the implement-#50770 branch 2 times, most recently from c0f4e63 to eb8bf1f Compare January 19, 2024 16:43

st0012 requested review from byroot and jonathanhefner January 19, 2024 16:43

st0012 commented Jan 19, 2024

View reviewed changes

railties/lib/rails/commands/console/console_command.rb Outdated Show resolved Hide resolved

railties/test/isolation/abstract_unit.rb Outdated Show resolved Hide resolved

byroot approved these changes Jan 19, 2024

View reviewed changes

st0012 force-pushed the implement-#50770 branch from eb8bf1f to e0b03dd Compare January 19, 2024 17:14

jonathanhefner approved these changes Jan 19, 2024

View reviewed changes

railties/CHANGELOG.md Outdated Show resolved Hide resolved

st0012 force-pushed the implement-#50770 branch from e0b03dd to 176b1a9 Compare January 19, 2024 17:17

st0012 requested a review from byroot January 19, 2024 18:22

byroot approved these changes Jan 19, 2024

View reviewed changes

Create IRBConsole to encapsulate IRB-specific setup

0c2898a

Add Rails-specific IRB prompt Update changelog

st0012 force-pushed the implement-#50770 branch from 176b1a9 to 0c2898a Compare January 19, 2024 19:01

byroot merged commit 30cb7a6 into rails:main Jan 19, 2024
3 of 4 checks passed

st0012 deleted the implement-#50770 branch January 19, 2024 19:12

st0012 mentioned this pull request Jan 19, 2024

Improve Rails console's IRB autocompletion control #50814

Merged

4 tasks

st0012 added a commit to Shopify/rails that referenced this pull request Jan 23, 2024

Display dev/test env in console prompt in blue instead of green

6fc1bd5

The combination of red and blue is more color-blind friendly than red and green. Discussion: rails#50796 (comment)

st0012 mentioned this pull request Jan 23, 2024

Display dev & test env in console prompt in blue instead of green #50855

Merged

4 tasks

st0012 added a commit to Shopify/rails that referenced this pull request Jan 24, 2024

Display dev/test env in console prompt in blue instead of green

7cbf06c

The combination of red and blue is more color-blind friendly than red and green. Discussion: rails#50796 (comment)

dorianmariecom reviewed Jan 26, 2024

View reviewed changes

nathansamson mentioned this pull request Jan 27, 2024

Allow customization to console prompt's format #50898

Closed

4 tasks

viralpraxis pushed a commit to viralpraxis/rails that referenced this pull request Mar 24, 2024

Display dev/test env in console prompt in blue instead of green

01d9c8c

The combination of red and blue is more color-blind friendly than red and green. Discussion: rails#50796 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add customized prompt for Rails console #50796

Add customized prompt for Rails console #50796

st0012 commented Jan 18, 2024 •

edited

jonathanhefner left a comment

byroot left a comment

byroot Jan 19, 2024

st0012 Jan 19, 2024

byroot Jan 19, 2024

st0012 Jan 19, 2024

byroot Jan 19, 2024

st0012 Jan 19, 2024

st0012 Jan 19, 2024

shloch commented Jan 26, 2024

dorianmariecom Jan 26, 2024

simi Jan 26, 2024

st0012 Jan 26, 2024

dorianmariecom Jan 26, 2024

st0012 Jan 26, 2024

dorianmariecom Jan 26, 2024

st0012 Jan 26, 2024

dorianmariecom Jan 26, 2024

Add customized prompt for Rails console #50796

Add customized prompt for Rails console #50796

Conversation

st0012 commented Jan 18, 2024 • edited

Motivation / Background

Detail

Additional information

Checklist

jonathanhefner left a comment

Choose a reason for hiding this comment

byroot left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shloch commented Jan 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

st0012 commented Jan 18, 2024 •

edited