Refactored ghdash to gh_dash and command changes

Author: johnseth97

README.md

@@ -4,10 +4,10 @@
 > Latest version: ![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/johnseth97/gh-dash.nvim?sort=semver)
 
 ### Features:
-- ✅ Toggle gh-dash floating window with `:ghdash-toggle`
+- ✅ Toggle gh-dash floating window with `:GHDashToggle`
 - ✅ Optional keymap mapping via `setup` call
 - ✅ Background running when window hidden
-- ✅ Statusline integration via `require('ghdash').status()` 
+- ✅ Statusline integration via `require('gh_dash').status()` 
 
 ### Installation:
 
@@ -34,7 +34,7 @@ return {
   keys = {
     {
       '<leader>cc',
-      function() require('gh-dash').toggle() end,
+      function() require('gh_dash').toggle() end,
       desc = 'Toggle gh-dash popup',
     },
   },
@@ -50,7 +50,7 @@ return {
 - If you are not using Lazy, I assume you can figure out how to install the plugin yourself by cloning the repo.
 
 ### Usage:
-- Call `:gh-dash` (or `:gh-dashToggle`) to open or close the gh-dash popup.
+- Call `:GHDash` (or `:GHDashToggle`) to open or close the gh-dash popup.
 -- Map your own keybindings via the `keymaps.toggle` setting.
 - Add the following code to show presence of backgrounded gh-dash window in lualine:
 ```lua

lua/gh_dash/init.lua

@@ -8,7 +8,7 @@ local config = {
   width = 0.8,
   height = 0.8,
   cmd = { 'gh', 'dash' },
-  -- whether to auto-install the ghdash TUI not found (requires npm)
+  -- whether to auto-install the gh_dash TUI not found (requires npm)
   autoinstall = false,
 }
 
@@ -20,20 +20,20 @@ local state = {
 
 function M.setup(user_config)
   config = vim.tbl_deep_extend('force', config, user_config or {})
-  -- define commands for toggling the ghdash popup
-  vim.api.nvim_create_user_command('ghdash', function()
+  -- define commands for toggling the gh_dash popup
+  vim.api.nvim_create_user_command('GHdash', function()
     M.toggle()
-  end, { desc = 'Toggle ghdash popup' })
-  vim.api.nvim_create_user_command('ghdash-toggle', function()
+  end, { desc = 'Toggle gh-dash popup' })
+  vim.api.nvim_create_user_command('GHdashToggle', function()
     M.toggle()
-  end, { desc = 'Toggle ghdash popup (alias)' })
+  end, { desc = 'Toggle gh-dash popup (alias)' })
   -- optional keymap for toggle
   if config.keymaps.toggle then
-    vim.api.nvim_set_keymap('n', config.keymaps.toggle, '<cmd>ghdash-toggle<CR>', { noremap = true, silent = true })
+    vim.api.nvim_set_keymap('n', config.keymaps.toggle, '<cmd>GHDashToggle<CR>', { noremap = true, silent = true })
   end
 end
 
--- Create a floating window displaying the ghdash buffer
+-- Create a floating window displaying the gh_dash buffer
 local function open_window()
   -- compute dimensions and position
   local width = math.floor(vim.o.columns * config.width)
@@ -101,10 +101,10 @@ function M.open()
     -- buffer options
     vim.api.nvim_buf_set_option(state.buf, 'bufhidden', 'hide')
     vim.api.nvim_buf_set_option(state.buf, 'swapfile', false)
-    vim.api.nvim_buf_set_option(state.buf, 'filetype', 'ghdash')
-    -- map <Esc> in terminal and normal modes to close the ghdash window
-    vim.api.nvim_buf_set_keymap(state.buf, 't', '<Esc>', [[<C-\><C-n><cmd>lua require('ghdash').close()<CR>]], { noremap = true, silent = true })
-    vim.api.nvim_buf_set_keymap(state.buf, 'n', '<Esc>', [[<cmd>lua require('ghdash').close()<CR>]], { noremap = true, silent = true })
+    vim.api.nvim_buf_set_option(state.buf, 'filetype', 'gh_dash')
+    -- map <Esc> in terminal and normal modes to close the gh_dash window
+    vim.api.nvim_buf_set_keymap(state.buf, 't', '<Esc>', [[<C-\><C-n><cmd>lua require('gh_dash').close()<CR>]], { noremap = true, silent = true })
+    vim.api.nvim_buf_set_keymap(state.buf, 'n', '<Esc>', [[<cmd>lua require('gh_dash').close()<CR>]], { noremap = true, silent = true })
   end
   open_window()
   -- determine if config.cmd is a simple executable name (no args) for checking
@@ -127,52 +127,52 @@ function M.open()
           local cmd = {
             shell_cmd,
             '-c',
-            "echo 'Autoinstalling OpenAI ghdash via npm...'; npm install -g @openai/ghdash",
+            "echo 'Autoinstalling OpenAI gh_dash via npm...'; npm install -g @openai/gh_dash",
           }
           state.job = vim.fn.termopen(cmd, {
             cwd = vim.loop.cwd(),
             on_exit = function(_, exit_code)
               if exit_code == 0 then
-                vim.notify('[ghdash.nvim] ghdash CLI installed successfully', vim.log.levels.INFO)
-                -- automatically re-launch ghdash CLI now that it's installed
+                vim.notify('[gh_dash.nvim] gh_dash CLI installed successfully', vim.log.levels.INFO)
+                -- automatically re-launch gh_dash CLI now that it's installed
                 vim.schedule(function()
                   M.close()
                   state.buf = nil
                   M.open()
                 end)
               else
-                vim.notify('[ghdash.nvim] failed to install ghdash CLI', vim.log.levels.ERROR)
+                vim.notify('[gh_dash.nvim] failed to install gh_dash CLI', vim.log.levels.ERROR)
               end
               state.job = nil
             end,
           })
         end
       else
-        -- show installation instructions in the ghdash popup
+        -- show installation instructions in the gh_dash popup
         local msg = {
-          'npm not found; cannot auto-install ghdash CLI.',
+          'npm not found; cannot auto-install gh_dash CLI.',
           '',
           'Please install via your system package manager, or manually run:',
-          '  npm install -g @openai/ghdash',
+          '  npm install -g @openai/gh_dash',
         }
         vim.api.nvim_buf_set_lines(state.buf, 0, -1, false, msg)
       end
     else
       -- show instructions inline when autoinstall is disabled
       local msg = {
-        'ghdash CLI not found.',
+        'gh_dash CLI not found.',
         '',
         'Install with:',
-        '  npm install -g @openai/ghdash',
+        '  npm install -g @openai/gh_dash',
         '',
         'Or enable autoinstall in your plugin setup:',
-        '  require("ghdash").setup{ autoinstall = true }',
+        '  require("gh_dash").setup{ autoinstall = true }',
       }
       vim.api.nvim_buf_set_lines(state.buf, 0, -1, false, msg)
     end
     return
   end
-  -- spawn the ghdash CLI in the floating terminal buffer
+  -- spawn the gh_dash CLI in the floating terminal buffer
   if not state.job then
     state.job = vim.fn.termopen(config.cmd, {
       cwd = vim.loop.cwd(),
@@ -200,20 +200,20 @@ end
 
 function M.statusline()
   if state.job and not (state.win and vim.api.nvim_win_is_valid(state.win)) then
-    return '[ghdash]'
+    return '[gh_dash]'
   end
   return ''
 end
 
---- Return a lualine.nvim component for displaying ghdash status
--- Usage: table.insert(opts.sections.lualine_x, require('ghdash').status())
+--- Return a lualine.nvim component for displaying gh_dash status
+-- Usage: table.insert(opts.sections.lualine_x, require('gh_dash').status())
 function M.status()
   return {
     -- component function
     function()
       return M.statusline()
     end,
-    -- only show when ghdash job is running in background
+    -- only show when gh_dash job is running in background
     cond = function()
       return M.statusline() ~= ''
     end,

plugin/gh_dash.lua

@@ -1,6 +1,5 @@
-local ok, ghdash = pcall(require, 'ghdash')
+local ok, gh_dash = pcall(require, 'gh_dash')
 if not ok then
   return
 end
-ghdash.setup()
-
+gh_dash.setup()

tests/gh_dash_spec.lua

@@ -1,63 +1,63 @@
--- tests/ghdash_spec.lua
+-- tests/gh_dash_spec.lua
 -- luacheck: globals describe it assert eq
 -- luacheck: ignore a            -- “a” is imported but unused
 local a = require 'plenary.async.tests'
 local eq = assert.equals
 
-describe('ghdash.nvim', function()
+describe('gh_dash.nvim', function()
   before_each(function()
     vim.cmd 'set noswapfile' -- prevent side effects
-    vim.cmd 'silent! bwipeout!' -- close any open ghdash windows
+    vim.cmd 'silent! bwipeout!' -- close any open gh_dash windows
   end)
 
   it('loads the module', function()
-    local ok, ghdash = pcall(require, 'ghdash')
-    assert(ok, 'ghdash module failed to load')
-    assert(ghdash.open, 'ghdash.open missing')
-    assert(ghdash.close, 'ghdash.close missing')
-    assert(ghdash.toggle, 'ghdash.toggle missing')
+    local ok, gh_dash = pcall(require, 'gh_dash')
+    assert(ok, 'gh_dash module failed to load')
+    assert(gh_dash.open, 'gh_dash.open missing')
+    assert(gh_dash.close, 'gh_dash.close missing')
+    assert(gh_dash.toggle, 'gh_dash.toggle missing')
   end)
 
-  it('creates ghdash commands', function()
-    require('ghdash').setup { keymaps = {} }
+  it('creates gh_dash commands', function()
+    require('gh_dash').setup { keymaps = {} }
 
     local cmds = vim.api.nvim_get_commands {}
-    assert(cmds['ghdash'], 'ghdash command not found')
-    assert(cmds['ghdashToggle'], 'ghdashToggle command not found')
+    assert(cmds['gh_dash'], 'gh_dash command not found')
+    assert(cmds['gh_dashToggle'], 'gh_dashToggle command not found')
   end)
 
   it('opens a floating terminal window', function()
-    require('ghdash').setup { cmd = "echo 'test'" }
-    require('ghdash').open()
+    require('gh_dash').setup { cmd = "echo 'test'" }
+    require('gh_dash').open()
 
     local win = vim.api.nvim_get_current_win()
     local buf = vim.api.nvim_win_get_buf(win)
     local ft = vim.api.nvim_buf_get_option(buf, 'filetype')
-    eq(ft, 'ghdash')
+    eq(ft, 'gh_dash')
 
-    require('ghdash').close()
+    require('gh_dash').close()
   end)
 
   it('toggles the window', function()
-    require('ghdash').setup { cmd = "echo 'test'" }
+    require('gh_dash').setup { cmd = "echo 'test'" }
 
-    require('ghdash').toggle()
+    require('gh_dash').toggle()
     local win1 = vim.api.nvim_get_current_win()
-    assert(vim.api.nvim_win_is_valid(win1), 'ghdash window should be open')
+    assert(vim.api.nvim_win_is_valid(win1), 'gh_dash window should be open')
 
-    require('ghdash').toggle()
+    require('gh_dash').toggle()
     local still_valid = pcall(vim.api.nvim_win_get_buf, win1)
-    assert(not still_valid, 'ghdash window should be closed')
+    assert(not still_valid, 'gh_dash window should be closed')
   end)
 
   it('shows statusline only when job is active but window is not', function()
-    require('ghdash').setup { cmd = 'sleep 1000' }
-    require('ghdash').open()
+    require('gh_dash').setup { cmd = 'sleep 1000' }
+    require('gh_dash').open()
 
     vim.defer_fn(function()
-      require('ghdash').close()
-      local status = require('ghdash').statusline()
-      eq(status, '[ghdash]')
+      require('gh_dash').close()
+      local status = require('gh_dash').statusline()
+      eq(status, '[gh_dash]')
     end, 100)
   end)
 end)

tests/init.lua

@@ -3,13 +3,13 @@
 -- luacheck: ignore async
 local async = require 'plenary.async.tests'
 
-describe('ghdash.nvim', function()
+describe('gh_dash.nvim', function()
   it('should load without errors', function()
-    require 'ghdash'
+    require 'gh_dash'
   end)
 
   it('should respond to basic command', function()
-    vim.cmd 'ghdash'
+    vim.cmd 'gh_dash'
     -- Add assertion if it triggers some output or state change
   end)
 end)

tests/minimal_init.lua

@@ -1,3 +1,3 @@
 vim.cmd 'set rtp+=.'
 vim.cmd 'set rtp+=./plenary.nvim' -- if using as a submodule or symlinked
-require 'plugin.ghdash' -- triggers plugin/ghdash.lua
+require 'plugin.gh_dash' -- triggers plugin/gh_dash.lua