flutter_project_booster 0.0.3
flutter_project_booster: ^0.0.3 copied to clipboard
A CLI tool to scaffold Flutter project structure and update pubspec.yaml.
π flutter_project_booster #
A CLI tool to quickly bootstrap your Flutter project's structure, clean up your pubspec.yaml
, and remove unused dependencies.
Keep your Flutter project lean, organized, and efficient β all from the terminal.
β¨ Features #
- π Create standard folder and file structure from a JSON config.
- π¦ Automatically update and clean
pubspec.yaml
. - π§Ό Remove unused dependencies from
pubspec.yaml
. - π‘ Built-in support for dependencies, dev_dependencies, and assets.
π¦ Installation #
- Clone the repository and get dependencies:
git clone https://github.com/3boodev/flutter_project_booster
cd flutter_project_booster
dart pub get
- OR ADD TO dev_dependencies in pubspec.yaml #
dev_dependencies:
flutter_project_booster:
git:
url: https://github.com/3boodev/flutter_project_booster
π Usage #
- Create project structure
dart run flutter_project_booster --create
This will:
- Create folders and files as defined in assets/project_components.json.
- Clean your pubspec.yaml (remove comments & empty lines).
- Add missing dependencies, dev_dependencies, and assets.
- Remove unused dependencies
dart run flutter_project_booster --remove
This will:
- Scan your Dart files.
- Detect dependencies listed in pubspec.yaml but not actually used.
- Remove them automatically.
π§Ύ CLI Options #
Option | Description --create | Generate folder structure & update pubspec.yaml --remove | Remove unused dependencies --help | Show help info
π JSON Config Format #
{
"directories": ["lib/screens", "lib/widgets", "lib/services"],
"files": ["lib/main.dart", "lib/widgets/app_button.dart"],
"dependencies": ["http", "provider"],
"dev_dependencies": ["flutter_lints"],
"assets": ["assets/images/", "assets/icons/"]
}
β Example Output #
π Created directory: lib/screens
π Created file: lib/main.dart
β
Updated pubspec.yaml successfully.
π Dependencies installed.
- For unused dependency removal:
Scanning for unused dependencies...
Removed: fluttertoast
Removed: shared_preferences
β
pubspec.yaml cleaned successfully.
π Roadmap #
- Support for customizable file templates.
- Backup mode for pubspec.yaml before edit.
- Lint integration for consistency checks.
π¨βπ» Author #
- Built with β€οΈ by Abdullah Alamary
π License #
- This project is licensed under the MIT License. See the LICENSE file for details.