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 when highlights contain multibyte characters #9649

Conversation

@osyo-manga
Copy link
Contributor

@osyo-manga osyo-manga commented Mar 31, 2021

Summary

When multibyte characters were included in the output results, they were not highlighted in the correct position.

Expected behavior

  • I'd like to see multibyte characters highlighted by their position
hash.rb:4:3: C: [Correctable] Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.
  'あああああ'=>1,
  ^^^^^^^^^^^^^^^
hash.rb:4:10: C: [Correctable] Layout/SpaceAroundOperators: Surrounding space missing for operator =>.
  'あああああ'=>1,
              ^^
hash.rb:5:14: C: [Correctable] Layout/SpaceAfterComma: Space missing after comma.
  'いいいい' => 2,"うううう" =>3,
                 ^
hash.rb:5:15: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
  'いいいい' => 2,"うううう" =>3,
                  ^^^^^^^^^^
hash.rb:5:22: C: [Correctable] Layout/SpaceAroundOperators: Surrounding space missing for operator =>.
  'いいいい' => 2,"うううう" =>3,
                             ^^
hash.rb:5:25: C: [Correctable] Style/TrailingCommaInHashLiteral: Avoid comma after the last item of a hash.
  'いいいい' => 2,"うううう" =>3,
                                ^

Actual behavior

  • However, the highlight is not positioned correctly
hash.rb:4:3: C: [Correctable] Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.
  'あああああ'=>1,
  ^^^^^^^^^^
hash.rb:4:10: C: [Correctable] Layout/SpaceAroundOperators: Surrounding space missing for operator =>.
  'あああああ'=>1,
         ^^
hash.rb:5:14: C: [Correctable] Layout/SpaceAfterComma: Space missing after comma.
  'いいいい' => 2,"うううう" =>3,
             ^
hash.rb:5:15: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
  'いいいい' => 2,"うううう" =>3,
              ^^^^^^
hash.rb:5:22: C: [Correctable] Layout/SpaceAroundOperators: Surrounding space missing for operator =>.
  'いいいい' => 2,"うううう" =>3,
                     ^^
hash.rb:5:25: C: [Correctable] Style/TrailingCommaInHashLiteral: Avoid comma after the last item of a hash.
  'いいいい' => 2,"うううう" =>3,
                        ^

Steps to reproduce the problem

$ cat hash.rb
# frozen_string_literal: true

{
  'あああああ'=>1,
  'いいいい' => 2,"うううう" =>3,
}

$ rubocop hash.rb
Inspecting 1 file
C

Offenses:

hash.rb:4:3: C: [Correctable] Layout/HashAlignment: Align the keys of a hash literal if they span more than one line.
  'あああああ'=>1,
  ^^^^^^^^^^
hash.rb:4:10: C: [Correctable] Layout/SpaceAroundOperators: Surrounding space missing for operator =>.
  'あああああ'=>1,
         ^^
hash.rb:5:14: C: [Correctable] Layout/SpaceAfterComma: Space missing after comma.
  'いいいい' => 2,"うううう" =>3,
             ^
hash.rb:5:15: C: [Correctable] Style/StringLiterals: Prefer sFix when highlights contain multibyte charactersingle-quoted strings when you don't need string interpolation or special symbols.
  'いいいい' => 2,"うううう" =>3,
              ^^^^^^
hash.rb:5:22: C: [Correctable] Layout/SpaceAroundOperators: Surrounding space missing for operator =>.
  'いいいい' => 2,"うううう" =>3,
                     ^^
hash.rb:5:25: C: [Correctable] Style/TrailingCommaInHashLiteral: Avoid comma after the last item of a hash.
  'いいいい' => 2,"うううう" =>3,
                        ^

1 file inspected, 6 offenses detected, 6 offenses auto-correctable
$

Ref: rubocop/rubocop-jp#43


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.
@osyo-manga osyo-manga marked this pull request as ready for review Mar 31, 2021
@koic koic merged commit 4711f1c into rubocop:master Mar 31, 2021
31 checks passed
31 checks passed
@github-actions
windows 2.4
Details
@github-actions
windows 2.5
Details
@github-actions
windows 2.6
Details
@github-actions
windows 2.7
Details
@github-actions
windows 3.0
Details
@github-actions
windows mingw
Details
@mergify
Summary 2 potential rules
Details
ci/circleci: cc-setup Your tests passed on CircleCI!
Details
ci/circleci: cc-upload-coverage Your tests passed on CircleCI!
Details
ci/circleci: documentation-checks Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-rubocop Your tests passed on CircleCI!
Details
ci/circleci: jruby-9.2-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.4-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.5-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.6-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-2.7-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-3.0-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-3.0-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-3.0-spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-ascii_spec Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-rubocop Your tests passed on CircleCI!
Details
ci/circleci: ruby-head-spec Your tests passed on CircleCI!
Details
@koic
Copy link
Member

@koic koic commented Mar 31, 2021

This highlight fix looks brilliant! Thanks!

@osyo-manga
Copy link
Contributor Author

@osyo-manga osyo-manga commented Apr 1, 2021

Tahnks for merge :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants