導入
開発現場で「自分の環境では動いたのに、他のメンバーの環境ではエラーになる」「チームでコードフォーマットがバラバラでコミットログが汚れる」といった経験はありませんか？これらは、エディタ設定の不一致が原因であることがほとんどです。本記事では、IDEやエディタにおける「ユーザー設定」と「ワークスペース設定」の使い分けを理解し、チーム開発における環境統一を実現する方法を解説します。
基礎知識
多くのモダンなエディタ（VS Codeなど）には、大きく分けて2つの設定階層が存在します。
1. ユーザー設定 (User Settings)
PC全体のエディタ設定です。フォントサイズやテーマなど、個人が作業しやすい好みの設定を記述します。設定ファイルはPC内の隠しフォルダに保存されるため、チーム間で共有されることはありません。
2. ワークスペース設定 (Workspace Settings)
プロジェクト（フォルダ）単位で適用される設定です。プロジェクト直下の `.vscode/settings.json` というファイルで管理されます。このファイルはGitでバージョン管理できるため、チーム全員に強制的に同じルールを適用させることが可能です。
実装/解決策
プロジェクト固有の設定を共有するには、プロジェクトのルートディレクトリに `.vscode` フォルダを作成し、その中に `settings.json` を配置します。ワークスペース設定はユーザー設定よりも優先されるため、チーム独自のルールを確実に適用できます。
具体的な手順は以下の通りです。
1. プロジェクトルートに `.vscode` フォルダを作成する。
2. その中に `settings.json` を作成する。
3. チームで統一したいルール（インデント幅、保存時の自動整形など）を記述する。
4. `.vscode/settings.json` をGitに追加（コミット）する。
サンプルプログラム
以下は、プロジェクトごとにインデントを2スペースに固定し、保存時に自動でフォーマットを行うための設定例です。
{
// インデントを2スペースに固定
“editor.tabSize”: 2,
“editor.insertSpaces”: true,
// ファイル保存時に自動でフォーマットを実行（Prettierなどの拡張機能が有効な場合）
“editor.formatOnSave”: true,
// 特定の言語で特定のフォーマッタを強制する設定
“[javascript]”: {
“editor.defaultFormatter”: “esbenp.prettier-vscode”
},
// ファイル保存時に不要なインポートを自動削除
“editor.codeActionsOnSave”: {
“source.organizeImports”: “explicit”
}
}
応用・注意点
注意すべき点として、機密情報や個人のパスを含めないことが重要です。例えば、特定のユーザーのローカルパス（例: /Users/username/project/…）をワークスペース設定に書いてしまうと、他のメンバーの環境でエラーが発生します。ワークスペース設定は「誰の環境でも動く相対パスやプロジェクトルール」に限定してください。
また、チーム開発の際は、設定を強制するだけでなく「EditorConfig」を併用するのもおすすめです。`.editorconfig` を活用することで、VS Code以外のエディタを使用しているメンバーがいても、基本的なインデントルールなどを共有できるようになります。設定の競合を避け、快適な開発環境をチームで維持していきましょう。
コメント