flutter_project_booster 0.1.0
flutter_project_booster: ^0.1.0 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
- OR USE It as Globally #
dart pub global activate flutter_project_booster
๐ Usage (with out 'dart run' If your Use Globally) #
- 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.