バッテラが如く

いつもお世話になっております。

【Flutter】チームでコーディングスタイルを統一する方法 (Settings WorkSpace)

この記事の情報は次のバージョンで動作確認しています。

  • MacOS Monterey (12.1)
  • VSCode (v1.67.2)
  • Flutter

    はじめに

    VSCodeではコーディングスタイルを設定することができます。個人ならどうでもいいですが、会社でコーディングスタイルが個々で異なると地獄です。

    上書き保存するたびに勝手に書き換えがされて更新がないはずのなのに差分が出てしまいます。Gitなどのバージョン管理ソフトを使っていると非常にやっかいなんです。

    ということで、今回はコーディングスタイルをチーム全員で統一するためにはどうしたらいいかを共有したいと思います。

    コーディングスタイルを設定するには?

    ⌘ + ,(カンマ) で「Settings」を開きます。

    検索窓で「Dart」と検索しFlutter関連のコーディングスタイルを変えます。

    「User」「WorkSpace」の2つのタブがあると思います。

    どちらも同じ設定ができるのですが、「WorkSpace」の方で設定しましょう。

    「User」はプロジェクトフォルダ外に生成されるのでコミットできません!これは自分用です。

    settings.jsonをコミットする

    コーディングスタイルを変更すると settings.json が生成されます。

    jsonの中身はこんな感じでになってます。

    このファイルをコミットすれば他のメンバーが自分と同じ設定になります。