Nginx.conf 파일을 Vim으로 편집할 때 Syntax Highlight 표시하기

Nginx를 설치하면 설정파일을 수정하기 위해 /etc/nginx/nginx.conf 파일을 자주 열게 될 것입니다.

그런데 언제부턴가 우분투(Ubuntu)에서 nginx 설정 파일을 vim으로 열면 문법 강조가 되지 않고 죄다 회색으로 나오고는 했습니다. 아래와 같이 말이죠.

이렇게되면 어디가 속성이고 어디가 값인지 헷갈려질 뿐만 아니라 가독성이 떨어지고 보기에 답답해집니다. 그렇다면 어떤 방법으로 nginx.conf 파일의 문법 강조(Syntax Highlighting)을 활성화할 수 있을까요?

Vim nginx.conf Syntax highlighting 활성화 방법

문법 강조를 활성화하기 위해서는 .vim에 정의된 문법 강조 파일을 넣어주면 됩니다. 마치 플러그인을 설치하듯이 구성을 만들어주는 것인데, 이를 쉽게 적용하기 위해 GitHub에서 제공되는 스크립트 파일이 공유되고 있습니다.

• 스크립트 제공 링크: https://gist.github.com/ralavay/c4c7750795ccfd72c2db

이 스크립트를 사용하기 전에 OS에 wget 패키지가 설치되어있어야 합니다. 만약 wget 명령어가 존재하지 않는다면 아래 명령어로 wget을 설치해주셔야 합니다. (Debian/Ubuntu는 apt, CentOS/RedHat은 dnf를 주로 사용합니다.)

# apt install wget

다음으로 아래 내용을 모두 복사해주세요. (위 링크의 스크립트 내용과 동일합니다.)

#!/bin/bash
#
# Highligh Nginx config file in Vim

# Download syntax highlight
mkdir -p ~/.vim/syntax/
wget http://www.vim.org/scripts/download_script.php?src_id=19394 -O ~/.vim/syntax/nginx.vim

# Set location of Nginx config file
cat > ~/.vim/filetype.vim <<EOF
au BufRead,BufNewFile /etc/nginx/*,/etc/nginx/conf.d/*,/usr/local/nginx/conf/* if &ft == '' | setfiletype nginx | endif
EOF

이제 아래 명령어를 사용하여 새 스크립트 파일을 만들어줍니다. 스크립트 파일명은 아래 예시와 같지 않아도 됩니다.

$ vim add_syntax_highlight.sh

이제 위에서 복사한 내용을 붙어넣습니다. 완료했다면 파일을 저장하고 나와줍니다.

이 과정이 끝났다면 스크립트를 실행할 수 있도록 권한을 추가해줍니다. 아래 명령어를 실행해주세요.

$ chmod +x add_syntax_highlight.sh

이제 해당 스크립트를 실행해보겠습니다.

$ ./add_syntax_highlight.sh

그러면 다음과 같이 스크립트가 실행되면서 작업이 완료될 것입니다.

$ ./test.sh 
--2021-06-03 11:53:31--  http://www.vim.org/scripts/download_script.php?src_id=19394
Resolving www.vim.org (www.vim.org)... 44.237.4.221
Connecting to www.vim.org (www.vim.org)|44.237.4.221|:80... connected.
HTTP request sent, awaiting response... 302 Found
Location: https://www.vim.org/scripts/download_script.php?src_id=19394 [following]
--2021-06-03 11:53:32--  https://www.vim.org/scripts/download_script.php?src_id=19394
Connecting to www.vim.org (www.vim.org)|44.237.4.221|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: unspecified [application/octetstream]
Saving to: ‘/root/.vim/syntax/nginx.vim’

/root/.vim/syntax/nginx.vim                             [ <=>                                                                                                               ]  28.85K  --.-KB/s    in 0.1s    

2021-06-03 11:53:32 (231 KB/s) - ‘/root/.vim/syntax/nginx.vim’ saved [29542]

이제 다시 파일(/etc/nginx/nginx.conf)을 열어보겠습니다. 아래와 같이 문법이 제대로 강조되어 표시되고 있습니다. (사진의 색상은 터미널 설정값에 따라 조금 다르게 보일 수 있습니다.)

이제 사용했던 스크립트 파일은 삭제해도 됩니다.