gh-dash

✨ 一个 GitHub (gh) CLI 扩展，用于显示包含您关心的拉取请求和议题过滤器的仪表板。

✨ 特性

🌅 完全可配置 - 使用 GitHub 过滤器定义区块
🔍 搜索拉取请求和议题
📝 使用 hidden、width 和 grow 属性自定义列
⚡️ 对拉取请求和议题执行检出、评论、打开、合并、差异等操作
⌨️ 设置带有新快捷键的自定义操作
💅 使用自定义主题
🔭 通过详细侧边栏查看拉取请求/议题的详细信息
🪟 编写多个配置文件，轻松切换完全不同的仪表板
♻️ 设置自动刷新仪表板的间隔

📦 安装

安装 gh CLI - 参见安装说明

安装需要支持扩展的 GitHub CLI 最低版本 (2.0.0)。
安装此扩展：
```
gh extension install dlvhdr/gh-dash
```
为了正确显示图标，您应该从 https://www.nerdfonts.com/ 下载并安装 Nerd 字体。然后，将该字体选为您的终端字体。

如果您想手动安装此扩展，请按以下步骤操作：

克隆仓库

# git
git clone https://github.com/dlvhdr/gh-dash

# GitHub CLI
gh repo clone dlvhdr/gh-dash

进入目录
```
cd gh-dash
```
构建
```
go build
```
本地安装
```
gh extension install .
```
</details>

<details> <summary>如何获得这些确切的颜色和字体？</summary>

我使用的是 Alacritty，搭配 tokyonight 主题和 Fira Code Nerd 字体。完整设置请查看我的配置文件。

</details>

⚡️ 使用

运行

gh dash

然后按 <kbd>?</kbd> 获取帮助。

运行 gh dash --help 获取更多信息：

用法：
  gh dash [flags]

标志：
  -c, --config string   使用此配置文件（默认为 $GH_DASH_CONFIG，如未设置，则为 $XDG_CONFIG_HOME/gh-dash/config.yml）
      --debug           传递此标志将允许将调试输出写入 debug.log
  -h, --help            gh-dash 的帮助信息

⚙️ 配置

一个区块由以下内容定义：

标题 - 显示在 TUI 中
过滤器 - 如何过滤仓库的拉取请求 - 这些是普通的 GitHub 过滤器

所有配置都在扩展目录（$XDG_CONFIG_HOME/gh-dash 或 ~/.config/gh-dash/ 或您的操作系统配置目录）下的 config.yml 文件中提供，或者在 $GH_DASH_CONFIG 中提供。

示例 config.yml 文件包含：

prSections:
  - title: 我的拉取请求
    filters: is:open author:@me
    layout:
      author:
        hidden: true
        # width: <列数>
        # grow: <布尔值> 这将使列大小增加
  - title: 需要我审查
    filters: is:open review-requested:@me
  - title: 已订阅
    filters: is:open -author:@me repo:cli/cli repo:dlvhdr/gh-dash
    limit: 50 # 可选的此区块获取的行数限制
issuesSections:
  - title: 已创建
    filters: is:open author:@me
  - title: 已分配
    filters: is:open assignee:@me
  - title: 已订阅
    filters: is:open -author:@me repo:microsoft/vscode repo:dlvhdr/gh-dash
defaults:
  layout:
    prs:
      repo:
        grow: true,
        width: 10
        hidden: false
    # issues: 与 prs 结构相同
  prsLimit: 20 # 全局限制
  issuesLimit: 20 # 全局限制
  preview:
    open: true # 是否默认打开预览窗格
    width: 60 # 宽度（列）
  refetchIntervalMinutes: 30 # 将每 30 分钟重新获取所有区块
repoPaths: # 配置检出拉取请求时定位仓库的位置
  :owner/:repo: ~/src/github.com/:owner/:repo # 模板，如果您始终在一致的位置克隆 GitHub 仓库
  dlvhdr/*: ~/code/repos/dlvhdr/* # 将匹配 dlvhdr/repo-name 到 ~/code/repos/dlvhdr/repo-name
  dlvhdr/gh-dash: ~/code/gh-dash # 不会匹配通配符，而是映射到指定路径
keybindings: # 可选，定义自定义快捷键 - 见下文更多信息
theme: # 可选，见下文更多信息
pager:
  diff: less # 或者例如 delta
confirmQuit: false # 退出时是否显示提示

🗃 使用不同的配置文件运行

您可以运行 gh dash --config <文件路径> 来使用另一个配置文件运行 gh-dash。

这使您可以轻松定义具有不同区块的多个仪表板。<br> 如果您想要 🧳 工作和 👩‍💻 个人仪表板，或者想同时查看多个仪表板，这可能很有用。

⌨️ 快捷键

您可以：

覆盖内置命令的快捷键
定义自己的自定义快捷键，以使用 Go 模板运行 bash 命令。

覆盖内置命令的快捷键

要覆盖"检出"快捷键，您可以在 config.yml 文件中包含以下内容：

keybindings:
  prs:
    - key: O
      builtin: checkout

可用的内置命令列表是：

universal：上、下、首行、末行、切换预览、打开 GitHub、刷新、全部刷新、下一页、上一页、下一节、上一节、搜索、复制 URL、复制编号、帮助、退出
prs：批准、分配、取消分配、评论、差异、检出、关闭、准备就绪、重新打开、合并、查看检查、查看问题
Issues：分配、取消分配、评论、关闭、重新打开、查看拉取请求

定义自定义快捷键

这适用于拉取请求和问题。对于拉取请求，可用的参数有：

参数	描述
`RepoName`	仓库的完整名称（例如 `dlvhdr/gh-dash`）
`RepoPath`	仓库路径，使用 `config.yml` 中的 `repoPaths` 键获取映射
`PrNumber`	拉取请求编号
`HeadRefName`	拉取请求的远程分支名
`BaseRefName`	拉取请求的基础分支名

对于问题，可用的参数有：

参数	描述
`RepoName`	仓库的完整名称（例如 `dlvhdr/gh-dash`）
`RepoPath`	仓库路径，使用 `config.yml` 中的 `repoPaths` 键获取映射
`IssueNumber`	问题编号

示例

要使用 Neovim 或 VSCode 审查拉取请求，在 config.yml 文件中包含以下内容：

repoPaths:
  dlvhdr/gh-dash: ~/code/gh-dash

keybindings:
  prs:
    - key: c
      command: >
        tmux new-window -c {{.RepoPath}} '
          gh pr checkout {{.PrNumber}} &&
          nvim -c ":DiffviewOpen master...{{.HeadRefName}}"
        '
    - key: v
      command: >
        cd {{.RepoPath}} &&
        code . &&
        gh pr checkout {{.PrNumber}}

要置顶问题，在 config.yml 文件中包含以下内容：

keybindings:
  issues:
    - key: P
      command: gh issue pin {{.IssueNumber}} --repo {{.RepoName}}

🚥 仓库路径匹配

仓库名称到路径的映射可以是精确匹配（完整名称，完整路径）或使用 owner 和部分路径的通配符匹配。

完整仓库名称到完整路径的精确匹配优先于匹配的通配符，通配符匹配必须匹配通配符路径。

可以指定 :owner/:repo 模板作为通用后备。

repoPaths:
  :owner/:repo: ~/src/github.com/:owner/:repo # 如果你总是在一致的位置克隆 GitHub 仓库，可以使用此模板
  dlvhdr/*: ~/code/repos/dlvhdr/* # 将匹配 dlvhdr/repo-name 到 ~/code/repos/dlvhdr/repo-name
  dlvhdr/gh-dash: ~/code/gh-dash # 不会匹配通配符，而是映射到指定路径

在发送到命令时，RepoName 和 RepoPath 快捷键参数会被完全展开。

💅 自定义主题

要覆盖默认的终端颜色集并创建自己的配色方案，你可以在 config.yml 文件中定义一个。如果选择这种方式，你需要以十六进制格式（#RRGGBB）指定以下所有键作为颜色，否则验证将失败。

theme:
  ui:
    sectionsShowCount: true
    table:
      showSeparator: true
  colors:
    text:
      primary: "#E2E1ED"
      secondary: "#666CA6"
      inverted: "#242347"
      faint: "#3E4057"
      warning: "#F23D5C"
      success: "#3DF294"
    background:
      selected: "#39386B"
    border:
      primary: "#383B5B"
      secondary: "#39386B"
      faint: "#2B2B40"

🪟 布局

你可以自定义每个部分的布局以及全局布局。

例如，要隐藏所有拉取请求部分的 author 列，在 config.yml 中包含以下内容：

defaults:
  layout:
    prs:
      author:
        hidden: true

对于 prs，列名为：updatedAt, repo, author, title, reviewStatus, state, ci, lines, assignees, base。
对于 issues，列名为：updatedAt, state, repo, title, creator, assignees, comments, reactions。
可用的控制属性有：grow（false, true）、width（单元格数量）和 hidden（false, true）。