feat: add `--decay` option to highlight newer files #526

aashirbadb · 2023-10-12T18:30:57Z

This PR adds --decay option that highlights newer files. It has two modes:

absolute: Evaluates based on file modification time relative to the past year.
relative: Considers file modification time in relation to other files.

Both modes use a luminance formula min + (1.0 - min) * exp(-4.0 * (1.0 - x)), where min can be customized by using the 'EZA_MIN_LUMINANCE' environment variable.

Screenshots:

relative mode
absolute mode
tree

(I'm calling it decay because I couldn't think of a better name 😅. I'd greatly appreciate any suggestions for a more fitting name)

Resolves #486

PThorpe92 · 2023-10-13T02:06:13Z

I like the term decay.. it's a hell of a lot better than rot lmao

cafkafk

This is looking cool.

For conventional commits: doc: add --decay option and EZA_MIN_LUMINANCE env var needs to be docs: add --decay option and EZA_MIN_LUMINANCE env var

cafkafk

Could we have default behavior where --decay without any arguments default to --decay relative?

aashirbadb · 2023-10-13T13:49:58Z

Could we have default behavior where --decay without any arguments default to --decay relative?

I tried adding it but it looks like TakesValue::Optional doesn't work like it should.
Passing --decay something gives (decay, Some(something)) instead of (decay, Some(default_value))(if something is invalid option for the flag) or (decay, Some(something)) (if something is valid option).

eza/src/options/parser.rs

Lines 201 to 207 in 9805dd5

    
           TakesValue::Optional(_) => { 
        
               if let Some(next_arg) = inputs.next() { 
        
                   result_flags.push((flag, Some(next_arg))); 
        
               } else { 
        
                   result_flags.push((flag, None)); 
        
               } 
        
           }

Should I fix this(maybe in a separate PR?) or wait for #197 and implement it then?

PThorpe92 · 2023-10-13T16:30:55Z

Should I fix this(maybe in a separate PR?) or wait for #197 and implement it then?

I am currently working through another implementation that gives a flag a default value. Once I'm finished I'll take a look and see if we can get it figured out.

Hopefully clap will be very soon. Honestly, this is a really exciting change and part of me does want to wait and release the functionality with v1.0

Feel free to come to the matrix channel too if you want to talk about it

cohml · 2023-10-23T17:42:39Z

Feel free to come to the matrix channel too if you want to talk about it

Link to said channel please? I'm not familiar with this "matrix", but would like to be a fly on the wall. Thanks.

PThorpe92 · 2023-10-23T21:52:39Z

If you go to the main page the "Chat on gitter" button

https://matrix.to/#/#eza-community:gitter.im is the link

Delapouite · 2023-10-26T11:57:37Z

Also, should the option --color-scale be renamed to avoid any confusion about where it applies ? size vs date?

PThorpe92 · 2023-10-26T13:03:01Z

Also, should the option --color-scale be renamed to avoid any confusion about where it applies ? size vs date?

That is a good question.. how would you feel about making this a value for the color-scale flag? e.g. --color-scale=age || --color-scale=size

PThorpe92 · 2023-10-26T13:05:49Z

also, I was able to get the --icons flag to take a default value and have a TakesValue::Optional(Some(VALUE))

So if you want to have this take an optional argument and set a default value, you can look at how icons does it now.

Delapouite · 2023-10-26T13:17:00Z

You're right PThorpe92, the notion of color-scale could even reach further.

Non exhaustive list of possible columns :

date: old → new (this PR)
size: small → big (kind of current behavior of --color-scale, but limited to magnitude kilo, mega, tera…)
links count : few → lot
octal permissions : very-restricted → open bar (777)
…

PThorpe92 · 2023-10-26T13:30:54Z

I think the way to go would be to have breaking changes, and make sure that --color-scale has a value. It will break people's alias's, but it will also alert them to the new feature.

Have you tested this alongside the current --color-scale flag? How does that work?

aashirbadb · 2023-10-26T13:43:08Z

That is a good question.. how would you feel about making this a value for the color-scale flag? e.g. --color-scale=age || --color-scale=size

--decay takes two values so I can just change it so that relative is default value when --color-scale=age is used and it can be changed to absolute mode using --color-scale=age --decay=absolute.

I think the way to go would be to have breaking changes, and make sure that --color-scale has a value. It will break people's alias's, but it will also alert them to the new feature.

We can also allow multiple choices using comma separated list(--color-scale=age,size) and maybe add an all choice which could be optional flag to not introduce a breaking change?

PThorpe92 · 2023-10-26T13:54:28Z

My thought process was kinda specifically to introduce the feature. Adding a value to a flag isn't nearly as exciting as the new decay option. But I do like that idea. It could just default to all

Signed-off-by: Aashirbad Bhandari <89701256+aashirbadb@users.noreply.github.com>

aashirbadb · 2023-10-27T08:28:04Z

I think it would be better to remove the --decay flag and use --color-scale and add a new flag(something like --color-scale-mode) to select the mode(fixed,gradient).

Fixed would work like the current --color-scale and gradient would work like relative mode.

This would also make it easier to add more columns like Delapouite suggested.

aashirbadb · 2023-10-28T11:30:57Z

I added this to size and it looks pretty cool.

aashirbadb · 2023-10-28T16:35:15Z

Had to make it a breaking change

I haven't done anything for time's fixed mode. I'm thinking of adding something like --color-scale. It will make the time colors more customizable but it will break custom color for date(da).

Not sure why the CI failing

cafkafk

Looks like you have a formatting issue, if you're using nix, this is easily fixed with nix fmt.

Also, your breaking change should have a BREAKING footer (or w/e exactly it's called) as specified by conventional commits, you can find more info about it in the conventional commits spec.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>

MartinFillon · 2023-11-08T17:20:20Z

README.md

@@ -90,7 +90,8 @@ eza’s options are almost, but not quite, entirely unlike `ls`’s.
 - **-x**, **--across**: sort the grid across, rather than downwards
 - **-F**, **--classify**: display type indicator by file names
 - **--colo[u]r=(when)**: when to use terminal colours (always, auto, never)
- **--colo[u]r-scale**: highlight levels of file sizes distinctly
+- **--colo[u]r-scale=(field)**: highlight levels of `field` distinctly(all, age, size)


I don't like age as Field name could you use the name used on the --header option

MartinFillon · 2023-11-08T17:27:47Z

src/options/theme.rs

-    test!(scale_1:  ColourScale <- ["--color-scale", "--colour-scale"];   Last => Ok(ColourScale::Gradient));
-    test!(scale_2:  ColourScale <- ["--color-scale",                 ];   Last => Ok(ColourScale::Gradient));
-    test!(scale_3:  ColourScale <- [                 "--colour-scale"];   Last => Ok(ColourScale::Gradient));
-    test!(scale_4:  ColourScale <- [                                 ];   Last => Ok(ColourScale::Fixed));
+    // test!(scale_1:  ColourScale <- ["--color-scale", "--colour-scale"];   Last => Ok(ColourScale::Gradient));
+    // test!(scale_2:  ColourScale <- ["--color-scale",                 ];   Last => Ok(ColourScale::Gradient));
+    // test!(scale_3:  ColourScale <- [                 "--colour-scale"];   Last => Ok(ColourScale::Gradient));
+    // test!(scale_4:  ColourScale <- [                                 ];   Last => Ok(ColourScale::Fixed));

-    test!(scale_5:  ColourScale <- ["--color-scale", "--colour-scale"];   Complain => err OptionsError::Duplicate(Flag::Long("color-scale"),  Flag::Long("colour-scale")));
-    test!(scale_6:  ColourScale <- ["--color-scale",                 ];   Complain => Ok(ColourScale::Gradient));
-    test!(scale_7:  ColourScale <- [                 "--colour-scale"];   Complain => Ok(ColourScale::Gradient));
-    test!(scale_8:  ColourScale <- [                                 ];   Complain => Ok(ColourScale::Fixed));
+    // test!(scale_5:  ColourScale <- ["--color-scale", "--colour-scale"];   Complain => err OptionsError::Duplicate(Flag::Long("color-scale"),  Flag::Long("colour-scale")));
+    // test!(scale_6:  ColourScale <- ["--color-scale",                 ];   Complain => Ok(ColourScale::Gradient));
+    // test!(scale_7:  ColourScale <- [                 "--colour-scale"];   Complain => Ok(ColourScale::Gradient));
+    // test!(scale_8:  ColourScale <- [                                 ];   Complain => Ok(ColourScale::Fixed));


Please remove those comments and test the code

If not possible to test just remove it

MartinFillon · 2023-11-08T17:32:33Z

src/output/decay.rs

+fn update_information_recursively(
+    information: &mut ColorScaleInformation,
+    files: &[File<'_>],
+    dot_filter: DotFilter,
+    git: Option<&GitCache>,
+    git_ignoring: bool,
+    depth: TreeDepth,
+    r: Option<RecurseOptions>,
+) {


Why is this function not in the impl above ?

MartinFillon · 2023-11-08T17:34:29Z

src/output/render/size.rs

+                    NumberPrefix::Standalone(_) => None,
+                    NumberPrefix::Prefixed(p, _) => Some(p),


please format those lines

This is based on a series of commits done by aashirabadb in #526. This introduces the `--color-scale` flag both for file age and size, as well as `--color-scale-mode` which allows "fixed" and gradient". The reason for reapplying from the diff of the PR instead of the patch is that the commit history was messy, and introduced "breaking changes" that were only locally breaking to the PR, that is, not the users. Further, the PR had seemingly gone stale, and the rather long and complicated commit history interwoven with merges made it seem more efficient to just work from scratch. Again, the work here is done by aashirbadb, my contribution is just ensuring the quality of the code they've written. Co-authored-by: aashirbadb <aashirbadbhandari@gmail.com> Signed-off-by: Christina Sørensen <christina@cafkafk.com> Refs: #486

cafkafk · 2023-11-08T18:46:54Z

This was fixed in #628

This is based on a series of commits done by aashirabadb in #526. This introduces the `--color-scale` flag both for file age and size, as well as `--color-scale-mode` which allows "fixed" and gradient". The reason for reapplying from the diff of the PR instead of the patch is that the commit history was messy, and introduced "breaking changes" that were only locally breaking to the PR, that is, not the users. Further, the PR had seemingly gone stale, and the rather long and complicated commit history interwoven with merges made it seem more efficient to just work from scratch. Again, the work here is done by aashirbadb, my contribution is just ensuring the quality of the code they've written. Co-authored-by: aashirbadb <aashirbadbhandari@gmail.com> Signed-off-by: Christina Sørensen <christina@cafkafk.com> Refs: #486

aashirbadb added 3 commits October 12, 2023 22:16

feat: adds new '--decay' option

e2edaa4

feat: add EZA_MIN_LUMINANCE environment variable

72bf094

feat(completions): add completions for decay

19ee492

aashirbadb requested review from PThorpe92 and cafkafk as code owners October 12, 2023 18:30

docs: add --decay option and EZA_MIN_LUMINANCE env var

a55bdde

cafkafk requested changes Oct 13, 2023

View reviewed changes

aashirbadb requested a review from cafkafk October 13, 2023 05:46

cafkafk requested changes Oct 13, 2023

View reviewed changes

aashirbadb and others added 3 commits October 26, 2023 14:19

Merge branch 'main' into decay

3e68a6c

Signed-off-by: Aashirbad Bhandari <89701256+aashirbadb@users.noreply.github.com>

feat: add default value in optional args

7f5b4d9

style: fix clippy warnings

f56c255

aashirbadb added 4 commits October 28, 2023 21:04

feat!: move decay to --color-scale and add --color-scale-mode flag

ee632dd

feat: add gradient for size

26c21e7

feat(completions): update completions

20125b2

fix: add values to color-scale flag

ada079f

cafkafk requested changes Nov 1, 2023

View reviewed changes

Merge branch 'main' into decay

cdadd87

Signed-off-by: Christina Sørensen <christina@cafkafk.com>

cafkafk requested a review from MartinFillon as a code owner November 8, 2023 17:13

MartinFillon requested changes Nov 8, 2023

View reviewed changes

cafkafk mentioned this pull request Nov 8, 2023

feat: add --color-scale #628

Merged

cafkafk closed this Nov 8, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `--decay` option to highlight newer files #526

feat: add `--decay` option to highlight newer files #526

aashirbadb commented Oct 12, 2023

PThorpe92 commented Oct 13, 2023

cafkafk left a comment

cafkafk left a comment

aashirbadb commented Oct 13, 2023

PThorpe92 commented Oct 13, 2023

cohml commented Oct 23, 2023

PThorpe92 commented Oct 23, 2023

Delapouite commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

Delapouite commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

aashirbadb commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

aashirbadb commented Oct 27, 2023

aashirbadb commented Oct 28, 2023

aashirbadb commented Oct 28, 2023

cafkafk left a comment

MartinFillon Nov 8, 2023

MartinFillon Nov 8, 2023

MartinFillon Nov 8, 2023

MartinFillon Nov 8, 2023

MartinFillon Nov 8, 2023

cafkafk commented Nov 8, 2023

		NumberPrefix::Standalone(_) => None,
		NumberPrefix::Prefixed(p, _) => Some(p),

feat: add --decay option to highlight newer files #526

feat: add --decay option to highlight newer files #526

Conversation

aashirbadb commented Oct 12, 2023

PThorpe92 commented Oct 13, 2023

cafkafk left a comment

Choose a reason for hiding this comment

cafkafk left a comment

Choose a reason for hiding this comment

aashirbadb commented Oct 13, 2023

PThorpe92 commented Oct 13, 2023

cohml commented Oct 23, 2023

PThorpe92 commented Oct 23, 2023

Delapouite commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

Delapouite commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

aashirbadb commented Oct 26, 2023

PThorpe92 commented Oct 26, 2023

aashirbadb commented Oct 27, 2023

aashirbadb commented Oct 28, 2023

aashirbadb commented Oct 28, 2023

cafkafk left a comment

Choose a reason for hiding this comment

MartinFillon Nov 8, 2023

Choose a reason for hiding this comment

MartinFillon Nov 8, 2023

Choose a reason for hiding this comment

MartinFillon Nov 8, 2023

Choose a reason for hiding this comment

MartinFillon Nov 8, 2023

Choose a reason for hiding this comment

MartinFillon Nov 8, 2023

Choose a reason for hiding this comment

cafkafk commented Nov 8, 2023

feat: add `--decay` option to highlight newer files #526

feat: add `--decay` option to highlight newer files #526