Hun Nginx 설정 닥터

nginx 설정의 컨텍스트를 읽는 진단 · 자동완성 · hover 문서
_{Context-aware diagnostics, IntelliSense and hover docs for nginx configuration files}

기능 · 지원 파일 · 설정 · 알려진 제한 · 릴리스 노트

🚀 설치

VS Code 에서 Ctrl+P (macOS Cmd+P) 를 누르고 아래를 붙여 넣으세요.

ext install buddham-hq.nginx-conf-doctor

👀 이렇게 알려 줍니다

server {
    worker_processes 4;   # ⚠ 'worker_processes' 는 이 위치(server)에서 쓸 수 없습니다
    listen 80
    server_name example.com;   # ✖ 앞 줄에 세미콜론(;)이 빠졌습니다
}

nginx 설정 파일(nginx.conf, conf.d/*.conf 등)을 편집할 때 구문 강조, 오류 진단, 자동완성, hover 문서를 제공하는 VS Code 확장입니다.

단순히 색만 입히는 것이 아니라, 지시어가 어느 컨텍스트(http, server, location 등)에 쓰였는지를 읽어서 "이 위치에서는 쓸 수 없는 지시어"까지 알려 줍니다.

✨ 주요 기능

구문 강조

• nginx 전용 TextMate 문법으로 지시어, 변수, 문자열, 주석을 구분해 표시합니다.
• Lua 블록(*_by_lua_block 등)은 내부를 Lua 문법으로 강조합니다.

진단 (Diagnostics)

저장하기 전에, 입력하는 즉시 문제를 표시합니다.

지시어 데이터를 읽지 못하는 경우에도 구조 진단(중괄호/세미콜론/따옴표)은 계속 동작합니다.

빠른 수정 (Quick Fix)

진단된 문제 위에서 Ctrl+. (macOS Cmd+.)로 제안되는 수정을 적용할 수 있습니다.

자동완성

현재 컨텍스트에서 사용할 수 있는 지시어를 제안합니다.

Hover 문서

지시어에 마우스를 올리면 설명을 볼 수 있습니다.

📂 지원 파일

아래 파일은 자동으로 nginx 언어로 인식됩니다.

• 파일명: nginx.conf, mime.types, fastcgi_params, scgi_params, uwsgi_params
• 확장자: .nginx, .nginx.conf
• 경로 패턴: **/nginx/**/*.conf, **/conf.d/*.conf, **/sites-available/*, **/sites-enabled/*, **/snippets/*.conf

그 밖의 파일은 우측 하단 언어 모드에서 Nginx를 직접 선택하면 됩니다.

⚙️ 설정

예: 서드파티 모듈 지시어 허용

{
  "nginx-conf-doctor.extraDirectives": [
    "more_set_headers",
    "brotli",
    "brotli_types"
  ]
}

📋 요구 사항

• VS Code 1.90.0 이상

⚠️ 알려진 제한

• nginx를 실제로 실행해서 검사하는 도구가 아닙니다. 최종 검증은 서버에서 nginx -t로 하세요.
• include로 불러오는 다른 파일의 내용은 분석하지 않습니다.
• 서드파티 모듈 지시어는 extraDirectives에 등록해야 경고가 사라집니다.

🛠️ 개발

npm install

npm run gen:grammar      # 구문 강조 문법 생성
npm run gen:directives   # 지시어 데이터 생성
npm run check            # 설정 파일 점검 스크립트
npm run mutate           # 변이 검사
npm run test:unit        # 단위 테스트

패키징은 아래 명령을 사용합니다.

npx vsce package

📝 릴리스 노트

0.0.2

• 아이콘 및 마켓플레이스 소개 페이지 정비

0.0.1

• 최초 릴리스
• 구문 강조, 구조/컨텍스트/알 수 없는 지시어 진단, 빠른 수정, 자동완성, hover 문서

📄 라이선스

MIT