skryukov / rubocop-gradual

Gradually improve your code with RuboCop
MIT License
36 stars 0 forks source link

Suggestion: rename the `--update` option to `--force-update` #5

Closed fvsch closed 2 years ago

fvsch commented 2 years ago

Following the lengthy brainstorming and discussion in #1, I suggest renaming the --update option, and possibly removing (or changing?) its short name.

Rationale:

  1. Without any options, rubocop-gradual already updates the lock file in the normal development workflow. The README even suggests using that command without options in git hooks to update the lock file. So having a separate --update command that does something else is confusing.
  2. Given that first point, the --update command should be named in a way that conveys its specificity (e.g. what type of update it does or when it does it).

I suggest using --force-update, because it disregards the "error" case of introducing new issues in the lock file.

It might also be useful to delete the -u short option (if you don't want to incentivize using it too much), or maybe change it to something else? Possible values for a short command: