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

Move REPL command from rake to bin #5906

Merged
merged 1 commit into from May 22, 2018

Conversation

koic
Copy link
Member

@koic koic commented May 22, 2018

Related PR #5905.

The main stream of Gem's REPL running seems to be bin/console command.
bundle gem also uses the following template.
https://github.com/bundler/bundler/blob/v1.16.2/lib/bundler/templates/newgem/bin/console.tt

This PR moves REPL command from rake repl task to bin/console command then it helps Gem developers to execute REPL intuitively.

In order not to confuse RuboCop developers, This PR suddenly did not remove rake repl task, but instead display a warning to remove in the future RuboCop 0.58.0.

% rake repl
DEPRECATION WARNING: `rake repl` is deprecated and will be removed in
RuboCop 0.58.0. Please use `bin/console`.
[1] pry(RuboCop)>

Before submitting the PR make sure the following are checked:

  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title
    and description in grammatically correct, complete sentences.
  • Run rake default or rake parallel. It executes all tests and RuboCop for itself, and generates the documentation.

Related PR rubocop#5905.

The main stream of Gem's REPL running seems to be `bin/console` command.
`bundle gem` also uses the following template.
https://github.com/bundler/bundler/blob/v1.16.2/lib/bundler/templates/newgem/bin/console.tt

This PR moves REPL command from `rake repl` task to `bin/console` command
then it helps Gem developers to execute REPL intuitively.

In order not to confuse RuboCop developers, This PR suddenly did not
remove `rake repl` task, but instead display a warning to remove in the
future RuboCop 0.58.0.

```console
% rake repl
DEPRECATION WARNING: `rake repl` is deprecated and will be removed in
RuboCop 0.58.0. Please use `bin/console`.
[1] pry(RuboCop)>
```
@koic koic force-pushed the move_repl_from_rake_to_bin branch from 60c4321 to 56ed514 Compare May 22, 2018 15:52
@bbatsov bbatsov merged commit 0ccd1f1 into rubocop:master May 22, 2018
@bbatsov
Copy link
Collaborator

bbatsov commented May 22, 2018

👍

@koic koic deleted the move_repl_from_rake_to_bin branch May 22, 2018 20:28
koic added a commit to koic/rubocop that referenced this pull request Jun 15, 2018
Currently, A Gem made with `bundle gem <gem-name>` provides
`bin/setup` command and `bin/console` command.
https://github.com/bundler/bundler/tree/v1.16.2/lib/bundler/templates/newgem/bin

`bin/setup` command is for setting up development.
RuboCop requires only the `bundle install` setup, so there may be
not much merit. However, developers trying to participate in
a new development may first think of `bin/setup`.

Although I'm not sure the frequency of the aspect to be used,
but I opened this PR because `bin/setup` command may be able to
help First step.

Related PR rubocop#5906.
@koic koic mentioned this pull request Jun 15, 2018
8 tasks
koic added a commit to koic/rubocop that referenced this pull request Jun 15, 2018
Follow up of rubocop#5906.
This PR removes `rake repl` task.

New features have been added to the master branch after RuboCop 0.57.2.
So I guess that the minor version will rise and the next version of
RuboCop will be 0.58.0.
https://github.com/rubocop-hq/rubocop/blob/38550ff/CHANGELOG.md#master-unreleased

This PR will remove `rake repl` according to the following warning.

```console
% rake repl
DEPRECATION WARNING: `rake repl` is deprecated and will be removed in
RuboCop 0.58.0. Please use `bin/console`.
[1] pry(RuboCop)>
```

In the future development REPL will be unified into `bin/console`.
@koic koic mentioned this pull request Jun 15, 2018
8 tasks
bbatsov pushed a commit that referenced this pull request Jun 15, 2018
Follow up of #5906.
This PR removes `rake repl` task.

New features have been added to the master branch after RuboCop 0.57.2.
So I guess that the minor version will rise and the next version of
RuboCop will be 0.58.0.
https://github.com/rubocop-hq/rubocop/blob/38550ff/CHANGELOG.md#master-unreleased

This PR will remove `rake repl` according to the following warning.

```console
% rake repl
DEPRECATION WARNING: `rake repl` is deprecated and will be removed in
RuboCop 0.58.0. Please use `bin/console`.
[1] pry(RuboCop)>
```

In the future development REPL will be unified into `bin/console`.
bbatsov pushed a commit that referenced this pull request Jun 17, 2018
Currently, A Gem made with `bundle gem <gem-name>` provides
`bin/setup` command and `bin/console` command.
https://github.com/bundler/bundler/tree/v1.16.2/lib/bundler/templates/newgem/bin

`bin/setup` command is for setting up development.
RuboCop requires only the `bundle install` setup, so there may be
not much merit. However, developers trying to participate in
a new development may first think of `bin/setup`.

Although I'm not sure the frequency of the aspect to be used,
but I opened this PR because `bin/setup` command may be able to
help First step.

Related PR #5906.
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.

None yet

2 participants