【prettier-plugin-organize-imports】を使用してimport 文を自動フォーマットする

はじめに

この記事は【prettier-plugin-organize-imports】の導入方法の備忘録である。
github

導入方法

1. インストール

以下コマンドを実行する。

npm install --save-dev prettier-plugin-organize-imports

2. 設定ファイル(prettier.config.js)にプラグインをロードする

設定ファイル(prettier.config.js)に以下の記述を追加する。

module.exports = {
  //...
  plugins: ['prettier-plugin-organize-imports'],
};

【prettier-plugin-organize-imports】とは

TypeScript ( or JavaScript ) コードにある import 文を自動フォーマットする Prettier のプラグインである。
ここでいうフォーマットは主に以下の 3 つの挙動を意味する。

1. import 文をアルファベット昇順でソート
2. 冗長に書かれた import 文を結合
3. インポートされたモジュールのうち未使用のものを削除する