npm 包 atlantis-for-hyper 使用教程

阅读时长 4 分钟读完

概述

atlantis-for-hyper 是一个方便 Hyper 命令行用户使用的插件,可以让用户在命令行中使用 Atlantis 管理 Pull Request。在本文中,我将详细介绍如何安装、配置和使用该插件。

环境和前置条件

  • 已经安装了 Hyper 命令行工具
  • 已经注册了 Atlantis 账号,并且拥有对应的 Atlantis 项目
  • 了解基本的命令行使用方法和 Git 基础知识

安装

在你的命令行中,通过 npm 安装 atlantis-for-hyper 插件:

配置

在安装完成后,你需要在 Hyper 的配置文件中设置 atlantis-for-hyper 插件:

  1. 打开 Hyper 命令行窗口。
  2. 输入 hyper i hyper-pane 命令,安装 hyper-pane 插件。该插件可以让你在 Hyper 窗口中创建多个面板。
  3. 在 Hyper 窗口中,按下 Ctrl + , 快捷键打开 Hyper 配置文件(或者在命令行中输入 hyper config)。
  4. 在配置文件中添加以下内容:
-- -------------------- ---- -------
-------------- - -
  ------- -
    -- ---
    --------- -
      --------- -----
      ---------- -----
      ------------ -----
      ----------- -----
      ------------------- -----
    --
    -- ---
  --
  -- ---
--
  1. atlantis 对象中设置以下属性:
  • prNumber:你想要管理的 Pull Request 编号。
  • authToken:Atlantis API 的认证 Token。你可以通过登录自己的 Atlantis 账号,然后在页面上找到它。
  • atlantisURL:Atlantis API 的 URL。
  • baseBranch:Pull Request 的目标分支。一般为空,除非你需要合并到特定的分支。
  • showAtlantisOutput:是否在 Hyper 窗口中展示 Atlantis API 的输出结果。

使用

在配置完成后,你就可以使用 atlantis-for-hyper 插件了。在 Hyper 窗口中,使用以下命令:

  • atlantis approve:审核一个 Pull Request。
  • atlantis merge:合并一个 Pull Request。
  • atlantis version:查看当前安装版本。

例如,如果你想要审核一个名为 PR-123 的 Pull Request,你可以使用以下命令:

该命令会访问 Atlantis API,根据你在配置文件中设置的 Token 和 URL 进行认证,并审核服务器上的 Pull Request。

示例代码

以下是一个完整的配置文件,可以帮助你更好地了解如何配置和使用 atlantis-for-hyper 插件。

-- -------------------- ---- -------
-------------- - -
  ------- -
    -- ---
    --------- -
      --------- ---------
      ---------- ------------------
      ------------ --------------------------------------------
      ----------- -------
      ------------------- -----
    --
    -- ---
  --
  -------- -
    ------------
  -
  -- ---
--

结论

通过本文的介绍,你现在应该了解如何安装、配置和使用 npm 包 atlantis-for-hyper,它可以在 Hyper 命令行中方便管理和审核并提高工作效率。当然,你也可以在该项目源代码中进行探索,并贡献你自己的代码。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065b42c6eb7e50355dbd76

纠错
反馈