SF CLI - Flutter Scaffolding Tool #

A powerful command-line interface tool for Flutter developers that automates the creation of feature-based project structures, model generation from JSON, and BLoC pattern implementation.

Features #

• 🏗️ Feature Scaffolding: Generate complete feature structures with feature folder structures
• 📱 Project Initialization: Set up Flutter projects with predefined folder structures
• 🔄 Model Generation: Create Dart model classes from JSON files with complex nested support
• 🧩 BLoC/Cubit Generation: Generate BLoC cubit and bloc classes with states following best practices (supports both Equatable and Freezed)
• ⚙️ Build Runner Integration: Execute build_runner commands with proper configurations
• 📋 Config-based Generation: Generate multiple components from configuration files

Installation #

Global Installation (Recommended) #

dart pub global activate sf_cli

Local Installation #

Add to your pubspec.yaml:

dev_dependencies:
  sf_cli: ^1.0.0

Then run:

dart pub get

Usage #

Initialize a New Flutter Project Structure #

sf_cli init

This creates a comprehensive folder structure including:

• Feature-based architecture (auth, splash)
• Shared components (API, constants, themes, utils)
• Clean architecture layers (domain, logic, screens, widgets)

Generate a New Feature #

sf_cli features --name user_profile
# or
sf_cli features -n user_profile

# Generate with Freezed cubit and state
sf_cli features --name user_profile --freezed

Creates a complete feature structure:

lib/features/user_profile/
├── domain/
│   ├── models/user_profile_model.dart
│   ├── repository/user_profile_repository.dart
│   └── services/user_profile_service.dart
├── logic/user_profile/
│   ├── user_profile_cubit.dart
│   └── user_profile_state.dart
├── screens/user_profile_screen.dart
├── widgets/user_profile_widget.dart
└── user_profile_config.json

Generate Model Classes from JSON #

sf_cli model --file path/to/your/model.json
# or
sf_cli model -f path/to/your/model.json

Example JSON input:

{
  "id": 1,
  "name": "John Doe",
  "email": "[email protected]",
  "profile": {
    "age": 30,
    "preferences": ["coding", "reading"]
  }
}

Generates a Dart model class with:

• Proper constructors
• JSON serialization methods
• Null safety support
• Nested class handling

Generate BLoC Cubit #

sf_cli cubit --name authentication
# or
sf_cli cubit -n authentication

# Generate with Freezed
sf_cli cubit --name authentication --freezed

Creates cubit and state files with proper BLoC patterns. Use --freezed flag to generate freezed variants with immutable state classes.

Generate BLoC #

sf_cli bloc --name authentication
# or
sf_cli bloc -n authentication

# Generate with Freezed
sf_cli bloc --name authentication --freezed

Creates bloc, event, and state files with proper BLoC patterns. Use --freezed flag to generate freezed variants with immutable event and state classes.

Run Build Runner #

sf_cli runner

Executes: dart run build_runner build --delete-conflicting-outputs

Generate from Configuration File #

sf_cli config --config-file path/to/config.json
# or
sf_cli config -c path/to/config.json

Example configuration:

{
  "user_model": {
    "model_class_relative_path": "lib/features/user/domain/models/user.json",
    "end_point": "/api/users",
    "method": "get",
    "function_name": "getUsers",
    "parameters": {
      "page": "int",
      "limit": "int"
    }
  }
}

Command Reference #

Requirements #

• Dart SDK: ^3.4.3
• Flutter: Compatible with latest stable versions

Architecture Patterns #

This tool promotes clean architecture patterns:

• Domain Layer: Models, repositories, and business logic
• Logic Layer: BLoC/Cubit state management
• Presentation Layer: Screens and widgets
• Shared Components: Reusable utilities and constants

Contributing #

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License #

This project is licensed under the MIT License - see the LICENSE file for details.

Support #

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions