action to rename the base name of file without changing directory or extension (#1155) #1791

ianhomer · 2022-11-30T15:12:29Z

Experimental solution for #1155

Not sure whether this should be bound to key by default. Would like to add to documentation somewhere, although other actions such as full_rename are only mentioned in docs via the default key mapping.

The relative_rename action can be bound in custom config with

  view = {
    mappings = {
      list = {
       { key = "r", action = "rename_relative" },
      },
    },
  },

edited : changed action name

alex-courtis

Works beautifully. I will enjoy using this feature.

You will be the owner of this feature, responsible for resolving any immediate issues that arise.

lua/nvim-tree/actions/dispatch.lua

alex-courtis · 2022-12-03T04:46:30Z

@sarmong your testing of this feature would be gratefully appreciated.

Also pickout extension in filename with more one dot

alex-courtis · 2022-12-04T00:59:08Z

Tested OK:

API
mapping

alex-courtis

I'm thinking again about the name relative_rename, which isn't quite a full explanation and base name isn't quite right.

Looking at vimlike naming for inspiration it maps to fnamemodify(bufname, ":t:r"). That's "tail root". We have two changes going on here. The root is arguably the most significant.

If we were building from scratch today I imagine something like this:
r rename ":t" - using tail is different, but arguably better UX
e rename_root ":t:r"
<c-r> rename_full ":p"

Thinking about fnamemodify now makes me realise that we could use that instead of manually calculating the name. Apologies, I should have realised this earlier.

Proposal

change rename_relative to rename_root - Alex
use fnamemodify in rename-file.lua.fn - Ian

Maybe later

Change rename to use the tail; this is a break of existing functionality and needs further thought. Raised #1803

ianhomer · 2022-12-04T12:35:38Z

Thx for the feedback, I'm traveling for the next few days, but will action this when I get back. No urgency to get it in, would prefer to get it right than rush it in.

sarmong · 2022-12-04T15:02:49Z

Hey, thanks for making this feature!

Found a bug - if you have directory with dots in its name then it will trim out part after the last dot.
Imho, rename_root is also a bit confusing, because root oftentimes refers to the root directory of the project. I found that in most programing languages file name without extension is called either stem or basename. I've never heard or used stem in this context, but it is a shorter word, whereas basename is much more common and understandable.

gegoune

Thanks for doing it.

Once again we are adding specialised functions rather than providing building blocks.

Imagine having a function that receives path for buffer under cursor - whatever is returned will be a candidate for renaming.

Input: path as /my/awesome.file.c, returning: path:gsub('awesome', ''), would set. /my/|.file.c as a rename candidate (| is cursor position).

We could then easily provide some builtins built on that, and adding more would be as simple as that:

action = actions.rename(path) return vim.fn.fnamemodify(path, ':t') end,

We could also make it accept fnamemodify's modifier like so:

action = action.rename(':t'),

Function would allow users greater flexibility -like returning precomputed candidates.

full_rename could then be refactored to just return the same path for backwards compatibility.

Are you willing to go this direction, @ianhomer? What do you think @alex-courtis? I think this would go a long way.

gegoune · 2022-12-04T16:55:20Z

doc/nvim-tree-lua.txt

@@ -1328,6 +1328,7 @@ DEFAULT MAPPINGS                                     *nvim-tree-default-mappings
 `D`               trash               trash a file via |trash| option
 `r`               rename              rename a file
 `<C-r>`           full_rename         rename a file and omit the filename on input
+`e`               rename_root         rename a file with filename-modifiers ':t:r' without changing extension


Since we already have full_rename let's follow up with rename_basename.
That is obviously if we don't gp 'function|string' route as described above.

ianhomer · 2022-12-04T20:11:22Z

I've done a minor change to use fnamemodify instead of custom string searching ... however I've not gone as far a few of the other suggestions here.

Regarding the /my/|.file.c suggestion, for me I don't find that behaviour as convenient as just seeing the ~~basename~~ stem, since my primary use case for renaming a file is a slight tweak of the current name, perhaps correcting a spelling mistake. If the original name has gone from the default value in the input box, then my rename is now harder. I also found the full absolute path in the input box a mild annoyance since I had more I could change than I wanted to. Perhaps that's another optional configuration - some people may prefer one vs the other.

I do like the generic function suggestion, and using vim fnamemodify modifiers. Not sure if there is a convenient vim function to rename a part of a filename based on the modifiers provided, but it wouldn't be hard to write that logic if needs be.

I'll be offline for the next few days, but happy to pick up any loose ends towards the end of the week if needs be.

ianhomer · 2022-12-04T20:21:46Z

2. I've never heard or used stem in this context, but it is a shorter word, whereas basename is much more common and understandable.

"stem" is the unambiguous term for this (in C/Python world at least) - agree that it's not commonly known and in that sense perhaps not great semantics, "basename" normally includes the extension. Having read that stackoverflow post I'd personally vote for "stem" since it's short, sweet and well defined in C and Python.

gegoune · 2022-12-04T20:23:32Z

Regarding the /my/|.file.c suggestion, for me I don't find that behaviour as convenient as just seeing the basename, since my primary use case for renaming a file is a slight tweak of the current name, perhaps correcting a spelling mistake. If the original name has gone from the default value in the input box, then my rename is now harder. I also found the full absolute path in the input box a mild annoyance since I had more I could change than I wanted to. Perhaps that's another optional configuration - some people may prefer one vs the other.

That was just an example how new functionality could be used.

Your explanation of intentions and expectations only solidifies my earlier assumptions - there are so many use cases that there is no way nvim-tree can satisfy them all. Therefore providing an easy framework in form of actions.rename() seems like a way to go.

Rename API now supports filename modifiers as arguments, although only with limited support of options. The function signature however will allow improvements going forward. The API signature is backward compatible, although the behviour has changed as per the next comment. This change changes the default behaviour of the renames, rename_full is what rename was, rename now just renames the tail (i.e. the filename)

ianhomer · 2022-12-09T15:15:17Z

I've updated so that we have a rename API that takes arguments. Only argument it currently supports are the filename modifiers ":p", ":t" and ":t:r". Couldn't see a way to generically support all modifiers, however getting the API contract to where we want is key. Now this first argument is the file modifier, not the path to replace. I wonder if it needs to be a table argument so it could support different options.

I couldn't work out how to place the cursor in the vim.ui.input. Perhaps we could just count back the number of characters and programatically move the cursor (although I'm not sure which command I would use to do that in the vim.ui.input window). That feels like another feature, however now we're heading down a generic api for rename, this could be one of the opts.

Is this heading in the right direction?

edit: I've hopefully made this change is a way that is backward compatible from a API invocation point of view, however the behaviour of "full_rename" and "rename" actions have changed to renaming ":p" and ":t" as suggested above. Users will see this difference and for some it might not be desirable. I wonder if we need to support the previous "full_rename" behaviour with another action with users could configure in their mapping if they wished.

alex-courtis · 2022-12-10T00:40:51Z

Hey, thanks for making this feature!

Found a bug - if you have directory with dots in its name then it will trim out part after the last dot.

Imho, rename_root is also a bit confusing, because root oftentimes refers to the root directory of the project. I found that in most programing languages file name without extension is called either stem or basename. I've never heard or used stem in this context, but it is a shorter word, whereas basename is much more common and understandable.

Thank you @sarmong

alex-courtis · 2022-12-10T01:19:45Z

I've updated so that we have a rename API that takes arguments. Only argument it currently supports are the filename modifiers ":p", ":t" and ":t:r". Couldn't see a way to generically support all modifiers, however getting the API contract to where we want is key. Now this first argument is the file modifier, not the path to replace.

This works now and can be customised via action_cb:

          { 
            key = "<C-P>",
            action = "tr",
            action_cb = function()
              require("nvim-tree.actions.fs.rename-file").fn()(":t")
            end
          },

We just need to add API...

Edit: done:

          { 
            key = "<C-P>",
            action = "pr",
            action_cb = function(node)
              require("nvim-tree.api").fs.rename_node(node, ":t")
            end
          },

It will be a lot more usable when we get to on_attach #1579

alex-courtis · 2022-12-10T01:22:41Z

Users will see this difference and for some it might not be desirable. I wonder if we need to support the previous "full_rename" behaviour with another action with users could configure in their mapping if they wished.

I'm happy; I was being to cautious. It's a break, but a reasonable one. #1803

alex-courtis · 2022-12-10T01:49:37Z

Summary (please correct me):

Done:

rename basename
rename full path -> filename
rename modifiers
API

Outstanding:

input dialogue hacking etc.

It seems that we can merge this then deal with outstanding. Continuing discussion in #1803

@gegoune are you happy with the above and the addition of rename_basename as a default action and API?

alex-courtis · 2022-12-10T01:58:04Z

lua/nvim-tree/actions/fs/rename-file.lua

-  return function(node)
+function M.fn(initialisation_arg)
+  local default_modifier = ":t"
+  -- backwards compatibility, support modifier as boolean


This isn't API; we can break it.

Pushed a fix.

alex-courtis · 2022-12-10T03:02:13Z

doc/nvim-tree-lua.txt

@@ -1196,8 +1196,10 @@ exists.
    - create
    - remove
    - trash
+    - rename_node `(node: table, modifier?: string vim.fn.fnamemodify argument)`


I took the liberty of adding this new pattern. Will be improved later: #1753

alex-courtis · 2022-12-10T03:11:45Z

lua/nvim-tree/actions/fs/rename-file.lua

+function M.fn(default_modifier)
+  default_modifier = default_modifier or ":t"
+
+  return function(node, modifier)


I removed capability for the first argument to be a modifier after adding the API, as I couldn't see a use case.

I may be missing something...

alex-courtis · 2022-12-10T03:15:23Z

You work here is greatly appreciated @ianhomer

This raised all sorts of good things well outside of the scope of your change. Thank you for pushing this one all this way.

rename ":t" and ":t:r" was moving file to root of project and not maintaining sub-directory

which was loosing sub-directory on rename

alex-courtis

Tested OK: r, e, <c-r> custom:

file with no dot
file with many dots
rename remove / add trailing dot

e (file.) -> file. fails to rename, however that is quite reasonable as it is not clear what should happen.

Thanks for resolving the bugs I introduced @ianhomer

…rename

relative rename action

34a5b70

ianhomer changed the title ~~relative rename action (#1155)~~ action to rename the base name of file without changing directory or extension (#1155) Nov 30, 2022

🔥 remove debug print statement

2646bfa

alex-courtis requested changes Dec 3, 2022

View reviewed changes

lua/nvim-tree/actions/dispatch.lua Outdated Show resolved Hide resolved

lua/nvim-tree/actions/dispatch.lua Outdated Show resolved Hide resolved

ianhomer added 5 commits December 3, 2022 16:29

🐛 better handling of dot files

9dbef88

Also pickout extension in filename with more one dot

🔧 keymap e for relative-rename action

af57e87

📝 update help with relative-rename mapping

470132e

✨ add API for rename_relative

47312e0

🚨 correct lint warnings

feb22bb

alex-courtis requested changes Dec 4, 2022

View reviewed changes

alex-courtis added 2 commits December 4, 2022 12:35

rename_relative -> rename_root

7c70489

stylua

999f41b

alex-courtis mentioned this pull request Dec 4, 2022

Rename Input Callback #1803

Open

gegoune requested changes Dec 4, 2022

View reviewed changes

♻️ use fnamemodify instead of custom logic

c573ba3

ianhomer added 3 commits December 9, 2022 14:27

🐛 make api rename, without args, functional

8ef88c9

✨ allow modifier argument to be used in API call

9bf034a

📝 update documentation with new command name

5ed4524

alex-courtis added 4 commits December 10, 2022 13:15

rename-file.fn takes only a modifier as argument

c097df2

add Api.fs.rename_basename, specify modifiers for rename, rename_sub

0f05d74

add Api.fs.rename_node

c190007

rename-file tidy allowed modifiers

fa01542

alex-courtis approved these changes Dec 10, 2022

View reviewed changes

alex-courtis requested a review from gegoune December 10, 2022 03:14

ianhomer added 3 commits December 10, 2022 17:06

🐛 fix bugs after last refactoring

ff670c8

rename ":t" and ":t:r" was moving file to root of project and not maintaining sub-directory

🐛 correct absolute rename

98bbb09

which was loosing sub-directory on rename

🔥 remove debug print statements

7dc6eda

alex-courtis approved these changes Dec 11, 2022

View reviewed changes

alex-courtis added 4 commits December 11, 2022 12:10

Merge remote-tracking branch 'upstream/master' into feature/relative-…

3571b01

…rename

Merge remote-tracking branch 'upstream/master' into feature/relative-…

291487d

…rename

stylua

3354ab3

Merge remote-tracking branch 'upstream/master' into feature/relative-…

0a515ba

…rename

alex-courtis merged commit 949913f into nvim-tree:master Dec 16, 2022

This comment was marked as off-topic.

Sign in to view

Uh oh!

action to rename the base name of file without changing directory or extension (#1155) #1791

action to rename the base name of file without changing directory or extension (#1155) #1791

Uh oh!

Conversation

ianhomer commented Nov 30, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alex-courtis commented Dec 3, 2022

Uh oh!

alex-courtis commented Dec 4, 2022

Uh oh!

alex-courtis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ianhomer commented Dec 4, 2022

Uh oh!

sarmong commented Dec 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gegoune left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gegoune Dec 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ianhomer commented Dec 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ianhomer commented Dec 4, 2022

Uh oh!

gegoune commented Dec 4, 2022

Uh oh!

ianhomer commented Dec 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alex-courtis commented Dec 10, 2022

Uh oh!

alex-courtis commented Dec 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alex-courtis commented Dec 10, 2022

Uh oh!

alex-courtis commented Dec 10, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

alex-courtis Dec 10, 2022

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 10, 2022

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 10, 2022

Choose a reason for hiding this comment

Uh oh!

alex-courtis Dec 10, 2022

Choose a reason for hiding this comment

Uh oh!

alex-courtis commented Dec 10, 2022

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as off-topic.

This comment was marked as off-topic.

Uh oh!

ianhomer commented Nov 30, 2022 •

edited

Loading

alex-courtis left a comment •

edited

Loading

sarmong commented Dec 4, 2022 •

edited

Loading

gegoune left a comment •

edited

Loading

gegoune Dec 4, 2022 •

edited

Loading

ianhomer commented Dec 4, 2022 •

edited

Loading

ianhomer commented Dec 9, 2022 •

edited

Loading

alex-courtis commented Dec 10, 2022 •

edited

Loading

alex-courtis commented Dec 10, 2022 •

edited

Loading