feat: add tcd cwd lock feature

When tcd cwd is locked, the current tab will always use the tab cwd as
default cwd

Author: towry

lazy-lock.json

@@ -67,21 +67,19 @@
   "nvim-ts-context-commentstring": { "branch": "main", "commit": "7ab799a9792f7cf3883cf28c6a00ad431f3d382a" },
   "nvim-web-devicons": { "branch": "master", "commit": "6662f059bf78e6092ba90cd1929599625f448f55" },
   "nvim-window-picker": { "branch": "main", "commit": "41cfaa428577c53552200a404ae9b3a0b5719706" },
-  "obsidian.nvim": { "branch": "main", "commit": "df0c5cce68a02481c0d40d1b25433e368fd12a5a" },
   "oil.nvim": { "branch": "master", "commit": "e462a3446505185adf063566f5007771b69027a1" },
   "overseer.nvim": { "branch": "master", "commit": "b04b0b105c07b4f02b3073ea3a98d6eca90bf152" },
   "plenary.nvim": { "branch": "master", "commit": "8aad4396840be7fc42896e3011751b7609ca4119" },
   "popfix": { "branch": "master", "commit": "bf3cc436df63cd535350d5ef1b951c91554d4b01" },
   "popup.nvim": { "branch": "master", "commit": "b7404d35d5d3548a82149238289fa71f7f6de4ac" },
-  "project_nvim": { "branch": "main", "commit": "8d1d178d58b9b83cbc878d775cb356727c668dd7" },
+  "project_nvim": { "branch": "main", "commit": "8f9c196bd159f85f949388a982770120cce1dcb7" },
   "range-highlight.nvim": { "branch": "master", "commit": "8b5e8ccb3460b2c3675f4639b9f54e64eaab36d9" },
   "registers": { "branch": "main", "commit": "22bb98f93a423252fffeb3531f7bc12a3e07b63f" },
   "rgflow.nvim": { "branch": "master", "commit": "e092b984d2ec244d67bedf6fea1b6ad5f91fbaba" },
   "smart-splits.nvim": { "branch": "master", "commit": "958d385f5f791ee4f8d63b9999b13d5f26eaff56" },
   "sqlite.lua": { "branch": "master", "commit": "40701b6151f8883980c1548647116de39b763540" },
   "ssr.nvim": { "branch": "main", "commit": "bb323ba621ac647b4ac5638b47666e3ef3c279e1" },
   "stay-in-place.nvim": { "branch": "main", "commit": "0628b6db8970fc731abf9608d6f80659b58932c9" },
-  "stickybuf.nvim": { "branch": "master", "commit": "2160fcd536d81f5fa43f7167dba6634e814e3154" },
   "switch.vim": { "branch": "main", "commit": "68d269301181835788dcdcb6d5bca337fb954395" },
   "telescope-file-browser.nvim": { "branch": "master", "commit": "61271263618f5dbff9d7c35a161565d158e77f64" },
   "telescope-fzf-native.nvim": { "branch": "main", "commit": "9ef21b2e6bb6ebeaf349a0781745549bbb870d27" },

lua/user/config/autocmd.lua

@@ -370,6 +370,9 @@ function M.load_on_startup()
         if not new_cwd then
           new_cwd = safe_cwd()
         end
+        if not vim.t.cwd_locked then
+          vim.cmd.tcd(new_cwd)
+        end
         local buf_cwd, buf_cwd_short = vim.b[ctx.buf].project_nvim_cwd, vim.b[ctx.buf].project_nvim_cwd_short
         local cwd, cwd_short = require('userlib.runtime.utils').update_cwd_env(buf_cwd, buf_cwd_short)
         if vim.b[ctx.buf].did_set_cwd_short == cwd then

lua/user/config/commands.lua

@@ -291,3 +291,14 @@ end, {
   nargs = 0,
   desc = 'Write all and save session and exit',
 })
+
+create_cmd('LockTcd', function()
+  require('userlib.runtime.utils').lock_tcd()
+end, {
+  desc = 'Lock tcd',
+})
+create_cmd('UnlockTcd', function()
+  require('userlib.runtime.utils').unlock_tcd()
+end, {
+  desc = 'Unlock tcd',
+})

lua/user/plugins/finder.lua

@@ -243,7 +243,7 @@ plug({
       pattern = 'oil:///*',
       callback = function(ctx)
         local cwd = require('oil').get_current_dir()
-        require('userlib.runtime.utils').change_cwd(cwd, 'tcd', true)
+        require('userlib.runtime.utils').change_cwd(cwd, 'lcd', true)
       end,
     })
   end,

lua/user/plugins/statusline.lua

@@ -44,7 +44,8 @@ plug({
         comp.Tabs,
         comp.lpad({ comp.Branch, comp.GitStatus }),
         comp.lpad(comp.Overseer),
-        -- comp.lpad(require('userlib.statusline.heirline.component_diagnostic')),
+        { provider = '%=' },
+        comp.TabCwdLock,
         { provider = '%=' },
         comp.rpad({
           provider = '%c,%l',

lua/user/plugins/workflow.lua

@@ -369,7 +369,7 @@ plug({
       -- * global (default)
       -- * tab
       -- * win
-      scope_chdir = 'tab',
+      scope_chdir = 'custom',
     },
   },
   {

lua/userlib/legendary/commands/migrate.lua

@@ -1,4 +1,12 @@
 return {
+  {
+    ':LockTcd',
+    description = "Lock current tab's cwd | Pin tab cwd",
+  },
+  {
+    ':UnlockTcd',
+    description = "Unlock current tab's cwd | Unpin tab cwd",
+  },
   {
     ':ToggleSpider',
     description = 'Toggle spider motion',

lua/userlib/mini/clue/folder-action.lua

@@ -7,6 +7,13 @@ M.open = function(new_cwd)
 
   require('userlib.mini.clue').shortly_open(function(set, unset)
     set('n', '1', '<cmd>echo expand("%")<cr>', { desc = ' :' .. nicely_cwd })
+
+    set('n', 'l', function()
+      require('userlib.runtime.utils').lock_tcd(new_cwd)
+    end, {
+      desc = 'Lock cwd to current tab',
+    })
+
     set('n', 'f', function()
       require('userlib.fzflua').files({
         cwd = new_cwd,

lua/userlib/runtime/utils.lua

@@ -314,16 +314,37 @@ function M.change_cwd(cwd, cmd, silent)
     return
   end
   cwd = require('userlib.runtime.path').remove_path_last_separator(cwd)
-  vim.cmd((cmd or 'cd') .. ' ' .. cwd)
+  if cmd ~= 'tcd' or vim.t.cwd_locked ~= true then
+    vim.cmd((cmd or 'cd') .. ' ' .. cwd)
+  end
   M.update_cwd_env(cwd)
   if not silent then
     vim.notify(('New cwd: %s'):format(vim.t.cwd_short), vim.log.levels.INFO)
   end
 end
 
+--- make tab stick to a cwd
+-- @param cwd? string
+function M.lock_tcd(cwd)
+  vim.t.cwd_locked = false
+  M.change_cwd(cwd or safe_cwd(), 'tcd', false)
+  --- must put at last
+  vim.t.cwd_locked = true
+end
+
+function M.unlock_tcd()
+  vim.t.cwd_locked = false
+end
+
 ---@param cwd string
 ---@param cwd_short? string
 function M.update_cwd_env(cwd, cwd_short)
+  -- if current tab have locked cwd
+  if vim.t.cwd_locked and vim.t.cwd then
+    cwd = vim.t.cwd
+    cwd_short = vim.t.cwd_short
+  end
+
   cwd = require('userlib.runtime.path').remove_path_last_separator(cwd)
   vim.t.cwd = cwd
   -- only show last part of path.

lua/userlib/statusline/heirline/components.lua

@@ -100,6 +100,28 @@ local ShortFileName = {
   },
 }
 
+local TabCwdLock = {
+  condition = function()
+    return vim.t.cwd_locked and vim.t.cwd_short ~= ''
+  end,
+  {
+    {
+      provider = 'TCD:%-2.30(',
+    },
+    {
+      init = function(self)
+        self.tabnr = vim.api.nvim_get_current_tabpage()
+      end,
+      provider = function(self)
+        return vim.t[self.tabnr].cwd_short
+      end,
+    },
+    {
+      provider = '%) ',
+    },
+  },
+}
+
 local ViMode = {
   init = function(self)
     self.mode = vim.fn.mode() -- :h mode()
@@ -645,7 +667,7 @@ local Copilot = {
     if not self.is_running() then
       return '󰚩 '
     end
-    return '󰆄 '
+    return '������������� '
   end,
   hl = function(self)
     local fg = vim.g.copilot_auto_mode == true and 'orange' or ''
@@ -974,4 +996,5 @@ return {
   UnsavedBufCount = UnsavedBufCount,
   CocStl = CocStl,
   ShortFileName = ShortFileName,
+  TabCwdLock = TabCwdLock,
 }