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

Show extension cop versions when using --verbose-version option #8908

Merged

Conversation

koic
Copy link
Member

@koic koic commented Oct 20, 2020

Summary

This PR shows extension cop versions when using --verbose-version option.

Before:

% rubocop -V
0.93.1 (using Parser 2.7.2.0, rubocop-ast 0.8.0, running on ruby 2.7.2 x86_64-darwin19)

After:

% rubocop -V
0.93.1 (using Parser 2.7.2.0, rubocop-ast 0.8.0, running on ruby 2.7.2 x86_64-darwin19)
  - rubocop-performance 1.8.1
  - rubocop-rspec 1.43.2

This information is not shown in rubocop -v as it is needed in the bug report, first.

More Information

It shows extension cop versions named rubocop-feature (e.g. rubocop-performance, rubocop-rspec).
Extention names separated by two or more, such as rubocop-feature-foo, are not supported by this PR. First of all, this is aimed at supporting the extension cop managed by RuboCop Headquarters.

This feature searches for version constant in two ways:

  • RuboCop core version style (e.g. RuboCop::Performance::Version::STRING)
  • bundle gem version style (e.g. RuboCop::Rake::VERSION)

This enriches the information when reporting bugs from users.

It was inspired by RSpec. Thank you.

% bundle exec rspec --version
RSpec 3.9
  - rspec-core 3.9.3
  - rspec-expectations 3.9.2
  - rspec-mocks 3.9.1
  - rspec-support 3.9.3

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 bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

Copy link
Collaborator

@bbatsov bbatsov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition!

@koic koic force-pushed the add_extension_versions_when_using_verbose_version branch 2 times, most recently from f1f1d4f to e289be0 Compare October 20, 2020 16:41
@koic koic changed the title Show extension cop versions when using --verbose_version option Show extension cop versions when using --verbose-version option Oct 20, 2020
@koic koic force-pushed the add_extension_versions_when_using_verbose_version branch 2 times, most recently from f206bc0 to ef3d9e8 Compare October 20, 2020 17:45
## Summary

This PR shows extension cop versions when using `--verbose-version` option.

Before:

```console
% rubocop -V
0.93.1 (using Parser 2.7.2.0, rubocop-ast 0.8.0, running on ruby 2.7.2 x86_64-darwin19)
```

After:

```console
% rubocop -V
0.93.1 (using Parser 2.7.2.0, rubocop-ast 0.8.0, running on ruby 2.7.2 x86_64-darwin19)
  - rubocop-performance 1.8.1
  - rubocop-rspec 1.43.2
```

This information is not shown in `rubocop -v` as it is needed in the bug report, first.

## More Information

It shows extension cop versions named rubocop-feature (e.g. rubocop-performance, rubocop-rspec).
Extention names separated by two or more, such as rubocop-feature-foo, are not
supported by this PR. First of all, this is aimed at supporting the extension cop managed
by RuboCop Headquarters.

This feature searches for version constant in two ways:

- RuboCop core version style (e.g. `RuboCop::Performance::Version::STRING`)
- `bundle gem` version style (e.g. `RuboCop::Rake::VERSION`)

This enriches the information when reporting bugs from users.

It was inspired by RSpec. Thank you.

```console
% bundle exec rspec --version
RSpec 3.9
  - rspec-core 3.9.3
  - rspec-expectations 3.9.2
  - rspec-mocks 3.9.1
  - rspec-support 3.9.3
```
@koic koic force-pushed the add_extension_versions_when_using_verbose_version branch from ef3d9e8 to 96d2809 Compare October 20, 2020 18:15
@koic koic merged commit e0713ad into rubocop:master Oct 20, 2020
@koic koic deleted the add_extension_versions_when_using_verbose_version branch October 20, 2020 18:54
koic added a commit to koic/rubocop that referenced this pull request Oct 21, 2020
Follow rubocop#8908.

This PR fixes the following error when ocurring cop error.

```console
% bundle exec rubocop
(snip)

1 file inspected, no offenses detected

1 error occurred:
An error occurred while Layout/ExtraSpacing cop was inspecting
/Users/koic/src/github.com/koic/rubocop-issues/43/example.rb.
undefined method `config_store' for nil:NilClass
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/version.rb:35:in
`extension_versions'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/version.rb:21:in
`version'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/cli/command/execute_runner.rb:62:in
`display_error_summary'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/cli/command/execute_runner.rb:27:in
`execute_runner'
/Users/koic/src/github.com/rubocop-hq/rubocop/lib/rubocop/cli/command/execute_runner.rb:17:in
`run'
```

It suppresses unexpected `undefined method `config_store' for nil:NilClass`.
@koic koic mentioned this pull request Oct 21, 2020
8 tasks
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