Add overseer/cmake-tools + neorg + configure remote-nvim

remote-nvim:
- TMUX integration
- Copy local plugins, needs amitds1997/remote-nvim.nvim#190

Author: arntanguy

init.lua

@@ -85,7 +85,8 @@ I hope you enjoy your Neovim journey,
 
 P.S. You can delete this when you're done too. It's your config now! :)
 --]]
-
+require 'globals'
+--
 -- Set <space> as the leader key
 -- See `:help mapleader`
 --  NOTE: Must happen before plugins are loaded (otherwise wrong leader will be used)
@@ -253,7 +254,28 @@ vim.opt.rtp:prepend(lazypath)
 --    :Lazy update
 --
 -- NOTE: Here is where you install your plugins.
-require('lazy').setup {
+
+-- NOTE: lazy.nvim options
+local lazy_config = {
+  dev = {
+    -- Directory where you store your local plugin projects. If a function is used,
+    -- the plugin directory (e.g. `~/projects/plugin-name`) must be returned.
+    path = function(plugin)
+      if vim.g.remote_neovim_host then
+        local remote_path = vim.fn.stdpath('config') .. '/../local_plugins/nvim/' .. plugin.name
+        return remote_path
+      else
+        local local_path = "~/devel/nvim/" .. plugin.name
+        return local_path
+      end
+    end,
+    ---@type string[] plugins that match these patterns will use your local versions instead of being fetched from GitHub
+    patterns = {}, -- For example {"folke"}
+    fallback = false, -- Fallback to git when local plugin doesn't exist
+  },
+}
+require('lazy').setup ({
+
   -- NOTE: Plugins can be added with a link (or for a github repo: 'owner/repo' link).
   'tpope/vim-sleuth', -- Detect tabstop and shiftwidth automatically
 
@@ -498,7 +520,7 @@ require('lazy').setup {
   --  Uncomment the following line and add your plugins to `lua/custom/plugins/*.lua` to get going.
   --    For additional information, see `:help lazy.nvim-lazy.nvim-structuring-your-plugins`
   { import = 'custom.plugins' },
-}
+}, lazy_config)
 
 -- The line beneath this is called `modeline`. See `:help modeline`
 -- vim: ts=2 sts=2 sw=2 et

lua/custom/plugins/cmake-tools.lua

@@ -0,0 +1,42 @@
+return {
+  'Civitasv/cmake-tools.nvim',
+  dependencies = { 'stevearc/overseer.nvim' },
+  config = function()
+    local osys = require("cmake-tools.osys")
+    require("cmake-tools").setup {
+      cmake_command = "cmake", -- this is used to specify cmake command path
+      ctest_command = "ctest", -- this is used to specify ctest command path
+      cmake_use_preset = true,
+      cmake_regenerate_on_save = true, -- auto generate when save CMakeLists.txt
+      cmake_generate_options = { "-DCMAKE_EXPORT_COMPILE_COMMANDS=1", "-GNinja" }, -- this will be passed when invoke `CMakeGenerate`
+      cmake_build_options = {}, -- this will be passed when invoke `CMakeBuild`
+      -- support macro expansion:
+      --       ${kit}
+      --       ${kitGenerator}
+      --       ${variant:xx}
+      cmake_build_directory = function()
+        require'plenary'.log.debug("cmake_build_directory windows: " .. tostring(osys.iswin32))
+        -- if osys.iswin32 then
+        --   print('windows')
+        --   return "out\\${variant:buildType}"
+        -- end
+        return "build/${variant:buildType}"
+      end, -- this is used to specify generate directory for cmake, allows macro expansion, can be a string or a function returning the string, relative to cwd.
+      cmake_soft_link_compile_commands = true, -- this will automatically make a soft link from compile commands file to project root dir
+      cmake_compile_commands_from_lsp = false, -- this will automatically set compile commands file location using lsp, to use it, please set `cmake_soft_link_compile_commands` to false
+      cmake_kits_path = nil, -- this is used to specify global cmake kits path, see CMakeKits for detailed usage
+      cmake_variants_message = {
+        short = { show = true }, -- whether to show short message
+        long = { show = true, max_length = 40 }, -- whether to show long message
+      },
+      cmake_executor = { -- executor to use
+        name = "overseer", -- name of the executor
+        opts = {}, -- the options the executor will get, possible values depend on the executor type. See `default_opts` for possible values.
+      },
+      cmake_runner = { -- runner to use
+        name = "overseer",
+        opts = {},
+      },
+    }
+  end
+}

lua/custom/plugins/mini.lua

@@ -34,7 +34,7 @@ return { -- Collection of various small independent plugins/modules
 
       -- check if this is an nvim-remote instance
       if vim.g.remote_neovim_host then
-        local remote_name = (" | Remote: %s"):format(vim.uv.os_gethostname()) or ""
+        local remote_name = (" | Remote: %s"):format(vim.g.remote_neovim_unique_host_id) or ""
         value = value .. remote_name
       end
 

lua/custom/plugins/neorg.lua

@@ -0,0 +1,35 @@
+return {
+    "nvim-neorg/neorg",
+    lazy = false, -- Disable lazy loading as some `lazy.nvim` distributions set `lazy = true` by default
+    version = "*", -- Pin Neorg to the latest stable release
+    config = function()
+          require("neorg").setup({
+            load = {
+              ["core.defaults"] = {}, -- Loads default behaviour
+              ["core.concealer"] = {}, -- Adds pretty icons to your documents
+              ["core.ui.calendar"] = {},
+              ["core.completion"] = { config = { engine = "nvim-cmp", name = "[Norg]" } },
+              ["core.integrations.nvim-cmp"] = {},
+              -- ["core.concealer"] = { config = { icon_preset = "diamond" } },
+              ["core.esupports.metagen"] = { config = { type = "auto", update_date = true } },
+              ["core.qol.toc"] = {},
+              ["core.qol.todo_items"] = {},
+              ["core.looking-glass"] = {},
+              ["core.presenter"] = { config = { zen_mode = "zen-mode" } },
+              ["core.export"] = {},
+              ["core.export.markdown"] = { config = { extensions = "all" } },
+              ["core.summary"] = {},
+              ["core.tangle"] = { config = { report_on_empty = false } },
+              ["core.dirman"] = { -- Manages Neorg workspaces
+                config = {
+                  workspaces = {
+                    notes = "~/notes/notes",
+                    work = "~/notes/work",
+                  },
+                  default_workspace = "notes",
+                },
+              },
+            },
+          })
+        end,
+}

lua/custom/plugins/overseer.lua

@@ -0,0 +1,4 @@
+return {
+  'stevearc/overseer.nvim',
+  opts = {},
+}

lua/custom/plugins/remote-nvim.lua

@@ -1,55 +1,77 @@
 return {
-   "amitds1997/remote-nvim.nvim",
-   version = "*", -- Pin to GitHub releases
-   dependencies = {
-       "nvim-lua/plenary.nvim", -- For standard functions
-       "MunifTanjim/nui.nvim", -- To build the plugin UI
-       "nvim-telescope/telescope.nvim", -- For picking b/w different remote methods
-   },
+  -- "amitds1997/remote-nvim.nvim",
+  "remote-nvim.nvim",
+  dev = true,
+  version = "*", -- Pin to GitHub releases
+  dependencies = {
+    "nvim-lua/plenary.nvim", -- For standard functions
+    "MunifTanjim/nui.nvim", -- To build the plugin UI
+    "nvim-telescope/telescope.nvim", -- For picking b/w different remote methods
+  },
   config = function()
     require("remote-nvim").setup(
       {
-         client_callback = function(port, workspace_config)
-            local cmd = ("wezterm cli set-tab-title --pane-id $(wezterm cli spawn nvim --server localhost:%s --remote-ui) %s"):format(
-              port,
-              ("'Remote: %s'"):format(workspace_config.host)
-            )
-            if vim.env.TERM == "xterm-kitty" then
-              cmd = ("kitty -e nvim --server localhost:%s --remote-ui"):format(port)
-            end
-            vim.fn.jobstart(cmd, {
-              detach = true,
-              on_exit = function(job_id, exit_code, event_type)
-                -- This function will be called when the job exits
-                print("Client", job_id, "exited with code", exit_code, "Event type:", event_type)
-              end,
-            })
-          end,
-
-  -- Remote configuration
-  remote = {
-    -- List of directories that should be copied over
-    copy_dirs = {
-      -- What to copy to remote's Neovim data directory
-      data = {
-        base = vim.fn.stdpath("data"),
-        dirs = "*",
-        compression = {
-          enabled = true,
-        },
-      },
-      -- What to copy to remote's Neovim cache directory
-      cache = {
-        base = vim.fn.stdpath("cache"),
-        dirs = {'codeium'},
-        compression = {
-          enabled = true,
-        },
-      },
-    },
-  },
+        -- You can supply your own callback that should be called to create the local client. This is the default implementation.
+        -- Two arguments are passed to the callback:
+        -- port: Local port at which the remote server is available
+        -- workspace_config: Workspace configuration for the host. For all the properties available, see https://github.com/amitds1997/remote-nvim.nvim/blob/main/lua/remote-nvim/providers/provider.lua#L4
+        -- A sample implementation using WezTerm tab is at: https://github.com/amitds1997/remote-nvim.nvim/wiki/Configuration-recipes
+        client_callback = function(port, workspace_config)
+          local cmd = ""
+          if vim.env.TERM == "tmux-256color" then
+            cmd = ("tmux new-window -n '%s' nvim --server localhost:%s --remote-ui"):format(
+            workspace_config.host,
+            port
+          )
+          elseif vim.env.TERM == 'wezterm' then
+            cmd = ("wezterm cli set-tab-title --pane-id $(wezterm cli spawn nvim --server localhost:%s --remote-ui) %s"):format(
+            port,
+            ("'Remote: %s'"):format(workspace_config.host)
+          )
+          elseif vim.env.TERM == "xterm-kitty" then
+            cmd = ("kitty -e nvim --server localhost:%s --remote-ui"):format(port)
+          end
+          vim.fn.jobstart(cmd, {
+            detach = true,
+            on_exit = function(job_id, exit_code, event_type)
+              -- This function will be called when the job exits
+              print("Client", job_id, "exited with code", exit_code, "Event type:", event_type)
+            end,
+          })
+        end,
 
+        -- Remote configuration
+        remote = {
+          -- List of directories that should be copied over
+          copy_dirs = {
+            local_plugins = {
+              -- home folder
+              base = "/home/arnaud/devel/nvim",
+              dirs = "*",
+              compression = {
+                enabled = true,
+              },
+            },
 
+            -- What to copy to remote's Neovim data directory
+            data = {
+              base = vim.fn.stdpath("data"),
+              -- dirs = "*",
+              dirs = nil,
+              compression = {
+                enabled = true,
+              },
+            },
+            -- What to copy to remote's Neovim cache directory
+            cache = {
+              base = vim.fn.stdpath("cache"),
+              dirs = {'codeium'},
+              compression = {
+                enabled = true,
+              },
+            },
+          },
+        }
       }
     )
   end,

lua/globals.lua

@@ -0,0 +1,30 @@
+-- load .nvim.lua per-project after init.lua
+-- see :help exrc
+vim.opt.exrc = true
+
+-- Hide neovim's command line by default
+vim.o.cmdheight = 0
+
+-- Use ESC to exit the terminal prompt 
+vim.cmd [[
+au TermOpen * tnoremap <Esc><Esc> <c-\><c-n>
+au FileType fzf tunmap <Esc><Esc>
+]]
+
+P = function(v)
+  vim.print(v)
+  return v
+end
+
+RELOAD=function(...)
+  return require("plenary.reload").reload_module(...)
+end
+
+R = function(name)
+  RELOAD(name)
+  return require(name)
+end
+
+-- Should only exist on lua files
+vim.keymap.set('n', '<leader><leader>x', ':write<CR>:source<CR>', { desc = 'Save and source current file' })
+vim.keymap.set('n', '<leader>t', '<Plug>PlanaryTestFile', { desc = 'Run test file using plenary' })