Change command for the rake task with arguments to a style that can also be used in zsh

[ydah]

If you try to add a new cop and use the wrong command in the rake task, you will get the following warning.

❯ bundle exec rake new_cop                                     
usage: bundle exec rake new_cop[Department/Name]

If you try to execute it as is, you will face the following error.

❯ bundle exec rake new_cop[Department/Name]
zsh: no matches found: new_cop[Department/Name]

#10695 (comment)

As noted in the documentation, it should be in a format that can be executed by zsh by enclosing it in single quotation marks.

---

Before submitting the PR make sure the following are checked:

• The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
• 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.
• Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
• [-] Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

[koic]

Hm, I wonder whether this makes sense because it depends on the user's shell and its settings. The effects other than zsh are unknown, and it is an unnecessary escape if zsh also uses noglob.

[ydah]

It certainly depends on the user's shell and its settings, but there are cases where it doesn't work, so it seems like there should be a good expression that works reasonably well in any environment. (would a better expression than this escape look good?)

Another way to make it readable in zsh is to put it in quotation marks:

❯ bundle exec rake new_cop
usage: bundle exec rake 'new_cop[Department/Name]'

[koic]

I'm not sure what happens to the developers of bash, fish, and others.

[ydah]

Certainly, I should have checked if it works in other shells. Sorry.
I have performed the following checks and at least the 'new_cop[Foo/Bar]' format appears to work.

> fish -v
fish, version 3.4.1
> bundle exec rake 'new_cop[Department/Name]'
[create] lib/rubocop/cop/department/name.rb
[create] spec/rubocop/cop/department/name_spec.rb
[modify] lib/rubocop.rb - `require_relative 'rubocop/cop/department/name'` was injected.
[modify] A configuration for the cop is added into config/default.yml.
Do 4 steps:
  1. Modify the description of Department/Name in config/default.yml
  2. Implement your new cop in the generated file!
  3. Commit your new cop with a message such as
     e.g. "Add new `Department/Name` cop"
  4. Run `bundle exec rake changelog:new` to generate a changelog entry
     for your new cop.
> git add -N .
> git diff --name-only
config/default.yml
lib/rubocop.rb
lib/rubocop/cop/department/name.rb
spec/rubocop/cop/department/name_spec.rb

$ bash --version
bash --version
GNU bash, version 3.2.57(1)-release (x86_64-apple-darwin21)
Copyright (C) 2007 Free Software Foundation, Inc.
$ bundle exec rake 'new_cop[Department/Name]'
bundle exec rake 'new_cop[Department/Name]'
rake new_cop: lib/rubocop/cop/department/name.rb already exists!
bash-3.2$ bundle exec rake 'new_cop[Department/Name]'
bundle exec rake 'new_cop[Department/Name]'
[create] lib/rubocop/cop/department/name.rb
[create] spec/rubocop/cop/department/name_spec.rb
[modify] lib/rubocop.rb - `require_relative 'rubocop/cop/department/name'` was injected.
[modify] A configuration for the cop is added into config/default.yml.
Do 4 steps:
  1. Modify the description of Department/Name in config/default.yml
  2. Implement your new cop in the generated file!
  3. Commit your new cop with a message such as
     e.g. "Add new `Department/Name` cop"
  4. Run `bundle exec rake changelog:new` to generate a changelog entry
     for your new cop.
$ git add -N .
$ git diff --name-only
config/default.yml
lib/rubocop.rb
lib/rubocop/cop/department/name.rb
spec/rubocop/cop/department/name_spec.rb

[koic]

I've just found the documentation. Let's use it in single quotes.
https://docs.rubocop.org/rubocop/1.30/development.html#create-a-new-cop

[koic]

Thanks!

[ydah]

@koic Thank you for your review and checked the documents!