feat(ci): add luacov-console and enhance installation docs

Change-Id: I3abc69e155626de7dd62cba678893cb264ef3502
Signed-off-by: Thomas Kosiewski <[email protected]>

Author: ThomasK33

.github/workflows/test.yml

@@ -41,6 +41,7 @@ jobs:
           luarocks install busted
           luarocks install luacov
           luarocks install luacov-reporter-lcov
+          luarocks install luacov-console
 
       - name: Run Luacheck
         run: luacheck lua/ tests/ --no-unused-args --no-max-line-length

README.md

@@ -29,16 +29,51 @@ Note: The terminal feature can use `Snacks.nvim` or the native Neovim terminal.
 
 ### Using [lazy.nvim](https://github.com/folke/lazy.nvim)
 
+Add the following to your plugins configuration:
+
 ```lua
 {
   "coder/claudecode.nvim",
   dependencies = {
     "nvim-lua/plenary.nvim",
-    "folke/snacks.nvim", -- Added dependency
+    "folke/snacks.nvim", -- Optional dependency for enhanced terminal
+  },
+  opts = {
+    -- Configuration for claudecode main
+    -- Optional: terminal_cmd = "claude --magic-flag",
+
+    -- Configuration for the interactive terminal:
+    terminal = {
+      split_side = "right",            -- "left" or "right"
+      split_width_percentage = 0.3,    -- 0.0 to 1.0
+      provider = "snacks",             -- "snacks" or "native"
+      show_native_term_exit_tip = true, -- Show tip for Ctrl-\\ Ctrl-N
+    },
+  },
+  -- The plugin will call require("claudecode").setup(opts)
+  config = true,
+  -- Optional: Add convenient keymaps
+  keys = {
+    { "<leader>cc", "<cmd>ClaudeCode<cr>", desc = "Toggle Claude Terminal" },
+    { "<leader>ck", "<cmd>ClaudeCodeSend<cr>", desc = "Send to Claude Code" },
+    { "<leader>co", "<cmd>ClaudeCodeOpen<cr>", desc = "Open Claude Terminal" },
+    { "<leader>cx", "<cmd>ClaudeCodeClose<cr>", desc = "Close Claude Terminal" },
+  },
+}
+```
+
+For those who prefer a function-style config:
+
+```lua
+{
+  "coder/claudecode.nvim",
+  dependencies = {
+    "nvim-lua/plenary.nvim",
+    "folke/snacks.nvim", -- Optional dependency
   },
   config = function()
-    -- Ensure snacks is loaded if you want to use the terminal immediately
-    -- require("snacks") -- Or handle this in your init.lua
+    -- If using snacks, ensure it's loaded
+    -- require("snacks")
     require("claudecode").setup({
       -- Optional configuration
     })
@@ -53,7 +88,7 @@ use {
   "coder/claudecode.nvim",
   requires = {
     "nvim-lua/plenary.nvim",
-    "folke/snacks.nvim", -- Added dependency
+    "folke/snacks.nvim", -- Optional dependency
   },
   config = function()
     require("claudecode").setup({
@@ -63,44 +98,6 @@ use {
 }
 ```
 
-### Using [LazyVim](https://github.com/LazyVim/LazyVim)
-
-Add the following to your `lua/plugins/claudecode.lua`:
-
-```lua
-return {
-  {
-    "coder/claudecode.nvim",
-    dependencies = {
-      "nvim-lua/plenary.nvim",
-      "folke/snacks.nvim", -- Added dependency
-    },
-    opts = {
-      -- Optional configuration for claudecode main
-      -- Example:
-      -- terminal_cmd = "claude --magic-flag",
-
-      -- Configuration for the interactive terminal can also be nested here:
-      terminal = {
-        split_side = "left",            -- "left" or "right"
-        split_width_percentage = 0.4, -- 0.0 to 1.0
-        provider = "snacks",          -- "snacks" or "native" (defaults to "snacks")
-        show_native_term_exit_tip = true, -- Show tip for Ctrl-\\ Ctrl-N (defaults to true)
-      },
-    },
-    -- The main require("claudecode").setup(opts) will handle passing
-    -- opts.terminal to the terminal module's setup.
-    config = true, -- or function(_, opts) require("claudecode").setup(opts) end
-    keys = {
-      { "<leader>cc", "<cmd>ClaudeCode<cr>", desc = "Toggle Claude Terminal" },
-      { "<leader>ck", "<cmd>ClaudeCodeSend<cr>", desc = "Send to Claude Code" },
-      { "<leader>co", "<cmd>ClaudeCodeOpen<cr>", desc = "Open Claude Terminal" },
-      { "<leader>cx", "<cmd>ClaudeCodeClose<cr>", desc = "Close Claude Terminal" },
-    },
-  },
-}
-```
-
 ### Local Development with LazyVim
 
 For local development with LazyVim, create a `lua/plugins/claudecode.lua` file with the following content:

tests/integration/basic_spec.lua

@@ -0,0 +1,8 @@
+local assert = require("luassert")
+
+describe("Claudecode Integration", function()
+  it("should pass placeholder test", function()
+    -- Simple placeholder test that will always pass
+    assert.is_true(true)
+  end)
+end)