エディタとしてVSCodeを用いる例は多いかと思います。自分もその1人です。 拡張や設定を自由にカスタマイズすることでストレスなく開発できるのが利点ですが、チーム開発においてはちょっとした足かせにもなり得ます。 今回は、拡張・設定を統一していなかったが故に遭遇したトラブルについてご紹介します。
VSCodeを用いたチーム開発開発者によってVSCodeの拡張機能や設定が異なり、特にPrettier等のコードフォーマッター周りの設定が異なると、各自が修正したかった箇所以外にも整形がかかります。
それだけなら問題ないのですが、マージ処理時に意図しない差分が発生してしまいます。
実例として、自分が遭遇したのは下記の例です。
format on saveが有効/無効になっている顕著なのがformat on saveの有無です。
これはVSCode上でファイルを保存した際に自動でフォーマットするかどうかの設定なのですが、開発チーム内でON/OFFの統一が取れていないと、
人によっては整形されている・いないが分かれてしまい、前述のような事象が発生します。
特に他チームからスポットでアサインしてもらう場合のように、VSCodeの設定が異なるメンバーが発生する場合はまずはじめにformat on saveをチェックするといいかと思います。
確認方法はVSCodeの【設定】から検索するか、Settings.jsonに下記の記載があるかで参照できます。
{
"editor.formatOnSave": true
}確実なのはSettings.jsonを共有することだと思います。
しかし、設定が異なるプロジェクトを並行して進めている場合も多いと思うので、ワークスペースの設定で対応するのが無難です。
ワークスペースの設定については、下記の記事が参考になります。
Qiita | プロジェクトごとにVSCodeの色とテーマを変えて気持ちを切り替える
今回はチーム開発でVSCodeを利用している場合に発生したコード整形のトラブルについて紹介しました。
ソースコートの品質を保つ意味でも、整形ルールは統一しておくといいかと思います。
Qiitaにも同様の記事を記載しました。