Skip to main content

Command Palette

Search for a command to run...

VSCode에서 Format on Save가 동작하지 않는 것 처럼 보일 때

cmd+shift+p 를 눌러 "format document"를 눌러보자

Published
1 min read
VSCode에서 Format on Save가 동작하지 않는 것 처럼 보일 때

VSCode의 Format on Save

VSCode를 쓰고 프로젝트를 설정한 뒤, "Format on Save" 옵션을 아래와 같이 켜 둘 경우, 파일 내 변화가 발생한 뒤 저장할 경우 사전에 설정된 방식으로 포맷팅을 진행한다.

VSCode의 Format on Save 옵션, Python 파일 예시

위 사진과 같이, python 환경이 설정된 상태에서는, autopep8이나 black와 같은 Formatter를 설치하도록 안내한다.

*단, 해당 기능은 VSCode Python Extension이 설치되어있고 & 해당 프로젝트(폴더)에 대해 Python 환경(어떤 경로의 python을 사용하는지)이 설정되어있어야 한다.

VSCode에서 python 포매터가 설정되어있지 않은 경우, 설치 안내 팝업이 뜬다.

black이 가장 빡빡한 편이라, 여러 사람이 협업하는 환경에서는 가장 좋은 듯 하다.(개인적 경험)

Formatter도 설치되어있는데, 왜 Auto format이 안되지?

간혹 환경에 따라 formatter가 설치되어있는데도 Format on Save 기능이 동작하지 않는 경우가 있다.

이 경우는 많은 경우, VSCode에 내장된 Formatter와 외부(npm등)에 설치된 Formatter가 모두 존재해, 어떤 Formatter를 사용할지 지정되지 않았기 때문인 경우다.

이때는, 아래와 같이 커맨드 팔레트를 열어 > Format Document 메뉴를 선택하면, VSCode에 내장된 포매터 혹은 외부 포매터 중에서 선택할 수 있다.

image.png