devforge 1.0.0 copy "devforge: ^1.0.0" to clipboard
devforge: ^1.0.0 copied to clipboard

CLI tool to generate Flutter/Dart boilerplate code.

devforge #

A powerful and flexible Command Line Interface (CLI) tool for generating common Flutter/Dart boilerplate code directly into your project. Stop writing the same utility files over and overβ€”let devforge handle the heavy lifting!

✨ Features #

devforge offers both direct command execution and an interactive mode to quickly scaffold necessary services and utilities.

  • ApiClient Service: Creates an api_client.dart file with dio api calling setup.
  • Assets Utility Generation: Creates an assets_utils.dart file with static paths for all resources in your assets folder.
  • FCM Service Scaffold: Generates a standard fcm_service.dart for handling Firebase Cloud Messaging setup.
  • Refresh Token Service: Scaffolds a dedicated service for managing token refresh logic.
  • Local Storage Service: Creates either shared_preferences_service.dart or get_storage_service.dart to store data locally.
  • Sqflite Service: Creates an sqflite_service.dart to store data locally.
  • Pagination Utilities: Creates both a pagination_controller.dart and a reusable paging_list_view.dart widget.
  • Bloc Classes: Creates a basic bloc folder structure with bloc.dart, state.dart and event.dart files with boilerplate prewritten code.
  • Getx Classes: Creates a basic getx folder structure with controller.dart, bindings.dart and screens.dart files with boilerplate prewritten code.
  • Interactive Mode: Use the devforge run command for a friendly menu-driven generation experience.

πŸš€ Installation #

1. Activate the Package #

Activate devforge globally using the Dart package manager. This makes the devforge command available anywhere on your system.

dart pub global activate devforge

2. Verify Installation #

Run the help command to confirm devforge is installed and working correctly.

devforge --help

πŸ‘¨β€πŸ’» Usage #

There are two primary ways to use devforge: Direct Commands and the Interactive Run mode.

1. Interactive Mode (devforge run)

For generating multiple files at once or for a guided experience, use the run command.

devforge run

This will launch an interactive multi-select menu, allowing you to choose which services you want to generate.

? Select what you have to generate:

[ ] Generate ApiClient [ ] Generate AssetsUtils [ ] Generate FcmService [ ] Generate RefreshToken service [ ] Generate Local Storage service [ ] Generate SqfliteService [ ] Generate Pagination Service [ ] Generate BLoC Service [ ] Generate Getx Service [ ] Generate App icons

2. Direct Commands

Use these commands for quick, single-purpose generation.

Command Description Output File(s)
devforge api_client Generates a boilerplate service for handling API calls. lib/api_client.dart
devforge assets Scans the assets folder and generates the assets utility file. lib/assets_utils.dart
devforge fcm Generates a boilerplate service for handling FCM. lib/fcm_service.dart
devforge refresh Generates the service for managing refresh token logic. lib/refresh_token_service.dart
devforge local_storage Generates shared_preferences or get_storage service. lib/shared_preferences_service.dart & lib/get_storage_service.dart
devforge sqflite Generates a sqflite singleton service. lib/sqflite_service.dart
devforge pagination Generates a controller and a reusable widget for paginated lists. lib/pagination_controller.dart & lib/paging_list_view.dart
devforge bloc Generate bloc directory which contains bloc.dart, state.dart, and event.dart in lib folder. From where you run this command or the path you set
devforge getx Generate getx directory which contains controllers, bindings, and views in a folder From where you run this command or the path you set
devforge app-icon Generate app icon of different sizes in platform specific folder. The files are generated at platform specific folders.

General Help #

To see the list of all available commands:

devforge --help

OR #

devforge -h

General Version #

To see current installed version on your device:

devforge --version

OR #

devforge -v
0
likes
0
points
74
downloads

Publisher

unverified uploader

Weekly Downloads

CLI tool to generate Flutter/Dart boilerplate code.

Repository (GitHub)
View/report issues

License

unknown (license)

Dependencies

args, http, image, interact, intl, path, yaml

More

Packages that depend on devforge