Visual Studio Code (VSCode)は、優れたカスタマイズ性を誇るエディタです。そのカスタマイズの要となるのが、settings.json
ファイルです。この設定ファイルを活用することで、開発環境を細かく調整し、プロジェクトごとに異なるニーズに応じた環境を構築することができます。
この記事では、VSCodeのsettings.json
を徹底解説し、プロジェクトごとの設定方法やおすすめのカスタマイズについて詳しく説明します。
[目次を開く]
settings.jsonとは?
settings.json
は、VSCodeの動作やエディタの見た目、動作を細かく設定するためのJSON形式の設定ファイルです。詳しくは以下を参照
settings.json
の場所
VSCodeで設定ファイルを直接編集する方法は簡単です。以下の手順でsettings.json
を開くことができます。
settings.json
の詳細と開き方については詳しく知りたい方は以下を参照してください。
ワークスペース設定
特定のプロジェクトにだけ設定を適用したい場合は、ワークスペースフォルダ内にある.vscode/settings.json
を編集します。
- プロジェクトを開き、左下のステータスバーにある「歯車アイコン」をクリックします。
- 「ワークスペース設定」を選択し、
settings.json
を編集します。
この方法で設定を追加すれば、他のプロジェクトには影響せず、現在のプロジェクトにだけ適用されます。
プロジェクトごとの設定方法
ワークスペースごとのsettings.json
を活用することで、プロジェクトごとに異なる開発環境を簡単に構築することができます。たとえば、JavaScriptプロジェクトでは特定のESLintルールを適用し、別のプロジェクトではPrettierを使用してコードを自動整形する、という設定が可能です。
以下は、プロジェクトごとの具体的な設定例です。
JavaScriptプロジェクトでの設定例
{
"editor.tabSize": 2,
"editor.formatOnSave": true,
"eslint.enable": true,
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript"
],
"prettier.singleQuote": true,
"prettier.trailingComma": "es5"
}
この設定では、以下のことが実現できます。
- タブサイズを2に設定
- ファイル保存時に自動でフォーマット
- ESLintの検証をJavaScript、TypeScriptで有効化
- Prettierでシングルクォートを使用し、末尾のカンマを適用
Pythonプロジェクトでの設定例
{
"python.pythonPath": "/usr/local/bin/python3",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.linting.flake8Enabled": true,
"editor.formatOnSave": true
}
この設定では、以下のことが実現できます。
- Pythonの実行パスを指定
- pylintとflake8の両方でコードのリントを実行
- 保存時に自動でフォーマットを適用
C++プロジェクトでの設定例
{
"C_Cpp.default.compilerPath": "/usr/bin/gcc",
"C_Cpp.intelliSenseEngine": "Tag Parser",
"editor.tabSize": 4,
"editor.formatOnSave": true
}
この設定では、以下のことが実現できます。
- GCCコンパイラをデフォルトとして使用
- IntelliSenseエンジンをTag Parserに設定
- 保存時に自動でフォーマット
おすすめのカスタマイズ設定
VSCodeでは、開発環境を最大限に活用するために、多くのカスタマイズ設定が可能です。以下は、特におすすめのカスタマイズ項目です。
エディタの基本設定
{
"editor.fontSize": 14,
"editor.tabSize": 2,
"editor.wordWrap": "on",
"editor.minimap.enabled": false,
"editor.cursorBlinking": "smooth"
}
- フォントサイズを14に設定
- タブのサイズを2に設定
- 単語の折り返しを有効化
- ミニマップを無効化
- カーソルの点滅をスムーズに
ファイル保存時の自動処理
{
"files.autoSave": "afterDelay",
"files.autoSaveDelay": 1000,
"files.trimTrailingWhitespace": true,
"files.insertFinalNewline": true
}
- 1秒の遅延で自動保存
- 行末の不要な空白を自動で削除
- ファイルの末尾に自動で改行を挿入
ターミナルの設定
{
"terminal.integrated.fontSize": 13,
"terminal.integrated.shell.windows": "C:\\Program Files\\Git\\bin\\bash.exe",
"terminal.integrated.cursorBlinking": true
}
- ターミナルフォントサイズを13に設定
- WindowsでGit Bashをデフォルトシェルに指定
- ターミナルカーソルの点滅を有効化
設定のエクスポートとインポート
VSCodeで設定をエクスポート・インポートすることで、別のPCやチームメンバーと同じ環境を共有することができます。settings.json
はGitリポジトリに含めることができるため、チーム全体で統一した開発環境を維持できます。
設定ファイルの共有方法
-
.vscode/settings.json
をプロジェクトルートに追加し、Gitにコミット。 - 他のメンバーがリポジトリをクローンすれば、同じ設定が適用されます。
まとめ
VSCodeのsettings.json
を活用することで、エディタの動作や見た目を自分好みに細かく調整できるだけでなく、プロジェクトごとに最適な設定を適用することが可能です。また、チームで共有することで、統一された開発環境を維持し、効率的に開発を進めることができます。
自分の作業スタイルやプロジェクトに合ったカスタマイズを行い、VSCodeをさらに使いやすいものにしてみてください。