Filepath select #138

anwarhahjjeffersongeorge · 2023-05-09T06:01:21Z

Hi. I tried to make a file path selector that:

Is its own prompt (PathSelect) with optional configuration (PathSelectPrompt) gated behind the path feature
Is OS-agnostic,
Uses the fs_err crate where possible for more detailed diagnostics,
Allows starting from a custom file path start_path_opt (defaulting to current process directory or root path if current process directory is unavailable)
Allows selection of one or multiple files with configuration option select_multiple,
Allows selecting (with select_multiple enabled) files from more than one directory,
Allows filtering of selectable file types by directory, extension, or a combination of multiple filters selection_mode,
Allows following/showing symbolic links with configuration option show_symlinks.
Allows showing hidden files with configuration option show_hidden,
Uses Rust's std::path and std::ffi::OsStr for portability instead of trying to figure out whether to convert paths to strings, and
Includes an example (path_select.rs).

Deficiencies

It does not:

Deal with permissions (it's possible, but I didn't know if it was a good idea),
Use existing prompts, although it is based heavily on the MultiSelect prompt code,
Handle formatting very aesthetically,
Support certain types of hidden files as I neither have a windows machine for testing nor understand how it works :(,
Support user-provided custom option filtering beyond selecting acceptable file types using the PathSelectionMode type ,
Support user-provided validation functions,
Show relative paths (there are crates to do this, but they seem to have some open issues), or
Have very many tests. I didn't know how you wanted tests written. For what it's worth, everything passes when I run cargo test --all-features-. It seems to work when I tried it on Ubuntu 23.04 and Mac OS 10.15.7.

I am opening this PR mainly for feedback. I know the contributor's guide said to do the discussion stage first, but I needed this feature for a project and did not see that detail until after I made it. I saw some existing issues (#124, #63), and tried to go from there, favoring the strategy of 63 ( a new prompt type) with the features of 124 (as detailed above).

With all that in mind, I understand if this needs more work.

mikaelmello · 2023-05-09T06:48:28Z

I really like this. And thank you for the attention to detail on the PR description lol.

Hopefully I'll find some time tomorrow for a full review.

One important point that I'd bring up is that recently (like yesterday maybe) I've refactored prompts. Far from a revamp but significant enough that you might want to get ahead in porting this PR already. Honestly, I can also do that myself if you'd prefer, whatever works.

anwarhahjjeffersongeorge · 2023-05-09T08:58:37Z

I gave refactoring the prompts a shot. For now, I'll chill out on this until whenever you get a chance to look and let me know what needs improvement.

mikaelmello

I took the first half hour I had to not keep you waiting too much!

I still haven't reviewed much of the prompt implementation itself, nor could tinker with PathSelect as an user, but so far it looks pretty solid!!! Thanks for your fantastic work

inquire/src/prompts/path_select/action.rs

inquire/src/prompts/path_select/mod.rs

mikaelmello · 2023-05-13T19:30:57Z

inquire/src/prompts/path_select/mod.rs

+#[derive(Clone, Eq, PartialEq)]
+pub enum PathSelectionMode<'a> {
+    /// The user may pick a file with the given (optional) extension
+    File(Option<&'a str>),


@LeoRiether, is using Cow<'a, str> here a good idea? From your comments on that another issue

There are pros and cons. Cow in some cases does provide easier lifetime handling, but it also adds some complexity to the API, like the need to write File(Some("jpg".into())) instead of File(Some("jpg")) and some users saying "what the hell is a Cow?"

Maybe it's worth it? I didn't find clear guidelines about this online, but I'll look into it again later to try and come up with a more definitive answer :)

Also, I feel like it would be nice to have a more flexible PathSelectionMode. I don't see an easy way, for example, to integrate the ignore crate to list files respecting .gitignore. If I have any ideas of how to actually implement this more flexible API, I'll make sure to post them.

. I don't see an easy way, for example, to integrate the ignore crate to list files respecting .gitignore.

Hiya. I'm not sure what you're asking for here. Would it help if I tried to add globs or some kind of name-matching/name-excluding patterns? I looked at the ignore crate, but I don't know if adding that dependency would be better than just using the regex crate. Are you wanting to respect .gitignore files in the ancestry of paths too?

inquire/src/prompts/path_select/mod.rs

inquire/src/prompts/path_select/prompt.rs

More explicit documentation for navigation behavior Co-authored-by: Mikael Mello <git@mikaelmello.com>

Fix my doc typo Co-authored-by: Mikael Mello <git@mikaelmello.com>

Fix doc string typo Co-authored-by: Mikael Mello <git@mikaelmello.com>

…e/pull/138/files/941036937254e45fccd1f813b74660d99b7be279#r1193028654

- Support user-selectable item sorting modes - Add a test for filtering files by extension

inquire/src/prompts/path_select/mod.rs

mikaelmello · 2023-06-11T01:57:53Z

inquire/src/prompts/path_select/mod.rs

+/// Prompt for choosing one or multiple files.  
+///
+/// The user can


We need to finish writing the docs

Let me know what you think. One thing I did not document was the divider. It is currently unused because I couldn't figure out how to make it work with the prompt — basically, I thought it would be less confusing with a visual divider between the current directory's entries and items selected from previous directories if any. Only I don't know how to insert a divider into the list or if that's possible, so maybe you can suggest something?

inquire/src/prompts/path_select/mod.rs

mikaelmello · 2023-06-11T02:24:01Z

inquire/src/prompts/path_select/modes.rs

+/// Different path selection modes specify what the user can choose
+#[derive(Clone, Eq, PartialEq)]
+pub enum PathSelectionMode<'a> {
+    /// The user may pick a directory.
+    Directory,
+    /// The user may pick a file with the given (optional) extension.
+    File(Option<&'a str>),
+    /// The user can set gitignore rules from a file 
+    /// The user may pick multiple paths
+    Multiple(Vec<PathSelectionMode<'a>>),
+}


I feel like this can be made simpler for end-users. On a first glance, it's not quite intuitive how this selection mode behaves, with the recursive Multiple warranting more attention.

wdyt of:

accept enum, like JS's accept attribute: All, Only(String), Any(Vec)

Then PathSelectionMode

Directory

File(Accept)

FileOrDirectory(Accept)

I still don't fee this is the best solution, but it feels more intuitive

Sure, I suppose it was redundant the way it was. I tried implementing an inner enum (PathFilter) that can accept or deny based on file extensions, stems, and matching functions. I also added some documentation tests for the different modes and tried to tighten up the documentation.

inquire/src/prompts/path_select/modes.rs

inquire/src/prompts/path_select/prompt.rs

mikaelmello · 2023-06-11T02:37:55Z

inquire/src/prompts/path_select/prompt.rs

+                if let Some(parent) = current_path.parent() {
+                    *current_path = parent.to_path_buf();
+                    *data_needs_refresh = true;
+                    *cursor_index = 0;
+                }


I got this error when going up and up, not sure why as it seems you put the handling into place, but worth checking out

IO( Os { code: 2, kind: NotFound, message: "No such file or directory", }, )

I am not able to replicate this on Ubuntu Linux, but it was indeed a persistent problem before. Can you please let me know what OS you were on so I can try to write a test or something and figure it out?

mikaelmello · 2023-06-11T02:44:12Z

I do feel bad about dumbing a lot of comments, but it is a very large feature :). I want it to be as good as possible before releasing, which today is basically the same as merging.

I was thinking, we should break this down in smaller chunks and get the thing going more gradually, we can merge but not expose this on the published crate until we gradually get this to the end state.

I think this would also allow us to work in parallel.

Also, obligatory sorry for taking too long on this round of reviews

Barre · 2023-08-01T10:43:56Z

Hi,

I am also interested in this.

Did this go anywhere? Any way I can help?

anwarhahjjeffersongeorge · 2023-08-02T12:06:42Z

@mikaelmello @Barre Hey there, I missed this before, but I'll take a look at these next weekend.

Remove vim mode support Co-authored-by: Mikael Mello <git@mikaelmello.com>

Formatting Co-authored-by: Mikael Mello <git@mikaelmello.com>

Prompt formatting Co-authored-by: Mikael Mello <git@mikaelmello.com>

Remove optional starting path from instantiator Co-authored-by: Mikael Mello <git@mikaelmello.com>

Remove raw prompt methods Co-authored-by: Mikael Mello <git@mikaelmello.com>

- Eliminate vim_mode - Add documentation

Clarify PathSelectionMode, Eliminate strum dependency from PathSortingMode,

anwarhahjjeffersongeorge · 2023-08-14T08:39:48Z

I was thinking, we should break this down in smaller chunks and get the thing going more gradually, we can merge but not expose this on the published crate until we gradually get this to the end state.

I think this would also allow us to work in parallel.

Just let me know how you'd like me to reorganize it that would work for you.

Also, obligatory sorry for taking too long on this round of reviews

No problem. It's been like 110+ degrees where I live, so haven't exactly been rushing to turn the computer on and heat up the house.

DaRacci · 2024-02-08T05:38:32Z

any progress with this?

anwarhahjjeffersongeorge · 2024-02-08T07:11:42Z

any progress with this?
@DaRacci
@mikaelmello Said above they wanted me to reorganize or break this down but I'm not sure what that meant, so I'm waiting on that before doing more with this.

mikaelmello · 2024-03-13T05:33:06Z

hey, I know I've been really dropping the ball on being responsive throughout inquire, life getting in the way as usual

I really really want to see this merged, the main point holding it back is that this is a very significant prompt to offer, counter-intuitively.

it's one of those things I'd like to polish and re-polish it before releasing, making sure the API is very intuitive and everything

anwarhahjjeffersongeorge added 11 commits May 7, 2023 22:42

Cargo feature for path select

ba1b47f

Support path feature in vscode

b6b7501

Basic path select prompt and builder

2082f9d

Path select prompt examples

f5e3af4

show hidden files option

652d1d4

bugfix respect multi-selection mode, refactor pathentry

7acd6f0

support optionally showing/browsing symlinks

07c509b

multiselection mode fix

2757f97

rustfmt

5c4b526

warnings

5142567

Merge branch 'main' into filepath-select

32006bb

anwarhahjjeffersongeorge added 4 commits May 9, 2023 01:20

Update path select to new architecture

be8141c

rustfmt

5c91a31

do not use nightly features, cleanup unused imports

52792a2

don't derive default on enum to suport msrv

9410369

mikaelmello reviewed May 13, 2023

View reviewed changes

anwarhahjjeffersongeorge and others added 12 commits May 17, 2023 00:51

Update inquire/src/prompts/path_select/action.rs

d382d0c

More explicit documentation for navigation behavior Co-authored-by: Mikael Mello <git@mikaelmello.com>

Update inquire/src/prompts/path_select/action.rs

f4f31e5

Fix my doc typo Co-authored-by: Mikael Mello <git@mikaelmello.com>

Update inquire/src/prompts/path_select/mod.rs

c2458e3

Fix doc string typo Co-authored-by: Mikael Mello <git@mikaelmello.com>

Remove vim mode as suggested at https://github.com/mikaelmello/inquir…

923d2a7

…e/pull/138/files/941036937254e45fccd1f813b74660d99b7be279#r1193028654

Add note about vim mode support.

4a01e87

Bust out PathEntry into its own module

83e31af

spacing

87e31aa

file size information and sorting modes

8f58450

- Move PathEntry to own module

e67a0e5

- Support user-selectable item sorting modes - Add a test for filtering files by extension

remove vim mode option

ec22cab

Improve display by selectively stripping prefixes

7b6d157

Relocate is_path_hidden_file method to PathSelectPrompt

94c01f8

remove example

3b2df27

mikaelmello reviewed Jun 11, 2023

View reviewed changes

anwarhahjjeffersongeorge and others added 9 commits August 12, 2023 18:41

Update inquire/src/prompts/path_select/mod.rs

4b6d119

Remove vim mode support Co-authored-by: Mikael Mello <git@mikaelmello.com>

Update inquire/src/prompts/path_select/mod.rs

1099e74

Formatting Co-authored-by: Mikael Mello <git@mikaelmello.com>

Update inquire/src/prompts/path_select/mod.rs

3b80840

Formatting Co-authored-by: Mikael Mello <git@mikaelmello.com>

Update inquire/src/prompts/path_select/prompt.rs

c29a281

Prompt formatting Co-authored-by: Mikael Mello <git@mikaelmello.com>

Update inquire/src/prompts/path_select/mod.rs

b87ca59

Remove optional starting path from instantiator Co-authored-by: Mikael Mello <git@mikaelmello.com>

Update inquire/src/prompts/path_select/mod.rs

58d0586

Remove raw prompt methods Co-authored-by: Mikael Mello <git@mikaelmello.com>

unneccessary brace

ec8a71b

- Eliminate raw_prompt,

db958ad

- Eliminate vim_mode - Add documentation

Support PathFilter,

a5f53ec

Clarify PathSelectionMode, Eliminate strum dependency from PathSortingMode,

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Filepath select #138

Filepath select #138

anwarhahjjeffersongeorge commented May 9, 2023

mikaelmello commented May 9, 2023

anwarhahjjeffersongeorge commented May 9, 2023

mikaelmello left a comment

mikaelmello May 13, 2023

LeoRiether May 14, 2023

LeoRiether May 14, 2023

anwarhahjjeffersongeorge May 18, 2023

mikaelmello Jun 11, 2023

anwarhahjjeffersongeorge Aug 14, 2023

mikaelmello Jun 11, 2023

anwarhahjjeffersongeorge Aug 14, 2023

mikaelmello Jun 11, 2023

anwarhahjjeffersongeorge Aug 14, 2023

mikaelmello commented Jun 11, 2023

Barre commented Aug 1, 2023

anwarhahjjeffersongeorge commented Aug 2, 2023

anwarhahjjeffersongeorge commented Aug 14, 2023

DaRacci commented Feb 8, 2024

anwarhahjjeffersongeorge commented Feb 8, 2024 •

edited

Loading

mikaelmello commented Mar 13, 2024

Filepath select #138

Are you sure you want to change the base?

Filepath select #138

Conversation

anwarhahjjeffersongeorge commented May 9, 2023

Deficiencies

mikaelmello commented May 9, 2023

anwarhahjjeffersongeorge commented May 9, 2023

mikaelmello left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikaelmello commented Jun 11, 2023

Barre commented Aug 1, 2023

anwarhahjjeffersongeorge commented Aug 2, 2023

anwarhahjjeffersongeorge commented Aug 14, 2023

DaRacci commented Feb 8, 2024

anwarhahjjeffersongeorge commented Feb 8, 2024 • edited Loading

mikaelmello commented Mar 13, 2024

anwarhahjjeffersongeorge commented Feb 8, 2024 •

edited

Loading