feat(parser): Introduce clap based parser #197

MartinFillon · 2023-09-05T20:48:37Z

Introduce a clap based arg parsing

PThorpe92 · 2023-09-08T00:00:17Z

I have cloned and built this fork. This is indeed a solid start 👍

After a couple fixes, this will be ready for a deeper look, and we can discuss things like the -h flag and duplicate args (if that cannot be fixed).

Thanks for your work here 😄

@cafkafk I"m going to help him get this ready for review... Still got some things to work on.

@MartinFillon I would suggest just re-marking this as a draft for now... No need to rush, it's a huge change.

MartinFillon · 2023-09-08T00:41:33Z

Tasks:

add the parser
add unit tests
enable multiple instance of a flag
override -h to use it for header

It is starting to look like something

ariasuni

I wasn’t convinced by the idea at first, but I must admit it’s more readable and it allows us to get rid of a ton of boilerplate! And we don’t need to test code too much since clap is already tested & trustworthy. So yeah, nice work so far!

src/options/dir_action.rs

src/options/view.rs

src/options/parser.rs

MartinFillon · 2023-09-08T18:22:25Z

Most of the work is done, only part lasting is finding bugs.
If anyone finds any please report them here.
@cafkafk you can now review it for the first time as a ready to prod project
@PThorpe92 Waiting for your returns on that as we talked a lot about this together
and everyone else any help will be thanked.

ariasuni

I wonder if we shouldn’t drop the strict mode, it seems complicated for a very marginal gain, but maybe some people use it??

Anyway, hope the feedback isn’t too heavy, it looks great overall.

src/options/filter.rs

src/options/dir_action.rs

src/options/filter.rs

src/options/parser.rs

src/options/theme.rs

src/options/view.rs

PThorpe92 · 2023-09-08T23:31:15Z

I went through some of the code as well, @MartinFillon we spoke about this, i'll be pushing my changes with tests probably to your fork maybe tomorrow, but I had a similar thought...

I wonder if we shouldn’t drop the strict mode

It feels like it would simplify a lot of what's going on. Are there any other thoughts on this? @cafkafk | @gierens ?

This is a pretty monumental change here... I wrote a .tape file with just about every permutation of command that can/should be run, it just needs to be refined a little and I'm going to write a script to run it against this fork and the main branch, so we can prove the output will remain the same. between the two.

I feel like there is really no substitution for just using it though.. So I will also temp remove eza from my path and use this fork for the next couple days and see if i run into any bugs personally.

ALSO: I'll wait till you resolve the current review before I add my official review on here.

gierens · 2023-09-09T11:24:47Z

It feels like it would simplify a lot of what's going on. Are there any other thoughts on this? @cafkafk | @gierens ?

I'm not actually sure I fully understand the "strictness", my assessment is solely based on what the man page says:

"EXA_STRICT" tells eza to error when incompatible options are given, right? If so, I'm a little baffled. I mean I would expect a program to always fail when presented with parameters that are mutually exclusive. I think most people would, which is probably also why clap doesn't allow it either.

So, the way I see it the "strict" mode (or its by default absence) is more of a trap or bug than a feature and should be removed in general. If it on top of that makes this PR easier then please go ahead and align this with claps behavior.

PThorpe92 · 2023-09-09T12:13:43Z

yeah u got it from what i understand, If you put it in the context of like my alias in my config.nu

alias ls = eza -hlA --no-user --no-permissions --git

but if I were to execute ls and then pass a conflicting flag, the command would fail instead of just work "the best it could" to come up with a command that it determines I'm most likely asking for.

I cannot see where this isn't the behavior you would want tbh.. but someone may very well have a reason for wanting it to fail, outside of testing?

gierens · 2023-09-09T13:14:16Z

but if I were to execute ls and then pass a conflicting flag, the command would fail instead of just work "the best it could" to come up with a command that it determines I'm most likely asking for.

I cannot see where this isn't the behavior you would want tbh.. but someone may very well have a reason for wanting it to fail, outside of testing?

I actually meant that the normal "non-strict" behavior is what should be removed, because imho a CLI program should fail immediately when flags are incompatible and not start guessing around.

PThorpe92 · 2023-09-09T14:12:36Z

I understand what you meant, I just think it might be problematic...

In that case you couldn't really have an alias for your default behavior and comfortably pass additional flags on the command line, because if any of them conflict or duplicate or just don't go together (just because of how many options there are), you would get an error instead of the default behavior. Which I think would happen quite frequently, they may often pass a Long option flag to a -1 view, and currently it will just display the -1 view instead of throwing an error.

If it wasn't used in alias's so extensively I dont think this would be a problem, but I imagine its a big reason why Ogham wrote it the way he did. I could definitely be wrong, this is just my impression of it.

gierens · 2023-09-09T14:21:13Z

Yeah sure, I agree that this is probably used quite often in aliases.

But then I kinda have to argue for the strict mode now :D

PThorpe92 · 2023-09-09T14:28:51Z

So strict mode stays an option 👍

or are you voting do away with normal mode? o_O

gierens · 2023-09-09T14:51:16Z

No, I mean that's just my opinion and I wouldn't wanna impose that on everyone, so I would just vote for let's keep strict mode if possible :)

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

Signed-off-by: Sandro-Alessio Gierens <sandro@gierens.de>

Replace "cat + grep + head + awk + tr" by one awk command. That's also avoid the "useless cat" case : https://github.com/koalaman/shellcheck/wiki/SC2002 Co-authored-by: gierens <sandro@gierens.de> Co-authored-by: Gardouille <gardouille@gmail.com>

This also avoid "useless cat" and allow `just` command to build manpages. Resolves eza-community#458 Co-authored-by: gierens <sandro@gierens.de> Co-authored-by: Gardouille <gardouille@gmail.com>

Bumps [libc](https://github.com/rust-lang/libc) from 0.2.148 to 0.2.149. - [Release notes](https://github.com/rust-lang/libc/releases) - [Commits](rust-lang/libc@0.2.148...0.2.149) --- updated-dependencies: - dependency-name: libc dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>

Bumps [DeterminateSystems/nix-installer-action](https://github.com/determinatesystems/nix-installer-action) from 4 to 5. - [Release notes](https://github.com/determinatesystems/nix-installer-action/releases) - [Commits](DeterminateSystems/nix-installer-action@v4...v5) --- updated-dependencies: - dependency-name: DeterminateSystems/nix-installer-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>

This var will override any --git or --git-repos

Updated the man page to include: - --dereference - --almost-all - --help - --version Additionally, added the following flags to the CLI --help information: - --dereference - --almost-all Updated shell completions.

Signed-off-by: Sandro-Alessio Gierens <sandro@gierens.de>

MartinFillon · 2023-10-11T21:15:13Z

Sorry for commit duplication xd

MartinFillon · 2023-10-25T12:38:20Z

poke @cafkafk how are we doing in terms of powertes ?

Hulxv · 2023-11-09T20:15:50Z

I think this PR took a lot of time. Is what you have achieved so far sufficient? When is it expected to end?

MartinFillon · 2023-11-09T23:22:12Z

Well this PR is stuck by powertests, which is another repo of eza, on which @cafkafk is supposed to work and I am awaiting her heads up in order to fully finish and then merge clap-based parser

cafkafk · 2023-11-10T09:44:54Z

I think this PR took a lot of time. Is what you have achieved so far sufficient? When is it expected to end?

Sadly, none of us are paid, and writing an extensive testing framework and integrating it into an open source project isn't easily the kind of feature that gets the most contributors inspired to contribute to, as it isn't as flashy as adding new features. It's a long, hard process, but when this groundwork is laid, it will serve as a very strong foundation for not only this, but many other extensive changes to come. I'm already working many hours just to review and maintain eza, and while a part of me wanna rush to finish this, open source is a marathon, the last thing I would want for eza is maintainership burnout, leaving us right where we started with exa.

Slowly and steadily we'll get there, we are building something that will support eza development for years, it's important to get it right. I've seen the result of other projects rushing for these things, and years later they're still stuck with the tech debt they introduced, and everyone hates it. And rewriting it when it has had some years to really get stuck as a fundamental part of the project is extremely painful.

We already banished vagrant, which wasn't easy either. We've done hard things before, and we'll do it again.

This commits is a copy of my local branch in order to help people contribute to it. This refs #197

MartinFillon · 2023-11-11T10:13:12Z

please now use #638 PR

MartinFillon requested a review from cafkafk as a code owner September 5, 2023 20:48

MartinFillon marked this pull request as draft September 5, 2023 20:48

gierens added the not ready for PRs that aren't finished label Sep 5, 2023

PThorpe92 added dependencies Pull requests that update a dependency file community › discussion labels Sep 6, 2023

MartinFillon force-pushed the Introduce-Clap-POC branch from 4e67b3e to 66da265 Compare September 7, 2023 23:27

MartinFillon marked this pull request as ready for review September 8, 2023 00:44

PThorpe92 self-assigned this Sep 8, 2023

MartinFillon force-pushed the Introduce-Clap-POC branch from 14fa6d1 to 9d88912 Compare September 8, 2023 14:21

ariasuni requested changes Sep 8, 2023

View reviewed changes

src/options/dir_action.rs Outdated Show resolved Hide resolved

src/options/dir_action.rs Outdated Show resolved Hide resolved

src/options/view.rs Outdated Show resolved Hide resolved

src/options/view.rs Outdated Show resolved Hide resolved

MartinFillon requested a review from ariasuni September 8, 2023 16:02

ariasuni reviewed Sep 8, 2023

View reviewed changes

src/options/parser.rs Outdated Show resolved Hide resolved

MartinFillon requested a review from ariasuni September 8, 2023 18:17

MartinFillon force-pushed the Introduce-Clap-POC branch from f5e8984 to 6dc3c87 Compare September 8, 2023 18:19

MartinFillon changed the title ~~WIP -- feat(parser): Introduce clap based parser~~ feat(parser): Introduce clap based parser Sep 8, 2023

MartinFillon force-pushed the Introduce-Clap-POC branch from 6dc3c87 to c0195a7 Compare September 8, 2023 18:33

ariasuni mentioned this pull request Sep 8, 2023

Output exa results differently in scripting environment with grid options ogham/exa#1083

Open

ariasuni requested changes Sep 8, 2023

View reviewed changes

MartinFillon force-pushed the Introduce-Clap-POC branch from 852168f to 6db6637 Compare September 9, 2023 23:30

dundargoc and others added 17 commits October 11, 2023 23:10

ci: treat warnings as errors

2b81a75

build: add codegen-units = 1 and remove opt-level = 3

69c6c09

build: add back opt-level = 3

d49f322

docs(readme): installation on fedora updated

273c8e8

chore: release eza v0.14.1

d7e2e3f

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

refactor(devtools): use musl target for amd64 deb package

4793ba2

Signed-off-by: Sandro-Alessio Gierens <sandro@gierens.de>

fix(justfile): comment out redundant static musl build

5b90f43

Signed-off-by: Sandro-Alessio Gierens <sandro@gierens.de>

style(justfile): remove trailing spaces and trailing line

a29728f

Signed-off-by: Sandro-Alessio Gierens <sandro@gierens.de>

fix: Refactor sed command to build manpages

ae0bc94

This also avoid "useless cat" and allow `just` command to build manpages. Resolves eza-community#458 Co-authored-by: gierens <sandro@gierens.de> Co-authored-by: Gardouille <gardouille@gmail.com>

feat(git): adding the EZA_OVERRIDE_GIT env var

65b522b

This var will override any --git or --git-repos

docs: Add missing options to man page and CLI --help info

a12385a

Updated the man page to include: - --dereference - --almost-all - --help - --version Additionally, added the following flags to the CLI --help information: - --dereference - --almost-all Updated shell completions.

feat(completions): add missing nu shell completions

c426949

Signed-off-by: Sandro-Alessio Gierens <sandro@gierens.de>

fix: broken merge

c7897bb

Merge remote-tracking branch 'upstream/main' into Introduce-Clap-POC

2004c9d

aashirbadb mentioned this pull request Oct 13, 2023

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

Closed

toymil mentioned this pull request Oct 25, 2023

Any interest about migration to clap ogham/exa#1111

Closed

MartinFillon added a commit that referenced this pull request Nov 11, 2023

feat(parser): Introducing-clap-parser

16b67b4

This commits is a copy of my local branch in order to help people contribute to it. This refs #197

MartinFillon added a commit that referenced this pull request Nov 11, 2023

feat(parser): Introducing-clap-parser

1bef756

This commits is a copy of my local branch in order to help people contribute to it. This refs #197

MartinFillon added a commit that referenced this pull request Nov 11, 2023

feat(parser): Introducing-clap-parser

5055eaa

This commits is a copy of my local branch in order to help people contribute to it. This refs #197

MartinFillon mentioned this pull request Nov 11, 2023

feat(parser): Introducing-clap-parser #638

Closed

MartinFillon closed this Nov 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(parser): Introduce clap based parser #197

feat(parser): Introduce clap based parser #197

MartinFillon commented Sep 5, 2023 •

edited

PThorpe92 commented Sep 8, 2023 •

edited

MartinFillon commented Sep 8, 2023 •

edited

ariasuni left a comment

MartinFillon commented Sep 8, 2023

ariasuni left a comment

PThorpe92 commented Sep 8, 2023 •

edited

gierens commented Sep 9, 2023 •

edited

PThorpe92 commented Sep 9, 2023

gierens commented Sep 9, 2023 •

edited

PThorpe92 commented Sep 9, 2023 •

edited

gierens commented Sep 9, 2023

PThorpe92 commented Sep 9, 2023

gierens commented Sep 9, 2023

MartinFillon commented Oct 11, 2023

MartinFillon commented Oct 25, 2023

Hulxv commented Nov 9, 2023

MartinFillon commented Nov 9, 2023

cafkafk commented Nov 10, 2023 •

edited

MartinFillon commented Nov 11, 2023

feat(parser): Introduce clap based parser #197

feat(parser): Introduce clap based parser #197

Conversation

MartinFillon commented Sep 5, 2023 • edited

PThorpe92 commented Sep 8, 2023 • edited

MartinFillon commented Sep 8, 2023 • edited

ariasuni left a comment

Choose a reason for hiding this comment

MartinFillon commented Sep 8, 2023

ariasuni left a comment

Choose a reason for hiding this comment

PThorpe92 commented Sep 8, 2023 • edited

gierens commented Sep 9, 2023 • edited

PThorpe92 commented Sep 9, 2023

gierens commented Sep 9, 2023 • edited

PThorpe92 commented Sep 9, 2023 • edited

gierens commented Sep 9, 2023

PThorpe92 commented Sep 9, 2023

gierens commented Sep 9, 2023

MartinFillon commented Oct 11, 2023

MartinFillon commented Oct 25, 2023

Hulxv commented Nov 9, 2023

MartinFillon commented Nov 9, 2023

cafkafk commented Nov 10, 2023 • edited

MartinFillon commented Nov 11, 2023

MartinFillon commented Sep 5, 2023 •

edited

PThorpe92 commented Sep 8, 2023 •

edited

MartinFillon commented Sep 8, 2023 •

edited

PThorpe92 commented Sep 8, 2023 •

edited

gierens commented Sep 9, 2023 •

edited

gierens commented Sep 9, 2023 •

edited

PThorpe92 commented Sep 9, 2023 •

edited

cafkafk commented Nov 10, 2023 •

edited