feat: add integrations.otter for LSP-like behaviours in code blocks (nvim-neorg#1329)

Author: benlubas

lua/neorg/modules/core/concealer/module.lua

@@ -651,6 +651,7 @@ module.public = {
                 local len = line_lengths[row_0b - row_start_0b + 1]
                 local mark_col_start_0b = math.max(0, col_start_0b - config.padding.left)
                 local mark_col_end_0bex = max_len + config.padding.right
+                local priority = 101
                 if len >= mark_col_start_0b then
                     vim.api.nvim_buf_set_extmark(bufid, module.private.ns_icon, row_0b, mark_col_start_0b, {
                         end_row = row_0b + 1,
@@ -661,6 +662,7 @@ module.public = {
                         virt_text_pos = "overlay",
                         virt_text_win_col = len,
                         spell = config.spell_check,
+                        priority = priority,
                     })
                 else
                     vim.api.nvim_buf_set_extmark(bufid, module.private.ns_icon, row_0b, len, {
@@ -675,6 +677,7 @@ module.public = {
                         virt_text_pos = "overlay",
                         virt_text_win_col = len,
                         spell = config.spell_check,
+                        priority = priority,
                     })
                 end
             end

lua/neorg/modules/core/integrations/otter/module.lua

@@ -0,0 +1,180 @@
+--[[
+    file: Otter
+    title: LSP Features in Code Cells
+    description: Integrates with otter.nvim to get LSP features directly in norg code cells.
+    ---
+
+From the otter README:
+
+> Otter.nvim provides lsp features and a code completion source for code embedded in other documents.
+
+This includes:
+- auto completion
+- diagnostics
+- hover
+- rename symbol
+- go to definition
+- go to references
+- go to type definition
+- range formatting (not document formatting)
+
+## Setup
+You need to install otter.nvim and make sure it's loaded before Neorg, you can configure it yourself
+by reading [the Otter.nvim README](https://github.com/jmbuhr/otter.nvim). You do not need to
+configure `handle_leading_whitespace`, neorg will do that for you.
+
+If you want auto complete, make sure you add `"otter"` as a source to nvim-cmp:
+
+```lua
+sources = {
+  -- ... other sources
+  { name = "otter" },
+  -- ... other sources
+}
+```
+
+## Commands
+- `:Neorg otter enable` - enable otter in the current buffer
+- `:Neorg otter disable` - disable otter in the current buffer
+--]]
+
+local neorg = require("neorg.core")
+local module = neorg.modules.create("core.integrations.otter")
+
+module.setup = function()
+    return {
+        success = pcall(require, "otter"),
+        requires = {
+            "core.neorgcmd",
+        },
+    }
+end
+
+local otter
+module.load = function()
+    local ok
+    ok, otter = pcall(require, "otter")
+    assert(ok, "[Neorg] Failed to load otter.nvim")
+
+    -- This will not interfere with other otter.nvim configuration
+    otter.setup({ handle_leading_whitespace = true })
+
+    if module.config.public.auto_start then
+        local group = vim.api.nvim_create_augroup("neorg.integrations.otter", {})
+        vim.api.nvim_create_autocmd({ "BufReadPost" }, {
+            desc = "Activate Otter on Buf Enter",
+            pattern = "*.norg",
+            group = group,
+            callback = function(_)
+                module.public.activate()
+            end
+        })
+    end
+
+    module.required["core.neorgcmd"].add_commands_from_table({
+        otter = {
+            args = 1,
+            name = "otter",
+            condition = "norg",
+            subcommands = {
+                enable = {
+                    args = 0,
+                    name = "otter.enable",
+                },
+                disable = {
+                    args = 0,
+                    name = "otter.disable",
+                },
+            },
+        },
+    })
+end
+
+module.events.subscribed = {
+    ["core.neorgcmd"] = {
+        ["otter.enable"] = true,
+        ["otter.disable"] = true,
+    },
+}
+
+module.on_event = function(event)
+    if module.private[event.split_type[2]] then
+        module.private[event.split_type[2]](event)
+    end
+end
+
+module.config.public = {
+    -- list of languages that otter will try to start a language server for.
+    -- `nil` means all languages
+    languages = nil,
+
+    -- Automatically start Otter when a norg buffer is opened
+    auto_start = true,
+
+    -- buffer local mappings set when otter is active
+    keys = {
+        hover = "K",
+        definition = "gd",
+        type_definition = "gD",
+        references = "gr",
+        rename = "<leader>rn",
+        format = "<leader>gf",
+        document_symbols = "gs",
+    },
+
+    completion = {
+        -- enable/disable autocomplete
+        enabled = true,
+    },
+
+    diagnostics = {
+        -- enable/disable diagnostics
+        enabled = true,
+    },
+}
+
+module.private = {
+    ["otter.enable"] = function(_)
+        module.public.activate()
+    end,
+    ["otter.disable"] = function(_)
+        module.public.deactivate()
+    end,
+}
+
+module.public = {
+    ---Activate otter in the current buffer, includes setting buffer keymaps
+    activate = function()
+        otter.activate(
+            module.config.public.languages,
+            module.config.public.completion.enabled,
+            module.config.public.diagnostics.enabled,
+            nil -- or a query...
+        )
+
+        local b = vim.api.nvim_get_current_buf()
+        for func, lhs in pairs(module.config.public.keys) do
+            vim.api.nvim_buf_set_keymap(
+                b,
+                "n",
+                lhs,
+                (":lua require'otter'.ask_%s()<cr>"):format(func),
+                { silent = true, noremap = true }
+            )
+        end
+    end,
+
+    ---Deactivate otter in the current buffer, including unsetting buffer keymaps
+    deactivate = function()
+        otter.deactivate(
+            module.config.public.completion.enabled,
+            module.config.public.diagnostics.enabled
+        )
+        local b = vim.api.nvim_get_current_buf()
+        for _, lhs in pairs(module.config.public.keys) do
+            vim.api.nvim_buf_del_keymap(b, "n", lhs)
+        end
+    end,
+}
+
+return module