Visual Studio Code で ESLint、Prettier、RuboCop、Solargraph、Jest、Babel、TypeScript などの設定ファイルのメンテコストを下げる戦略

前提

チームプロジェクトを「汚さない」ようにすることを前提とします。

結論

  • VS Code の「ユーザー」設定(一番上位に位置する包括設定)はなるべく変更しないようにします
  • 設定を変更する場合には「ワークスペース」ごとの設定を変更するようにします
    • 「ワークスペース」ごとの設定において、各種の実行ファイルの場所の設定や、参照される設定ファイルの場所を書きます
      • つまり、必要な部分だけ「ユーザー」設定の上書きをすることになります
  • 「ワークスペース」の設定ファイル、およびそれに付随する設定ファイルはプロジェクトを汚してしまわないよう、.git/info/exclude に書きます*1

補足

  • メンテコストを下げるために「疎」にする形です*2
  • ユーザーのローカルで完結する形で構成を考えます
  • 設定ファイルのひな形を dotfiles に入れておくと便利でしょう

備考

このあたりの設定の詳細については、一度がっつりと時間をとって丁寧に学ぶとそれ以降にずっと使えて武器になる知識となると思います。ただ、試行錯誤しながら設定を突き詰めていくことはそれなりのコストがかかります*3。既存の知見のコピペで済むことも多いですし、既存プロジェクトに設定ファイルが存在しているならばまずはそれに従っておけばいいとも思います。

特に、フロントエンドは Lint に限らず、設定ファイルが多すぎですからね……*4

*1:.gitignore ではなく

*2:これは、あらゆる分野に通じることかと思います

*3:私はそういう作業が好きですが

*4:そして Lint よりも重要な設定ファイルも多いですしね。最たる例は webpack

Powered by はてなブログ