Add new `--style` called `header-filesize` and display it by default (#1988)

Also rename `header` to `header-filename`.

Related to #1701

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Features
 
+- New style component `header-filesize` to show size of the displayed file in the header. See #1988 (@mdibaiee)
+
 ## Bugfixes
 
 ## Other

Cargo.lock

@@ -82,6 +82,7 @@ dependencies = [
  "atty",
  "bincode",
  "bugreport",
+ "bytesize",
  "clap",
  "clircle",
  "console",
@@ -169,6 +170,12 @@ version = "1.7.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "439989e6b8c38d1b6570a384ef1e49c8848128f5a97f3914baef02920842712f"
 
+[[package]]
+name = "bytesize"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "6c58ec36aac5066d5ca17df51b3e70279f5670a72102f5752cb7e7c856adfc70"
+
 [[package]]
 name = "cc"
 version = "1.0.72"

Cargo.toml

@@ -65,6 +65,7 @@ dirs-next = { version = "2.0.0", optional = true }
 grep-cli = { version = "0.1.6", optional = true }
 regex = { version = "1.0", optional = true }
 walkdir = { version = "2.0", optional = true }
+bytesize = { version = "1.1.0" }
 
 [dependencies.git2]
 version = "0.13"

src/bin/bat/clap_app.rs

@@ -396,11 +396,19 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                 .validator(|val| {
                     let mut invalid_vals = val.split(',').filter(|style| {
                         !&[
-                            "auto", "full", "plain", "header", "grid", "rule", "numbers", "snip",
+                            "auto",
+                            "full",
+                            "plain",
+                            "header",
+                            "header-filename",
+                            "header-filesize",
+                            "grid",
+                            "rule",
+                            "numbers",
+                            "snip",
                             #[cfg(feature = "git")]
-                                "changes",
+                            "changes",
-                        ]
+                        ].contains(style)
-                            .contains(style)
                     });
 
                     if let Some(invalid) = invalid_vals.next() {
@@ -426,7 +434,9 @@ pub fn build_app(interactive_output: bool) -> ClapApp<'static, 'static> {
                      * auto: same as 'full', unless the output is piped.\n  \
                      * plain: disables all available components.\n  \
                      * changes: show Git modification markers.\n  \
-                     * header: show filenames before the content.\n  \
+                     * header: alias for 'header-filename'.\n  \
+                     * header-filename: show filenames before the content.\n  \
+                     * header-filesize: show file sizes before the content.\n  \
                      * grid: vertical/horizontal lines to separate side bar\n          \
                        and the header from the content.\n  \
                      * rule: horizontal lines to delimit files.\n  \

src/input.rs

@@ -1,4 +1,5 @@
 use std::convert::TryFrom;
+use std::fs;
 use std::fs::File;
 use std::io::{self, BufRead, BufReader, Read};
 use std::path::{Path, PathBuf};
@@ -87,6 +88,7 @@ impl<'a> InputKind<'a> {
 #[derive(Clone, Default)]
 pub(crate) struct InputMetadata {
     pub(crate) user_provided_name: Option<PathBuf>,
+    pub(crate) size: Option<u64>,
 }
 
 pub struct Input<'a> {
@@ -130,9 +132,14 @@ impl<'a> Input<'a> {
 
     fn _ordinary_file(path: &Path) -> Self {
         let kind = InputKind::OrdinaryFile(path.to_path_buf());
+        let metadata = InputMetadata {
+            size: fs::metadata(path).map(|m| m.len()).ok(),
+            ..InputMetadata::default()
+        };
+
         Input {
             description: kind.description(),
-            metadata: InputMetadata::default(),
+            metadata,
             kind,
         }
     }

src/printer.rs

@@ -4,6 +4,8 @@ use std::vec::Vec;
 use ansi_term::Colour::{Fixed, Green, Red, Yellow};
 use ansi_term::Style;
 
+use bytesize::ByteSize;
+
 use console::AnsiCodeIterator;
 
 use syntect::easy::HighlightLines;
@@ -29,6 +31,7 @@ use crate::error::*;
 use crate::input::OpenedInput;
 use crate::line_range::RangeCheckResult;
 use crate::preprocessor::{expand_tabs, replace_nonprintable};
+use crate::style::StyleComponent;
 use crate::terminal::{as_terminal_escaped, to_ansi_color};
 use crate::vscreen::AnsiStyle;
 use crate::wrapping::WrappingMode;
@@ -250,6 +253,21 @@ impl<'a> InteractivePrinter<'a> {
         }
     }
 
+    fn print_header_component_indent(&mut self, handle: &mut dyn Write) -> std::io::Result<()> {
+        if self.config.style_components.grid() {
+            write!(
+                handle,
+                "{}{}",
+                " ".repeat(self.panel_width),
+                self.colors
+                    .grid
+                    .paint(if self.panel_width > 0 { "│ " } else { "" }),
+            )
+        } else {
+            write!(handle, "{}", " ".repeat(self.panel_width))
+        }
+    }
+
     fn preprocess(&self, text: &str, cursor: &mut usize) -> String {
         if self.config.tab_width > 0 {
             return expand_tabs(text, self.config.tab_width, cursor);
@@ -287,25 +305,6 @@ impl<'a> Printer for InteractivePrinter<'a> {
             return Ok(());
         }
 
-        if self.config.style_components.grid() {
-            self.print_horizontal_line(handle, '┬')?;
-
-            write!(
-                handle,
-                "{}{}",
-                " ".repeat(self.panel_width),
-                self.colors
-                    .grid
-                    .paint(if self.panel_width > 0 { "│ " } else { "" }),
-            )?;
-        } else {
-            // Only pad space between files, if we haven't already drawn a horizontal rule
-            if add_header_padding && !self.config.style_components.rule() {
-                writeln!(handle)?;
-            }
-            write!(handle, "{}", " ".repeat(self.panel_width))?;
-        }
-
         let mode = match self.content_type {
             Some(ContentType::BINARY) => "   <BINARY>",
             Some(ContentType::UTF_16LE) => "   <UTF-16LE>",
@@ -315,17 +314,60 @@ impl<'a> Printer for InteractivePrinter<'a> {
         };
 
         let description = &input.description;
+        let metadata = &input.metadata;
 
-        writeln!(
+        // We use this iterator to have a deterministic order for
-            handle,
+        // header components. HashSet has arbitrary order, but Vec is ordered.
-            "{}{}{}",
+        let header_components: Vec<StyleComponent> = [
-            description
+            (
-                .kind()
+                StyleComponent::HeaderFilename,
-                .map(|kind| format!("{}: ", kind))
+                self.config.style_components.header_filename(),
-                .unwrap_or_else(|| "".into()),
+            ),
-            self.colors.filename.paint(description.title()),
+            (
-            mode
+                StyleComponent::HeaderFilesize,
-        )?;
+                self.config.style_components.header_filesize(),
+            ),
+        ]
+        .iter()
+        .filter(|(_, is_enabled)| *is_enabled)
+        .map(|(component, _)| *component)
+        .collect();
+
+        // Print the cornering grid before the first header component
+        if self.config.style_components.grid() {
+            self.print_horizontal_line(handle, '┬')?;
+        } else {
+            // Only pad space between files, if we haven't already drawn a horizontal rule
+            if add_header_padding && !self.config.style_components.rule() {
+                writeln!(handle)?;
+            }
+        }
+
+        header_components.iter().try_for_each(|component| {
+            self.print_header_component_indent(handle)?;
+
+            match component {
+                StyleComponent::HeaderFilename => writeln!(
+                    handle,
+                    "{}{}{}",
+                    description
+                        .kind()
+                        .map(|kind| format!("{}: ", kind))
+                        .unwrap_or_else(|| "".into()),
+                    self.colors.header_value.paint(description.title()),
+                    mode
+                ),
+
+                StyleComponent::HeaderFilesize => {
+                    let bsize = metadata
+                        .size
+                        .map(|s| format!("{}", ByteSize(s)))
+                        .unwrap_or_else(|| "-".into());
+                    writeln!(handle, "Size: {}", self.colors.header_value.paint(bsize))
+                }
+                _ => Ok(()),
+            }
+        })?;
 
         if self.config.style_components.grid() {
             if self.content_type.map_or(false, |c| c.is_text()) || self.config.show_nonprintable {
@@ -617,7 +659,7 @@ const DEFAULT_GUTTER_COLOR: u8 = 238;
 pub struct Colors {
     pub grid: Style,
     pub rule: Style,
-    pub filename: Style,
+    pub header_value: Style,
     pub git_added: Style,
     pub git_removed: Style,
     pub git_modified: Style,
@@ -646,7 +688,7 @@ impl Colors {
         Colors {
             grid: gutter_style,
             rule: gutter_style,
-            filename: Style::new().bold(),
+            header_value: Style::new().bold(),
             git_added: Green.normal(),
             git_removed: Red.normal(),
             git_modified: Yellow.normal(),

src/style.rs

@@ -3,6 +3,7 @@ use std::str::FromStr;
 
 use crate::error::*;
 
+#[non_exhaustive]
 #[derive(Debug, Eq, PartialEq, Copy, Clone, Hash)]
 pub enum StyleComponent {
     Auto,
@@ -11,6 +12,8 @@ pub enum StyleComponent {
     Grid,
     Rule,
     Header,
+    HeaderFilename,
+    HeaderFilesize,
     LineNumbers,
     Snip,
     Full,
@@ -31,14 +34,17 @@ impl StyleComponent {
             StyleComponent::Changes => &[StyleComponent::Changes],
             StyleComponent::Grid => &[StyleComponent::Grid],
             StyleComponent::Rule => &[StyleComponent::Rule],
-            StyleComponent::Header => &[StyleComponent::Header],
+            StyleComponent::Header => &[StyleComponent::HeaderFilename],
+            StyleComponent::HeaderFilename => &[StyleComponent::HeaderFilename],
+            StyleComponent::HeaderFilesize => &[StyleComponent::HeaderFilesize],
             StyleComponent::LineNumbers => &[StyleComponent::LineNumbers],
             StyleComponent::Snip => &[StyleComponent::Snip],
             StyleComponent::Full => &[
                 #[cfg(feature = "git")]
                 StyleComponent::Changes,
                 StyleComponent::Grid,
-                StyleComponent::Header,
+                StyleComponent::HeaderFilename,
+                StyleComponent::HeaderFilesize,
                 StyleComponent::LineNumbers,
                 StyleComponent::Snip,
             ],
@@ -58,6 +64,8 @@ impl FromStr for StyleComponent {
             "grid" => Ok(StyleComponent::Grid),
             "rule" => Ok(StyleComponent::Rule),
             "header" => Ok(StyleComponent::Header),
+            "header-filename" => Ok(StyleComponent::HeaderFilename),
+            "header-filesize" => Ok(StyleComponent::HeaderFilesize),
             "numbers" => Ok(StyleComponent::LineNumbers),
             "snip" => Ok(StyleComponent::Snip),
             "full" => Ok(StyleComponent::Full),
@@ -89,7 +97,15 @@ impl StyleComponents {
     }
 
     pub fn header(&self) -> bool {
-        self.0.contains(&StyleComponent::Header)
+        self.header_filename() || self.header_filesize()
+    }
+
+    pub fn header_filename(&self) -> bool {
+        self.0.contains(&StyleComponent::HeaderFilename)
+    }
+
+    pub fn header_filesize(&self) -> bool {
+        self.0.contains(&StyleComponent::HeaderFilesize)
     }
 
     pub fn numbers(&self) -> bool {

tests/benchmarks/many-small-files/small-file-0.txt

@@ -0,0 +1 @@
+I am small file 0

tests/benchmarks/many-small-files/small-file-1.txt

@@ -0,0 +1 @@
+I am small file 1

tests/benchmarks/many-small-files/small-file-10.txt

@@ -0,0 +1 @@
+I am small file 10

tests/benchmarks/many-small-files/small-file-100.txt

@@ -0,0 +1 @@
+I am small file 100

tests/benchmarks/many-small-files/small-file-11.txt

@@ -0,0 +1 @@
+I am small file 11

tests/benchmarks/many-small-files/small-file-12.txt

@@ -0,0 +1 @@
+I am small file 12

tests/benchmarks/many-small-files/small-file-13.txt

@@ -0,0 +1 @@
+I am small file 13

tests/benchmarks/many-small-files/small-file-14.txt

@@ -0,0 +1 @@
+I am small file 14

tests/benchmarks/many-small-files/small-file-15.txt

@@ -0,0 +1 @@
+I am small file 15

tests/benchmarks/many-small-files/small-file-16.txt

@@ -0,0 +1 @@
+I am small file 16

tests/benchmarks/many-small-files/small-file-17.txt

@@ -0,0 +1 @@
+I am small file 17

tests/benchmarks/many-small-files/small-file-18.txt

@@ -0,0 +1 @@
+I am small file 18

tests/benchmarks/many-small-files/small-file-19.txt

@@ -0,0 +1 @@
+I am small file 19

tests/benchmarks/many-small-files/small-file-2.txt

@@ -0,0 +1 @@
+I am small file 2

tests/benchmarks/many-small-files/small-file-20.txt

@@ -0,0 +1 @@
+I am small file 20

tests/benchmarks/many-small-files/small-file-21.txt

@@ -0,0 +1 @@
+I am small file 21

tests/benchmarks/many-small-files/small-file-22.txt

@@ -0,0 +1 @@
+I am small file 22

tests/benchmarks/many-small-files/small-file-23.txt

@@ -0,0 +1 @@
+I am small file 23

tests/benchmarks/many-small-files/small-file-24.txt

@@ -0,0 +1 @@
+I am small file 24

tests/benchmarks/many-small-files/small-file-25.txt

@@ -0,0 +1 @@
+I am small file 25

tests/benchmarks/many-small-files/small-file-26.txt

@@ -0,0 +1 @@
+I am small file 26

tests/benchmarks/many-small-files/small-file-27.txt

@@ -0,0 +1 @@
+I am small file 27

tests/benchmarks/many-small-files/small-file-28.txt

@@ -0,0 +1 @@
+I am small file 28

tests/benchmarks/many-small-files/small-file-29.txt

@@ -0,0 +1 @@
+I am small file 29

tests/benchmarks/many-small-files/small-file-3.txt

@@ -0,0 +1 @@
+I am small file 3

tests/benchmarks/many-small-files/small-file-30.txt

@@ -0,0 +1 @@
+I am small file 30

tests/benchmarks/many-small-files/small-file-31.txt

@@ -0,0 +1 @@
+I am small file 31

tests/benchmarks/many-small-files/small-file-32.txt

@@ -0,0 +1 @@
+I am small file 32

tests/benchmarks/many-small-files/small-file-33.txt

@@ -0,0 +1 @@
+I am small file 33

tests/benchmarks/many-small-files/small-file-34.txt

@@ -0,0 +1 @@
+I am small file 34

tests/benchmarks/many-small-files/small-file-35.txt

@@ -0,0 +1 @@
+I am small file 35

tests/benchmarks/many-small-files/small-file-36.txt

@@ -0,0 +1 @@
+I am small file 36

tests/benchmarks/many-small-files/small-file-37.txt

@@ -0,0 +1 @@
+I am small file 37

tests/benchmarks/many-small-files/small-file-38.txt

@@ -0,0 +1 @@
+I am small file 38

tests/benchmarks/many-small-files/small-file-39.txt

@@ -0,0 +1 @@
+I am small file 39

tests/benchmarks/many-small-files/small-file-4.txt

@@ -0,0 +1 @@
+I am small file 4

tests/benchmarks/many-small-files/small-file-40.txt

@@ -0,0 +1 @@
+I am small file 40

tests/benchmarks/many-small-files/small-file-41.txt

@@ -0,0 +1 @@
+I am small file 41

tests/benchmarks/many-small-files/small-file-42.txt

@@ -0,0 +1 @@
+I am small file 42

tests/benchmarks/many-small-files/small-file-43.txt

@@ -0,0 +1 @@
+I am small file 43

tests/benchmarks/many-small-files/small-file-44.txt

@@ -0,0 +1 @@
+I am small file 44

tests/benchmarks/many-small-files/small-file-45.txt

@@ -0,0 +1 @@
+I am small file 45

tests/benchmarks/many-small-files/small-file-46.txt

@@ -0,0 +1 @@
+I am small file 46

tests/benchmarks/many-small-files/small-file-47.txt

@@ -0,0 +1 @@
+I am small file 47

tests/benchmarks/many-small-files/small-file-48.txt

@@ -0,0 +1 @@
+I am small file 48

tests/benchmarks/many-small-files/small-file-49.txt

@@ -0,0 +1 @@
+I am small file 49

tests/benchmarks/many-small-files/small-file-5.txt

@@ -0,0 +1 @@
+I am small file 5

tests/benchmarks/many-small-files/small-file-50.txt

@@ -0,0 +1 @@
+I am small file 50

tests/benchmarks/many-small-files/small-file-51.txt

@@ -0,0 +1 @@
+I am small file 51

tests/benchmarks/many-small-files/small-file-52.txt

@@ -0,0 +1 @@
+I am small file 52

tests/benchmarks/many-small-files/small-file-53.txt

@@ -0,0 +1 @@
+I am small file 53

tests/benchmarks/many-small-files/small-file-54.txt

@@ -0,0 +1 @@
+I am small file 54

tests/benchmarks/many-small-files/small-file-55.txt

@@ -0,0 +1 @@
+I am small file 55

tests/benchmarks/many-small-files/small-file-56.txt

@@ -0,0 +1 @@
+I am small file 56

tests/benchmarks/many-small-files/small-file-57.txt

@@ -0,0 +1 @@
+I am small file 57

tests/benchmarks/many-small-files/small-file-58.txt

@@ -0,0 +1 @@
+I am small file 58

tests/benchmarks/many-small-files/small-file-59.txt

@@ -0,0 +1 @@
+I am small file 59

tests/benchmarks/many-small-files/small-file-6.txt

@@ -0,0 +1 @@
+I am small file 6

tests/benchmarks/many-small-files/small-file-60.txt

@@ -0,0 +1 @@
+I am small file 60

tests/benchmarks/many-small-files/small-file-61.txt

@@ -0,0 +1 @@
+I am small file 61

tests/benchmarks/many-small-files/small-file-62.txt

@@ -0,0 +1 @@
+I am small file 62

tests/benchmarks/many-small-files/small-file-63.txt

@@ -0,0 +1 @@
+I am small file 63

tests/benchmarks/many-small-files/small-file-64.txt

@@ -0,0 +1 @@
+I am small file 64

tests/benchmarks/many-small-files/small-file-65.txt

@@ -0,0 +1 @@
+I am small file 65

tests/benchmarks/many-small-files/small-file-66.txt

@@ -0,0 +1 @@
+I am small file 66

tests/benchmarks/many-small-files/small-file-67.txt

@@ -0,0 +1 @@
+I am small file 67

tests/benchmarks/many-small-files/small-file-68.txt

@@ -0,0 +1 @@
+I am small file 68

tests/benchmarks/many-small-files/small-file-69.txt

@@ -0,0 +1 @@
+I am small file 69

tests/benchmarks/many-small-files/small-file-7.txt

@@ -0,0 +1 @@
+I am small file 7

tests/benchmarks/many-small-files/small-file-70.txt

@@ -0,0 +1 @@
+I am small file 70

tests/benchmarks/many-small-files/small-file-71.txt

@@ -0,0 +1 @@
+I am small file 71

tests/benchmarks/many-small-files/small-file-72.txt

@@ -0,0 +1 @@
+I am small file 72

tests/benchmarks/many-small-files/small-file-73.txt

@@ -0,0 +1 @@
+I am small file 73

tests/benchmarks/many-small-files/small-file-74.txt

@@ -0,0 +1 @@
+I am small file 74

tests/benchmarks/many-small-files/small-file-75.txt

@@ -0,0 +1 @@
+I am small file 75

tests/benchmarks/many-small-files/small-file-76.txt

@@ -0,0 +1 @@
+I am small file 76

tests/benchmarks/many-small-files/small-file-77.txt

@@ -0,0 +1 @@
+I am small file 77

tests/benchmarks/many-small-files/small-file-78.txt

@@ -0,0 +1 @@
+I am small file 78

tests/benchmarks/many-small-files/small-file-79.txt

@@ -0,0 +1 @@
+I am small file 79

tests/benchmarks/many-small-files/small-file-8.txt

@@ -0,0 +1 @@
+I am small file 8

tests/benchmarks/many-small-files/small-file-80.txt

@@ -0,0 +1 @@
+I am small file 80

tests/benchmarks/many-small-files/small-file-81.txt

@@ -0,0 +1 @@
+I am small file 81

tests/benchmarks/many-small-files/small-file-82.txt

@@ -0,0 +1 @@
+I am small file 82

tests/benchmarks/many-small-files/small-file-83.txt

@@ -0,0 +1 @@
+I am small file 83

tests/benchmarks/many-small-files/small-file-84.txt

@@ -0,0 +1 @@
+I am small file 84

tests/benchmarks/many-small-files/small-file-85.txt

@@ -0,0 +1 @@
+I am small file 85

tests/benchmarks/many-small-files/small-file-86.txt

@@ -0,0 +1 @@
+I am small file 86

tests/benchmarks/many-small-files/small-file-87.txt

@@ -0,0 +1 @@
+I am small file 87

tests/benchmarks/many-small-files/small-file-88.txt

@@ -0,0 +1 @@
+I am small file 88

tests/benchmarks/many-small-files/small-file-89.txt

@@ -0,0 +1 @@
+I am small file 89

tests/benchmarks/many-small-files/small-file-9.txt

@@ -0,0 +1 @@
+I am small file 9

tests/benchmarks/many-small-files/small-file-90.txt

@@ -0,0 +1 @@
+I am small file 90

tests/benchmarks/many-small-files/small-file-91.txt

@@ -0,0 +1 @@
+I am small file 91