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 git-grep match-highlighting at line-start #1057

Merged
merged 2 commits into from
Jul 16, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 63 additions & 5 deletions src/handlers/grep.rs
Original file line number Diff line number Diff line change
Expand Up @@ -222,17 +222,19 @@ fn get_code_style_sections<'b>(
non_match_style: Style,
grep: &GrepLine,
) -> Option<StyleSectionSpecifier<'b>> {
if let Some(raw_code_start) = ansi::ansi_preserving_index(
if let Some(prefix_end) = ansi::ansi_preserving_index(
raw_line,
match grep.line_number {
Some(n) => format!("{}:{}:", grep.path, n).len(),
None => grep.path.len() + 1,
Some(n) => format!("{}:{}:", grep.path, n).len() - 1,
None => grep.path.len(),
},
) {
let match_style_sections = ansi::parse_style_sections(&raw_line[raw_code_start..])
let match_style_sections = ansi::parse_style_sections(&raw_line[(prefix_end + 1)..])
Copy link
Contributor Author

Choose a reason for hiding this comment

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

If there are no escape-code-sequences separating the prefix-section from the code-section, the old approach would have produced the same value as the new approach. If there are escape-code-sequences between the two, the old approach would have skipped them, which isn't what we want. So I think this is okay?

.iter()
.map(|(ansi_term_style, s)| {
if ansi_term_style.foreground.is_some() {
if ansi_term_style.is_bold
&& ansi_term_style.foreground == Some(ansi_term::Colour::Red)
{
(match_style, *s)
} else {
(non_match_style, *s)
Expand Down Expand Up @@ -900,4 +902,60 @@ mod tests {
let apparently_grep_output = "src/co-7-fig.rs:xxx";
assert_eq!(parse_grep_line(apparently_grep_output), None);
}

#[test]
fn test_get_code_style_sections() {
use crate::ansi::strip_ansi_codes;
use crate::handlers::grep::get_code_style_sections;
use crate::paint::StyleSectionSpecifier;
use crate::style::Style;

let fake_parent_grep_command = "git --doesnt-matter grep --nor-this nor_this -- nor_this";
let _args = FakeParentArgs::for_scope(fake_parent_grep_command);

let miss = Style::new();
let hit = Style {
is_emph: true,
..miss
};

let escape = "\x1B";
let working_example = format!("foo/bar/baz.yaml{escape}[36m:{escape}[m1090{escape}[36m:{escape}[m - {escape}[1;31mkind: Service{escape}[mAccount");
let stripped = strip_ansi_codes(&working_example);
let grep = parse_grep_line(&stripped).unwrap();

assert_eq!(
get_code_style_sections(&working_example, hit, miss, &grep),
Some(StyleSectionSpecifier::StyleSections(vec![
(miss, " - "),
(hit, "kind: Service"),
(miss, "Account")
]))
);

let broken_example = format!("foo/bar/baz.yaml{escape}[36m:{escape}[m2{escape}[36m:{escape}[m{escape}[1;31mkind: Service{escape}[m");
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These variable-names aren't really applicable anymore. working_example was the one that worked before the changes were made to get_code_style_sections, broken_example was the one that didn't. That wouldn't actually be a useful distinction going forward; maybe we should rename them?

let broken_stripped = strip_ansi_codes(&broken_example);
let broken_grep = parse_grep_line(&broken_stripped).unwrap();

assert_eq!(
get_code_style_sections(&broken_example, hit, miss, &broken_grep),
Some(StyleSectionSpecifier::StyleSections(vec![(
hit,
"kind: Service"
)]))
);

let plus_example = format!("etc/examples/189-merge-conflict.2.diff{escape}[36m:{escape}[m10{escape}[36m:{escape}[m{escape}[32m + let (style, non_emph_style) = {escape}[1;31mmatch{escape}[m state {{{escape}[m");
let plus_stripped = strip_ansi_codes(&plus_example);
let plus_grep = parse_grep_line(&plus_stripped).unwrap();

assert_eq!(
get_code_style_sections(&plus_example, hit, miss, &plus_grep),
Some(StyleSectionSpecifier::StyleSections(vec![
(miss, " + let (style, non_emph_style) = "),
(hit, "match"),
(miss, " state {")
]))
);
}
}