admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Move multi-line comments with the code they're 'attached' to

Browse Source 
Co-authored-by: Bevan J. Kay <email@bevankay.me>
This commit is contained in:
Issy Long 2024-01-21 12:42:22 +00:00
parent 8910d5a479
commit 458844af44
No known key found for this signature in database
GPG Key ID: 8247C390DADC67D4
2 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Library/Homebrew/rubocops/cask/array_alphabetization.rb
View File

@ -38,15 +38,10 @@ module RuboCop
end
def sort_array(source)
# Combine each comment with the line below it so that they remain connected to the line they comment
# Combine each comment with the line(s) below so that they remain in the same relative location
combined_source = source.each_with_index.map do |line, index|
if line.strip.start_with?("#") && index < source.length - 1
"#{line}\n#{source[index + 1]}"
elsif source[index - 1]&.strip&.start_with?("#")
nil
else
line
end
next if line.strip.start_with?("#")
next recursively_find_comments(source, index, line)
end.compact
# Separate the lines into those that should be sorted and those that should not
@ -63,6 +58,14 @@ module RuboCop
# Merge the sorted lines and the unsorted lines, preserving the original positions of the unsorted lines
combined_source.map { |line| to_keep.include?(line) ? line : to_sort.shift }
end
def recursively_find_comments(source, index, line)
if source[index - 1].strip.start_with?("#")
return recursively_find_comments(source, index - 1, "#{source[index - 1]}\n#{line}")
end
line
end
end
end
end

6
Library/Homebrew/test/rubocops/cask/array_alphabetization_spec.rb
View File

@ -146,6 +146,9 @@ describe RuboCop::Cop::Cask::ArrayAlphabetization, :config do
^ The array elements should be ordered alphabetically
# comment related to foo
"~/Library/Application Support/Foo",
# a really long comment related to Zoo
# and the Zoo comment continues
"~/Library/Application Support/Zoo",
"~/Library/Application Support/Bar",
"~/Library/Application Support/Baz", # in-line comment
]
@ -161,6 +164,9 @@ describe RuboCop::Cop::Cask::ArrayAlphabetization, :config do
"~/Library/Application Support/Baz", # in-line comment
# comment related to foo
"~/Library/Application Support/Foo",
# a really long comment related to Zoo
# and the Zoo comment continues
"~/Library/Application Support/Zoo",
]
end
CASK