From 2ee1c5e17fdfbf5013af31b1410e4a5f28f4cadd Mon Sep 17 00:00:00 2001
From: Alexander Courtis <alex@courtis.org>
Date: Sat, 9 Nov 2024 14:44:59 +1100
Subject: [PATCH] feat(#2819): add actions.open_file.relative_path, default
 enabled, following successful experiment (#2995)

---
 doc/nvim-tree-lua.txt                    | 20 +++++++++-----------
 lua/nvim-tree.lua                        |  6 +-----
 lua/nvim-tree/actions/node/open-file.lua |  2 +-
 3 files changed, 11 insertions(+), 17 deletions(-)

diff --git a/doc/nvim-tree-lua.txt b/doc/nvim-tree-lua.txt
index 968218c659a..89ac4e722ca 100644
--- a/doc/nvim-tree-lua.txt
+++ b/doc/nvim-tree-lua.txt
@@ -592,6 +592,7 @@ Following is the default configuration. See |nvim-tree-opts| for details. >lua
           quit_on_open = false,
           eject = true,
           resize_window = true,
+          relative_path = true,
           window_picker = {
             enable = true,
             picker = "default",
@@ -631,11 +632,6 @@ Following is the default configuration. See |nvim-tree-opts| for details. >lua
         },
       },
       experimental = {
-        actions = {
-          open_file = {
-            relative_path = false,
-          },
-        },
       },
       log = {
         enable = false,
@@ -1497,6 +1493,11 @@ Configuration options for opening a file from nvim-tree.
     Resizes the tree when opening a file.
       Type: `boolean`, Default: `true`
 
+    *nvim-tree.experimental.actions.open_file.relative_path*
+    Buffers opened by nvim-tree will use with relative paths instead of
+    absolute.
+      Type: `boolean`, Default: `true`
+
     *nvim-tree.actions.open_file.window_picker*
     Window picker configuration.
 
@@ -1625,12 +1626,6 @@ Confirmation prompts.
 Experimental features that may become default or optional functionality.
 In the event of a problem please disable the experiment and raise an issue.
 
-    *nvim-tree.experimental.actions.open_file.relative_path*
-    Buffers opened by nvim-tree will use with relative paths instead of
-    absolute.
-    Execute |:ls| to see the paths of all open buffers.
-      Type: `boolean`, Default: `false`
-
 ==============================================================================
  5.20 OPTS: LOG                                           *nvim-tree-opts-log*
 
@@ -2767,6 +2762,9 @@ Windows WSL and PowerShell
 - Executable file detection is disabled as this is non-performant and can
   freeze nvim
 - Some filesystem watcher error related to permissions will not be reported
+- Some users have reported unspecified issues with
+  |nvim-tree.experimental.actions.open_file.relative_path|. Please report any
+  issues or disable this feature.
 
 ==============================================================================
  12. NETRW                                                   *nvim-tree-netrw*
diff --git a/lua/nvim-tree.lua b/lua/nvim-tree.lua
index 0ece7f1916e..4d72d1859df 100644
--- a/lua/nvim-tree.lua
+++ b/lua/nvim-tree.lua
@@ -451,6 +451,7 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
       quit_on_open = false,
       eject = true,
       resize_window = true,
+      relative_path = true,
       window_picker = {
         enable = true,
         picker = "default",
@@ -490,11 +491,6 @@ local DEFAULT_OPTS = { -- BEGIN_DEFAULT_OPTS
     },
   },
   experimental = {
-    actions = {
-      open_file = {
-        relative_path = false,
-      },
-    },
   },
   log = {
     enable = false,
diff --git a/lua/nvim-tree/actions/node/open-file.lua b/lua/nvim-tree/actions/node/open-file.lua
index 92086df4aeb..1d1fc2ecc12 100644
--- a/lua/nvim-tree/actions/node/open-file.lua
+++ b/lua/nvim-tree/actions/node/open-file.lua
@@ -421,7 +421,7 @@ end
 function M.setup(opts)
   M.quit_on_open = opts.actions.open_file.quit_on_open
   M.resize_window = opts.actions.open_file.resize_window
-  M.relative_path = opts.experimental.actions.open_file.relative_path
+  M.relative_path = opts.actions.open_file.relative_path
   if opts.actions.open_file.window_picker.chars then
     opts.actions.open_file.window_picker.chars = tostring(opts.actions.open_file.window_picker.chars):upper()
   end