Package selection guidance compiled from public package information, community data, and project usage.
Import Sorter is a developer tool for Flutter that automatically organizes Dart import statements in your code. It ensures imports are sorted consistently, improving readability and maintainability. The package integrates seamlessly into development workflows, supporting all major platforms including Android, iOS, macOS, Windows, and Linux. By running a simple command, developers can format their import lists according to predefined rules, reducing manual effort and minimizing merge conflicts. Ideal for teams enforcing consistent code style across projects.
Use cases
Automating import organization
Enforcing consistent code style
Reducing merge conflicts
Improving code readability
Streamlining team workflows
Key features
Automatic import sorting
Command-line integration
Supports multiple platforms
Prevents manual import errors
Integrates with Flutter workflows
Suitable for
Flutter teams
Code quality advocates
Large-scale projects
CI/CD pipelines
Developers prioritizing consistency
Considerations
Requires setup in project
May conflict with other formatters
Needs regular updates
Depends on correct configuration
Not suitable for one-off scripts
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
🎯 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.