【Python】VSCode拡張機能をチーム内で共有したい

Pythonに限ったことではないですが、「チーム全体の生産性と開発環境の統一」のために、便利な方法をメモしておきます。

現代のモダンな開発現場では「必須」のプラクティスではないかと思います。

.vscode ディレクトリをGitで管理することで、新しくチームに入った人がリポジトリを git clone して VS Code で開いた瞬間、「推奨の拡張機能をインストールしますか？」と聞かれ、設定も自動適用されるようになります。

具体的に、PythonのVSCode拡張機能（型チェックやRuff）を含めた「最強のスタートキット」の作り方を見ていきましょう。
※あくまで例ということで参考にしてみてください。

1. 推奨拡張機能の共有 (extensions.json)

これを置いておくと、チームメンバーが VS Code でプロジェクトを開いた際に、右下に「このワークスペースには推奨の拡張機能があります」という通知が出て、ワンクリックでインストールできるようになります。

.vscode/extensions.json

ここには、各拡張機能のIDを記載します。
以下はわかりやすくコメントしていますが、JSONファイルなのでコメントは消しておいた方が良いと思います。
（※.vscode の中はコメントあっても特別に大丈夫という話も聞きますが…）

{
  "recommendations": [
    "ms-python.python",       // Python本体 & Pylance
    "charliermarsh.ruff",     // 先ほど紹介した最強のLinter/Formatter
    "tamasfe.even-better-toml" // pyproject.tomlを見やすくする（あると便利）
  ]
}

2. 設定の共有 (settings.json)

ここで、フォーマッターの指定を記述します。

ここでの設定は「ワークスペース設定」と呼ばれ、各個人の「ユーザー設定」よりも優先されます。つまり、メンバーが個人的にどう設定していようと、このプロジェクトを開いている間だけは、チームのルールが強制（適用）されます。

.vscode/settings.json

繰り返しになりますが、以下はわかりやすくコメントしていますが、JSONファイルなのでコメントは消しておいた方が良いと思います。

{
  // --- Pythonの基本設定 ---
  // 型チェックを「basic」で統一
  "python.analysis.typeCheckingMode": "basic",

  // --- フォーマッター(Ruff)の設定 ---
  // PythonファイルはRuffでフォーマットする
  "[python]": {
    "editor.defaultFormatter": "charliermarsh.ruff",
    "editor.codeActionsOnSave": {
      "source.organizeImports": "explicit" // 保存時にimport順序も直す
    }
  },
  
  // 保存した瞬間にフォーマットを掛ける
  "editor.formatOnSave": true,

  // --- その他のおすすめ設定 ---
  // 検索対象から除外するフォルダ（動作を軽くする）
  "search.exclude": {
    "**/__pycache__": true,
    "**/.venv": true
  }
}

3. Git運用の注意点

この運用をする際、.gitignore の設定に注意が必要です。

通常、.vscode フォルダ自体はGit管理に含めますが、個人のローカル環境に依存するファイルが含まれる可能性があるため、賢いチームは以下のように設定するようです。

.gitignore ファイルに追加

# .vscodeフォルダ内のすべてを一旦除外
.vscode/*

# ただし、チームで共有したいこの2つだけは許可（除外しない）
!.vscode/settings.json
!.vscode/extensions.json
!.vscode/launch.json 
# ↑ launch.json はデバッグ実行の設定です。これも共有すると喜ばれます。

もし、.gitignore がすでにあり、.vscode/ 全体が除外されている場合は、git add -f .vscode/settings.json のように -f (force) オプションを使えば強制的にコミットできます。
※使用には自己責任でお願いいたします。

まとめ

これは、コードを書く以前の「環境整備」という重要なタスクです。

1. ローカルで .vscode フォルダを作る。

2. 上記の内容でjsonファイルを作る。

3. VS Codeを再起動して、意図通り動くか確認する。

これができれば、「チームの環境を改善する人」です。