File picker config #988

dannasessha · 2021-11-05T09:14:37Z

Fixes #280

Connects settings from user defined config in cargo.toml to file picker by adding a second parameter to file_picker().

This is an extensible pattern for more user defined file picker configuration options, including the option to see or ignore dotfiles, etc.

Currently sets config for file picker to hide or display files listed in .gitignore.

Sets default preference to see files listed in .gitignore.

dannasessha · 2021-11-05T09:16:29Z

May be relevant to #983.

dannasessha · 2021-11-05T09:21:31Z

#648 May also be relevant.

helix-term/src/ui/mod.rs

archseer · 2021-11-10T02:13:10Z

helix-view/src/editor.rs

@@ -61,6 +61,7 @@ pub struct Config {
    pub completion_trigger_len: u8,
    /// Whether to display infoboxes. Defaults to true.
    pub auto_info: bool,
+    pub hide_gitignore: bool,


Let's match the name on walk builder: git_ignore. This also needs to be documented in the book/

I think I have addressed these changes on commit 45c131c.

archseer · 2021-11-10T02:13:35Z

helix-term/src/ui/mod.rs

@@ -93,13 +93,14 @@ pub fn regex_prompt(
    )
 }

-pub fn file_picker(root: PathBuf) -> FilePicker<PathBuf> {
+pub fn file_picker(root: PathBuf, config: &helix_view::editor::Config) -> FilePicker<PathBuf> {
    use ignore::{types::TypesBuilder, WalkBuilder};
    use std::time;

    // We want to exclude files that the editor can't handle yet
    let mut type_builder = TypesBuilder::new();
    let mut walk_builder = WalkBuilder::new(&root);


There's another WalkBuilder in commands.rs used for global search, we should pass this option there too.

Okay, thank you for review, I will look into this!

In commit 339325f I added a variable to allow for passing into .git_ignore() argument without fiddling with explicit lifetimes, and then inserted this call right after WalkBuilder::new(...) is called.

The remaining changes were all due to formatting, using Helix with rust-analyser.

book/src/configuration.md

archseer · 2021-11-11T01:00:17Z

helix-view/src/editor.rs

@@ -92,6 +94,7 @@ impl Default for Config {
            idle_timeout: Duration::from_millis(400),
            completion_trigger_len: 2,
            auto_info: true,
+            git_ignore: false,


I don't know where @pickfire's comment went but this should indeed be true to match the current default.

Okay, thank you for your note.

I am seeing with this, and also the next comment as saying you'd like to define defaults based on the ignore crate, specifically leaving in the default filters.

archseer · 2021-11-12T17:04:57Z

helix-view/src/editor.rs

+        Self {
+            // could simply use .standard_filters if these are uniform.
+            // Enables ignoring hidden files.
+            hidden: false,


The defaults should match the WalkBuilder defaults.

hidden: true, ignore: true, git-ignore: true, git-global: true, git-exclude: true, follow-links: false, max-depth: None

I will set defaults to match the ignore crate's in my forthcoming commits.

sudormrfbin · 2021-11-14T04:56:29Z

book/src/configuration.md

@@ -23,6 +23,15 @@ To override global configuration parameters, create a `config.toml` file located
 | `idle-timeout` | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | `400` |
 | `completion-trigger-len` | The min-length of word under cursor to trigger autocompletion | `2` |
 | `auto-info` | Whether to display infoboxes | `true` |
+| `file-picker` | Sets options for file picker and global search. Multiple pairs in an inline table. Details below.  | `{hidden = true, parents = true, ignore = false, git-ignore = true, git-global = true, git-exclude = true } |


I think it would be better to move this to an "[editor.file-picker] section" like the "[editor] section" above and have the same key, description, default table.

Okay, I will make a commit for this today. Thank you!

I think that the commit 80ba0e0 has the changes you were looking for!

archseer · 2021-11-15T15:35:18Z

helix-view/src/editor.rs

+            // IgnoreOptions
+            // Enables ignoring hidden files.
+            hidden: true,
+            // Enables reading ignore files from parent directories.
+            parents: true,
+            // Enables reading `.ignore` files.
+            ignore: true,
+            // Enables reading `.gitignore` files.
+            /// Whether to hide files in .gitignore from displaying in file picker. Defaults to false.
+            git_ignore: true,
+            // Enables reading global .gitignore, whose path is specified in git's config: `core.excludefile` option.
+            git_global: true,
+            // Enables reading `.git/info/exclude` files.
+            git_exclude: true,
+            // WalkBuilder options
+            // Maximum Depth to recurse.
+            max_depth: None,


These comments should really be doc comments (///) on the FilePickerConfig struct, that way they show in crate docs.

OK, I saw that was the way with previous config, now that makes sense. I'll make an adjustment.

archseer · 2021-11-15T15:35:33Z

helix-view/src/editor.rs

+    /// Whether to hide files in .gitignore from displaying in file picker. Defaults to false.
+    //pub git_ignore: bool,


This should be removed

pickfire · 2021-11-16T14:09:16Z

helix-term/src/commands.rs

+                                match all_matches_sx_cl
+                                    .send((line_num as usize - 1, dent.path().to_path_buf()))
+                                {
+                                    Ok(_) => Ok(true),
+                                    Err(_) => Ok(false),
+                                }


Suggested change

match all_matches_sx_cl

.send((line_num as usize - 1, dent.path().to_path_buf()))

{

Ok(_) => Ok(true),

Err(_) => Ok(false),

}

Ok(all_matches_sx_cl

.send((line_num as usize - 1, dent.path().to_path_buf()))

.is_ok())

This can probably be simplified, but probably needs reformatting.

I do not believe I changed this logic in the course of this PR--the formatting changed due to the addition of the fluent-style calls above (lines 1392-1398).

Here are the same lines in master.

pickfire · 2021-11-16T14:12:33Z

helix-view/src/editor.rs

+pub struct FilePickerConfig {
+    /// IgnoreOptions
+    /// Enables ignoring hidden files.
+    /// Whether to hide, that is, to stop hidden files from displaying in file picker. Defaults to false.
+    pub hidden: bool,
+    /// Enables reading ignore files from parent directories.
+    pub parents: bool,
+    /// Enables reading `.ignore` files.
+    /// Whether to hide files listed in .ignore from displaying in file picker. Defaults to false.
+    pub ignore: bool,
+    /// Enables reading `.gitignore` files.
+    /// Whether to hide files in .gitignore from displaying in file picker. Defaults to false.
+    pub git_ignore: bool,
+    /// Enables reading global .gitignore, whose path is specified in git's config: `core.excludefile` option.
+    /// Whether to hide files in global .gitignore from displaying in file picker. Defaults to false.
+    pub git_global: bool,
+    /// Enables reading `.git/info/exclude` files.
+    /// Whether to hide files in .git/info/exclude from displaying in file picker. Defaults to false.
+    pub git_exclude: bool,
+    /// WalkBuilder options
+    /// Maximum Depth to recurse.
+    pub max_depth: Option<usize>,
+}
+
+impl Default for FilePickerConfig {
+    fn default() -> Self {
+        Self {
+            hidden: true,
+            parents: true,
+            ignore: true,
+            git_ignore: true,
+            git_global: true,
+            git_exclude: true,
+            max_depth: None,
+        }
+    }
+}


The comments seemed confusing to me. It's good to put the defaults in comments, but it doesn't seemed to match the defaults it code.

I made some updates to these comments and to the book, hope they are more clear and accurate!

I think we should get rid of mentioning defaults in comments altogether since it could get outdated, and for the book we could do something like #1119.

fraunos · 2021-11-20T15:31:55Z

Does this change allow to set gitignore file picker behaviour in config.toml only? Is there some flag/option in file picker during file picking itself?

dannasessha · 2021-11-21T23:37:36Z

Does this change allow to set gitignore file picker behaviour in config.toml only? Is there some flag/option in file picker during file picking itself?

I am personally very interested in the potential direction of making the file picker more interactive (change views/config, sort, move through directories or even tree-type views) as well as more informative (metadata). I would love to have a robust discussion of this, here or elsewhere, see what community interest is as well as compatibility with the vision for helix.

sudormrfbin · 2021-11-22T02:17:00Z

@dannasessha I also had some thoughts about formatting in the picker, it's best to open an issue or discussion to discuss properly.

dannasessha · 2021-11-29T17:50:52Z

Does this change allow to set gitignore file picker behaviour in config.toml only? Is there some flag/option in file picker during file picking itself?

@dannasessha I also had some thoughts about formatting in the picker, it's best to open an issue or discussion to discuss properly.

I think #1163 is the main spot right for talk about the file picker now!

AjBreidenbach · 2024-06-18T12:54:25Z

see #10221 for current discussion

kirawi reviewed Nov 5, 2021

View reviewed changes

helix-term/src/ui/mod.rs Outdated Show resolved Hide resolved

dannasessha force-pushed the file_picker_config branch from 5d6d5ce to 57a19b2 Compare November 7, 2021 06:27

dannasessha changed the title ~~DRAFT: File picker config~~ File picker config Nov 9, 2021

dannasessha added 3 commits November 10, 2021 01:56

squashed WIP commits

d686c8e

hide_gitignore working with config

1f69124

pass reference to new config parameter of file_picker()

e049182

dannasessha force-pushed the file_picker_config branch from 8f8e9de to e049182 Compare November 10, 2021 02:02

archseer requested changes Nov 10, 2021

View reviewed changes

dannasessha added 3 commits November 10, 2021 02:28

update config option name to match name on walk builder

07955f9

add comments to config and documentation of option to book

45c131c

add git_ignore option to WalkBuilder within prompt in commands.rs

339325f

pickfire reviewed Nov 11, 2021

View reviewed changes

book/src/configuration.md Outdated Show resolved Hide resolved

archseer reviewed Nov 11, 2021

View reviewed changes

WIP: add FilePickerConfig struct

69e9bc8

dannasessha changed the title ~~File picker config~~ WIP: File picker config Nov 12, 2021

dannasessha added 2 commits November 12, 2021 12:21

WIP: cleanup

0740957

WIP: add more options including max_depth

5fd9dca

archseer reviewed Nov 12, 2021

View reviewed changes

dannasessha added 4 commits November 13, 2021 08:12

WIP: changed defaults to match ignore crate defaults

4d1f0fa

WIP: change WalkBuilder in global_search() to use config options

8d8aa14

WIP: removed follow_links, changed max_depth to follow config setting

770e31e

WIP: update book with file-picker inline table notation

c706744

sudormrfbin reviewed Nov 14, 2021

View reviewed changes

sudormrfbin mentioned this pull request Nov 14, 2021

Custom file picker width max min and factor #1089

Closed

update documentation for file-picker config in book

5cfb86f

dannasessha changed the title ~~WIP: File picker config~~ File picker config Nov 14, 2021

adjusted to [editor.file-picker] in book configuration.md

80ba0e0

archseer reviewed Nov 15, 2021

View reviewed changes

adjust comments in editor.rs to be doc comments, cleanup

5e07a6b

pickfire reviewed Nov 16, 2021

View reviewed changes

dannasessha added 2 commits November 16, 2021 16:25

adjust comments

3b381df

adjust book

92664a0

archseer merged commit 6a4d969 into helix-editor:master Nov 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

File picker config #988

File picker config #988

dannasessha commented Nov 5, 2021

dannasessha commented Nov 5, 2021

dannasessha commented Nov 5, 2021

archseer Nov 10, 2021

dannasessha Nov 10, 2021

archseer Nov 10, 2021

dannasessha Nov 10, 2021

dannasessha Nov 10, 2021

archseer Nov 11, 2021

dannasessha Nov 13, 2021

archseer Nov 12, 2021

dannasessha Nov 13, 2021

sudormrfbin Nov 14, 2021

dannasessha Nov 15, 2021

dannasessha Nov 15, 2021

archseer Nov 15, 2021

dannasessha Nov 16, 2021

archseer Nov 15, 2021

dannasessha Nov 16, 2021

pickfire Nov 16, 2021

dannasessha Nov 16, 2021

pickfire Nov 16, 2021

dannasessha Nov 16, 2021

sudormrfbin Nov 19, 2021

fraunos commented Nov 20, 2021

dannasessha commented Nov 21, 2021

sudormrfbin commented Nov 22, 2021

dannasessha commented Nov 29, 2021

AjBreidenbach commented Jun 18, 2024 •

edited

Loading

		/// Whether to hide files in .gitignore from displaying in file picker. Defaults to false.
		//pub git_ignore: bool,

File picker config #988

File picker config #988

Conversation

dannasessha commented Nov 5, 2021

dannasessha commented Nov 5, 2021

dannasessha commented Nov 5, 2021

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

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

fraunos commented Nov 20, 2021

dannasessha commented Nov 21, 2021

sudormrfbin commented Nov 22, 2021

dannasessha commented Nov 29, 2021

AjBreidenbach commented Jun 18, 2024 • edited Loading

AjBreidenbach commented Jun 18, 2024 •

edited

Loading