🕯️

import_sorterを使ってみた

2024/04/21に公開

📕Overview

https://pub.dev/packages/import_sorter
🎯 Dart インポートを自動的に整理する Dart パッケージ。 あらゆるダーツプロジェクトをサポートします! インポートをアルファベット順に並べ替えて、次の順序でグループ化します。

ダーツの輸入

  1. フラッターインポート
  2. パッケージのインポート
  3. プロジェクトのインポート
  4. 以下に例を示します。

インストールしたら、flutter pub run import_sorter:main (通常の dart アプリケーションの場合は pub run import_sorter:main) を実行して、lib、bin、test、tests フォルダー内のすべてのファイル dart ファイルをフォーマットするだけです。 これらのフォルダーが存在しなくても心配する必要はありません。

🧷summary

import文がDartのモジュールだったり、パッケージだったり、プロジェクト内の他のフォルダからモジュールを読み込んでいますね。
配置するルールがあるそうです。どうやるのかというと、ライブラリを追加後にターミナルでコマンドを実行するだけで、並び替えるソートをやってくれます。

lintの警告が出ている状態ですね。

コマンドを実行してみる

flutter pub run import_sorter:main

このように綺麗に順番を並び替えてくれます。ルール通りと説明した方がいいかもしれないです。

🧑‍🎓thoughts

先程のコマンドを打つと、どうやら全てのファイルのimport文をルールが正しい順番に並び替えてくれるようです。effective-dartによると配置するルールが決まっているようですね。読むより見た方がいいかも。
Dartのimportが上の方で、Flutterのimportが上のようです。その下にDartnのパッケージのimportがきます。

https://dart.dev/effective-dart/style#ordering

Discussion