devforgeYamlTemplate top-level property

String devforgeYamlTemplate

Implementation

String devforgeYamlTemplate = """
# -----------------------------------------------------------------------------
# Devforge Configuration File
# -----------------------------------------------------------------------------
# This file is used by the Devforge CLI tool to determine
# default input sources and output generation paths.
#
# Place this file in the root of your Flutter project.
#
# Example location:
#   my_flutter_app/devforge.yaml
# -----------------------------------------------------------------------------

devforge:

  # ---------------------------------------------------------------------------
  # INPUT PATHS
  # ---------------------------------------------------------------------------
  # These paths define where Devforge should read data from.
  # These files/folders must already exist inside your project.
  # ---------------------------------------------------------------------------
  input_path:

    # Root assets directory as declared in pubspec.yaml.
    # Devforge will scan this folder to auto-generate asset constants.
    assets: assets/

    # Path to your main application icon.
    # Used for automated app icon handling or configuration generation.
    #
    # Must be a valid image file (png recommended).
    app_icon: assets/icon/logo.png

    # Path to the default translation JSON file.
    # Used to auto-generate strongly typed translation keys.
    #
    # Example format:
    # {
    #   "login": "Login",
    #   "logout": "Logout"
    # }
    #
    # Devforge will read this file and generate translation key constants.
    translation_file: assets/localization/en_US.json


  # ---------------------------------------------------------------------------
  # OUTPUT PATHS
  # ---------------------------------------------------------------------------
  # These paths define where Devforge will generate files.
  # Files will be created automatically if they do not exist.
  # ---------------------------------------------------------------------------
  output_path:

    # API Client base file.
    # Used to configure Dio/Base API logic.
    api_client: lib/api_service/api_client.dart

    # Logger Interceptor file for network debugging.
    # Automatically attached to Dio for request/response logging.
    logger_interceptor: lib/api_service/interceptor/logger_interceptor.dart

    # Utility file for accessing asset paths as constants.
    assets_utils: lib/core/utils/assets_utils.dart

    # Firebase Cloud Messaging service file.
    fcm_service: lib/core/services/fcm_service.dart

    # Refresh token handling service.
    refresh_token: lib/core/services/refresh_token_service.dart

    # Shared Preferences or Get Storage wrapper service.
    # Provides strongly typed local storage access.
    app_storage_service: lib/core/services/shared_preferences_service.dart

    # Sqflite database service file.
    sqflite_service: lib/core/services/sqflite_service.dart

    # Pagination service folder.
    # Devforge will generate pagination-service files inside this directory.
    pagination_service: lib/core/services/

    # Theme configuration folder.
    theme: lib/core/theme/

    # Translation keys output file.
    # Generated from translation_file input.
    translation_keys: lib/core/localization/translation_keys.dart
""";