README.md

pr_status.nvim

Neovim plugin written in lua which uses the gh cli to fetch pull request check results and allow to display them in a status bar or similar.

⚡️ Requirements

• Neovim >= 0.8.0
• a Nerd Font
• local install of github cli
• this can in theory be configured to be something else, but that would also require a line by line parser for its output

📦 Installation

Install the plugin with your preferred package manager:

-- lazy.nvim
{
  'Velrok/pr_status.nvim',
  config = function()
    require("pr_status").setup(
      { auto_start = true } -- if you want it to just start
    )
  end
},

🧰 Usage

-- somewhere in your status bar
require("pr_status").get_last_result_string() or "pr_status failed"

⚙️ Configuration

pr_status.nvim comes with the following defaults:

{
  icons = {
    gh_icon = " ",
    unknown = '?',
    running = ' ',
    failed = ' ',
    passed = ' ',
  },
  failure_decorations = {
    left = '[',
    right = ']',
    join_string = ', ',
    separator = ' ',
  },
  gh_command = "gh pr checks",
  status_line_parser = github_cli_parser,
  auto_start = false, -- or function which returns true|false
  timer = {
    initial_delay_ms = 1000,
    regular_poll_delay_ms = 30000,
  }
}