feat: Add a time style with better human readability

Cargo.toml

@@ -19,6 +19,8 @@ name = "exa"
 
 [dependencies]
 ansi_term = "0.12"
+chrono = "0.4.26"
+chrono-humanize = "0.2.2"
 glob = "0.3"
 lazy_static = "1.3"
 libc = "0.2"

README.md

@@ -89,7 +89,7 @@ Some of the options accept parameters:
 - Valid **--color** options are **always**, **automatic**, and **never**.
 - Valid sort fields are **accessed**, **changed**, **created**, **extension**, **Extension**, **inode**, **modified**, **name**, **Name**, **size**, **type**, and **none**. Fields starting with a capital letter sort uppercase before lowercase. The modified field has the aliases **date**, **time**, and **newest**, while its reverse has the aliases **age** and **oldest**.
 - Valid time fields are **modified**, **changed**, **accessed**, and **created**.
-- Valid time styles are **default**, **iso**, **long-iso**, and **full-iso**.
+- Valid time styles are **default**, **iso**, **long-iso**, **full-iso** and **relative**.
 
 
 ---

completions/bash/exa

@@ -29,7 +29,7 @@ _exa()
             ;;
 
         --time-style)
-            COMPREPLY=( $( compgen -W 'default iso long-iso full-iso --' -- "$cur" ) )
+            COMPREPLY=( $( compgen -W 'default iso long-iso full-iso relative --' -- "$cur" ) )
             return
             ;;
     esac

completions/fish/exa.fish

@@ -79,6 +79,7 @@ complete -c exa        -l 'time-style'    -d "How to format timestamps" -x -a "
     iso\t'Display brief ISO timestamps'
     long-iso\t'Display longer ISO timestaps, up to the minute'
     full-iso\t'Display full ISO timestamps, up to the nanosecond'
+    relative\t'Display more readable date forms for humans'
 "
 complete -c exa        -l 'no-permissions' -d "Suppress the permissions field"
 complete -c exa        -l 'octal-permissions' -d "List each file's permission in octal format"

completions/zsh/_exa

@@ -43,7 +43,7 @@ __exa() {
         {-n,--numeric}"[List numeric user and group IDs.]" \
         {-S,--blocks}"[List each file's number of filesystem blocks]" \
         {-t,--time}="[Which time field to show]:(time field):(accessed changed created modified)" \
-        --time-style="[How to format timestamps]:(time style):(default iso long-iso full-iso)" \
+        --time-style="[How to format timestamps]:(time style):(default iso long-iso full-iso relative)" \
         --no-permissions"[Suppress the permissions field]" \
         --octal-permissions"[List each file's permission in octal format]" \
         --no-filesize"[Suppress the filesize field]" \

man/exa.1.md

@@ -157,7 +157,7 @@ These options are available when running with `--long` (`-l`):
 `--time-style=STYLE`
 : How to format timestamps.
 
-: Valid timestamp styles are ‘`default`’, ‘`iso`’, ‘`long-iso`’, and ‘`full-iso`’.
+: Valid timestamp styles are ‘`default`’, ‘`iso`’, ‘`long-iso`’, ‘`full-iso`’, and ‘`relative`’.
 
 `-u`, `--accessed`
 : Use the accessed timestamp field.

src/options/flags.rs

@@ -52,7 +52,7 @@ pub static ACCESSED:   Arg = Arg { short: Some(b'u'), long: "accessed",   takes_
 pub static CREATED:    Arg = Arg { short: Some(b'U'), long: "created",    takes_value: TakesValue::Forbidden };
 pub static TIME_STYLE: Arg = Arg { short: None,       long: "time-style", takes_value: TakesValue::Necessary(Some(TIME_STYLES)) };
 const TIMES: Values = &["modified", "changed", "accessed", "created"];
-const TIME_STYLES: Values = &["default", "long-iso", "full-iso", "iso"];
+const TIME_STYLES: Values = &["default", "long-iso", "full-iso", "iso", "relative"];
 
 // suppressing columns
 pub static NO_PERMISSIONS: Arg = Arg { short: None, long: "no-permissions", takes_value: TakesValue::Forbidden };

src/options/help.rs

@@ -54,7 +54,7 @@ LONG VIEW OPTIONS
   -u, --accessed       use the accessed timestamp field
   -U, --created        use the created timestamp field
   --changed            use the changed timestamp field
-  --time-style         how to format timestamps (default, iso, long-iso, full-iso)
+  --time-style         how to format timestamps (default, iso, long-iso, full-iso, relative)
   --no-permissions     suppress the permissions field
   --octal-permissions  list each file's permission in octal format
   --no-filesize        suppress the filesize field

src/options/view.rs

@@ -266,6 +266,9 @@ impl TimeFormat {
         else if &word == "full-iso" {
             Ok(Self::FullISO)
         }
+        else if &word == "relative" {
+            Ok(Self::Human)
+        }
         else {
             Err(OptionsError::BadArgument(&flags::TIME_STYLE, word))
         }
@@ -466,6 +469,7 @@ mod test {
         test!(iso:       TimeFormat <- ["--time-style", "iso"], None;       Both => like Ok(TimeFormat::ISOFormat));
         test!(long_iso:  TimeFormat <- ["--time-style=long-iso"], None;     Both => like Ok(TimeFormat::LongISO));
         test!(full_iso:  TimeFormat <- ["--time-style", "full-iso"], None;  Both => like Ok(TimeFormat::FullISO));
+        test!(relative:  TimeFormat <- ["--time-style=relative"], None;     Both => like Ok(TimeFormat::Human));
 
         // Overriding
         test!(actually:  TimeFormat <- ["--time-style=default", "--time-style", "iso"], None;  Last => like Ok(TimeFormat::ISOFormat));

src/output/time.rs

@@ -2,6 +2,7 @@
 
 use std::time::{SystemTime, UNIX_EPOCH};
 
+use chrono_humanize::HumanTime;
 use datetime::{LocalDateTime, TimeZone, DatePiece, TimePiece};
 use datetime::fmt::DateFormat;
 
@@ -24,7 +25,7 @@ use unicode_width::UnicodeWidthStr;
 /// prints month names as numbers.
 ///
 /// Currently exa does not support *custom* styles, where the user enters a
-/// format string in an environment variable or something. Just these four.
+/// format string in an environment variable or something. Just these five.
 #[derive(PartialEq, Eq, Debug, Copy, Clone)]
 pub enum TimeFormat {
 
@@ -46,6 +47,10 @@ pub enum TimeFormat {
     /// millisecond and includes its offset down to the minute. This too uses
     /// only numbers so doesn’t require any special consideration.
     FullISO,
+
+    /// The **Human format** converts the time form into a more human readable form, 
+    /// such as one month ago, three weeks ago
+    Human,
 }
 
 // There are two different formatting functions because local and zoned
@@ -58,6 +63,7 @@ impl TimeFormat {
             Self::ISOFormat      => iso_local(time),
             Self::LongISO        => long_local(time),
             Self::FullISO        => full_local(time),
+            Self::Human          => hu_local(time),
         }
     }
 
@@ -67,6 +73,7 @@ impl TimeFormat {
             Self::ISOFormat      => iso_zoned(time, zone),
             Self::LongISO        => long_zoned(time, zone),
             Self::FullISO        => full_zoned(time, zone),
+            Self::Human          => hu_zoned(time, zone),
         }
     }
 }
@@ -97,6 +104,19 @@ fn get_dateformat(date: &LocalDateTime) -> &'static DateFormat<'static> {
     }
 }
 
+#[allow(trivial_numeric_casts)]
+fn hu_local(time: SystemTime) -> String {
+    format!("{}", HumanTime::from(time))
+}
+
+#[allow(trivial_numeric_casts)]
+fn hu_zoned(time: SystemTime, _: &TimeZone) -> String {
+
+    let dt: chrono::DateTime<chrono::Utc> = time.clone().into();
+    let tt: chrono::DateTime<chrono::Local> = dt.with_timezone(&chrono::Local);
+    format!("{}", HumanTime::from(tt))
+}
+
 #[allow(trivial_numeric_casts)]
 fn long_local(time: SystemTime) -> String {
     let date = LocalDateTime::at(systemtime_epoch(time));

xtests/input-options.toml

@@ -42,7 +42,7 @@ tags = [ 'options' ]
 name = "exa displays an error for option that takes the wrong parameter"
 shell = "exa -l --time-style=24"
 stdout = { empty = true }
-stderr = { string = "Option --time-style has no \"24\" setting (choices: default, long-iso, full-iso, iso)" }
+stderr = { string = "Option --time-style has no \"24\" setting (choices: default, long-iso, full-iso, iso, relative)" }
 status = 3
 tags = [ 'options' ]
 

xtests/outputs/help.ansitxt

@@ -46,7 +46,7 @@ LONG VIEW OPTIONS
   -u, --accessed       use the accessed timestamp field
   -U, --created        use the created timestamp field
   --changed            use the changed timestamp field
-  --time-style         how to format timestamps (default, iso, long-iso, full-iso)
+  --time-style         how to format timestamps (default, iso, long-iso, full-iso, relative)
   --no-permissions     suppress the permissions field
   --octal-permissions  list each file's permission in octal format
   --no-filesize        suppress the filesize field