【VS Code】拡張機能などの設定ファイルを共有して共同開発を快適にする方法

概要

インデントがタブやスペースにしてなど基本的にコーディング規則に準拠すればいいですが、VS Codeで異なるプログラミング言語で書いているとうまく反映できなかったりして他人に指摘されたりします。そのようなことをなるべく避けるためにバージョン管理しておくと良いファイルを考えてみます。

VS Codeの設定ファイルについて

ためにプロジェクト直下に生成されている.vscodeが設定ファイルの置き場所です。

よく.gitignoreの対象になっていたりしますが今回はこの中のファイルで共有しておくことになります。

  • extensions.json
  • settings.json

推奨拡張機能を共有する

  • extensions.json

こちらを設定共有しておくとプロジェクト単位（ワークスペース）の推奨拡張機能を設定できます。

{
  "recommendations": [
    "ms-python.black-formatter", 
    ...
  ]
}

のように記載

名前がわからないので正しく追加する場合

  • インストールを推奨したい拡張機能のページにアクセスする（今回はBlack Formatterを例にする。）
Black Formatter - Visual Studio Marketplace
Extension for Visual Studio Code - Formatting support for Python files using the Black formatter.
marketplace.visualstudio.com
  • コマンドパレットを呼び出し「推奨」で検索して「拡張機能：ワークスペースフォルダーの推奨事項に拡張機能を追加する」を選択
  • 日本語ではない場合は「Add Ex」
  • 設定ファイルが追加される
{
  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp

  // List of extensions which should be recommended for users of this workspace.
  "recommendations": ["ms-python.black-formatter"],
  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
  "unwantedRecommendations": []
}

新規開発者が推奨拡張機能をインストールしたい場合

  • 拡張機能の推奨を表示
  • ワークスペースで推奨されている拡張機能をインストール

たまに右下にもでるのでそれでも問題ない。

ワークスペースの設定を共有する

  • settings.json

例：推奨機能にしたBlack Formatterの設定を変更して共有

こちらの記事で書かれている設定改行する長さを変更する場合

【VS Code】拡張機能でpythonのフォーマッターであるBlack Formatterを使用してフォーマットする
概要最近blackというものが流行っておりVS Codeでも使用できるようになったので利用する。変更点2023/11/03 VSCodeで勝手に改行される場合や改行されたくない場合に対しての設定も追記拡張機...
im0039kp.jp
2023.01.05
  • ワークスペースで設定を変更しておくとsettings.jsonに反映される。
{
  "black-formatter.args": ["--line-length=120"]
}

タブを変更する場合

  • 「editor.tabSize」で検索
{
  "black-formatter.args": ["--line-length=120"],
  "editor.tabSize": 2
}

ほかの設定も変更すると反映される。

.gitignoreの無視リストから除外する

.vscodeの中にほかの設定ファイルも自動生成されるので一度.vscodeの中をすべて無視して特定のファイルのみ除外するという設定を行う

.vscode/*
!extensions.json
!settings.json

おわりに

改行コードなどはコピーすると既存の改行コードに合わさられる可能性があるので

.gitattributes

などで設定を確実にすると良いかも。

コメント