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

[Fix #9895] Disable Naming/InclusiveLanguage by default #9896

Merged

Conversation

koic
Copy link
Member

@koic koic commented Jun 29, 2021

Fixes #9895 and follow up #9893 (comment).

This PR disables Naming/InclusiveLanguage by default because it has an unexpectedly impact for many users who give feedback.


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.

@bbatsov
Copy link
Collaborator

bbatsov commented Jun 29, 2021

Either this or just disabling the checking of string literals, which I think is the real problem. I'm reasonably certain this won't generate much noise for identifier names and file names.

In hindsight - it doesn't make much sense for a cop focused on naming to check string literals, as their contents are text, not names. I should have thought of this a bit earlier. :D

@bbatsov
Copy link
Collaborator

bbatsov commented Jun 29, 2021

We might also remove master from the defaults, although I doubt anyone names identiers master. :D

@tjwp
Copy link
Contributor

tjwp commented Jun 29, 2021

As the author of this cop, I want to endorse that I'm in support of disabling by default. I think this is a useful tool to put in user's hands but don't want to force it or a specific configuration on anyone.

@koic koic force-pushed the disable_naming_inclusive_language_by_default branch from 16ad963 to d983382 Compare June 29, 2021 13:42
@koic
Copy link
Member Author

koic commented Jun 29, 2021

@bbatsov Sure! I agree with your suggestions! I updated this PR to set CheckStrings: false and remove master from FlaggedTerms for Naming/InclusiveLanguage. I think these updates can reduce an unexpectedly impact for users much smaller. So, I reverted the cop's status to pending.

@dvandersluis
Copy link
Member

I agree with making the default configuration more permissive if this cop is going to be enabled by default. It'd be good to have an exhaustive example of how to configure the cop in the docs though so that people could, for example, just apply the original configuration if they are so inclined.

… `FlaggedTerms` for `Naming/InclusiveLanguage`

Fixes rubocop#9895 and follow up rubocop#9893 (comment).

This PR sets `CheckStrings: false` and removes `master` from `FlaggedTerms` for `Naming/InclusiveLanguage`
because it has an unexpectedly impact for many users who give feedback.
@koic koic force-pushed the disable_naming_inclusive_language_by_default branch from d983382 to 1976f27 Compare June 29, 2021 14:29
@bbatsov bbatsov merged commit 122109a into rubocop:master Jun 29, 2021
@koic koic deleted the disable_naming_inclusive_language_by_default branch June 29, 2021 14:58
koic added a commit to rubocop/rubocop-performance that referenced this pull request Jul 13, 2021
renawatson68 added a commit to renawatson68/performance-develop-rubyonrails that referenced this pull request Sep 23, 2022
richardstewart0213 added a commit to richardstewart0213/performance-build-Performance-optimization-analysis- that referenced this pull request Nov 4, 2022
MarttiCheng added a commit to MarttiCheng/Rubocop-Performance that referenced this pull request Sep 28, 2023
SerhiiMisiura added a commit to SerhiiMisiura/Rubocop-Performance that referenced this pull request Oct 5, 2023
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.

Do we really need Naming/InclusiveLanguage enabled by default?
4 participants