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

[Fixes #10439] Add Style/RedundantStringEscape #11002

Merged
merged 8 commits into from
Sep 29, 2022

Conversation

owst
Copy link
Contributor

@owst owst commented Sep 13, 2022

Add new Style/RedundantStringEscape cop, as suggested in #10439


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.

module RuboCop
module Cop
module Style
# Checks for redundant escapes in Strings.
Copy link
Collaborator

Choose a reason for hiding this comment

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

in string literals

include RangeHelp
extend AutoCorrector

MSG = 'Redundant escape inside string literal.'
Copy link
Collaborator

Choose a reason for hiding this comment

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

Perhaps we should mention the exact escape in the message?

module Style
# Checks for redundant escapes in Strings.
#
# @example
Copy link
Collaborator

Choose a reason for hiding this comment

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

Probably you should add a couple of examples with heredocs as well, so it's clear to everyone those are considered.

@owst owst requested a review from bbatsov September 28, 2022 23:18
@bbatsov bbatsov merged commit 378eea5 into rubocop:master Sep 29, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Sep 29, 2022

Well done!

kkitadate added a commit to kkitadate/rubocop-rails that referenced this pull request Sep 29, 2022
CI seems to have failed because rubocop/rubocop#11002 was merged (e.g. rubocop@2723be4)

This commit is for fixing it.
kkitadate added a commit to kkitadate/rubocop-rails that referenced this pull request Sep 29, 2022
CI seems to have failed because rubocop/rubocop#11002 was merged (e.g. rubocop@2723be4)

This commit is for fixing it.
kkitadate added a commit to kkitadate/rubocop-rails that referenced this pull request Sep 29, 2022
CI seems to have failed because rubocop/rubocop#11002 was merged (e.g. rubocop@2723be4)

This commit is for fixing it.
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