flu-cli 0.0.2 → 0.0.5

package/lib/createProject.js

@@ -1,60 +1,102 @@
 /**
  * 项目创建模块
  * 
- * 负责协调整个项目创建流程
+ * 负责协调整个Flutter项目的创建流程，包括用户交互、项目初始化、模板复制和环境配置
+ * 支持通过命令行参数或交互式方式创建不同类型和模板的Flutter项目
  */
 
+import { execSync } from 'child_process';
+import ora from 'ora';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import fsExtra from 'fs-extra';
+const { existsSync, mkdirSync, accessSync, constants, removeSync } = fsExtra;
+import { getUserInteraction } from './userInteraction.js';
+import { copyLibDirectory, copyVscode } from './libCopier.js';
+import { runFlutterCreate } from './flutterProjectCreator.js';
+import { printColored, updateReadme, openProjectInIde, getTemplateBranch } from './utils.js';
 
-const { execSync } = require('child_process');
-const ora = require('ora');
-const path = require('path');
-const fs = require('fs-extra');
-const { getUserInteraction } = require('./userInteraction');
-const { copyLibDirectory } = require('./libCopier');
-const { runFlutterCreate } = require('./flutterProjectCreator');
-const { printColored, updateReadme, openProjectInIde } = require('./utils');
+/**
+ * 生成默认项目名称
+ * 
+ * 根据项目类型和当前日期生成唯一的默认项目名称，避免命名冲突
+ * 应用类型项目以'flutter_app_'为前缀，模块类型以'flutter_module_'为前缀
+ * 
+ * @param {string} projectType - 项目类型 ('app' 或 'module')
+ * @returns {string} 带时间戳的默认项目名称
+ */
+function getDefaultProjectName (projectType) {
+  const date = new Date();
+  const timestamp = `${date.getFullYear()}${String(date.getMonth() + 1).padStart(2, '0')}${String(date.getDate()).padStart(2, '0')}`;
+  return projectType === 'app' ? `flutter_app_${timestamp}` : `flutter_module_${timestamp}`;
+}
 
 /**
  * 创建项目的主函数
  * 
- * 协调整个项目创建流程，包括获取用户输入、创建项目、复制模板等
- * @param {Object} options - 命令行参数选项
- * @param {boolean} options.useCommandLineArgs - 是否使用命令行参数
- * @param {string} options.projectType - 项目类型 ('app'或'module')
- * @param {string} options.templateType - 模板类型 ('0', '1', '2')
- * @param {boolean} options.isNeedDemo - 是否需要示例代码
- * @param {string} options.projectName - 项目名称
- * @param {string} options.packageName - 包名
- * @param {string} options.parentDir - 项目存放路径
- * @param {string} options.ideChoice - IDE选择
+ * 协调整个项目创建流程，包括获取用户输入、验证环境、创建Flutter项目、复制模板文件、
+ * 生成README和自动打开IDE等步骤。支持命令行参数和交互式两种模式
+ * 
+ * @param {Object} [options={}] - 命令行参数选项
+ * @param {boolean} [options.useCommandLineArgs=false] - 是否使用命令行参数
+ * @param {string} [options.projectType] - 项目类型 ('app','module','package','plugin')
+ * @param {string} [options.templateType] - 模板类型 ('only', 'min', 'normal', 'pro')
+ * @param {string} [options.stateManager] - 状态管理 ('state', 'GetX', 'Provider', etc.)
+ * @param {string} [options.projectName] - 项目名称
+ * @param {string} [options.packageName] - 包名
+ * @param {string} [options.parentDir] - 项目存放路径
+ * @param {string} [options.ideChoice] - IDE选择 ('vscode', 'android_studio', etc.)
+ * @param {string} [options.flutterSdk] - Flutter SDK路径
+ * @example
+ * // 交互式创建项目
+ * createProject();
+ * // 命令行模式创建项目
+ * createProject({
+ *   useCommandLineArgs: true,
+ *   projectType: 'app',
+ *   templateType: 'pro',
+ *   projectName: 'my_app',
+ *   packageName: 'com.example.myapp',
+ *   parentDir: '/path/to/projects'
+ * });
  */
 async function createProject (options = {}) {
   try {
     // 获取项目类型 - 从命令行参数或交互式输入
     const projectType = options.useCommandLineArgs ? options.projectType : await getUserInteraction.getProjectType();
+    let templateType = '';
+    // 项目类型为app或module时，获取模板类型
+    if (projectType == "app" || projectType == "module") {
+      // 获取模板类型 - 从命令行参数或交互式输入
+      templateType = options.useCommandLineArgs ? options.templateType : await getUserInteraction.getTemplateType();
+    } else {
+      // 项目类型为package或plugin时，模板类型固定为only
+      templateType = 'only';
+    }
 
-    // 获取模板类型 - 从命令行参数或交互式输入
-    const templateType = options.useCommandLineArgs ? options.templateType : await getUserInteraction.getTemplateType();
 
-    // 获取是否需要demo的确认 - 从命令行参数或交互式输入
-    const isNeedDemo = options.useCommandLineArgs ? options.isNeedDemo : await getUserInteraction.getIsNeedDemo();
+    // 获取状态管理 - 仅在非基础模板时需要
+    let stateManager = '';
+    if (templateType != 'only' && templateType != 'min') {
+      stateManager = options.useCommandLineArgs ? options.stateManager : await getUserInteraction.getStateManager();
+    }
 
     // 获取当前脚本所在目录作为源目录
-    const sourceDir = path.dirname(require.main.filename);
+    const sourceDir = dirname(fileURLToPath(import.meta.url));
 
     // 获取项目信息 - 从命令行参数或交互式输入
     let projectName, packageName, parentDir, targetDir, flutterSdkPath;
 
-    if (options.useCommandLineArgs && options.projectName && options.packageName && options.parentDir) {
+    if (options.useCommandLineArgs && options.projectName && options.packageName && options.parentDir && options.flutterSdk) {
       // 使用命令行参数
       projectName = options.projectName;
       packageName = options.packageName;
       parentDir = options.parentDir;
-      targetDir = path.join(parentDir, projectName);
+      targetDir = join(parentDir, projectName);
       flutterSdkPath = options.flutterSdk;
     } else if (options.useCommandLineArgs) {
       // 命令行参数不完整，使用交互式输入，但预填充已提供的参数
-      const defaultName = projectType === 'module' ? "hzy_example_module" : "hzy_example_project";
+      const defaultName = getDefaultProjectName(projectType);
       const projectInfo = await getUserInteraction.getProjectInfo(
         projectType,
         options.projectName || defaultName,
@@ -69,8 +111,11 @@ async function createProject (options = {}) {
     } else {
       // 完全使用交互式输入
       const projectInfo = await getUserInteraction.getProjectInfo(projectType);
+      // 项目名字
       projectName = projectInfo.projectName;
+      // 包名 
       packageName = projectInfo.packageName;
+      // 项目存放地址
       parentDir = projectInfo.parentDir;
       targetDir = projectInfo.targetDir;
       flutterSdkPath = projectInfo.flutterSdkPath;
@@ -78,9 +123,9 @@ async function createProject (options = {}) {
 
     console.log('flutterSdkPath:', flutterSdkPath);
     // 验证目标目录是否存在并具有写权限
-    if (!fs.existsSync(parentDir)) {
+    if (!existsSync(parentDir)) {
       try {
-        fs.mkdirSync(parentDir, { recursive: true });
+        mkdirSync(parentDir, { recursive: true });
       } catch (e) {
         printColored(`错误: 无法创建目录 ${parentDir}: ${e.message}`, 'red');
         return;
@@ -89,14 +134,14 @@ async function createProject (options = {}) {
 
     // 检查目标目录是否具有写权限
     try {
-      fs.accessSync(parentDir, fs.constants.W_OK);
+      accessSync(parentDir, constants.W_OK);
     } catch (e) {
       printColored(`错误: 目录 ${parentDir} 没有写权限`, 'red');
       return;
     }
 
     // 检查目标目录是否已存在
-    if (fs.existsSync(targetDir)) {
+    if (existsSync(targetDir)) {
       const overwrite = await getUserInteraction.confirmOverwrite(targetDir);
       if (!overwrite) {
         printColored("操作已取消", 'yellow');
@@ -104,7 +149,7 @@ async function createProject (options = {}) {
       }
 
       // 删除已存在的目录
-      fs.removeSync(targetDir);
+      removeSync(targetDir);
     }
 
     // 使用flutter create创建新项目
@@ -116,40 +161,25 @@ async function createProject (options = {}) {
     }
     flutterCreateSpinner.succeed('Flutter项目创建成功');
 
-    // 根据模板类型选择Git分支和是否需要demo分支
-    let templateBranch = 'master';
-
-    switch (templateType) {
-      case '0':
-        // 基础模版
-        templateBranch = 'master';
-        break;
-      case '1':
-        // State模板
-        templateBranch = 'depend';
-        break;
-      case '2':
-        // GetX模板
-        templateBranch = 'depend-get';
-        break;
-      default:
-        break;
-    }
 
-    if (isNeedDemo && templateType != '0') {
-      templateBranch = templateBranch + '-demo';
-    }
-    // 复制项目文件
-    const copySpinner = ora('正在复制项目模板...').start();
-    const copyResult = await copyLibDirectory(sourceDir, targetDir, projectName, projectType, templateType, packageName, templateBranch);
-    if (!copyResult) {
-      copySpinner.fail('项目模板复制失败');
-      return;
+
+    if (templateType != 'only') {
+      // 获取模板分支名称
+      const templateBranch = getTemplateBranch(templateType, stateManager);
+      // 复制项目文件
+      const copySpinner = ora('正在复制项目模板...').start();
+      const copyResult = await copyLibDirectory(sourceDir, targetDir, projectName, projectType, templateType, packageName, templateBranch);
+      if (!copyResult) {
+        copySpinner.fail('项目模板复制失败');
+        return;
+      }
+      copySpinner.succeed('项目模板复制成功');
+      // 更新README.md
+      updateReadme(targetDir, projectName, packageName);
     }
-    copySpinner.succeed('项目模板复制成功');
 
-    // 更新README.md
-    updateReadme(targetDir, projectName,);
+
+
 
     // 打印完成信息
     printColored("\n新项目已创建成功！", 'green');
@@ -161,6 +191,9 @@ async function createProject (options = {}) {
 
     // 获取用户选择的IDE类型 - 从命令行参数或交互式输入
     const ideChoice = options.useCommandLineArgs ? options.ideChoice : await getUserInteraction.getIdeChoice();
+    if (ideChoice == 'vscode' && templateType != 'only') {
+      await copyVscode(targetDir);
+    }
     if ((ideChoice == 'vscode' || ideChoice == 'android_studio') && flutterSdkPath === 'flutter') {
       const pubGetSpinner = ora('正在获取Flutter依赖...').start();
       try {
@@ -184,4 +217,4 @@ async function createProject (options = {}) {
   }
 }
 
-module.exports = { createProject };
+export { createProject };

package/lib/flutterProjectCreator.js

@@ -1,66 +1,80 @@
 /**
- * Flutter项目创建模块
+ * Flutter项目创建器模块
  * 
- * 负责执行flutter create命令创建新项目
+ * 负责执行Flutter官方命令行工具创建新项目，处理不同项目类型的创建参数
+ * 支持应用、模块、包和插件等多种项目类型，并处理Flutter SDK路径配置
  */
 
-const { exec } = require('child_process');
-const path = require('path');
-const { printColored } = require('./utils');
-const os = require('os');
-const { console } = require('inspector');
+import { exec } from 'child_process';
+import { printColored } from './utils.js';
 
 /**
- * 使用flutter create命令创建新项目
+ * 执行flutter create命令创建新项目
  * 
- * @param {string} targetDir - 目标目录路径
+ * 根据提供的参数调用Flutter SDK的create命令，创建指定类型的Flutter项目
+ * 支持自定义Flutter SDK路径，处理不同操作系统下的命令格式差异
+ * 
+ * @param {string} targetDir - 项目创建目标目录绝对路径
  * @param {string} projectName - 项目名称
- * @param {string} packageName - 包名
- * @param {string} projectType - 项目类型 ('app'-应用, 'module'-模块)
- * @returns {Promise<boolean>} 是否创建成功
+ * @param {string} packageName - 应用包名（Android）或Bundle ID（iOS）
+ * @param {string} projectType - 项目类型，可选值：'app', 'module', 'package', 'plugin'
+ * @param {string} [flutterSdkPath='flutter'] - Flutter SDK路径，默认为系统环境变量中的'flutter'
+ * @returns {Promise<boolean>} 创建成功返回true，失败返回false
  */
-async function runFlutterCreate (targetDir, projectName, packageName, projectType = 'app', flutterSdkPath = 'flutter') {
+async function runFlutterCreate (targetDir, projectName, packageName, projectType, flutterSdkPath = 'flutter') {
   return new Promise((resolve) => {
-    printColored(`正在创建Flutter项目: ${flutterSdkPath}`, 'green');
-    try {
-      // 确保路径是绝对路径
-      targetDir = path.resolve(targetDir);
-      let flutterCmd = flutterSdkPath;
-      if (flutterSdkPath !== 'flutter') {
-        flutterCmd = path.join(flutterSdkPath, 'bin', 'flutter');
-        printColored(`使用自定义Flutter SDK路径: ${flutterCmd}`, 'yellow');
-      }
-      // 构建命令参数
-      const orgName = packageName.split('.').slice(0, -1).join('.');
-      let command = `${flutterCmd} create --org ${orgName} --project-name ${projectName}`;
-      // 根据项目类型添加参数
-      if (projectType === 'module') {
+    // 构建flutter create命令参数
+    let command = `${flutterSdkPath} create`;
+
+    // 根据项目类型添加参数
+    switch (projectType) {
+      case 'module':
         command += ' --template=module';
-      }
-      // 添加目标目录
-      command += ` "${targetDir}"`;
-      // 执行命令
-      exec(command, (error, stdout, stderr) => {
-        if (error) {
-          printColored(`创建Flutter项目失败: ${error.message}`, 'red');
-          printColored("请确保Flutter已正确安装并添加到系统PATH中", 'yellow');
-          printColored("可以尝试在命令行中运行'flutter doctor'检查Flutter安装状态", 'yellow');
-          resolve(false);
-          return;
-        }
+        break;
+      case 'package':
+        command += ' --template=package';
+        break;
+      case 'plugin':
+        command += ' --template=plugin';
+        break;
+      case 'app':
+      default:
+        // 默认创建应用项目
+        break;
+    }
+
+    // 添加包名参数
+    command += ` --org ${packageName}`;
+
+    // 添加项目名称和目标路径
+    command += ` --project-name ${projectName}  ${targetDir}`;
 
-        if (stderr) {
-          printColored(`警告: ${stderr}`, 'yellow');
-        }
+    printColored(`执行命令: ${command}`, 'blue');
 
-        printColored("Flutter项目创建成功！", 'green');
+    // 执行命令
+    exec(command, (error, stdout, stderr) => {
+      // 输出命令执行过程信息
+      if (stdout) printColored(stdout, 'gray');
+      if (stderr) printColored(stderr, 'yellow');
+
+      // 处理错误
+      if (error) {
+        printColored(`Flutter项目创建失败: ${error.message}`, 'red');
+        resolve(false);
+        return;
+      }
+
+      // 验证是否包含成功信息
+      if (stdout.includes('All done!') || stdout.includes('Created project')) {
+        printColored(`Flutter ${projectType}项目创建成功`, 'green');
         resolve(true);
-      });
-    } catch (e) {
-      printColored(`创建Flutter项目时发生未知错误: ${e.message}`, 'red');
-      resolve(false);
-    }
+      } else {
+        printColored('Flutter项目创建未检测到成功标志', 'yellow');
+        resolve(false);
+      }
+    });
   });
 }
 
-module.exports = { runFlutterCreate };
+export { runFlutterCreate };
+