Import Sorter는 Flutter용 개발자 도구로, 코드 내 Dart 임포트 문을 자동으로 정렬합니다. 일관된 순서로 임포트를 정리하여 가독성과 유지보수성을 향상시킵니다. 이 패키지는 Android, iOS, macOS, Windows, Linux 등 모든 주요 플랫폼을 지원하며 개발 워크플로우에 원활하게 통합됩니다. 간단한 명령어를 실행함으로써 미리 정의된 규칙에 따라 임포트 목록을 포맷할 수 있어 수작업을 줄이고 병합 충돌을 최소화할 수 있습니다. 프로젝트 간 일관된 코드 스타일을 유지하고자 하는 팀에게 이상적입니다.
🎯 Dart package to automatically organize your dart imports. Any dart project supported! Will sorts imports alphabetically and then group them in the following order:
Simply add import_sorter: ^4.6.0 to your pubspec.yaml's dev_dependencies.
🏃♂️ Running
Once you've installed it simply run flutter pub run import_sorter (pub run import_sorter if normal dart application) to format every file dart file in your lib, bin, test, and tests folder! Don't worry if these folders don't exist.
💻 Command Line
Add the -e flag to the run command and have emojis added to your imports 😄.
If you're using a config in the pubspec.yaml you can have the program ignore it by adding --ignore-config.
Want to make sure your files are sorted? Add --exit-if-changed to make sure the files are sorted. Good for things like CI.
Have no comments before your imports by adding the --no-comments flag.
Add the -h flag if you need any help from the command line!
You can only run import_sorter on certain files by passing in a regular expression(s) that will only sort certain files. Below are two examples:
pub run import_sorter bin/main.dart lib/args.dart (only sorts bin/main.dart and lib/args.dart)
pub run import_sorter lib\/* test\/* (only sorts files in the lib and test folders)
🏗️ Config
If you use import_sorter a lot or need to ignore certain files you should look at using the config you put in your pubspec.yaml. Ignored files are in the format of regex. This regex is then applied to the project root path (the one outputted to the terminal). Below is an example config setting emojis to true and ignoring all files in the lib folder:
import_sorter:emojis:true# Optional, defaults to falsecomments:false# Optional, defaults to trueignored_files:# Optional, defaults to []-\/lib\/*
There are two pre-commit hooks available: dart-import-sorter and flutter-import-sorter. They use pub run and flutter pub run respectively. Use the former for a generic Dart project and the latter for a Flutter project.
Using pre-commit hooks in your project:
Install and configure pre-commit.
Install and configure import_sorter using instructions above.
Add the following to the repos section of your .pre-commit-config.yaml:
-repo:https://github.com/fluttercommunity/import_sorterrev:'master'hooks:-id:dart-import-sorter# use `flutter-import-sorter` for a Flutter project
Run initial sort:
pre-commit run --all-files
🙋♀️🙋♂️ Contributing
All contributions are welcome! Just make sure that it's not an already existing issue or pull request.