ユニフェイスの開発者ブログ

はじめに

Prettier のコード整形はとても強力。
チームで開発する際には特に便利ですよね。

とはいえ、どうしても一部ファイルだけを整形対象から除外したい場面にも直面するわけです。
例えばMarkdownのファイルとか、システムで自動的に出力したTSファイルとか。

そうした時の対処法を調べてみました。

Visual Studio Code の設定ファイルに除外対象を記載する方法

ルートフォルダの直下に .vscode フォルダに保存されている settings.json に設定を追加する方法です。
例えば、Markdownのファイルを対象外にするならこんな感じです。

{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "[markdown]": {
    "editor.formatOnSave": false
  },
}

[] にファイルタイプを指定することで、該当する種類のファイルは整形対象外となります。

しかしこれはファイル単位なので、例えば特定のフォルダに保存されているファイルだけを整形対象外にする、ということができません。

そこでもう一つの方法です。

.prettierignore ファイルを追加する

.prettierignore というファイルを用意して、そこにパスを書けば、特定のフォルダ以下を～というワガママも実現できます。
例えば srcフォルダ配下のfeaturesフォルダに含まれるファイルは整形対象から外す場合はこんな感じです。

/src/features/*

Prettier の公式ドキュメントはこちら

これだけでOK。

さいごに

コードの品質を保つためには、基本的に整形対象とすべきではあるんですが、諸事情でどうしても……という場合にはとても有難い方法なので備忘録として残しておきます。