GiitHub의 TUI 도구 제작

개시하다

예전에 Vim을 사용하여 GitHub의 플러그인gh를 조작합니다.비디오 소개라는 기사를 썼어요.
본고에서 소개한 gh.vim는Vim에서 GiitHub 기능을 사용할 수 있는Vim 플러그인이다.작업 중에 GiitHub을 사용한다면 매우 편리한 플러그인이라고 생각합니다.
하지만 Vism을 사용하지 않은 사람이 많기 때문에 이런 사람을 위한 도구가 있는 것이 좋다고 생각해 지티허브의 TUI 도구github-tui를 제작했다.
TUI는 CLI에 비해 상호작용이 가능하고 직관적으로 조작할 수 있는 장점이 있어 편리하다고 생각합니다.
주제 밖의 말을 하면 과거에도 Docker의 TUI 도구docui를 만들어 봤다.
github-tui 아직 완성되지는 않았지만 최소한의 형식이라 필요한지 보고 싶어서 선공개했다.
본 보도는 github-tui에 대한 소개와 전망을 할 것이니 관심 있는 사람은 끝까지 읽어주십시오.

화면 구성

github-tui는 크게 다음과 같은 3가지 패널로 나뉜다.

입력

일람

미리 보기

상세한 상황은 아래와 같다.
패널
설명
Filters
화면 상단의 쿼리 섹션 입력
issues
issue 일람
assignees
issue의 사용자 탐색 선택 중
labels
issue에서 탭 목록 선택
milestones
선택한 issue에 연결된 이정표
projects
선택한 issue와 연결된 항목 목록
issue preview
issue 본문 미리 보기 선택
comments
issue의 주석 목록 선택
comment preview
주석 본문 미리 보기 선택
search
화면 아래쪽에 검색 키워드 섹션을 입력합니다.

기능

현재 issue 관련 기능을 실시하고 있습니다.설치되지 않은 기능은 여기.를 참조하십시오.

Issue

list

create

close

open

open browser

preview

edit

Issue comment

list

preview

delete

기본용법

창고를 시작하거나 시간을 정하지 않고 현재 디렉터리의 창고를 자동으로 지정합니다.

# current repository
$ ght

# specified repository
$ ght owner/repo

시작 후 issue 검색을 진행하여 일람표를 표시합니다.Ctrl-N/Ctrl-P를 사용하여 패널을 이동합니다.

찾다

github-tui에서 search의 검색어를 사용하여 issue를 검색할 수 있습니다.현재 issue만 검색할 수 있지만 앞으로도 PR 등을 검색할 수 있을 것으로 예상된다.
어떤 검색어를 사용할 수 있는지 검색 문서를 참조하십시오. 예를 들어 issue의 제목과 본문에서 '고릴라' 라는 글자가 있는 issue를 검색하려면 아래의 검색어를 입력하고 Enter를 누르면 검색할 수 있습니다.

is:issue state:open ゴリラ in:body,title

데모처럼 기본적으로 선택한 issue가 변할 때마다 issue 본문과 평론의 미리보기가 변한다.
검색할 때 issue의 본문과 관련 탭과 주석 등을 동시에 얻을 수 있기 때문에 질질 끌지 않고 미리 볼 수 있습니다.
기본적으로 검색한 issue는 최대 30건이지만 f로 검색 결과를 더 얻을 수 있습니다.
기릿허브의 규격은 한 번에 100건을 받을 수 있지만, 위에서 설명한 대로 아이슈에 관한 정보를 많이 확보해 30건으로 제한했다.
나는 장래에 config로 기본 limit을 변경할 수 있을 것이라고 생각한다.

키워드 검색

키워드를 검색하려면 요약 및 미리 보기 패널/을 누릅니다.목록에 표시된 항목과 미리 보기 패널에 표시된 내용이 각각 검색됩니다.

미리보기 패널의 키워드가 강조 표시되고 다음 키워드n는 이전 키워드로 이동할 수 있습니다.나는 VImmer가 이 조작에 쉽게 적응할 수 있다고 생각한다.

확대 미리 보기 패널

N 터미널의 크기에 따라 패널의 크기를 동적으로 조정합니다.각 패널의 크기 비율은 고정되어 있다.
따라서 화면이 작으면 미리보기 화면도 작아지고 issue와 댓글의 본문도 어려워진다.
이때 github-tui 패널을 확대하고 o를 다시 누르면 원상태로 회복됩니다.

issue의 Open 및 Close

issue 일람 패널에서 o/Ctrl-J를 사용하여 여러 issue를 검사하고 그것들을 집중하여 Open 또는 Close를 진행합니다.
선택하지 않으면 현재 선택한 issue에 영향을 줍니다.Open issueCtrl+K를 사용하려면 Closeo를 사용합니다.

또한 브라우저에서 선택한 issue를 열 수도 있습니다.

issue 만들기

issue 일람 패널 c 에서 새 issue를 만들 수 있습니다.제작 시 양식이 표시되므로 Ctrl-O에서 각 항목을 전환하면서 필요한 부분을 매립할 수 있습니다.
n는 Tab 중Repo에서 얻었기 때문에 제작 시 반드시 조회해야 합니다.Filters와 repo:owner/repo, Assignees는 입력 보완이 가능하며, 임의의 키워드를 입력하면 보완 후보가 표시됩니다.다만, 복수 후보를 추가하려면 Labels로 칸막이가 필요하다.UI의 제한 사항입니다.(고통)Projects 및 ,는 옵션이며, MileStone 및 Temaplte는 옵션이며, ↑는 선택 취소할 수 있습니다.↓ 단추는 Esc에 설정된 편집기에서 issue 본문을 편집할 수 있지만 특별한 설정이 없으면 기본값Edit Body을 사용합니다.$EDITOR 단추를 누르면isse를 만들 수 있습니다.성공하면 폼을 1초 동안 닫으면 issue 일람이 업데이트됩니다.1초를 기다리는 이유는 제작 후 바로 아이슈 일람을 받아도 바로 반영되지 않기 때문이다.

다음 데이터가 없으면 항목 자체가 표시되지 않습니다.

$EDITOR

Vim

Create

Enter

향후의 전망

기본적으로 브라우저에서 하는 일은 터미널에서도 할 수 있다.예를 들어 issue의 제작, PR의 제작, PR의 평론 등이다.
그러나 사용하는 프로그램 라이브러리는 실현하기 어려우므로 어느 정도 타협이 필요하다.
요즘은 isssue와 PR 주변의 기능을 충실히 하는 것이 우선이다.할 일은 많지만 열심히 하겠습니다.

최후

현재 설치된 기능을 대략적으로 소개하는 것이 어떻습니까?편하시다면 꼭 해보세요.issue에서 받아들여야 하기 때문에 이런 기능을 원합니다!그런 거 있으면 꼭 눌러주세요.탐구하다.
그리고 개발에 관심이 있다면 연락 주시면 감사하겠습니다.