Visual Studio Code (이하 VSCode)은 Microsoft에서 개발 한 소스 코드 편집기입니다. Extension(확장 기능)을 추가하는 것으로 다양한 프로그래밍 언어에 대응 가능하고, 합쳐서 사용의 용이성도 향상시킬 수도 있습니다. 본 기사에서는 그런 VSCode의 Extension을 쉘과 Git을 이용해 관리하면 편리하게 된 이야기를 다룹니다.

배경

VSCode Extension은 VSCode를 시작하고 확장 프로그램에서 설치할 수 있습니다. 그러나 PC를 여러 대 소유하고 있는 경우나 교체시에 수작업으로 다시 넣는 것은 매우 번잡하고, 또한 누설도 발생합니다. 여러가지 조사해 보았던 곳, Extension의 인스톨은 커멘드에서도 인스톨 가능하다는 것을 알았습니다. 그 명령은 다음과 같습니다.

VSCode Extension을 설치하는 명령

code --install-extension EXTENSION_NAME

쉘 파일화로 자동화

상기의 커멘드를 기재한 쉘 파일을 작성해, Git로 관리하면 PC의 교체나 복구시에도 신속하게 개발 환경을 복구할 수 있습니다. Exstension은 자신이 설치하고 싶은 것을 기재하십시오. 그 때에 기재하는 이름은 아래 그림의 붉은 원 부분에 따라 기재해 주세요. 아래 그림은 확장 기능으로 Python의 Extension(MS사제)을 검색했을 때의 스크린 스크린샷입니다.



쉘 파일 내용의 예

#!/bin/bash

# Python用拡張機能
code --install-extension ms-python.python
code --install-extension tht13.python
code --install-extension kevinglasson.cornflakes-linter

Windows에 대응

회사의 개발 환경은 WSL@Windows10입니다. WSL상에서 VSCode는 실행할 수 있습니다만, 사용감이 헛소리이기 때문에, Windows상에 VSCode를 인스톨 하고 있습니다. Windows의 경우, 쉘의 실행에는 bat 파일을 사용하는 것이 일반적입니다만, 문법이 bash와는 달리, 필자는 아무래도 피부에 맞지 않습니다. 그래서 bat 파일도 자동 생성하기로 합니다.

Windows용 bat 파일 작성용 쉘 파일

#!/bin/bash

rm -f install_extensions.bat
# ユニコード対応化
echo "chcp 65001 && ^" > install_extensions.bat
# コメント部分, 空白行を除く, batの複数コマンド記述対応化
cat install_extensions.sh | grep -v '^#' | sed '/^$/d' | sed -e "s/\$/ \&\& \^/" >> install_extensions.bat
# Remote WSLを追加
echo "code --install-extension ms-vscode-remote.remote-wsl & ^" >> install_extensions.bat
echo "echo Finished! & ^" >> install_extensions.bat
# コマンドが終了しても画面が閉じないようにする
echo "pause" >> install_extensions.bat
# 改行コードをWindows用に
sed -i -e 's/$/\r/' install_extensions.bat >> install_extensions.bat

이러한 쉘 파일을 저장하는 Git 리포지토리에 .gitignore를 추가하고 *.bat와 추가하면 리포지토리에 실수로 추가되지 않도록합니다.

.gitignore 예제

*.bat

요약

VSCode의 Extension 설치를 자동화하고 관리를 돕기 위해 스크립트 파일을 만드는 방법을 소개했습니다. 현재 Linux/Unix계 OS상에서 주로 이용하는 것을 상정하고 있기 때문에, Windows를 메인으로 하고 있는 분에게는 조금 불친절한 내용일지도 모릅니다. . . 실제로 직장의 개발 환경(Windows10)상의 WSL상에서 쉘을 실행해, 완성된 bat 파일을 Windows상에서 실행한 곳, Extension의 인스톨이 자동으로 행해져, 순식간에 환경 구축을 할 수 있었습니다 했다.