vim 설정 글을 쓸 때, 꼭 있었으면 하는 내용

2022-12-23 au VimEnter * call Bye2022() 세미나에 참가할 때 5분 정도 얘기하려던 내용인데, 게으르게 신청하다보니 매진 되어버렸습니다. (vim관련 세미나가 이렇게 금방 매진 되다니!) 그래서, 한쪽으로 치워 두고 잊을만한 글로 생각했는데, 읽어보니 뭐, 그런대로 말이 되는 것 같아 옮겨 둡니다.

오래 전부터 리눅스 설치/설정 문서들을 봐 오면서, 특히 도움이 됐던 문서들은 아래 항목들이 들어가 있는 문서들이었습니다. vim 문서도 마찬가지입니다. 물론 저도 잘 지키지 못하는 어려운 가이드입니다.

2022-12-24 추가

추가 인원으로 참여 확정되어 어제 다녀 왔습니다. 발표자로 마지막까지 공지되지 않아, 발표는 안 하는 걸로 알고 가벼운 마음으로 갔다가, 20분 정도 발표하게 되었습니다. 뭐, 특별할 것도 없는 내용인데, 다행히 공감을 표시해 주는 분들이 많아 즐겁게 발표했습니다. 아래는, 준비했던 발표 자료입니다.
“Vim 잘 쓰게, 잘 쓰는 법” 슬라이드

국내 vim 유저들 사이에서 기본 방문하는 곳인가 본데, 전 이제야 알았습니다.
행사 주최측이며, 첫 번째로 발표하신 이종립님의 블로그입니다. 개발에 대한 애정이 묻어 있는 글들이 많습니다.
기계인간 John Grib

명확한 버전 표시

vi, vim, neovim, vim9 생태계가 호환이 안되는 부분이 있을 수 있습니다. 어느 버전에서 돌아가는지 명확히 알지 못하면, 현재 자신의 환경만이라도 명시해 주는 것이 필요합니다. 더불어 각기 조금씩 다른 Vim들에서 사용하는 플러그인이 조금씩 다르기도 하고, 같은 걸 쓰더라도 설정이 다르기도 합니다.

설정파일 위치를 알려주기 보단, 찾는 방법을

보통 “config 파일을 수정한다”라고만 쓰는데, 배포판이나 사용 환경에 따라 설정 파일 위치는 달라질 수 있습니다. 설정 파일 위치만 알려주기 보다는 설정 파일을 찾는 방법을 알려주면 좋습니다. 메인 설정 파일 뿐만 아니라, 플러그인들이 추가로 필요하는 설정 파일이 있다면, 어디에서 결정하는지 알려주는 것도 좋습니다.

예) neovim의 설정 파일 위치는 :echo stdpath("config")로 알 수 있습니다.

단순 따라하기 보단 명령어 뜻도 같이

명령어를 무조건 따라하기식으로 남겨 두기 보다는, 간단하게나마 명령어들의 뜻을 알려준다면, 나중에 응용할 수 있는 응용력이 차곡 차곡 쌓일 수 있습니다. 가능하다면 현재 왜 이런 명령어를 쓰고 있는지 컨텍스트도 같이 알려주면 좋습니다.

예) :source % 라고만 언급하지 않고, “%는 파일의 처음과 끝을 의미한다”를 알려줍니다.

설치가 잘 됐는지 확인하는 방법

설치를 하고 나면, 잘 설치가 됐는지 확인하는 방법을 써 줍니다. 눈에 바로 보이는 플러그인이 아닌 경우, 의외로 필요한 항목입니다.

예)

• Telescope플러그인 관련 명령어를 보려면 :Te<tab> 적당한 앞글자를 치다 tab을 누르면 가용 명령어를 보여줍다. (외부 플러그인의 명령어는 주로 대문자로 시작합니다.)
• :command로 전체 명령어를 볼 수 있습니다.
• 특정 상황, 이벤트에 따라 자동 활성화 되는 플러그인이라면 :autocmd로 자동 활성화 등록이 되어 있는 모든 명령들을 볼 수 있습니다.
• 단축키로 동작할 경우, 제대로 단축키 등록이 되었는지 :verbose map을 통해 확인할 수 있습니다.

설치가 안 됐을 때, 해결 실마리를 얻는 방법

특히, 설치가 잘 안됐을 때 힌트를 얻을 방법을 써 준 문서가 좋았습니다.

외부 바이너리가 필요할 때, 해당 바이너리가 있는지, 작동하는지 확인하는 방법을 써줍니다.

예) Coc과 HLS설치

:CocCommand workspace.showOutput
:CocOpenLog
:messages

위 명령어들을 통해 로그를 볼 수 있고, 콘솔 환경에서 바로 HLS를 standalone으로 실행해서 정상 작동하는지 확인 할 수 있습니다.

오래전 리눅스에 여러가지 설정, 설치하는 문서들을 볼 때, 가장 반가웠고 쓸모 있던 문서들이 문제가 생기면 어떻게 해결 실마리를 찾을 수 있는가를 알려주는 문서였습니다. 위 가이드 중 가장 중요한 하나를 뽑자면 마지막 실마리를 알려주는 것을 뽑겠습니다. 항상 아무 일 없이 똑같이 돌아가는 설정은 드뭅니다.

많이 써본척 얘기했지만 vim관련 글은 딱 한 번 써봤습니다. vi, vim을 쓴지는 오래됐지만, 본격 프로그래밍 IDE로 풀 셋팅을 하고 쓴지는 얼마 안됐습니다.

https://lionhairdino.github.io/posts/2022-07-02-vim.html

쓰고나서 보니, 매 번 올릴만한 내용이 아닌 것도 포함되어 있긴 합니다.