Zeal; IDE, 에디터에 도움말 (프로그램 언어, 함수, 명령어 사용법) 기능 넣기

0. Dash

Mac을 개발용으로 사용할 때, Dash라는 유료 프로그램을 오랫동안 사용했다. 자주 미국으로 다니면서 비행기에서 인터넷 없이 개발할 땐, 개발에 필요한 도움말 문서를 모두 노트북에 넣어 가면 편한데, Dash가 거기에 꼭 맞는 프로그램이었다.

Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli

 

Dash는

• 200 이상의 Docset이라는 도움말 / 참고문서와
• 100개 이상의 Cheat sheet이라는 명령어 도움말
• 각종 Language Script를 사용해서 직접 Docset을 만드는 방법
• 40여 가지의 IDE, Editor에 연결할 수 있는 Plugin

을 제공하고 있어, 오프라인에서 개발할 때뿐 아니라 온라인 개발할 때에도 인터넷에서 사용법을 찾는 수고를 줄여주는 매우 유용한 Mac용 개발 보조 도구이다. 물론 유료 프로그램이다.

 

윈도우에서는 Dash기능을 무료로 이용할 수 있는 Zeal이 있다.

1. Zeal

Dash와 유사하고, Dash에서 제공하는 도움말 / 참고문서인 Docset을 수정 없이 사용할 수 있는 윈도우용 프로그램이다.

Zeal - Offline Documentation Browser

Zeal을 사용하면, Java, Spring, Python, Django, Typescript, Node.js 등을 사용해서 개발할 때 필요한 함수나 명령에 대한 도움말을 인터넷을 뒤지지 않아도 된다. 물론 VSCode에 Hint로 팝업 되는 내용도 도움이 되지만, 공식문서를 참고하고 싶으면 브라우저를 열고 인터넷으로 찾아야 되는데, Zeal을 사용하면 VSCode에서 바로 공식문서를 띄우고 볼 수 있다.

 

Zeal을 설치하려면 공홈을 방문하고 윈도우용 설치프로그램(MSI)을 받아서 설치하거나,

 

아니면 간편하게 winget을 사용해서 설치하면 된다.

 

winget install OlegShparber.Zeal

 

설치가 끝나면, Zeal을 실행한 다음 Docset을 선택하고 설치한다. Python 3의 예를 보면,

 

Docset을 받고 나면, 파이썬을 개발할 때 사용하는 함수의 도움말뿐 아니라 가이드 문서까지 모든 공홈의 문서를 Zeal에서 볼 수 있다. Elasticsearch의 프로그램 Logging 할 때 참고했던 "Logging Cookbook"도 파이썬 Docset을 설치하면 쉽게 찾아볼 수 있다.

2. Vim / Neovim, VSCode 연결

Zeal은 프로그램을 실행하고 검색입력창(Search)에 찾고자 하는 함수, 명령어를 넣고 찾을 수도 있지만, VSCode나 Neovim으로 프로그램을 수정하다가, 바로 커서에 있는 클래스나 함수의 도움말 / 참고문서를 찾아볼 수도 있다.

a. Vim / Neovim 연결

vim은 .vimrc에 설정하고, 지난번에 소개한 vim의 다른 개선 버전인 Neovim은 % LOCALAPPDATA%\nvim\init.vim에 아래 내용을 추가한 다음 저장하고, command mode에서 gz를 입력하면 커서 밑의 단어를 Zeal의 docset에서 찾아 보여준다.

 

nnoremap gz :!zeal "<cword>"&<CR><CR>

 

Neovim에 대해 알고 싶으면 아래를 참고하면 된다

Neovim; DevOps에 최적인 vim 에디터를 업그레이드 해보자

b. VSCode 연결

VSCode에서 Zeal을 사용하려면 Dash extension을 설치하면 사용할 수 있다.

 

extension이 설치되면 문서를 열고 찾고자 원하는 클래스나 함수 이름 위에 커서를 옮기고 Ctrl + Alt + h를 누르면 Zeal 프로그램이 실행되고 커서 아래와 같이 곰식 참고문서의 내용을 찾아 보여 준다.