Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidy up trailing whitespace in gem post_install_message #3689

Merged

Conversation

jdufresne
Copy link
Member

Previously, the post_install_message contained trailing whitespace on its last line such that the user's console prompt would be shifted to the right in an unusual way.

Now, follow shell conventions and finish the message with the a final newline and nothing else.

This change also left aligns the message like other Ruby gem post_install_messages do.

Before:

$ bundle install

...

Post-install message from rails_admin:

    ### Upgrading RailsAdmin from 2.x.x to 3.x.x ###

    Due to introduction of Webpack/Webpacker support, some additional dependencies and configuration will be needed.
    Running `bin/rails g rails_admin:install` will suggest required changes, based on the current setup of your app.

    For a complete list of changes, see https://github.com/railsadminteam/rails_admin/blob/master/CHANGELOG.md
  jon@localhost$

After:

### Upgrading RailsAdmin from 2.x.x to 3.x.x ###

Due to introduction of Webpack/Webpacker support, some additional dependencies and configuration will be needed.
Running `bin/rails g rails_admin:install` will suggest required changes, based on the current setup of your app.

For a complete list of changes, see https://github.com/railsadminteam/rails_admin/blob/master/CHANGELOG.md
Successfully installed rails_admin-3.1.2
jon@localhost$

Previously, the post_install_message contained trailing whitespace on
its last line such that the user's console prompt would be shifted to
the right in an unusual way.

Now, follow shell conventions and finish the message with the a final
newline and nothing else.

This change also left aligns the message like other Ruby gem
post_install_messages do.

Before:

```
$ bundle install

...

Post-install message from rails_admin:

    ### Upgrading RailsAdmin from 2.x.x to 3.x.x ###

    Due to introduction of Webpack/Webpacker support, some additional dependencies and configuration will be needed.
    Running `bin/rails g rails_admin:install` will suggest required changes, based on the current setup of your app.

    For a complete list of changes, see https://github.com/railsadminteam/rails_admin/blob/master/CHANGELOG.md
  jon@localhost$
```

After:

```
\### Upgrading RailsAdmin from 2.x.x to 3.x.x ###

Due to introduction of Webpack/Webpacker support, some additional dependencies and configuration will be needed.
Running `bin/rails g rails_admin:install` will suggest required changes, based on the current setup of your app.

For a complete list of changes, see https://github.com/railsadminteam/rails_admin/blob/master/CHANGELOG.md
Successfully installed rails_admin-3.1.2
jon@localhost$
```
@mshibuya mshibuya merged commit b9e8161 into railsadminteam:master Jun 16, 2024
21 of 23 checks passed
@mshibuya
Copy link
Member

👍

@jdufresne jdufresne deleted the post-install-message-whitespace branch October 8, 2024 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants