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.

Sign up for GitHub

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

Jump to bottom

Make it possible to enable/disable pending cops via a configuration option #7850

Closed
bbatsov opened this issue Apr 5, 2020 · 6 comments · Fixed by #7856
Closed

Make it possible to enable/disable pending cops via a configuration option #7850

bbatsov opened this issue Apr 5, 2020 · 6 comments · Fixed by #7856
Assignees
@koic
Labels
feature request high priority A ticket considered important by RuboCop's Core Team
Milestone
1.0

Comments

@bbatsov
Copy link
Collaborator

bbatsov commented Apr 5, 2020

Is your feature request related to a problem? Please describe.

It seems some people are frustrated by the fact they have to manually enable/disable pending cops (see #7771). This also came up a few times in the RuboCop defaults survey.

Describe the solution you'd like

We should add configuration option allowing pending cops to be treated as pending (default), enabled or disabled by default. This would allow everyone to decide how to best handle those those.

Describe alternatives you've considered

I don't think there are any better alternatives.

@rubocop-hq/rubocop-core Any thoughts on this?
@bbatsov bbatsov added feature request high priority A ticket considered important by RuboCop's Core Team labels Apr 5, 2020
@bbatsov bbatsov added this to the 1.0.0 milestone Apr 5, 2020
@koic
Copy link
Member

koic commented Apr 5, 2020 •
edited

I think that the new feature will lead to a solution. I'm considering command line and configuration options.

Command line options

Run including pending cops.

% rubocop --with-pending-cops

Run excluding pending cops.

% rubocop --without-pending-cops

.rubocop.yml configuration

In addition, it is an example to specify in .rubocop.yml instead of the command line option. These configuration values have the same meaning as the Enabled option's values.

AllCops:
  EnabledNewCops: pending # default
AllCops:
  EnabledNewCops: true
AllCops:
  EnabledNewCops: false

Maybe option and configuration names could be considered further.

@bbatsov
Copy link
Collaborator Author

bbatsov commented Apr 5, 2020

% rubocop --with-pending-cops

I'm fine with the proposal but let's use naming like --enable/disable-pending-cops instead. I think that's easier to understand.

AllCops:
  EnabledNewCops: pending # default

Yeah, that's more or less what I had in mind. I guess the option can be named "NewCops" and have potential values "enable", "disable", "pending". Generally, we can go only with the command-line option, as users can put it in their .rubocop if they want to use it all the time.

@koic
Copy link
Member

koic commented Apr 6, 2020

These naming sounds easy to understand 🌟I will take this issue!

@koic koic self-assigned this Apr 6, 2020
@koic koic mentioned this issue Apr 7, 2020
Merged
8 tasks
koic added a commit to koic/rubocop that referenced this issue Apr 7, 2020
@koic
[Fix rubocop#7850] Make it possible to enable/disable pending cops
544edbf 
Resolves rubocop#7850.

This PR will add `--enable-pending-cops` and `--disable-pending-cops`
command-line options and `NewCops` will be provided in .rubocop.yml.

When `NewCops` is `enable`, pending cops are enabled in bulk.

```yaml
AllCops:
  NewCops: enable
```

Can be overridden by the `--enable-pending-cops` command-line option.

When `NewCops` is `disable`, pending cops are disabled in bulk.

```yaml
AllCops:
  NewCops: disable
```

Can be overridden by the `--disable-pending-cops` command-line option.

The default value of `NewCops` is `pending`.
bbatsov pushed a commit that referenced this issue Apr 7, 2020
@koic @bbatsov
[Fix #7850] Make it possible to enable/disable pending cops
61090b1 
Resolves #7850.

This PR will add `--enable-pending-cops` and `--disable-pending-cops`
command-line options and `NewCops` will be provided in .rubocop.yml.

When `NewCops` is `enable`, pending cops are enabled in bulk.

```yaml
AllCops:
  NewCops: enable
```

Can be overridden by the `--enable-pending-cops` command-line option.

When `NewCops` is `disable`, pending cops are disabled in bulk.

```yaml
AllCops:
  NewCops: disable
```

Can be overridden by the `--disable-pending-cops` command-line option.

The default value of `NewCops` is `pending`.
@ShockwaveNN
Copy link
Contributor

ShockwaveNN commented Apr 17, 2020 •
edited

I think it's worth mention that final variant in rubocop 0.82.0
not

AllCops:
  EnabledNewCops: true

But

AllCops:
  NewCops: enable

@koic
Copy link
Member

koic commented Apr 17, 2020

EnableNewCops: true seems like a good name, however NewCops accepts three values: enalbe, disable, and pending.

@danielpowell4
Copy link

Thank you thank you thank you

@Volosh1n Volosh1n mentioned this issue Jun 7, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@koic koic

Labels
feature request high priority A ticket considered important by RuboCop's Core Team
Projects
None yet
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

[Fix #7850] Make it possible to enable/disable pending cops koic/rubocop
4 participants
@koic @bbatsov @ShockwaveNN @danielpowell4