tidy_imports 2.2.0
tidy_imports: ^2.2.0 copied to clipboard
Automatically organize your Dart imports. Sorts and groups dart, flutter, package, and project imports alphabetically. Spiritual successor to import_sorter.
████████╗██╗██████╗░██╗░░░██╗ ██╗███╗░░░███╗██████╗░░█████╗░██████╗░████████╗░██████╗
╚══██╔══╝██║██╔══██╗╚██╗░██╔╝ ██║████╗░████║██╔══██╗██╔══██╗██╔══██╗╚══██╔══╝██╔════╝
░░░██║░░░██║██║░░██║░╚████╔╝░ ██║██╔████╔██║██████╔╝██║░░██║██████╔╝░░░██║░░░╚█████╗░
░░░██║░░░██║██║░░██║░░╚██╔╝░░ ██║██║╚██╔╝██║██╔═══╝░██║░░██║██╔══██╗░░░██║░░░░╚═══██╗
░░░██║░░░██║██████╔╝░░░██║░░░ ██║██║░╚═╝░██║██║░░░░░╚█████╔╝██║░░██║░░░██║░░░██████╔╝
░░░╚═╝░░░╚═╝╚═════╝░░░░╚═╝░░░ ╚═╝╚═╝░░░░░╚═╝╚═╝░░░░░░╚════╝░╚═╝░░╚═╝░░░╚═╝░░░╚═════╝░
A Dart CLI tool that automatically organizes your import statements — sorted alphabetically and grouped by origin (Dart, Flutter, package, project).
Spiritual successor to import_sorter,
rebuilt for Dart 3+ with bug fixes, new flags, custom import tiers, pubspec.yaml
sorting, and monorepo support.
How it works #
Imports are grouped in this order and sorted alphabetically within each group:
- Dart imports (
dart:) - Flutter imports (
package:flutter/) - Package imports (
package:) - Project imports (relative or
package:<your_package>/)
Before #
import 'package:flutter/material.dart';
import 'package:provider/provider.dart';
import 'dart:io';
import 'package:myapp/home.dart';
import 'dart:async';
import 'package:intl/intl.dart';
import 'another_file.dart';
After #
// Dart imports:
import 'dart:async';
import 'dart:io';
// Flutter imports:
import 'package:flutter/material.dart';
// Package imports:
import 'package:intl/intl.dart';
import 'package:provider/provider.dart';
// Project imports:
import 'package:myapp/home.dart';
import 'another_file.dart';
Installation #
tidy_imports is a tool you run over your source, never something your app
imports at runtime. It belongs in dev_dependencies — put it in
dependencies and you ship a sorting tool inside your app.
In a project (recommended) #
dart pub add dev:tidy_imports
Flutter projects use flutter pub add dev:tidy_imports. Either way it lands in
the right section, at the current version:
dev_dependencies:
tidy_imports: ^1.5.0
Then, from the project root:
dart run tidy_imports
This is the form to prefer: the version is pinned in pubspec.yaml, so your
machine, your teammates' machines and CI all sort with the same rules.
Globally #
dart pub global activate tidy_imports
tidy_imports
Good for a one-off run on a project you do not want to touch the pubspec.yaml
of. The version is whatever you activated last, which is exactly why it is the
second choice.
Usage #
# Sort every dart file in the project
dart run tidy_imports
# Sort specific files
dart run tidy_imports lib/main.dart lib/app.dart
# Sort one folder
dart run tidy_imports "lib/features/"
# Preview changes without writing (dry run)
dart run tidy_imports --dry-run
# CI: fail if any file is unsorted
dart run tidy_imports --exit-if-changed
Choosing which files to sort #
A positional argument is a regular expression, matched against each file's path — not a shell glob. Two things follow from that:
dart run tidy_imports "lib/features/" # every file under lib/features
dart run tidy_imports "_test\.dart$" # only test files
dart run tidy_imports "lib/a/" "lib/b/" # several patterns: any match wins
Write patterns with forward slashes on every platform, Windows included — paths are normalised before matching. With no pattern, the whole project is sorted.
What is on by default #
Almost nothing. tidy_imports sorts and groups your imports and changes
nothing else about the file unless you ask it to — no deleting, no rewriting,
no touching pubspec.yaml.
| On by default | Why |
|---|---|
Group comments (// Dart imports: …) |
The point of the tool. --no-comments drops them |
| Blank line between groups | Readability. --no-blank-lines drops it |
| Blank line before relative project imports | Not taste — see below. --no-separate-relative-imports drops it |
Everything else — sorting exports, sorting pubspec.yaml, grouping by folder,
splitting out test doubles, removing duplicates, removing unused imports, flat
ordering, relative rewriting — is off until you turn it on, by flag or by
config key. Every flag is negatable, so a config file is never the last word:
--no-<flag> overrides it for one run.
Why that third one is on #
Since Dart 3.13, dart format puts a blank line between the package: and
relative sections itself. With this off, tidy_imports removes the line and
dart format puts it back, forever — every run of either tool produces a diff
(issue #1). Turning it on by default is a bug fix wearing the clothes of a
preference.
It does nothing when you have no relative project imports, and it is suppressed
entirely under --no-blank-lines. If your project pins Dart below 3.13 and you
prefer the tighter output, --no-separate-relative-imports or
separate_relative_imports: false restores it.
Options #
| Flag | Short | Description |
|---|---|---|
--emojis |
-e |
Add emojis to import group comments |
--no-comments |
Omit group comments entirely | |
--no-blank-lines |
Omit blank lines between import groups | |
--blank-lines |
Force them back on, over a config that disabled them | |
--sort-pubspec |
Also sort pubspec.yaml dependencies alphabetically |
|
--sort-exports |
Also sort export directives into their own block |
|
--group-by-folder |
Separate project imports by subfolder | |
--group-by-folder-depth=<n> |
Folder segments to group project imports by (0 = whole path; above 0 implies --group-by-folder) |
|
--test-imports |
Group project test doubles (fake_/mock_) separately |
|
--flat |
One alphabetical run per section, no groups — what directives_ordering expects (off by default) |
|
--relative-imports |
Rewrite own-package imports as relative paths (off by default) | |
--remove-duplicates |
Drop an import written identically twice (off by default) | |
--remove-unused |
Run dart fix --code=unused_import before sorting (off by default) |
|
--separate-relative-imports |
Blank line before relative imports, matching dart format (Dart 3.13+) — on by default; use --no-separate-relative-imports to turn it off |
|
--report |
Read the import graph: cycles, and files no entry point reaches. Writes nothing | |
--dry-run |
Preview changes without writing files | |
--exit-if-changed |
Exit with code 1 if any file would change — or, with --report, on any finding |
|
--ignore-config |
Ignore configuration file / pubspec.yaml block |
|
--version |
-v |
Print version and exit |
--help |
-h |
Show help |
Turning an option off #
Everything in the first group above is negatable, so a flag can override your config file for a single run — not only switch something on. A flag you type always wins:
# pubspec.yaml says `emojis: true`, but not for this run
dart run tidy_imports --no-emojis
# pubspec.yaml says `comments: false`, but put them back this once
dart run tidy_imports --comments
--no-comments and --no-blank-lines are simply the "off" side of the
comments and blank-lines options, and mean what they always meant.
--dry-run, --exit-if-changed, --ignore-config, --version and --help
describe a single invocation rather than a preference, so there is nothing to
negate.
Configuration #
Add a tidy_imports: block to your pubspec.yaml:
tidy_imports:
emojis: false # Default: false — add emojis to group comments
comments: true # Default: true — add group comments
blank_lines: true # Default: true — blank lines between groups
sort_pubspec: false # Default: false — also sort pubspec.yaml deps
sort_exports: false # Default: false — also sort export directives
group_project_by_folder: false # Default: false — split project imports by folder
group_project_by_folder_depth: 0 # Default: 0 — folder segments to group by (0 = whole path)
separate_relative_imports: true # Default: TRUE — blank line before relative imports
test_imports: false # Default: false — split fake_/mock_ files into their own group
flat: false # Default: false — no groups, one alphabetical run per section
relative_imports: false # Default: false — rewrite own-package imports as relative
remove_duplicates: false # Default: false — drop an import written identically twice
remove_unused: false # Default: false — run dart fix --code=unused_import first
report_roots: [] # Default: [] — extra entry points for --report, as regexes
test_import_prefixes: # Default: [fake_, mock_] — file-name prefixes treated as test doubles
- fake_
- mock_
ignored_files: # Regex patterns applied to relative file paths
- \/lib\/generated\/ # ignore a whole folder
- \.g\.dart$ # ignore generated files (build_runner)
- \.freezed\.dart$ # ignore freezed files
- \.gr\.dart$ # ignore auto_route files
tiers: # Custom import groups (see below)
- name: "Company imports:"
pattern: "package:acme_"
The ignored_files patterns are regular expressions matched against the path
relative to the project root (e.g. /lib/src/foo.dart).
sort_exports turns on the separate export block described in
Sorting exports. group_project_by_folder_depth limits how
much of the folder path counts as a grouping key, as described in
Limiting the folder grouping depth — any
value above 0 enables folder grouping on its own, so group_project_by_folder
does not have to be set as well.
Standalone config file #
Instead of the pubspec.yaml block, you can place the same options in a
tidy_imports.yaml file at the project root. When present, it takes precedence
over the pubspec.yaml block — handy for monorepos with a shared root config.
# tidy_imports.yaml
emojis: false
sort_pubspec: true
ignored_files:
- \.g\.dart$
Custom import tiers #
By default, all third-party packages share the single Package imports group. Custom tiers let you split out internal/shared packages into their own group, placed between the generic package group and your project imports:
tidy_imports:
tiers:
- name: "Shared imports:"
pattern: "package:acme_shared"
- name: "Company imports:"
pattern: "package:acme_"
Each import whose line contains a tier's pattern goes into that tier (first
match wins, so list the most specific patterns first). Result:
// Package imports:
import 'package:http/http.dart';
// Shared imports:
import 'package:acme_shared/utils.dart';
// Company imports:
import 'package:acme_billing/api.dart';
// Project imports:
import 'package:myapp/home.dart';
Sorting pubspec.yaml #
Pass --sort-pubspec (or set sort_pubspec: true) to also alphabetize the
dependencies, dev_dependencies, and dependency_overrides sections of your
pubspec.yaml. Nested dependency blocks (git/path/hosted) and comments attached
to a dependency are preserved.
dart run tidy_imports --sort-pubspec
Sorting exports #
Pass --sort-exports (or set sort_exports: true) to also sort your export
directives. They are collected into a block of their own, placed right after the
import block, using the same taxonomy — // Dart exports:,
// Flutter exports:, // Package exports:, // Project exports: and
// Test exports:. Custom import tiers apply to exports as well.
It is off by default on purpose: enabled everywhere, it would rewrite the
barrel file of every existing project on the first run. Barrels are also where
it pays off — a lib/index.dart in a large app, or a generated database.dart
with hundreds of export lines, is the one file no formatter orders for you.
Before #
export 'src/widgets/button.dart';
export 'package:acme_shared/utils.dart';
export 'dart:async' show Future;
export 'src/models/user.dart';
export 'package:flutter/material.dart';
After #
// Dart exports:
export 'dart:async' show Future;
// Flutter exports:
export 'package:flutter/material.dart';
// Package exports:
export 'package:acme_shared/utils.dart';
// Project exports:
export 'src/models/user.dart';
export 'src/widgets/button.dart';
Reading your import graph #
tidy_imports already parses every directive in your project on every run.
Those directives are a dependency graph — --report says what it shows,
sorts nothing and writes nothing:
dart run tidy_imports --report
┏━━ Reading the import graph of 9 files
┃ ✖ 1 group of files that import each other:
┃ lib/core/api.dart → lib/core/db.dart → lib/features/home.dart → lib/core/api.dart
┃ ! 2 files no entry point reaches:
┃ lib/core/legacy_cart.dart
┃ lib/core/old_checkout.dart
┃ (build_runner, reflection and dynamic loading are invisible here — read before deleting)
┗━━ • 3 findings
Files that import each other. Dart allows import cycles, so nothing in
the toolchain points them out — but two files in a cycle cannot be read,
tested or moved apart independently. Each group is drawn as a walk along
imports that really exist; when the group is larger than the shortest loop
through it, the rest is counted (+2 more in this group).
Files no entry point reaches. Different from an unused import: a whole
file that no entry point can get to through any chain of import, export or
part. That sees through a dead barrel to the files it exports, and through a
pair of dead files that only import each other. In a long-lived app there are
usually more than you expect.
What counts as an entry point #
Anything you can run or publish, so it is unreferenced by definition:
lib/main.dart, and everylib/main_*.dartflavour- any file under
lib/that declares a top-levelmain() - every file outside
lib/— tests,bin/,tool/,example/,web/ - for a library — no
publish_to: none, nolib/main.dart— every file outsidelib/src/, since pub convention makes that the public surface your consumers import lib/<your_package>.dart, the Flutter plugin registrant, and whatever you list underreport_roots:
tidy_imports:
report_roots:
- /lib/app/bootstrap\.dart # regex on the project-relative path
A generated .g.dart is reached through the part directive of the file it
belongs to, so it is only ever listed alongside a dead owner.
Narrowing the report #
A positional pattern or an ignored_files entry narrows what is printed,
never what is read. The graph is always built from the whole project, so a
file kept alive only by something you filtered out is still alive:
dart run tidy_imports --report "lib/features/" # findings in lib/features only
That is also how a cycle inside generated code gets out of the way without
losing its edges — flutter gen-l10n output is the stock example:
tidy_imports:
ignored_files:
- /lib/l10n/
In CI #
dart run tidy_imports --report --exit-if-changed
Exits 1 on any finding, with a line on stderr saying so, so a cycle introduced by a pull request fails the build instead of settling in. A run that finds no Dart files at all also exits 1 here: a gate that inspected nothing must not pass.
What it cannot see #
The graph is built from directives, nothing else. Code reached by
build_runner, reflection, or a path assembled at runtime is invisible to it,
so an "unreachable" file is a question to answer, not an instruction to follow.
Read before deleting.
Matching Dart's own lints #
Two lints in the Dart ecosystem disagree with how tidy_imports sorts by
default. Both are off unless you ask, because the default output — grouped,
labelled — is the whole point of the tool for most people.
--flat — for directives_ordering #
The directives_ordering lint wants one alphabetical run per section: dart:,
then package:, then relative. The default grouping breaks it, because
package:flutter/… is lifted above the other packages:
// default // --flat
// Dart imports: import 'dart:io';
import 'dart:io'; import 'package:args/args.dart';
import 'package:flutter/material.dart';
// Flutter imports: import 'helper.dart';
import 'package:flutter/material.dart';
// no lint warning
// Package imports:
import 'package:args/args.dart';
// ← Sort directive sections alphabetically
With --flat the Flutter group stops being special, the headers go away — a
comment between two runs the lint reads as one section would be a lie about the
structure — and export directives get their own block below the imports,
which is also what the lint asks for.
Grouping options (--group-by-folder, --test-imports, custom tiers) are
ignored under --flat: there are no groups left for them to shape.
--relative-imports — for prefer_relative_imports #
Rewrites imports of your own package as paths relative to the importing file:
// in lib/src/p2/bar.dart
import 'package:my_app/src/foo.dart'; → import '../foo.dart';
import 'package:my_app/src/p2/foo.dart'; → import 'foo.dart';
Only files under lib/ are touched. A file in test/ or bin/ cannot reach
lib/ with a relative URI at all, so its package: imports are left exactly as
they are.
Another package's imports are never rewritten, and the prefix, show/hide
clause and trailing comment all survive the rewrite. If a rewrite happens to
produce an import you already had, --remove-duplicates will fold the two.
Note that prefer_relative_imports and always_use_package_imports are
opposites — the Dart team ships both and expects you to pick one. This flag
serves the first; leave it off for the second.
Removing duplicate and unused imports #
Both are off by default. A sorter that deletes lines uninvited is a sorter you stop trusting, so each one has to be asked for — by flag, or by config key.
--remove-duplicates #
Drops an import written identically twice, keeping the first occurrence:
// before // after
import 'dart:math'; import 'dart:math';
import 'package:demo/z.dart';
import 'dart:math'; import 'package:demo/z.dart';
It compares text, with runs of whitespace collapsed — so a directive that
dart format wrapped over two lines still matches its one-line twin. Anything
that reads differently is left alone, because folding it could change what
the file means:
| Left alone | Why |
|---|---|
import 'z.dart' as a; and as b; |
Different prefixes; both are in use |
show Foo; and show Bar; |
Different combinators |
import 'dart:math'; // for max and the plain form |
Dropping one drops what the comment says |
--remove-unused #
Runs dart fix --apply --code=unused_import over the project first, then sorts
— so the holes it leaves behind are tidied up in the same pass:
dart run tidy_imports --remove-unused --remove-duplicates
This one shells out on purpose. Deciding that an import is unused means
resolving every identifier in the file to the library that declares it,
extension methods included. The analyzer that ships with your SDK already does
that, correctly; approximating it with text matching would eventually remove an
import that is in use. So the SDK answers the question and tidy_imports
handles the layout.
It needs the Dart SDK on PATH and a project that resolves — run dart pub get
first. It also costs a full analyzer pass, about a second on a small project and
longer on a large one, which is the other reason it is opt-in.
Under --dry-run and --exit-if-changed nothing is written: dart fix runs in
its own dry-run mode, and duplicates are counted and reported rather than
removed.
Grouping project imports by folder #
Pass --group-by-folder (or set group_project_by_folder: true) to visually
separate your project imports by their subfolder with a blank line whenever the
folder changes — useful in large projects with many local files.
// Project imports:
import 'package:myapp/data/user_repository.dart';
import 'package:myapp/data/user_service.dart';
import 'package:myapp/ui/home_page.dart';
import 'package:myapp/ui/settings_page.dart';
Limiting the folder grouping depth #
--group-by-folder breaks project imports at every folder change, because
the grouping key is the whole folder path. Pass --group-by-folder-depth=<n>
(or set group_project_by_folder_depth: <n>) to count only the first n folder
segments after the package root. Any value above 0 already enables folder
grouping — you do not need to pass --group-by-folder as well.
For package:myapp/features/orders/presentation/widgets/order_card.dart the
grouping key is:
| Depth | Key |
|---|---|
0 (default) |
package:myapp/features/orders/presentation/widgets — the whole path |
1 |
package:myapp/features |
2 |
package:myapp/features/orders |
This exists because of feature-first / Clean Architecture layouts. There,
--group-by-folder on its own splits a file with 25 project imports into about
a dozen groups of one or two lines each, which is noise rather than structure.
At depth 1 the groups match the architecture instead: one core/, one
components/, one features/, one providers/.
--group-by-folder (depth 0) #
// Project imports:
import 'package:myapp/components/app_button.dart';
import 'package:myapp/core/theme/app_theme.dart';
import 'package:myapp/core/util/format_utils.dart';
import 'package:myapp/features/orders/domain/order.dart';
import 'package:myapp/features/orders/presentation/order_page.dart';
import 'package:myapp/features/orders/presentation/widgets/order_card.dart';
import 'package:myapp/providers/session_provider.dart';
--group-by-folder-depth=1 #
// Project imports:
import 'package:myapp/components/app_button.dart';
import 'package:myapp/core/theme/app_theme.dart';
import 'package:myapp/core/util/format_utils.dart';
import 'package:myapp/features/orders/domain/order.dart';
import 'package:myapp/features/orders/presentation/order_page.dart';
import 'package:myapp/features/orders/presentation/widgets/order_card.dart';
import 'package:myapp/providers/session_provider.dart';
Matching dart format (Dart 3.13+) #
Since Dart 3.13 the
formatter inserts a blank line between the package: and relative import
sections. Because tidy_imports keeps package:<your_project>/… and relative
imports together in one Project imports: block, the two tools used to undo
each other on every run.
This is on by default since 2.0.0 — it emits that blank line up front, so
both tools agree and the file stops flip-flopping. Turn it off with
--no-separate-relative-imports or separate_relative_imports: false if you
prefer the tighter block and do not run dart format:
// Project imports:
import 'package:myapp/home.dart';
import 'another_file.dart';
The option is a no-op when blank lines are disabled (--no-blank-lines /
blank_lines: false), and it never doubles up with --group-by-folder, which
already breaks at that boundary. It applies to the --test-imports group too.
Grouping test doubles #
Pass --test-imports (or set test_imports: true) to pull fakes and mocks out
of your project imports and into a dedicated group:
// Project imports:
import 'package:myapp/cliente_details_repository.dart';
// Test imports:
import 'package:myapp/mock_auth_service.dart';
import 'fake_cliente_details_repository.dart';
A file counts as a test double when it is a project import (relative or
package:<your_package>/) and its file name starts with a configured
prefix — fake_ or mock_ by default. Override the list with
test_import_prefixes (e.g. add stub_ or spy_); a custom list replaces the
defaults rather than extending them.
Third-party packages are never affected, so real pub packages whose names look
like doubles — package:fake_async/fake_async.dart,
package:mock_web_server/mock_web_server.dart — stay in Package imports.
To group testing libraries such as mockito, use a
custom tier instead:
tidy_imports:
test_imports: true
tiers:
- name: "Testing imports:"
pattern: "package:mockito"
Multi-line and commented imports #
A directive does not have to be one clean line to be sorted. There is nothing to turn on here — these are all recognised, classified and sorted like any other import:
-
Imports that
dart formatwrapped onto two lines, usually because of a longshoworasclause. They used to be missed entirely, sliding out of the sorted block and ending up loose below the groups:import 'package:flutter_riverpod/flutter_riverpod.dart' show Consumer, ProviderContainer;The same goes for conditional imports (
if (dart.library.io)), which previously landed outside every group. -
Imports with a trailing line comment. They used to be ejected from the sorted block; now they are sorted normally and the comment stays on the same line:
import 'package:app/x.dart'; // ignore-me: documented reason -
// ignore:comments above an import travel with it. Sorting used to tear the comment off its import and leave it below the block, silently switching the lint suppression off.// ignore_for_file:applies to the whole file, so it stays where it is, at the top.
Classification also reads the import URI, not the raw text of the line. A
line such as import 'package:http/http.dart'; // uses dart:io underneath used
to be filed under Dart imports because of the word in the comment; it now
goes to Package imports, where it belongs.
What is left alone #
The other half of the promise: text that only looks like a directive is never moved. A commented-out import stays commented out, and an import inside a string stays inside the string.
/*
import 'package:app/disabled.dart'; // stays disabled
*/
const template = '''
import 'package:app/generated.dart'; // stays in the template
''';
The sorter tracks quotes and /* */ blocks — which nest in Dart — line by line,
so only a line that begins in executable code can be a directive at all.
CI Integration #
GitHub Actions #
- name: Check import order
run: dart run tidy_imports --exit-if-changed
--exit-if-changed checks the whole project in one pass and lists every
file that needs sorting before exiting with code 1 — so a single CI run shows
you everything to fix, not just the first offender. It never writes files. Use
--dry-run locally for the same read-only preview with a friendlier summary.
pre-commit hook #
# .pre-commit-config.yaml
repos:
- repo: https://github.com/Franklyn-R-Silva/tidy_imports
rev: 'v1.1.0' # use the latest release tag
hooks:
- id: dart-import-sorter # for plain Dart projects
# - id: flutter-import-sorter # for Flutter projects
Directories scanned #
lib/, src/, bin/, test/, tests/, test_driver/, integration_test/, packages/
The packages/ directory is included to support pub workspaces and monorepos.
Monorepo / pub workspace support #
tidy_imports works in pub workspaces where individual packages do not have their own pubspec.lock. When no lock file is found, the tool continues normally — Flutter plugin registrant detection is simply skipped. No crash, no manual workaround needed.
Improvements over import_sorter #
| Issue | import_sorter | tidy_imports |
|---|---|---|
| Arg parsing | Raw string matching — breaks with flags | ArgParser — correct flag resolution |
| Positional file args | Passes raw args (includes flags) |
Uses argResults.rest |
pubspec.lock in monorepos |
Crashes with PathNotFoundException |
Graceful fallback |
packages/ folder |
Not scanned | Scanned |
--dry-run preview |
Not available | Available |
--no-blank-lines |
Not available | Available |
| Custom import tiers | Not available | Available |
Sort pubspec.yaml deps |
Not available | --sort-pubspec |
| Group project imports by folder | Not available | --group-by-folder |
| Folder grouping depth | Not available | --group-by-folder-depth=<n> |
| Separate group for test doubles | Not available | --test-imports |
Sort export directives |
Not available | --sort-exports |
dart format 3.13+ import sections |
Fights the formatter | Agrees with it, by default |
| Remove duplicate imports | Requested in #57, still open | --remove-duplicates |
| Remove unused imports | Requested in #56, still open | --remove-unused |
directives_ordering lint |
Requested in #58 / #28, still open | --flat |
| Rewrite own imports as relative | Requested in #59, still open | --relative-imports |
| Invalid file pattern | Unhandled FormatException |
Readable error, exit 1 |
| Group comments inside string literals | Silently deleted | Preserved |
Multi-line imports (wrapped show/as) |
Dropped out of the sorted block | Sorted like any other import |
| Trailing comment on an import | Ejected the import from the block | Sorted, comment kept on the line |
// ignore: above an import |
Detached from its import | Travels with the import |
| Import classification | Reads the raw line, comments included | Reads the import URI |
| Standalone config file | Not available | tidy_imports.yaml |
| Direct CLI command | dart pub global run ...:main |
tidy_imports |
--exit-if-changed in CI |
Aborts on first unsorted file | Reports every unsorted file |
| pre-commit hook | language: script (broken) |
language: system (works) |
| Dart SDK | >=2.12.0 |
>=3.0.0 |
| Conditional imports | Misclassified | Handled correctly |
| Versioning | Manual | Manual, with CI refusing a mismatch |
Contributing #
Pull requests are welcome! See CONTRIBUTING.md for dev setup, commit format, and the release process.
- Code of Conduct
- Security Policy
- Changelog
Credits #
Based on the original work by @gleich and contributors of import_sorter.
License #
MIT © Franklyn R. Silva