initial commit

Author: johnseth97

.github/workflows/ci.yml

@@ -0,0 +1,86 @@
+name: CI
+
+on:
+  push:
+    branches: [main, codecov-dev]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Neovim ${{ matrix.neovim }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        neovim: ["stable", "v0.10.0", "nightly"]
+
+    steps:
+      - name: Checkout plugin
+        uses: actions/checkout@v4
+
+      - name: Install Neovim ${{ matrix.neovim }}
+        run: |
+          set -euo pipefail
+
+          VERSION=${{ matrix.neovim }}
+
+          # All historic 0.x tags use nvim-linux64.tar.gz, everything newer uses -x86_64
+          if [[ "$VERSION" =~ ^v0\.[0-9]+\. ]]; then
+            FILENAME=nvim-linux64.tar.gz
+          else
+            FILENAME=nvim-linux-x86_64.tar.gz
+          fi
+
+          URL="https://github.com/neovim/neovim/releases/download/${VERSION}/${FILENAME}"
+          echo "Downloading $URL"
+
+          curl -fL -o nvim.tar.gz "$URL"        # -f = fail on 4xx/5xx, -L = follow redirects
+
+          mkdir nvim-extract
+          tar -xzf nvim.tar.gz -C nvim-extract
+
+          DIR="$(ls nvim-extract | head -n1)"   # should be nvim-linux64 or nvim-linux-x86_64
+          sudo mv "nvim-extract/$DIR" /opt/nvim
+          echo "/opt/nvim/bin" >> "$GITHUB_PATH"
+
+      - name: Verify Neovim
+        run: nvim --version
+
+      - name: Install Plenary
+        run: |
+          mkdir -p ~/.local/share/nvim/site/pack/test/start
+          git clone https://github.com/nvim-lua/plenary.nvim ~/.local/share/nvim/site/pack/test/start/plenary.nvim
+
+      - name: Install LuaRocks + luacheck + coverage tools
+        run: |
+          set -euo pipefail
+          sudo apt-get update
+          sudo apt-get install -y lua5.1 liblua5.1-0-dev luarocks
+          luarocks --lua-version=5.1 --local install luacheck
+          luarocks --lua-version=5.1 --local install luacov
+          luarocks --lua-version=5.1 --local install luacov-reporter-lcov
+          echo "$HOME/.luarocks/bin" >> $GITHUB_PATH
+
+      - name: Run tests with coverage
+        run: |
+          eval "$(luarocks --lua-version=5.1 path)"
+          luarocks --lua-version=5.1 list # debug
+          nvim --headless -u tests/minimal_init.lua -c "luafile tests/run_cov.lua"
+          
+          luacov -r lcov > lcov.info
+          sed -i 's|SF:.*/codex.nvim/codex.nvim/|SF:|g' lcov.info
+          head -n 10 lcov.info # debug
+
+          # Debug output
+          echo "=== first 20 lines of lcov.info ==="
+          head -n 20 lcov.info
+
+          echo "=== all source-file entries ==="
+          grep '^SF:' lcov.info | sed -e 's/^SF://g' | sort | uniq | head -n 10
+    
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: lcov.info               # <-- new file
+          disable_search: true
+          token: ${{ secrets.CODECOV_TOKEN }}

.luacheckrc

@@ -0,0 +1,9 @@
+-- .luacheckrc
+std = "luajit"
+globals = { "vim" }
+ignore = {
+  "plugin/*", -- plugin loader shim
+}
+
+max_line_length = false      -- or turn it off completely
+

.luacov

@@ -0,0 +1,15 @@
+-- .luacov  (Lua, not INI)
+return {
+  statsfile  = "luacov.stats.out",
+  reportfile = "luacov.report.out",
+
+  -- collect coverage only for plugin source
+  include = {
+    "lua/",
+  },
+
+  -- ignore test helpers and specs
+  exclude = {
+    "tests/",
+  },
+}

.stylua.toml

@@ -0,0 +1,7 @@
+# ~/.config/stylua/stylua.toml
+indent_type  = "Spaces"
+indent_width = 2
+column_width = 160
+line_endings = "Unix"
+quote_style  = "AutoPreferSingle"
+call_parentheses = "None"

README.md

@@ -0,0 +1,56 @@
+# gh-dash Neovim Plugin
+
+## A Neovim plugin integrating the open-source gh-dash TUI for the `gh` cli ([gh-dash](https://github.com/dlvhdr/gh-dash/)).
+> 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`
+- ✅ Optional keymap mapping via `setup` call
+- ✅ Background running when window hidden
+- ✅ Statusline integration via `require('ghdash').status()` 
+
+### Installation:
+
+- Install the `gh-dash` CLI via npm, or mark autoinstall as true in the config function
+
+```bash
+npm install -g @openai/gh-dash
+```
+
+- Grab an API key from OpenAI and set it in your environment variables:
+  - Note: You can also set it in your `~/.bashrc` or `~/.zshrc` file to persist across sessions, but be careful with security. Especially if you share your config files.
+
+```bash
+export OPENAI_API_KEY=your_api_key
+```
+
+- Use your plugin manager, e.g. lazy.nvim:
+
+```lua
+return {
+  'johnseth97/gh-dash.nvim',
+  lazy = true,
+  keys = {
+    {
+      '<leader>cc',
+      function() require('gh-dash').toggle() end,
+      desc = 'Toggle gh-dash popup',
+    },
+  },
+  opts = {
+    keymaps     = {},    -- disable internal mapping
+    border      = 'rounded', -- or 'double'
+    width       = 0.8,
+    height      = 0.8,
+    autoinstall = true,
+  },
+}
+```
+
+### Usage:
+- Call `:gh-dash` (or `:gh-dashToggle`) 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
+require('gh-dash').status() -- drop in to your lualine sections
+```