refactor(#2988): multi instance change_dir and dir_up #3209

Uanela · 2025-10-30T08:57:23Z

This PR is part of one of the Multi Instance tasks and aims to make a refactor moving the root actions change_dir and dir_up to the Explorer class.

PS: This is my first contribution to some nvim plugin, I've using nvim for almost 4-5 months now and become interested in getting involved into its Open source world.

alex-courtis

This is looking great, really happy with your contributions and it's working as per current behaviour.

Please:

The ones marked with a * will just go away if we move further with this refactor; see incoming comment.

alex-courtis · 2025-11-03T00:04:13Z

lua/nvim-tree/explorer/dir-up.lua

 local M = {}

---@param node Node
 function M.fn(node)


This function has been moved to Explorer:dir_up and it's working beautifully there.
This is great as this function is now unused, therefore we can delete this whole file.

Looks like this file is still present.

You might have to git rm lua/nvim-tree/explorer/dir-up.lua

~~Edit: I am mistaken, I was thinking of the old file location.~~

Edit2: this stands: we really don't need this file and it should be removed.

lua/nvim-tree/explorer/change-dir.lua

lua/nvim-tree/api.lua

lua/nvim-tree/lib.lua

lua/nvim-tree/actions/root/init.lua

lua/nvim-tree/explorer/init.lua

alex-courtis · 2025-11-03T01:17:35Z

lua/nvim-tree/explorer/init.lua

+  end
+end
+
+Explorer.change_dir = change_dir


Explorer.change_dir is assigned to the Explorer class, instead of the instance. This isn't great as all Explorer instances will share the same change_dir.
It should be set to the instance during the constructor e.g. self.change_dir = ...

lua/nvim-tree/explorer/init.lua

alex-courtis · 2025-11-03T01:27:38Z

Testing with lua/nvim-tree/explorer/dir-up.lua deleted.

Success: Base Cases

Open /home/alex/src/keyd

:NvimTreeOpen

<C-]> data
:pwd
/home/alex/src/keyd/data

-
:pwd
/home/alex/src/keyd

-
:pwd
/home/alex/src

Fail: `respect_buf_cwd` = true

Open /home/alex/src/keyd

:NvimTreeOpen

-

q

:NvimTreeOpen

E5108: Error executing lua: ...ack/packer/start/nvim-tree.lua.dev/lua/nvim-tree/lib.lua:30: module 'lua.nvim-tree.explorer.change-dir' not found:
        no field package.preload['lua.nvim-tree.explorer.change-dir']
        no file '/usr/share/lua/5.4/lua/nvim-tree/explorer/change-dir.lua'
        ...
stack traceback:
        [C]: in function 'require'
        ...ack/packer/start/nvim-tree.lua.dev/lua/nvim-tree/lib.lua:30: in function 'handle_buf_cwd'
        ...ack/packer/start/nvim-tree.lua.dev/lua/nvim-tree/lib.lua:38: in function 'open_view_and_draw'
        ...ack/packer/start/nvim-tree.lua.dev/lua/nvim-tree/lib.lua:132: in function 'open'
        ...rt/nvim-tree.lua.dev/lua/nvim-tree/actions/tree/open.lua:32: in function 'open'
        /tmp/nd/config/nvim/nd.lua:52: in function </tmp/nd/config/nvim/nd.lua:52>

alex-courtis · 2025-11-03T01:46:06Z

This is great, I'm happy to merge (following fixes) OR we can go further in this pull request OR go further in the next pull request.

You've refactored the dir_up functionality to be a method of Explorer which is the best case end state.

If you're keen we can do the same for ALL the change-dir.lua functionality: fn(input_cwd, with_open) can be changed to a method Explorer:change_dir. The local functions in change-dir.lua can be changed to ---@private explorer methods.

What's the advantage? The code will simplify greatly when they are part of the explorer class:

core.get_explorer() won't be necessary
config is available so we can remove setup
core.cwd() is unnecessary etc.
other code will just melt away as methods are moved

alex-courtis · 2025-11-03T01:52:10Z

FYI you can execute all the CI checks locally so that you don't have to wait for CI.

Once you've merged this PR I can add you as a repo member so that you can run CI checks yourself.

Uanela · 2025-11-05T07:01:42Z

@alex-courtis hope you doing well, thanks for your time, I will be making this changes by saturday and also following all other instructions and comments you left.

alex-courtis · 2025-11-05T22:33:06Z

@alex-courtis hope you doing well, thanks for your time, I will be making this changes by saturday and also following all other instructions and comments you left.

There's no rush; we can take all the time we want.

Uanela · 2025-11-14T07:48:35Z

@alex-courtis how is it hanging? sorry for disappearing, I just have been through some personal problems that's why I was unable to proceed on the they I mentioned.

On the weekend I will spending some time on it.

Uanela · 2025-11-21T00:08:16Z

This PR was updated to meet the required changes of the last review:

Originally posted by @alex-courtis in #3209 (review)

Uanela · 2025-11-23T20:53:15Z

@alex-courtis are you there?

alex-courtis · 2025-11-26T22:14:46Z

This PR was updated to meet the required changes of the last review:

Fantastic! I've run CI and there are a couple of issues requiring attention: https://github.com/nvim-tree/nvim-tree.lua/actions/runs/19577377412/job/56496916252?pr=3209

@alex-courtis are you there?

I should get to this review on the weekend.
Please note that the nvim-tree.lua project team are volunteers who have limited time available.

- Use wrap_explorer for change_root_to_parent to match other API methods - Fix incorrect require paths in dir-up.lua (remove "lua." prefix) - Remove unused explorer variable in change-dir.lua - Move change_dir assignment in Explorer:new before _load call - Add find_file require to explorer/init.lua for dir_up method

…/nvim-tree.lua into refactor-explorer-actions

Uanela · 2025-11-27T06:52:05Z

This PR was updated to meet the required changes of the last review:

Fantastic! I've run CI and there are a couple of issues requiring attention: https://github.com/nvim-tree/nvim-tree.lua/actions/runs/19577377412/job/56496916252?pr=3209

@alex-courtis are you there?

I should get to this review on the weekend. Please note that the nvim-tree.lua project team are volunteers who have limited time available.

I Just solved this but pre commit checks wouldn't let em commit, and I didn't noticed that I just ended up committing it right now successfully.

I yes I know the nvim-tree contributors a volunteers my bad be a little be annoying for yourselves.

alex-courtis · 2025-11-29T02:50:14Z

Test Cases

Change Dir Down

Open /home/alex/src/keyd

:NvimTreeOpen

<C-]> data

Exception thrown:

E5108: Error executing lua: ...ack/packer/start/nvim-tree.lua.dev/lua/nvim-tree/api.lua:167: attempt to index field 'change_dir' (a nil value)

alex-courtis · 2025-11-29T03:12:54Z

I Just solved this but pre commit checks wouldn't let em commit, and I didn't noticed that I just ended up committing it right now successfully.

That occurs for github security reasons. You will be able to run checks after you have merged your first PR.

alex-courtis

This is looking good, your style has visibly improved since last review.

Please:

Decide upon splitting this PR: https://github.com/nvim-tree/nvim-tree.lua/pull/3209/files#r2572775780
Resolve the runtime exception #3209 (comment)
Revert unrelated changes https://github.com/nvim-tree/nvim-tree.lua/pull/3209/files#r2572770381

alex-courtis · 2025-11-29T03:13:15Z

.luarc.json

Please don't make unnecessary changes.

alex-courtis · 2025-11-29T03:29:44Z

lua/nvim-tree/explorer/init.lua

 ---@field opts table user options
 ---@field augroup_id integer
 ---@field renderer Renderer
+---@field change_dir any


This still isn't quite right: we're assigning the static change_dir module to a member field on the Explorer class. In this class we are directly calling the module change_dir directly, instead of via the member, which is the right way to use a static module.

We're stuck at a half way point in the refactor of change dir. The outcome of this issue is to have all of change dir moved into the Explorer class as methods. You've achieved this nicely for Explorer:dir_up.

Decision time:

Option 1:

complete both refactors, moving everything from change-dir.lua into Explorer

Option 2:

revert the change-dir changes

merge the dir-up changes

create a follow up PR for change-dir

This is my fault: I said "It might be easiest to split into two PRs." where I should have said "complete these changes in two PRs"

I strongly recommend option 2.
The first few multiinstance refactor PRs were done in single PRs; we started doing many refactors in one PR only after we were practiced.

Thanks for your review once again, I quickly follow instructions and update the PR.

Uanela and others added 3 commits October 30, 2025 10:50

chore: moving root actions to explorer

0f2b74b

Merge branch 'master' into refactor-explorer-actions

2a07d7c

chore: syncing changes

d9d70f0

Uanela mentioned this pull request Oct 30, 2025

Falling to first folder on path, e.g: nvim project/packages/docs, shows docs first and when open a file falls to project. #3182

Open

alex-courtis requested changes Nov 3, 2025

View reviewed changes

alex-courtis changed the title ~~Moving root actions change_dir and dir_up to the Explorer class~~ refactor(#2988): multi instance explore: change_dir and dir_up Nov 3, 2025

alex-courtis changed the title ~~refactor(#2988): multi instance explore: change_dir and dir_up~~ refactor(#2988): multi instance change_dir and dir_up Nov 3, 2025

Merge branch 'master' into refactor-explorer-actions

d9124d7

Uanela requested a review from alex-courtis November 21, 2025 00:06

Merge branch 'master' into refactor-explorer-actions

538ad5f

Uanela added 2 commits November 27, 2025 08:43

Merge branch 'refactor-explorer-actions' of https://github.com/uanela…

3a6190b

…/nvim-tree.lua into refactor-explorer-actions

alex-courtis requested changes Nov 29, 2025

View reviewed changes

Uh oh!

refactor(#2988): multi instance change_dir and dir_up #3209

Are you sure you want to change the base?

refactor(#2988): multi instance change_dir and dir_up #3209

Uh oh!

Conversation

Uanela commented Oct 30, 2025 • edited by alex-courtis Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

alex-courtis Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

alex-courtis Nov 29, 2025 • 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

alex-courtis Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alex-courtis commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Success: Base Cases

Fail: respect_buf_cwd = true

Uh oh!

alex-courtis commented Nov 3, 2025

Uh oh!

alex-courtis commented Nov 3, 2025

Uh oh!

Uanela commented Nov 5, 2025

Uh oh!

alex-courtis commented Nov 5, 2025

Uh oh!

Uanela commented Nov 14, 2025

Uh oh!

Uanela commented Nov 21, 2025

Uh oh!

Uanela commented Nov 23, 2025

Uh oh!

alex-courtis commented Nov 26, 2025

Uh oh!

Uanela commented Nov 27, 2025

Uh oh!

alex-courtis commented Nov 29, 2025

Test Cases

Change Dir Down

Uh oh!

alex-courtis commented Nov 29, 2025

Uh oh!

alex-courtis left a comment

Choose a reason for hiding this comment

Uh oh!

alex-courtis Nov 29, 2025

Choose a reason for hiding this comment

Uh oh!

alex-courtis Nov 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Option 1:

Option 2:

Uh oh!

Uanela Nov 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uanela commented Oct 30, 2025 •

edited by alex-courtis

Loading

alex-courtis left a comment •

edited

Loading

alex-courtis Nov 29, 2025 •

edited

Loading

alex-courtis commented Nov 3, 2025 •

edited

Loading

Fail: `respect_buf_cwd` = true

alex-courtis Nov 29, 2025 •

edited

Loading