create-mobile-arch 1.0.0

package/src/prompts.js

@@ -0,0 +1,140 @@
+const inquirer = require('inquirer');
+const chalk = require('chalk');
+
+/**
+ * Prompts the user for project configuration choices
+ * @returns {Promise<Object>} User's answers
+ */
+async function promptUserChoices() {
+  console.log('\n');
+  console.log(chalk.cyan.bold('⚙️  Configure your Flutter project'));
+  console.log(chalk.gray('Answer the following questions to customize your project setup:'));
+  console.log('\n');
+
+  const questions = [
+    {
+      type: 'list',
+      name: 'architecture',
+      message: 'Select your preferred architecture pattern:',
+      choices: [
+        {
+          name: 'Clean Architecture (Domain-driven with layers)',
+          value: 'clean',
+          short: 'Clean Architecture'
+        },
+        {
+          name: 'Feature First (Organized by features)',
+          value: 'feature-first',
+          short: 'Feature First'
+        }
+      ],
+      default: 'clean'
+    },
+    {
+      type: 'list',
+      name: 'stateManagement',
+      message: 'Choose your state management solution:',
+      choices: [
+        {
+          name: 'Riverpod (Recommended - compile-safe, testable)',
+          value: 'riverpod',
+          short: 'Riverpod'
+        },
+        {
+          name: 'Bloc (Event-driven state management)',
+          value: 'bloc',
+          short: 'Bloc'
+        }
+      ],
+      default: 'riverpod'
+    },
+    {
+      type: 'list',
+      name: 'backend',
+      message: 'Select your backend integration:',
+      choices: [
+        {
+          name: 'Firebase (Auth, Firestore, Storage)',
+          value: 'firebase',
+          short: 'Firebase'
+        },
+        {
+          name: 'REST API (Custom backend with HTTP)',
+          value: 'rest',
+          short: 'REST API'
+        }
+      ],
+      default: 'rest'
+    },
+    {
+      type: 'confirm',
+      name: 'includeExamples',
+      message: 'Include example code and sample features?',
+      default: true
+    }
+  ];
+
+  try {
+    const answers = await inquirer.prompt(questions);
+    return answers;
+  } catch (error) {
+    if (error.isTtyError) {
+      throw new Error('Prompt could not be rendered in this environment');
+    } else {
+      throw new Error(`Failed to get user input: ${error.message}`);
+    }
+  }
+}
+
+/**
+ * Confirms before overwriting an existing directory
+ * @param {string} projectName - Name of the existing project
+ * @returns {Promise<boolean>} User's confirmation
+ */
+async function confirmOverwrite(projectName) {
+  console.log('\n');
+  console.log(chalk.yellow.bold('⚠️  Warning:'), `Directory "${projectName}" already exists!`);
+  
+  const { confirm } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'confirm',
+      message: 'Do you want to overwrite it?',
+      default: false
+    }
+  ]);
+  
+  return confirm;
+}
+
+/**
+ * Displays a summary of user choices before generation
+ * @param {string} projectName - Project name
+ * @param {Object} choices - User's configuration choices
+ */
+function displayConfigSummary(projectName, choices) {
+  console.log('\n');
+  console.log(chalk.cyan.bold('📋 Project Configuration Summary:'));
+  console.log(chalk.gray('─'.repeat(50)));
+  console.log(chalk.white('  Project Name:      '), chalk.green(projectName));
+  console.log(chalk.white('  Architecture:      '), chalk.green(
+    choices.architecture === 'clean' ? 'Clean Architecture' : 'Feature First'
+  ));
+  console.log(chalk.white('  State Management:  '), chalk.green(
+    choices.stateManagement === 'riverpod' ? 'Riverpod' : 'Bloc'
+  ));
+  console.log(chalk.white('  Backend:           '), chalk.green(
+    choices.backend === 'firebase' ? 'Firebase' : 'REST API'
+  ));
+  console.log(chalk.white('  Include Examples:  '), chalk.green(
+    choices.includeExamples ? 'Yes' : 'No'
+  ));
+  console.log(chalk.gray('─'.repeat(50)));
+  console.log('\n');
+}
+
+module.exports = {
+  promptUserChoices,
+  confirmOverwrite,
+  displayConfigSummary
+};

package/src/utils.js

@@ -0,0 +1,185 @@
+const fs = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+
+/**
+ * Validates the project name according to Flutter naming conventions
+ * @param {string} name - Project name to validate
+ * @returns {Object} - { valid: boolean, error: string }
+ */
+function validateProjectName(name) {
+  if (!name) {
+    return {
+      valid: false,
+      error: 'Project name is required'
+    };
+  }
+
+  // Flutter project names must be valid Dart package names
+  // Must be lowercase, can contain underscores and numbers, but not start with a number
+  const validNamePattern = /^[a-z][a-z0-9_]*$/;
+  
+  if (!validNamePattern.test(name)) {
+    return {
+      valid: false,
+      error: 'Project name must start with a lowercase letter and can only contain lowercase letters, numbers, and underscores'
+    };
+  }
+
+  // Reserved Dart keywords
+  const reservedWords = [
+    'abstract', 'as', 'assert', 'async', 'await', 'break', 'case', 'catch',
+    'class', 'const', 'continue', 'default', 'do', 'else', 'enum', 'export',
+    'extends', 'false', 'final', 'finally', 'for', 'if', 'import', 'in',
+    'is', 'library', 'new', 'null', 'operator', 'part', 'return', 'super',
+    'switch', 'this', 'throw', 'true', 'try', 'var', 'void', 'while', 'with'
+  ];
+
+  if (reservedWords.includes(name)) {
+    return {
+      valid: false,
+      error: `Project name "${name}" is a reserved Dart keyword`
+    };
+  }
+
+  return { valid: true };
+}
+
+/**
+ * Checks if a directory exists
+ * @param {string} dirPath - Directory path to check
+ * @returns {boolean}
+ */
+async function directoryExists(dirPath) {
+  try {
+    const stats = await fs.stat(dirPath);
+    return stats.isDirectory();
+  } catch (error) {
+    return false;
+  }
+}
+
+/**
+ * Converts a string to PascalCase (for app names)
+ * @param {string} str - String to convert
+ * @returns {string}
+ */
+function toPascalCase(str) {
+  return str
+    .split('_')
+    .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
+    .join('');
+}
+
+/**
+ * Converts a string to snake_case
+ * @param {string} str - String to convert
+ * @returns {string}
+ */
+function toSnakeCase(str) {
+  return str
+    .toLowerCase()
+    .replace(/[^a-z0-9]/g, '_')
+    .replace(/_+/g, '_')
+    .replace(/^_|_$/g, '');
+}
+
+/**
+ * Recursively copies directory and replaces placeholders in file contents
+ * @param {string} srcDir - Source directory
+ * @param {string} destDir - Destination directory
+ * @param {Object} replacements - Key-value pairs for placeholder replacement
+ */
+async function copyAndReplace(srcDir, destDir, replacements) {
+  try {
+    // Ensure destination directory exists
+    await fs.ensureDir(destDir);
+    
+    // Read all items in source directory
+    const items = await fs.readdir(srcDir);
+    
+    for (const item of items) {
+      const srcPath = path.join(srcDir, item);
+      const destPath = path.join(destDir, item);
+      
+      const stats = await fs.stat(srcPath);
+      
+      if (stats.isDirectory()) {
+        // Recursively copy subdirectories
+        await copyAndReplace(srcPath, destPath, replacements);
+      } else if (stats.isFile()) {
+        // Read file content
+        let content = await fs.readFile(srcPath, 'utf8');
+        
+        // Replace all placeholders
+        Object.keys(replacements).forEach(placeholder => {
+          const regex = new RegExp(placeholder, 'g');
+          content = content.replace(regex, replacements[placeholder]);
+        });
+        
+        // Write to destination
+        await fs.writeFile(destPath, content, 'utf8');
+      }
+    }
+  } catch (error) {
+    throw new Error(`Failed to copy template: ${error.message}`);
+  }
+}
+
+/**
+ * Checks if Flutter is installed on the system
+ * @returns {boolean}
+ */
+async function isFlutterInstalled() {
+  const { exec } = require('child_process');
+  const util = require('util');
+  const execPromise = util.promisify(exec);
+  
+  try {
+    await execPromise('flutter --version');
+    return true;
+  } catch (error) {
+    return false;
+  }
+}
+
+/**
+ * Prints a success message with next steps
+ * @param {string} projectName - Name of the created project
+ * @param {string} projectPath - Path to the project
+ */
+function printSuccessMessage(projectName, projectPath) {
+  console.log('\n');
+  console.log(chalk.green.bold('✅ Success!'), `Your Flutter project "${projectName}" has been created!`);
+  console.log('\n');
+  console.log(chalk.cyan('📁 Project location:'), chalk.white(projectPath));
+  console.log('\n');
+  console.log(chalk.yellow.bold('Next steps:'));
+  console.log(chalk.white('  1.'), `cd ${projectName}`);
+  console.log(chalk.white('  2.'), 'Open the project in your IDE (VS Code, Android Studio, etc.)');
+  console.log(chalk.white('  3.'), 'Run:', chalk.cyan('flutter run'));
+  console.log('\n');
+  console.log(chalk.gray('💡 Tip: Check the README.md file in your project for architecture details'));
+  console.log('\n');
+}
+
+/**
+ * Prints an error message
+ * @param {string} message - Error message
+ */
+function printError(message) {
+  console.log('\n');
+  console.log(chalk.red.bold('❌ Error:'), chalk.white(message));
+  console.log('\n');
+}
+
+module.exports = {
+  validateProjectName,
+  directoryExists,
+  toPascalCase,
+  toSnakeCase,
+  copyAndReplace,
+  isFlutterInstalled,
+  printSuccessMessage,
+  printError
+};

package/templates/flutter-clean/analysis_options.yaml

@@ -0,0 +1,46 @@
+include: package:flutter_lints/flutter.yaml
+
+linter:
+  rules:
+    # Error rules
+    - avoid_empty_else
+    - avoid_relative_lib_imports
+    - avoid_types_as_parameter_names
+    - no_duplicate_case_values
+    - prefer_void_to_null
+    - valid_regexps
+    
+    # Style rules
+    - always_declare_return_types
+    - always_require_non_null_named_parameters
+    - annotate_overrides
+    - avoid_init_to_null
+    - avoid_return_types_on_setters
+    - camel_case_extensions
+    - camel_case_types
+    - constant_identifier_names
+    - curly_braces_in_flow_control_structures
+    - empty_catches
+    - empty_constructor_bodies
+    - library_names
+    - library_prefixes
+    - prefer_contains
+    - prefer_final_fields
+    - prefer_is_empty
+    - prefer_is_not_empty
+    - prefer_single_quotes
+    - slash_for_doc_comments
+    - unnecessary_const
+    - unnecessary_new
+    - unnecessary_this
+    - use_rethrow_when_possible
+
+analyzer:
+  exclude:
+    - "**/*.g.dart"
+    - "**/*.freezed.dart"
+    - "**/*.config.dart"
+    - "build/**"
+  
+  errors:
+    invalid_annotation_target: ignore

package/templates/flutter-clean/lib/core/constants/app_constants.dart

@@ -0,0 +1,26 @@
+/// Application-wide constants
+class AppConstants {
+  // Private constructor to prevent instantiation
+  AppConstants._();
+
+  /// App Information
+  static const String appName = '__APP_NAME_PASCAL__';
+  static const String appVersion = '1.0.0';
+
+  /// API Configuration
+  static const String baseUrl = 'https://api.example.com';
+  static const String apiVersion = 'v1';
+  static const Duration apiTimeout = Duration(seconds: 30);
+
+  /// Storage Keys
+  static const String tokenKey = 'auth_token';
+  static const String userKey = 'user_data';
+  static const String themeKey = 'theme_mode';
+
+  /// Pagination
+  static const int defaultPageSize = 20;
+
+  /// Validation
+  static const int minPasswordLength = 8;
+  static const int maxUsernameLength = 30;
+}

package/templates/flutter-clean/lib/core/theme/app_theme.dart

@@ -0,0 +1,90 @@
+import 'package:flutter/material.dart';
+
+/// Application theme configuration
+/// Defines light and dark theme for the app
+class AppTheme {
+  // Private constructor to prevent instantiation
+  AppTheme._();
+
+  // Color palette
+  static const Color primaryColor = Color(0xFF2196F3);
+  static const Color secondaryColor = Color(0xFF03DAC6);
+  static const Color errorColor = Color(0xFFB00020);
+  static const Color backgroundColor = Color(0xFFF5F5F5);
+
+  /// Light theme configuration
+  static ThemeData get lightTheme {
+    return ThemeData(
+      useMaterial3: true,
+      brightness: Brightness.light,
+      primaryColor: primaryColor,
+      scaffoldBackgroundColor: backgroundColor,
+      colorScheme: const ColorScheme.light(
+        primary: primaryColor,
+        secondary: secondaryColor,
+        error: errorColor,
+        background: backgroundColor,
+      ),
+      appBarTheme: const AppBarTheme(
+        centerTitle: true,
+        elevation: 0,
+        backgroundColor: primaryColor,
+        foregroundColor: Colors.white,
+      ),
+      elevatedButtonTheme: ElevatedButtonThemeData(
+        style: ElevatedButton.styleFrom(
+          padding: const EdgeInsets.symmetric(horizontal: 24, vertical: 12),
+          shape: RoundedRectangleBorder(
+            borderRadius: BorderRadius.circular(8),
+          ),
+        ),
+      ),
+      inputDecorationTheme: InputDecorationTheme(
+        border: OutlineInputBorder(
+          borderRadius: BorderRadius.circular(8),
+        ),
+        contentPadding: const EdgeInsets.symmetric(
+          horizontal: 16,
+          vertical: 12,
+        ),
+      ),
+    );
+  }
+
+  /// Dark theme configuration
+  static ThemeData get darkTheme {
+    return ThemeData(
+      useMaterial3: true,
+      brightness: Brightness.dark,
+      primaryColor: primaryColor,
+      scaffoldBackgroundColor: const Color(0xFF121212),
+      colorScheme: const ColorScheme.dark(
+        primary: primaryColor,
+        secondary: secondaryColor,
+        error: errorColor,
+      ),
+      appBarTheme: const AppBarTheme(
+        centerTitle: true,
+        elevation: 0,
+        backgroundColor: Color(0xFF1F1F1F),
+      ),
+      elevatedButtonTheme: ElevatedButtonThemeData(
+        style: ElevatedButton.styleFrom(
+          padding: const EdgeInsets.symmetric(horizontal: 24, vertical: 12),
+          shape: RoundedRectangleBorder(
+            borderRadius: BorderRadius.circular(8),
+          ),
+        ),
+      ),
+      inputDecorationTheme: InputDecorationTheme(
+        border: OutlineInputBorder(
+          borderRadius: BorderRadius.circular(8),
+        ),
+        contentPadding: const EdgeInsets.symmetric(
+          horizontal: 16,
+          vertical: 12,
+        ),
+      ),
+    );
+  }
+}

package/templates/flutter-clean/lib/core/utils/app_utils.dart

@@ -0,0 +1,29 @@
+/// Common utility functions for the application
+class AppUtils {
+  // Private constructor to prevent instantiation
+  AppUtils._();
+
+  /// Validates email format
+  static bool isValidEmail(String email) {
+    final emailRegex = RegExp(
+      r'^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$',
+    );
+    return emailRegex.hasMatch(email);
+  }
+
+  /// Validates password strength
+  static bool isValidPassword(String password) {
+    return password.length >= 8;
+  }
+
+  /// Formats date to readable string
+  static String formatDate(DateTime date) {
+    return '${date.day}/${date.month}/${date.year}';
+  }
+
+  /// Capitalizes first letter of string
+  static String capitalize(String text) {
+    if (text.isEmpty) return text;
+    return text[0].toUpperCase() + text.substring(1);
+  }
+}

package/templates/flutter-clean/lib/data/models/user_model.dart

@@ -0,0 +1,57 @@
+import '../domain/entities/user.dart';
+
+/// Data model for User
+/// Models are responsible for JSON serialization/deserialization
+class UserModel {
+  final String id;
+  final String name;
+  final String email;
+  final String createdAt;
+
+  UserModel({
+    required this.id,
+    required this.name,
+    required this.email,
+    required this.createdAt,
+  });
+
+  /// Convert JSON to UserModel
+  factory UserModel.fromJson(Map<String, dynamic> json) {
+    return UserModel(
+      id: json['id'] as String,
+      name: json['name'] as String,
+      email: json['email'] as String,
+      createdAt: json['created_at'] as String,
+    );
+  }
+
+  /// Convert UserModel to JSON
+  Map<String, dynamic> toJson() {
+    return {
+      'id': id,
+      'name': name,
+      'email': email,
+      'created_at': createdAt,
+    };
+  }
+
+  /// Convert UserModel to domain entity
+  User toEntity() {
+    return User(
+      id: id,
+      name: name,
+      email: email,
+      createdAt: DateTime.parse(createdAt),
+    );
+  }
+
+  /// Create UserModel from domain entity
+  factory UserModel.fromEntity(User user) {
+    return UserModel(
+      id: user.id,
+      name: user.name,
+      email: user.email,
+      createdAt: user.createdAt.toIso8601String(),
+    );
+  }
+}

package/templates/flutter-clean/lib/domain/entities/user.dart

@@ -0,0 +1,23 @@
+import 'package:equatable/equatable.dart';
+
+/// Example entity representing a user in the domain layer
+/// Entities are plain Dart classes with business logic
+class User extends Equatable {
+  final String id;
+  final String name;
+  final String email;
+  final DateTime createdAt;
+
+  const User({
+    required this.id,
+    required this.name,
+    required this.email,
+    required this.createdAt,
+  });
+
+  @override
+  List<Object?> get props => [id, name, email, createdAt];
+
+  @override
+  String toString() => 'User(id: $id, name: $name, email: $email)';
+}

package/templates/flutter-clean/lib/main.dart

@@ -0,0 +1,33 @@
+import 'package:flutter/material.dart';
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'core/theme/app_theme.dart';
+import 'presentation/screens/home_screen.dart';
+
+void main() async {
+  WidgetsFlutterBinding.ensureInitialized();
+  
+  // Initialize dependencies here
+  // await setupDependencyInjection();
+  
+  runApp(
+    const ProviderScope(
+      child: MyApp(),
+    ),
+  );
+}
+
+class MyApp extends StatelessWidget {
+  const MyApp({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      title: '__APP_NAME_PASCAL__',
+      debugShowCheckedModeBanner: false,
+      theme: AppTheme.lightTheme,
+      darkTheme: AppTheme.darkTheme,
+      themeMode: ThemeMode.system,
+      home: const HomeScreen(),
+    );
+  }
+}