better_imports

Description:

better imports

better_imports #
This Dart package provides a command-line interface (CLI) for sorting and organizing imports in Dart projects.
Users can customize the import sorting behavior using various flags and options.
Features #

default config
using external config
sorting all .dart files
converting package imports to relative imports and back
sorting specific folders
sorting specific files
regex-based filtering for inclusion or exclusion
ignoring specific files
adding comments to import types / sections
toggling console output
tracing/logging

Example #
Before #

library better_imports;
import 'dart:io';
import 'package:better_imports/lib.dart';
import 'cfg_test.dart';
import 'package:dart_style/dart_style.dart';
import '../res/sorter_fixtures.dart';
import 'package:test/test.dart';

void main() {
final formatter = DartFormatter();
}

copied to clipboard
After (default config) #

library better_imports;

// Dart Imports
import 'dart:io';

// Package Imports
import 'package:dart_style/dart_style.dart';
import 'package:test/test.dart';

// Project Imports
import 'package:better_imports/lib.dart';

// Relative Project Imports
import '../res/sorter_fixtures.dart';
import 'cfg_test.dart';

void main() {
final formatter = DartFormatter();
}

copied to clipboard
Usage #
Recommended: Native executeable #

Download the precompiled executeables OR fork the repo and compile it yourself

Inside your project, root directory:
dart compile exe .\bin\better_imports.dart
on Linux dart compile exe ./bin/better_imports.dart -o ./bin/better_imports


Extract the downloaded archive / move the compiled executeable in to a folder of your choosing

If needed rename the executeable for your OS to better_imports


Add the chosen folder / executeable to your PATH environment variable

Win: How to Add to Windows PATH Environment Variable
Mac: How to Set the PATH Variable in macOS
Linux: How to Add a Directory to Your $PATH in Linux

You might need to make the file executable with chmod




Go to your project folder, root directory
run:

better_imports



As a dependency (this is around 10x slower) #

Follow the usual package installation instructions
Consider making it a dev_dependency, you won't depend on anything
run:

dart pub run better_imports:better_imports
OR in flutter:
flutter pub run better_imports:better_imports



On Save Action in VSCode #

Install Run on Save extension
Add the following config to your settings.json


"emeraldwalk.runonsave": {
"commands": [
{
"match": "\\.dart$",
"cmd": "better_imports --files ${fileBasename} -s"
}
]
}

copied to clipboard
CLI Flags and Options #

Flags
Name Abbr Description

--help -h Prints this screen.
--no-recursive Performs a non recursive search when collecting .dart files.
--silent -s Disables results output in console.
--relative Converts all project package imports to relative project imports.
--no-comments Removes comments from import types / sections.
--trace Prints extended logs to console.
--dry-run Prints the results of the run without writing it to the file.
--dart-fmt Formats the file after sorting imports. Default is true.
Can be disabled by using --no-dart-fmt
copied to clipboard


Options

Name Args Description

--cfg "path/to/cfg" Path to an external yaml config. "" are optional.
If path contains spaces, then "" is required.
--project-name "project_name" Project name used to identify project imports. "" are optional.
If project name contains spaces, then "" are required.
--folders "folder1,folder2" Sorts the given folders and subfolders only. "" are optional.
If folder names contain spaces, then "" is required.
Must be seperated by ','
If folders are not in the project root, then provide a path relative
to project root. Example:
"lib/sub folder/folder1, bin/subfolder/folder2"
--files "file1,file2" Sorts only the given Files. "" are optional.
If file names contain spaces, then "" is required.
Must be seperated by ','
--ignore-files "file1,file2" Files to be ignored when sorting imports. "" are optional.
If file names contain spaces, then "" is required.
Must be seperated by ','
--files-like ".*\.g\.dart,.*\.g\.dart" Regex used to filter files which should be sorted. "" are optional.
If regex contain spaces, then "" is required.
Must be seperated by ','
--ignore-files-like ".*\.g\.dart,.*\.g\.dart" Regex used to filter files which should be ignored. "" are optional.
If regex contain spaces, then "" is required.
Must be seperated by ','

copied to clipboard

Additional information #
Overriding default values #
You can override default config values by adding an better_imports section to your pubspec.yaml file.
Or by providing command line arguments.
Command line argements override any other setting if provided!
For example:
Copy and paste the default config into your pubspec.yaml file.
Make sure you keep the proper indentation.
External config #
If you want to use an external config file you can add a minimalistic better_imports section to your pubspec.yaml file.
For example:

better_imports:
cfg_path: path/to/your/config/cfg.yaml

copied to clipboard
--- OR ---
Provide the --cfg CLI option.
For example:
better_imports --cfg path/to/your/config/cfg.yaml
Default Yaml config #

Show Config
# Better Imports default config
# Default config is overwritten when settings are passed in as arguments in the cli
better_imports:
# If set overwrites the project name
# Used for sorting project imports
project_name:

# Absolute path to an external configuration
# If set, rest in this section will be ignored
cfg_path:

# Flag to include subfolders
recursive: true

# Flag to add comments above import sections
comments: true

# Flag to disable results output in console
silent: false

# Flag to use relative imports in the project
relative: false

# Flag to use to log everything happening to console
trace: false

# Flag to use to run a dry run without changing files
dry_run: false

# Flag to use the dart formatter after sorting imports
dart_fmt: true

# Folder names used for collecting dart files
folders:
- lib
- bin
- res
- example
- test
- tests
- integration_test
- integration_tests
- test_driver

# File names which should be sorted
files:

# File names which should be excluded
ignore_files:

# RegEx pattern for files which should be collected
files_like:

# RegEx pattern for files which should be excluded
ignore_files_like:
- .*generated_plugin_registrant\.dart
- .*\.g\.dart
- .*\.gr\.dart
- .*\.freezed\.dart
copied to clipboard

Contributors #






Alexander Schellenberg💻 ⚠️ 🚇 🚧 👀