feat(integrations): support outline.nvim (#335)

## 📃 Summary

closes #296

Makefile

@@ -36,6 +36,7 @@ deps:
 	git clone --depth 1 https://github.com/antoinemadec/FixCursorHold.nvim deps/fixcursorhold
 	git clone --depth 1 https://github.com/mfussenegger/nvim-dap deps/nvimdap
 	git clone --depth 1 https://github.com/rcarriga/nvim-dap-ui deps/nvimdapui
+	git clone --depth 1 https://github.com/hedyhli/outline.nvim deps/outline
 
 test-ci: deps test
 

README.md

@@ -262,13 +262,22 @@ require("no-neck-pain").setup({
             -- When `true`, if the tree was opened before enabling the plugin, we will reopen it.
             reopen = true,
         },
+        -- @link https://github.com/rcarriga/nvim-dap-ui
         NvimDAPUI = {
             -- The position of the tree.
             --- @type "none"
             position = "none",
             -- When `true`, if the tree was opened before enabling the plugin, we will reopen it.
             reopen = true,
         },
+        -- @link https://github.com/hedyhli/outline.nvim
+        outline = {
+            -- The position of the tree.
+            --- @type "left"|"right"
+            position = "right",
+            -- When `true`, if the tree was opened before enabling the plugin, we will reopen it.
+            reopen = true,
+        },
     },
 })
 

doc/no-neck-pain.txt

@@ -364,6 +364,14 @@ values:
               -- When `true`, if the tree was opened before enabling the plugin, we will reopen it.
               reopen = true,
           },
+          -- @link https://github.com/hedyhli/outline.nvim
+          outline = {
+              -- The position of the tree.
+              --- @type "left"|"right"
+              position = "right",
+              -- When `true`, if the tree was opened before enabling the plugin, we will reopen it.
+              reopen = true,
+          },
       },
   }
 

lua/no-neck-pain/config.lua

@@ -300,6 +300,14 @@ NoNeckPain.options = {
             -- When `true`, if the tree was opened before enabling the plugin, we will reopen it.
             reopen = true,
         },
+        -- @link https://github.com/hedyhli/outline.nvim
+        outline = {
+            -- The position of the tree.
+            --- @type "left"|"right"
+            position = "right",
+            -- When `true`, if the tree was opened before enabling the plugin, we will reopen it.
+            reopen = true,
+        },
     },
 }
 

lua/no-neck-pain/util/constants.lua

@@ -67,6 +67,11 @@ Co.INTEGRATIONS = {
         close = "lua require('dapui').close()",
         open = "lua require('dapui').open()",
     },
+    outline = {
+        fileTypePattern = "outline",
+        close = "Outline",
+        open = "Outline",
+    },
 }
 
 ---Dashboards filetypes that delays the plugin enable step until next buffer entered.

scripts/init_with_outline.lua

@@ -0,0 +1,12 @@
+vim.cmd([[let &rtp.=','.getcwd()]])
+
+vim.cmd("set rtp+=deps/mini.nvim")
+vim.cmd("set rtp+=deps/outline")
+
+require("mini.test").setup()
+require("outline").setup()
+require("no-neck-pain").setup({
+    width = 1,
+    minSideBufferWidth = 0,
+    integrations = { outline = { reopen = true } },
+})

tests/test_API.lua

@@ -146,6 +146,10 @@ T["setup"]["sets exposed methods and default options value"] = function()
         undotree = {
             position = "left",
         },
+        outline = {
+            position = "right",
+            reopen = true,
+        },
     })
 end
 

tests/test_integrations.lua

@@ -67,6 +67,10 @@ T["setup"]["overrides default values"] = function()
             position = "left",
             reopen = false,
         },
+        outline = {
+            position = "right",
+            reopen = true,
+        }
     })
 end
 
@@ -173,6 +177,35 @@ T["neotest"]["keeps sides open"] = function()
     })
 end
 
+T["outline"] = MiniTest.new_set()
+
+T["outline"]["keeps sides open"] = function()
+    child.restart({ "-u", "scripts/init_with_outline.lua", "lua/no-neck-pain/main.lua" })
+    child.set_size(20, 100)
+
+    Helpers.toggle(child)
+
+    Helpers.expect.equality(Helpers.winsInTab(child), { 1001, 1000, 1002 })
+    Helpers.expect.state(child, "tabs[1].wins.main", {
+        curr = 1000,
+        left = 1001,
+        right = 1002,
+    })
+
+    child.cmd("Outline")
+    vim.loop.sleep(50)
+
+    Helpers.expect.state(child, "tabs[1].wins.splits", vim.NIL)
+
+    Helpers.expect.state(child, "tabs[1].wins.integrations.outline", {
+        close = "Outline",
+        fileTypePattern = "outline",
+        id = 1004,
+        open = "Outline",
+        width = 40,
+    })
+end
+
 T["NvimTree"] = MiniTest.new_set()
 
 T["NvimTree"]["keeps sides open"] = function()

tests/test_tabs.lua

@@ -505,6 +505,11 @@ T["tabnew/tabclose"]["does not pick tab 1 for the first active tab"] = function(
                     fileTypePattern = "undotree",
                     open = "UndotreeToggle",
                 },
+                outline = {
+                    close = "Outline",
+                    fileTypePattern = "outline",
+                    open = "Outline",
+                },
             },
             main = {
                 curr = 1000,