Adds option to reverse path display with highlighting #3010

alycklama · 2024-03-24T15:39:35Z

Description

Long paths make it sometimes difficult to see the file name. You can create a custom formatter, but I thought it would be great if we can all have a format similar to Intelij, where the file name is in front.

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

I've tested my code with the following configurations:

Simple config:

path_display = {
  filename_first = {
    reverse_directories = false
  }
},

Screenshots

Find Files

Live Grep

Quickfix

Find Word

Configuration:

Neovim version (nvim --version): NVIM v0.9.5 | Build type: Release | LuaJIT 2.1.1710088188
Operating system and version: MacOs 13.6.4 (22G513)

Checklist:

[ x ] My code follows the style guidelines of this project (stylua)
[ x ] I have performed a self-review of my own code
[ x ] I have commented my code, particularly in hard-to-understand areas
[ x ] I have made corresponding changes to the documentation (lua annotations)

lua/telescope/utils.lua

alycklama · 2024-03-24T16:53:58Z

I've added the highlighting code of @chrisgrieser, as it was the most simple and straightforward solution for highlighting:
#2014 (comment)

I tried the code posted here, put I guess it has not yet been implemented:
#2014 (comment)

alycklama · 2024-03-25T20:39:06Z

I think I found a nice way to do highlighting in a flexible way. I'm lacking a bit of time right now, so I made a very simple proof-of-concept:

make_entry.lua

    mt_file_entry.display = function(entry)
      local hl_group, icon
      local display = utils.transform_path(opts, entry.value)
     -- local display, path_style = utils.transform_path(opts, entry.value)

      display, hl_group, icon = utils.transform_devicons(entry.value, display, disable_devicons)
       
     -- path_style would be returned from utils.transform_path (see commented code above)
      local path_style = { { 10, 20, }, hl_group }
      local style = { { { 0, #icon, }, hl_group }, path_style }

      if hl_group then
        return display, style
      else
        return display
      end
    end

When utils.transform_path returns both the transformed_path, as well as the path_style, you can easily merge the styles, resulting in the image below. The 10th up until the 20th character take the color of the icon. This is now statically done in the example above, but imagine every transform_path to decide for itself what styling to return. It would make it quite powerful and flexible.

What do you think? I'll work on a real example this week so you can see how it would look like.

alycklama · 2024-03-26T17:40:23Z

I've pushed a new commit as a proof-of-concept:
106ac89

I've a hardcoded value (4) in there that I want to get rid of, but I need to learn more about unpacking tables dynamically in Lua. That way I could return a relative style position in the functions and shift it to the right absolute position where I need it.

alycklama · 2024-03-26T19:20:01Z

I've removed the hardcoded value (4) with a function to shift the offset dynamically:
ac33dd0

alycklama · 2024-03-26T22:16:33Z

Hereby an example how this could work for other places where the transform_path function is called:

alycklama · 2024-03-27T20:12:48Z

So far, it seems to be working quite well. Does this align with what you envision? @jamestrew

Find Files

LSP definitions

Live Grep

Quickfix

jamestrew · 2024-03-28T03:03:22Z

Thanks @alycklama
At first glance, this all looks pretty good. Give me a few days to give it a proper look through.

alycklama · 2024-03-28T21:34:05Z

Thanks @alycklama At first glance, this all looks pretty good. Give me a few days to give it a proper look through.

Take all the time you need!

In the meantime I'm trying to fix the tests, but I'm having some issues running them. Any idea what the easiest way would be? I've created a local Docker container to install Ubuntu 22.04. However, I'm not able to run make test:

nvim --headless --noplugin -u scripts/minimal_init.vim -c "PlenaryBustedDirectory lua/tests/automated/ { minimal_init = './scripts/minimal_init.vim' }"
Error detected while processing command line:
E492: Not an editor command: PlenaryBustedDirectory lua/tests/automated/ { minimal_init = './scripts/minimal_init.vim' }

To workaround this, I've manually created a ~/.config/nvim/init.lua file with Lazy to install plenary. This works, because I can now use the PlenaryBustedDirectory Ex Command from the command line. However, it still looks like plenary.path is missing.

Any tips regarding testing?

jamestrew · 2024-03-28T23:56:19Z

Yeah I have another PR to improve the CI and local testing workflow better.
In the meantime, probably easiest thing is to temporarily edit the minimal_init.vim file like this

set rtp+=.
set rtp+=../plenary.nvim/ " changed this to your plenary installation path
" set rtp+=../tree-sitter-lua/ not needed for testing

runtime! plugin/plenary.vim
runtime! plugin/telescope.lua

" I think you can comment this out as well
" outputs unnecessary warnings
" runtime! plugin/ts_lua.vim

let g:telescope_test_delay = 100

alycklama · 2024-03-30T19:30:14Z

@jamestrew I've updated the initial post, fixed the tests. However, the nightly OSX build seems to fail in the preparation phase. Any idea what could be wrong? If that's fixed then this PR is ready for review.

jamestrew · 2024-03-30T19:32:23Z

lua/telescope/make_entry.lua

+ local function get_offset()
+ local offset = 0
+
+ if hl_group then
+ offset = #icon + 1
+ end
+
+ return offset
+ end
+
 if hl_group then
- return display, { { { 0, #icon }, hl_group } }
+ local style = { { { 0, get_offset() }, hl_group } }
+ style = utils.merge_styles(style, path_style, get_offset())


Is this get_offset function necessary? Seems redundant to me. Something similar to what been done to gen_from_vimgrep should work no?

You are correct. I cleaned it up and pushed my changes.

jamestrew · 2024-03-30T19:57:33Z

@jamestrew I've updated the initial post, fixed the tests. However, the nightly OSX build seems to fail in the preparation phase. Any idea what could be wrong? If that's fixed then this PR is ready for review.

Yeah don't worry about that. I think I'm pretty good with these changes. It's slightly unfortunate that entry makers using entry_display.create won't be able to utilize the highlighting but I think there's plans to rework the whole entry_display stuff so I think we'll handle the remaining entry makers in a follow up.

alycklama · 2024-03-30T20:34:44Z

@jamestrew I've updated the initial post, fixed the tests. However, the nightly OSX build seems to fail in the preparation phase. Any idea what could be wrong? If that's fixed then this PR is ready for review.

Yeah don't worry about that. I think I'm pretty good with these changes. It's slightly unfortunate that entry makers using entry_display.create won't be able to utilize the highlighting but I think there's plans to rework the whole entry_display stuff so I think we'll handle the remaining entry makers in a follow up.

Ok, that's great to hear! If there are discussions going on regarding the plans around entry_display, I'd be more than happy to jump in and read through them.

lkhphuc

Tested on neovim nightly and worked great. Thanks.

alycklama · 2024-04-13T17:13:07Z

Tested on neovim nightly and worked great. Thanks.

Good to hear, thanks!

I've rebased the PR and resolved the conflict.

lkhphuc · 2024-04-18T09:35:09Z

I found a case where the path is not properly highlight (applied the Comment hlgroup?) when run: Telescope buffers
All other pickers (find files, git files, oldfiles, grep word, etc) are highlighted correctly though.

alycklama · 2024-04-18T19:18:00Z

I found a case where the path is not properly highlight (applied the Comment hlgroup?) when run: Telescope buffers All other pickers (find files, git files, oldfiles, grep word, etc) are highlighted correctly though.

I've pushed a commit fixing this issue. Can you check again?

lkhphuc · 2024-04-19T02:03:34Z

That worked. Thank you.
On that note, do you think this would be nicer / possible to add the cursor position right after the file's name, instead of after the path i.e invariant.md:1 docs/typeclasses in your screenshot above?
I think that would make more sense, and the highlight color would match too.

jamestrew · 2024-04-20T04:19:49Z

I fixed some formatting (and rebased to try something with our docgen CI but didn't work, whatever 🤷).

I'll need to think deeper about some of the loose ends like entry_display.create and line number stuff but I think we have a good starting point, enough to merge this.

Thanks!

…vim#3010 <3 (#79) * Love ya Telescope <3 * Fix inlay_hint old API deprecation

Tronikelis · 2024-04-20T18:10:13Z

Hi, was testing these changes and I saw that with truncate parameter, it truncates the filename and not the filepath, see image below of find files picker

Image

Config:

				path_display = {
					"truncate",
					filename_first = {
						reverse_directories = false,
					},
				},

This is probably not the expected behavior right?

alycklama · 2024-04-20T18:23:15Z

Hi, was testing these changes and I saw that with truncate parameter, it truncates the filename and not the filepath, see image below of find files picker

Config:
				path_display = {
					"truncate",
					filename_first = {
						reverse_directories = false,
					},
				},
This is probably not the expected behavior right?

~~The path_display options are mutually exclusive (as far as I understand). You need to remove "truncate" and only use the "filename_first" option. Does that solve your issue?~~

alycklama · 2024-04-20T18:32:15Z

I didn't realize the options are composable. Straight from the documentation:

        path_display can be set to an array with a combination of:
        - "hidden"          hide file names
        - "tail"            only display the file name, and not the path
        - "absolute"        display absolute paths
        - "smart"           remove as much from the path as possible to only show
                            the difference between the displayed paths.
                            Warning: The nature of the algorithm might have a negative
                            performance impact!
        - "shorten"         only display the first character of each directory in
                            the path
        - "truncate"        truncates the start of the path when the whole path will
                            not fit. To increase the gap between the path and the edge,
                            set truncate to number `truncate = 3`
        - "filename_first"  shows filenames first and then the directories

I don't think filename_first is going to be composable in any way. The reason for that is it's the only option with the filename in front.

What do you guys want to do with this? I can document that this option is not composable with any of the other options for now. If we want it to be make it composable, then the internals need to be refactored. You can't do any logic on a string. So maybe returning a tuple instead (filename, other directories) could be an option.

Tronikelis · 2024-04-20T18:51:58Z

What do you guys want to do with this?

What vscode does and what I expected to happen

image

But it would be awesome if the current truncate behavior was not changed, i.e. the path end is visible, not the start

Basically, I would want it to be truncated like it currently is:

[truncate start] Ideally

[truncate end] how vscode does it, but not my ideal solution

jamestrew · 2024-04-20T19:01:02Z

In terms of general composability, I think moving the filename_first logic to the end of the transform_path function could help in most cases I believe.

For flipping which side of the path (start vs end) is truncated, we would need to tweak the truncate logic to check for whether filename_first exists in path_display. The actual truncate function has a direction param which I'm guessing here controls the start vs end.

edit: nvm I misinterpreted, maybe we just keep truncating at the start.

alycklama · 2024-04-20T19:50:23Z

@jamestrew I created a new PR fixing this issue:
#3065

Thanks for reporting! @Tronikelis

Tronikelis · 2024-04-20T21:11:33Z

@alycklama awesome 🚀

Leiyi548 · 2024-04-21T07:07:51Z

@alycklama Telescope git_files not useful

alycklama · 2024-04-21T10:10:55Z

Telescope git_files not useful

@Leiyi548 Could you be a bit more specific? What is not useful and why is it not useful?

A quick check on my side makes me believe everything works as intended:

Leiyi548 · 2024-04-21T10:19:41Z

Telescope git_files not useful

@Leiyi548 Could you be a bit more specific? What is not useful and why is it not useful?

A quick check on my side makes me believe everything works as intended:

This is my config

alycklama · 2024-04-21T10:22:26Z

@Leiyi548 Would you be able to post a screenshot of what you see as well?

Leiyi548 · 2024-04-21T10:43:46Z

@Leiyi548 Would you be able to post a screenshot of what you see as well?

alycklama · 2024-04-21T11:33:15Z

@Leiyi548 I can't reproduce it. Are you sure you are on the latest commit? Please check and report back.

Leiyi548 · 2024-04-21T13:12:40Z

@Leiyi548 I can't reproduce it. Are you sure you are on the latest commit? Please check and report back.

maybe I use neovim in windows11?

nvim-telescope/telescope.nvim#3010

alycklama · 2024-04-21T13:48:25Z

maybe I use neovim in windows11?

From your screenshot it seems you're not using the latest code, hence it'll never show correctly. I asked you earlier if you could check which commit you are at. If you can't answer this question, then unfortunately, I won't be able to help you further.

Leiyi548 · 2024-04-21T13:51:46Z

maybe I use neovim in windows11?

From your screenshot it seems you're not using the latest code, hence it'll never show correctly. I asked you earlier if you could check which commit you are at. If you can't answer this question, then unfortunately, I won't be able to help you further.

jamestrew · 2024-04-21T14:00:05Z

@Leiyi548 please open a bug report for this and provide info there.

thanks to the merge of nvim-telescope/telescope.nvim#3010 I was able to simplify my telescope config quite a bit without sacrificing on looks :)

thanks to the merge of nvim-telescope/telescope.nvim#3010 I was able to simplify my telescope config quite a bit without sacrificing on looks :) [skip ci] Automated sync from scottmckendry/Windots

alycklama mentioned this pull request Mar 24, 2024

Adds option to reverse the path_display #3005

Closed

alycklama commented Mar 24, 2024

View reviewed changes

lua/telescope/utils.lua Outdated Show resolved Hide resolved

alycklama changed the title ~~Adds option to reverse path display~~ Adds option to reverse path display with highlighting Mar 24, 2024

alycklama requested a review from jamestrew March 27, 2024 17:27

jamestrew linked an issue Mar 28, 2024 that may be closed by this pull request

Ability to make file name more visible in file path #2014

Closed

jamestrew mentioned this pull request Mar 28, 2024

Ability to make file name more visible in file path #2014

Closed

alycklama force-pushed the feature/adds-option-to-reverse-path-display branch from b3167da to f702ad2 Compare March 28, 2024 18:42

alycklama marked this pull request as draft March 29, 2024 09:49

alycklama force-pushed the feature/adds-option-to-reverse-path-display branch from f702ad2 to 883b238 Compare March 29, 2024 10:08

alycklama marked this pull request as ready for review March 29, 2024 20:09

jamestrew reviewed Mar 30, 2024

View reviewed changes

lkhphuc approved these changes Apr 12, 2024

View reviewed changes

alycklama force-pushed the feature/adds-option-to-reverse-path-display branch from 1199f9b to 10ac537 Compare April 13, 2024 17:11

alycklama requested a review from jamestrew April 13, 2024 17:12

alycklama and others added 2 commits April 20, 2024 00:11

Adds highlighting for gen_from_buffer

8ed46a0

fix formatting

3489b5c

jamestrew force-pushed the feature/adds-option-to-reverse-path-display branch from 99cbf40 to 3489b5c Compare April 20, 2024 04:12

jamestrew merged commit a4432df into nvim-telescope:master Apr 20, 2024
8 of 9 checks passed

fusillicode added a commit to fusillicode/dotfiles that referenced this pull request Apr 20, 2024

[78]: Refactor telescope setup thanks to nvim-telescope/telescope.n…

942f75e

…vim#3010 <3 (#79) * Love ya Telescope <3 * Fix inlay_hint old API deprecation

This was referenced Apr 20, 2024

feat:support path style nvim-telescope/telescope-file-browser.nvim#383

Open

feat:support path style nvim-telescope/telescope-frecency.nvim#192

Closed

mikavilpas added a commit to mikavilpas/dotfiles that referenced this pull request Apr 21, 2024

feat(nvim): telescope shows files first, directories second

a40bfdf

nvim-telescope/telescope.nvim#3010

delphinus mentioned this pull request May 1, 2024

Support path_display: filename_first nvim-telescope/telescope-frecency.nvim#195

Merged

scottmckendry added a commit to scottmckendry/Windots that referenced this pull request May 5, 2024

simplify telescope config 🔥

a80bf4a

thanks to the merge of nvim-telescope/telescope.nvim#3010 I was able to simplify my telescope config quite a bit without sacrificing on looks :)

jamestrew mentioned this pull request May 26, 2024

filename_first renders path not correctly for git_status #3106

Closed

Adds option to reverse path display with highlighting #3010

Adds option to reverse path display with highlighting #3010

Conversation

alycklama commented Mar 24, 2024 • edited Loading

Description

Type of change

How Has This Been Tested?

Screenshots

Find Files

Live Grep

Quickfix

Find Word

Checklist:

alycklama commented Mar 24, 2024

alycklama commented Mar 25, 2024 • edited Loading

make_entry.lua

alycklama commented Mar 26, 2024

alycklama commented Mar 26, 2024

alycklama commented Mar 26, 2024

alycklama commented Mar 27, 2024

Find Files

LSP definitions

Live Grep

Quickfix

jamestrew commented Mar 28, 2024

alycklama commented Mar 28, 2024

jamestrew commented Mar 28, 2024

alycklama commented Mar 30, 2024

jamestrew Mar 30, 2024

Choose a reason for hiding this comment

alycklama Mar 30, 2024

Choose a reason for hiding this comment

jamestrew commented Mar 30, 2024

alycklama commented Mar 30, 2024

lkhphuc left a comment

Choose a reason for hiding this comment

alycklama commented Apr 13, 2024

lkhphuc commented Apr 18, 2024 • edited Loading

alycklama commented Apr 18, 2024

lkhphuc commented Apr 19, 2024

jamestrew commented Apr 20, 2024

Tronikelis commented Apr 20, 2024 • edited Loading

alycklama commented Apr 20, 2024 • edited Loading

alycklama commented Apr 20, 2024

Tronikelis commented Apr 20, 2024

jamestrew commented Apr 20, 2024 • edited Loading

alycklama commented Apr 20, 2024 • edited Loading

Tronikelis commented Apr 20, 2024

Leiyi548 commented Apr 21, 2024

alycklama commented Apr 21, 2024 • edited Loading

Leiyi548 commented Apr 21, 2024

alycklama commented Apr 21, 2024

Leiyi548 commented Apr 21, 2024

alycklama commented Apr 21, 2024

Leiyi548 commented Apr 21, 2024

alycklama commented Apr 21, 2024

Leiyi548 commented Apr 21, 2024

jamestrew commented Apr 21, 2024

alycklama commented Mar 24, 2024 •

edited

Loading

alycklama commented Mar 25, 2024 •

edited

Loading

lkhphuc commented Apr 18, 2024 •

edited

Loading

Tronikelis commented Apr 20, 2024 •

edited

Loading

alycklama commented Apr 20, 2024 •

edited

Loading

jamestrew commented Apr 20, 2024 •

edited

Loading

alycklama commented Apr 20, 2024 •

edited

Loading

alycklama commented Apr 21, 2024 •

edited

Loading