Skip to content

Drop leading space, highlight empty lines, highlight whitespace errors #225

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.

Sign up for GitHub

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

Merged
Parent: Fixed some typos
merged 8 commits into from
Jun 17, 2020
Merged

Drop leading space, highlight empty lines, highlight whitespace errors #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5d5b4a3
Eliminate leading space unless --keep-plus-minus-markers
dandavison Jun 16, 2020
c2c279b
Highlight added/removed empty lines if they would be invisible
dandavison Jun 17, 2020
7bea572
Add failing test that whitespace errors are highlighted
dandavison Jun 17, 2020
c2bf4cd
Highlight whitespace errors
dandavison Jun 17, 2020
6d0327b
Refactor: simplify paint_lines terminal background color logic
dandavison Jun 17, 2020
71f1330
Refactor test utilities
dandavison Jun 17, 2020
ba8cd95
Add failing test: removal of whitespace error is not an error
dandavison Jun 17, 2020
e8ba95d
Fix failing test: removal of whitespace error is not an error
dandavison Jun 17, 2020
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
16 changes: 16 additions & 0 deletions src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,22 @@ pub struct Opt {
#[structopt(parse(from_os_str))]
pub plus_file: Option<PathBuf>,

/// Style for removed empty line marker (used only if --minus-style has no background color)
#[structopt(
long = "--minus-empty-line-marker-style",
default_value = "normal auto"
)]
pub minus_empty_line_marker_style: String,

/// Style for added empty line marker (used only if --plus-style has no background color)
#[structopt(long = "--plus-empty-line-marker-style", default_value = "normal auto")]
pub plus_empty_line_marker_style: String,

/// Style for whitespace errors. Defaults to color.diff.whitespace if that is set in git
/// config, or else 'magenta reverse'.
#[structopt(long = "whitespace-error-style", default_value = "auto auto")]
pub whitespace_error_style: String,

#[structopt(long = "minus-color")]
/// Deprecated: use --minus-style='normal my_background_color'.
pub deprecated_minus_background_color: Option<String>,
Expand Down
85 changes: 66 additions & 19 deletions src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pub enum Width {
Variable,
}

pub struct Config<'a> {
pub struct Config {
pub background_color_extends_to_terminal_width: bool,
pub commit_style: Style,
pub decorations_width: Width,
Expand All @@ -35,6 +35,7 @@ pub struct Config<'a> {
pub file_removed_label: String,
pub file_renamed_label: String,
pub file_style: Style,
pub keep_plus_minus_markers: bool,
pub hunk_header_style: Style,
pub list_languages: bool,
pub list_syntax_theme_names: bool,
Expand All @@ -43,8 +44,8 @@ pub struct Config<'a> {
pub max_line_distance: f64,
pub max_line_distance_for_naively_paired_lines: f64,
pub minus_emph_style: Style,
pub minus_empty_line_marker_style: Style,
pub minus_file: Option<PathBuf>,
pub minus_line_marker: &'a str,
pub minus_non_emph_style: Style,
pub minus_style: Style,
pub navigate: bool,
Expand All @@ -58,8 +59,8 @@ pub struct Config<'a> {
pub number_plus_style: Style,
pub paging_mode: PagingMode,
pub plus_emph_style: Style,
pub plus_empty_line_marker_style: Style,
pub plus_file: Option<PathBuf>,
pub plus_line_marker: &'a str,
pub plus_non_emph_style: Style,
pub plus_style: Style,
pub show_background_colors: bool,
Expand All @@ -71,10 +72,11 @@ pub struct Config<'a> {
pub tab_width: usize,
pub true_color: bool,
pub tokenization_regex: Regex,
pub whitespace_error_style: Style,
pub zero_style: Style,
}

impl<'a> Config<'a> {
impl Config {
pub fn from_args(args: &[&str], git_config: &mut Option<GitConfig>) -> Self {
Self::from_arg_matches(cli::Opt::clap().get_matches_from(args), git_config)
}
Expand Down Expand Up @@ -149,7 +151,7 @@ fn is_truecolor_terminal() -> bool {
.unwrap_or(false)
}

impl<'a> From<cli::Opt> for Config<'a> {
impl From<cli::Opt> for Config {
fn from(opt: cli::Opt) -> Self {
let assets = HighlightingAssets::new();

Expand Down Expand Up @@ -208,10 +210,13 @@ impl<'a> From<cli::Opt> for Config<'a> {
minus_style,
minus_emph_style,
minus_non_emph_style,
minus_empty_line_marker_style,
zero_style,
plus_style,
plus_emph_style,
plus_non_emph_style,
plus_empty_line_marker_style,
whitespace_error_style,
) = make_hunk_styles(&opt, is_light_mode, true_color);

let (commit_style, file_style, hunk_header_style) =
Expand All @@ -236,17 +241,6 @@ impl<'a> From<cli::Opt> for Config<'a> {
};
let syntax_dummy_theme = assets.theme_set.themes.values().next().unwrap().clone();

let minus_line_marker = if opt.keep_plus_minus_markers {
"-"
} else {
" "
};
let plus_line_marker = if opt.keep_plus_minus_markers {
"+"
} else {
" "
};

let max_line_distance_for_naively_paired_lines =
env::get_env_var("DELTA_EXPERIMENTAL_MAX_LINE_DISTANCE_FOR_NAIVELY_PAIRED_LINES")
.map(|s| s.parse::<f64>().unwrap_or(0.0))
Expand All @@ -271,6 +265,7 @@ impl<'a> From<cli::Opt> for Config<'a> {
file_removed_label: opt.file_removed_label,
file_renamed_label: opt.file_renamed_label,
file_style,
keep_plus_minus_markers: opt.keep_plus_minus_markers,
hunk_header_style,
list_languages: opt.list_languages,
list_syntax_theme_names: opt.list_syntax_theme_names,
Expand All @@ -279,8 +274,8 @@ impl<'a> From<cli::Opt> for Config<'a> {
max_line_distance: opt.max_line_distance,
max_line_distance_for_naively_paired_lines,
minus_emph_style,
minus_empty_line_marker_style,
minus_file: opt.minus_file.map(|s| s.clone()),
minus_line_marker,
minus_non_emph_style,
minus_style,
navigate: opt.navigate,
Expand All @@ -294,8 +289,8 @@ impl<'a> From<cli::Opt> for Config<'a> {
number_plus_style,
paging_mode,
plus_emph_style,
plus_empty_line_marker_style,
plus_file: opt.plus_file.map(|s| s.clone()),
plus_line_marker,
plus_non_emph_style,
plus_style,
show_background_colors: opt.show_background_colors,
Expand All @@ -307,6 +302,7 @@ impl<'a> From<cli::Opt> for Config<'a> {
tab_width: opt.tab_width,
tokenization_regex,
true_color,
whitespace_error_style,
zero_style,
}
}
Expand All @@ -316,7 +312,18 @@ fn make_hunk_styles<'a>(
opt: &'a cli::Opt,
is_light_mode: bool,
true_color: bool,
) -> (Style, Style, Style, Style, Style, Style, Style) {
) -> (
Style,
Style,
Style,
Style,
Style,
Style,
Style,
Style,
Style,
Style,
) {
let minus_style = Style::from_str(
&opt.minus_style,
None,
Expand Down Expand Up @@ -350,6 +357,20 @@ fn make_hunk_styles<'a>(
false,
);

// The style used to highlight a removed empty line when otherwise it would be invisible due to
// lack of background color in minus-style.
let minus_empty_line_marker_style = Style::from_str(
&opt.minus_empty_line_marker_style,
None,
Some(color::get_minus_background_color_default(
is_light_mode,
true_color,
)),
None,
true_color,
false,
);

let zero_style = Style::from_str(&opt.zero_style, None, None, None, true_color, false);

let plus_style = Style::from_str(
Expand Down Expand Up @@ -385,14 +406,40 @@ fn make_hunk_styles<'a>(
false,
);

// The style used to highlight an added empty line when otherwise it would be invisible due to
// lack of background color in plus-style.
let plus_empty_line_marker_style = Style::from_str(
&opt.plus_empty_line_marker_style,
None,
Some(color::get_plus_background_color_default(
is_light_mode,
true_color,
)),
None,
true_color,
false,
);

let whitespace_error_style = Style::from_str(
&opt.whitespace_error_style,
None,
None,
None,
true_color,
false,
);

(
minus_style,
minus_emph_style,
minus_non_emph_style,
minus_empty_line_marker_style,
zero_style,
plus_style,
plus_emph_style,
plus_non_emph_style,
plus_empty_line_marker_style,
whitespace_error_style,
)
}

Expand Down
28 changes: 22 additions & 6 deletions src/delta.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,7 @@ fn handle_hunk_header_line(
"",
config.null_style,
config.null_style,
None,
Some(false),
);
painter.output_buffer.pop(); // trim newline
Expand Down Expand Up @@ -467,7 +468,11 @@ fn handle_hunk_line(
}
Some(' ') => {
let state = State::HunkZero;
let prefix = if line.is_empty() { "" } else { &line[..1] };
let prefix = if config.keep_plus_minus_markers && !line.is_empty() {
&line[..1]
} else {
""
};
painter.paint_buffered_lines();
let lines = vec![prepare(&line, true, config)];
let syntax_style_sections = Painter::get_syntax_style_sections_for_lines(
Expand All @@ -491,6 +496,7 @@ fn handle_hunk_line(
config.zero_style,
config.zero_style,
None,
None,
);
painter.minus_line_number += 1;
painter.plus_line_number += 1;
Expand Down Expand Up @@ -520,12 +526,22 @@ fn prepare(line: &str, append_newline: bool, config: &Config) -> String {
if !line.is_empty() {
let mut line = line.graphemes(true);

// The first column contains a -/+/space character, added by git. We substitute it for a
// space now, so that it is not present during syntax highlighting, and substitute again
// when emitting the line.
// The first column contains a -/+/space character, added by git. If we are retaining them
// (--keep-plus-minus-markers), then we substitute it for a space now, so that it is not
// present during syntax highlighting, and reinstate it when emitting the line in
// Painter::paint_lines. If we not retaining them, then we drop it now, and
// Painter::paint_lines doesn't inject anything.
line.next();

format!(" {}{}", expand_tabs(line, config.tab_width), terminator)
format!(
"{}{}{}",
if config.keep_plus_minus_markers {
" "
} else {
""
},
expand_tabs(line, config.tab_width),
terminator
)
} else {
terminator.to_string()
}
Expand Down
Loading