에디터 편집 화면이나 좌측 탐색기 파일 목록에서 마우스 오른쪽 버튼을 클릭하여 적합한 포맷을 빠르게 실행할 수 있습니다:
SQL 파일 (.sql): 우클릭 시 Format SQL 메뉴가 노출되며, 즉시 해당 파일에 포맷을 적용하고 저장합니다.
XML 파일 (.xml): 우클릭 시 Format SQL (MyBatis) 및 문서 생성 (.md) 메뉴가 노출됩니다.
Format SQL (MyBatis) 기능을 실행하면, 해당 파일에 포맷을 적용하고 저장합니다.
문서 생성 (.md) 기능을 실행하면, Mapper XML에 달린 설명 주석 및 입출력 주석(또는 쿼리 분석을 통해 자동 추론된 파라미터 정보) 기반으로, 동일한 경로에 해당 파일 명의 마크다운(.md) 문서를 즉시 생성합니다.
하단 상태 표시줄 (Status Bar) 연동
VS Code 우측 하단 상태 표시줄에 DevPro SQLFormatter 표시가 활성화됩니다.
이 표시를 클릭하면 언제든지 DevPro SQLFormatter 웹뷰 제어판 패널 화면을 간편하게 열 수 있습니다.
명령 팔레트 (Ctrl + Shift + P 또는 F1)
DevPro SQLFormatter: Format SQL: 현재 에디터 내용 혹은 선택 영역을 포맷합니다.
DevPro SQLFormatter: Format SQL (MyBatis): 현재 MyBatis XML 문서를 포맷합니다.
DevPro SQLFormatter: 문서 생성 (.md): 현재 MyBatis Mapper XML에 대응하는 마크다운 개발 문서를 생성합니다.
DevPro SQLFormatter: Copy Formatted SQL: 포맷한 결과를 클립보드에 복사합니다.
DevPro SQLFormatter: Open Webview: DevPro SQLFormatter 웹뷰 제어판을 엽니다.
사용자 설정 옵션 및 설정창 사용법
VS Code의 전역 설정 화면(Ctrl+,) 또는 settings.json을 통해 옵션을 제어할 수 있으며, 대화형 웹뷰 UI 우측 상단의 ⚙️ 설정 버튼을 클릭하여 통합 설정 모달창을 통해 편리하게 변경할 수 있습니다.
⚙️ 설정 모달창 주요 기능
일괄 설정 및 동기화: 11가지 포맷 옵션을 한 화면에서 설정하고 저장을 누르면 VS Code 사용자 설정(settings.json)에 즉각 자동 반영됩니다.
실시간 요약 표시: 웹뷰 헤더 영역에 핵심 포맷팅 스타일(쉼표 위치, 예약어 정렬, 대소문자 변환, 들여쓰기 크기)이 직관적인 한글 요약 문구로 상시 표시됩니다.
도움말 툴팁: 각 설정 옵션 옆의 ? 아이콘에 마우스를 올리거나 클릭하면 옵션에 대한 상세 설명 및 예시가 담긴 말풍선 도움말이 제공됩니다.
스마트 옵션 비활성화: MyBatis XML 지원을 해제할 경우, 관련 하위 옵션인 MyBatis SQL 추가 들여쓰기가 화면 레이아웃의 흔들림 없이 비활성화(반투명 및 클릭 불가능) 상태로 자동 전환됩니다.
가독성 높은 테마 및 UI: VS Code 에디터 기본 폰트 크기(0.9rem)와 조화롭게 구성되어 높은 가독성을 제공하며, 은은한 배경 흐림(Blur 3px) 및 반투명(Overlay Opacity 0.1) 효과를 적용하여 뒷배경의 코드 상태를 확인하면서 설정을 조율할 수 있습니다.
설정 옵션 목록
설정 한글 명칭
설정 키
타입
기본값
설명
콤마 위치
devproSqlFormatter.commaPosition
string
"leading"
SQL SELECT 절 등에서 콤마(,)의 정렬 위치를 결정합니다. ("leading": 앞 콤마, "trailing": 뒷 콤마)
예약어 정렬
devproSqlFormatter.riverAlign
boolean
false
true로 설정 시 SQL 키워드를 오른쪽으로 정렬(8자 고정폭 패딩)합니다.
MyBatis XML 지원
devproSqlFormatter.mybatisSupport
boolean
true
MyBatis XML 파일 내 동적 SQL 태그와 CDATA 영역을 감지하여 포맷팅을 지원합니다.
MyBatis SQL 추가 들여쓰기
devproSqlFormatter.mybatisIndent
boolean
true
MyBatis XML 태그 내부의 SQL 블록에 대해 들여쓰기 한 수준(설정 크기)을 더 적용합니다.
대소문자 변환
devproSqlFormatter.caseMode
string
"upper"
예약어/함수의 대소문자 변환 설정 ("upper", "lower", "preserve")
들여쓰기 크기
devproSqlFormatter.indentSize
number
4
SQL 및 XML 들여쓰기 적용 시 사용할 공백 칸 수를 지정합니다.
MyBatis XML 자동 감지
devproSqlFormatter.autoDetectMyBatis
boolean
true
XML 파일 열기 및 저장 시 MyBatis Mapper 파일인지 감지하여 포매터를 자동으로 연결합니다.
상태 표시줄 표시
devproSqlFormatter.showStatusBar
boolean
true
VS Code 에디터 우측 하단 상태 표시줄에 DevPro SQLFormatter 피드백 상태 표시기를 노출합니다.
입출력 주석 자동 삽입
devproSqlFormatter.addInOutComments
boolean
true
SQL 구문의 변수(INPUT)와 컬럼 별칭 및 주석(OUTPUT) 정보를 분석하여 쿼리 상단에 주석으로 자동 삽입합니다. (단, MyBatis Mapper XML의 SQL 블록에만 적용됩니다.)
입출력 주석 위치
devproSqlFormatter.inOutCommentPosition
string
"outside"
자동 생성된 입출력 주석을 SQL문 내부(Inside) 또는 MyBatis XML 태그 외부(Outside) 중 어디에 배치할지 결정합니다.
저장 시 자동 포맷
devproSqlFormatter.formatOnSave
boolean
true
파일을 저장할 때 자동으로 포맷팅을 실행합니다. 비활성화 시 명시적으로 우클릭 또는 명령어로만 작동합니다.
