flu-cli 0.0.1 → 0.0.4

package/lib/userInteraction.js

@@ -4,17 +4,20 @@
  * 包含所有与用户交互相关的函数
  */
 
-const inquirer = require('inquirer');
-const fs = require('fs');
-const chalk = require('chalk');
-const path = require('path');
-const { printColored, validatePackageName, validateProjectName } = require('./utils');
-const { getDesktopPath } = require('./desktopPath');
+
+import inquirer from 'inquirer';
+const { prompt } = inquirer;
+import { existsSync } from 'fs';
+
+import { join } from 'path';
+import { printColored, validatePackageName, validateProjectName } from './utils.js';
+
+
 
 /**
  * 用户交互功能集合
  */
-const getUserInteraction = {
+export const getUserInteraction = {
   /**
    * 获取项目类型
    * 
@@ -22,14 +25,16 @@ const getUserInteraction = {
    */
   getProjectType: async () => {
 
-    const { projectType } = await inquirer.prompt([
+    const { projectType } = await prompt([
       {
         type: 'list',
         name: 'projectType',
         message: '请选择项目类型:',
         choices: [
-          { name: '应用 (app)', value: 'app' },
-          { name: '模块 (module)', value: 'module' }
+          { name: '应用 (app)', value: 'app', },
+          { name: '模块 (module)', value: 'module', },
+          { name: '原生插件 (plugin)', value: 'plugin', },
+          { name: '插件 (package)', value: 'package', }
         ],
         default: 'app'
       }
@@ -40,28 +45,52 @@ const getUserInteraction = {
   /**
    * 获取模板类型
    * 
-   * @returns {Promise<string>} '1' 或 '2'
+   * @returns {Promise<string>} 'only' 或 'min' 或 'normal' 或 'pro'
    */
   getTemplateType: async () => {
 
-    const { templateType } = await inquirer.prompt([
+
+
+    const { templateType } = await prompt([
       {
         type: 'list',
         name: 'templateType',
         message: '请选择项目模版:',
         choices: [
-          { name: 'min (基础UI)', value: '0' },
-          { name: 'normal (State)', value: '1' },
-          { name: 'pro (GetX)', value: '2' }
+          { name: 'only (main.dart)', value: 'only' },
+          { name: 'min (项目结构、路由管理、主题管理、状态管理、工具集)', value: 'min' },
+          { name: 'normal (项目结构、路由管理、主题管理、状态管理、工具集、UI组件库)', value: 'normal' },
+          { name: 'pro (项目结构、路由管理、主题管理、状态管理、工具集、UI组件库、网络请求、数据缓存、示例模块)', value: 'pro' }
         ],
-        default: '2'
+        default: 'pro'
       }
     ]);
     return templateType;
   },
 
+  /**
+   * 获取状态管理
+   * 
+   * @returns {Promise<string>} 'state' 或 'GetX'  
+   */
+  getStateManager: async () => {
+    const { stateManager } = await prompt([
+      {
+        type: 'list',
+        name: 'stateManager',
+        message: '请选择状态管理:',
+        choices: [
+          { name: 'state (State)', value: 'state' },
+          { name: 'get (GetX)', value: 'GetX' },
+        ],
+        default: 'state'
+      }
+    ]);
+    return stateManager;
+  },
+
   getIsNeedDemo: async () => {
-    const { isNeedDemo } = await inquirer.prompt([
+    const { isNeedDemo } = await prompt([
       {
         type: 'confirm',
         name: 'isNeedDemo',
@@ -81,59 +110,69 @@ const getUserInteraction = {
    * @param {string} defaultParentDir - 默认父目录
    * @returns {Promise<Object>} 项目信息对象
    */
-  getProjectInfo: async (projectType, defaultProjectName, defaultPackageName, defaultParentDir) => {
-    // 设置默认值
-    if (!defaultProjectName) {
-      defaultProjectName = projectType === 'module' ? "hzy_example_module" : "hzy_example_project";
-    }
-
+  getProjectInfo: async (projectType, defaultProjectName, defaultPackageName, defaultParentDir, flutterSdkPath) => {
     // 获取项目名称
-    const flutterPath = await getFlutterSdkPath();
+    let projectName = defaultProjectName;
+    if (!defaultProjectName) {
+      defaultProjectName = getDefaultProjectName(projectType);
+      const res = await prompt([
+        {
+          type: 'input',
+          name: 'projectName',
+          message: '请输入新项目名称（小写字母、数字和下划线）:',
+          default: defaultProjectName,
+          validate: validateProjectName
+        }
 
-    const { projectName } = await inquirer.prompt([
-      {
-        type: 'input',
-        name: 'projectName',
-        message: '请输入新项目名称（小写字母、数字和下划线）:',
-        default: defaultProjectName,
-        validate: validateProjectName
-      }
-    ]);
+      ]);
+      projectName = res.projectName;
+    }
 
+    // 获取Flutter SDK路径
+    if (!flutterSdkPath) {
+      flutterSdkPath = await getFlutterSdkPath();
+    }
     // 获取包名
-    const { packageName } = await inquirer.prompt([
-      {
-        type: 'input',
-        name: 'packageName',
-        message: '请输入包名:',
-        default: defaultPackageName || `com.example.${projectName}`,
-        validate: validatePackageName
-      }
-    ]);
+    let packageName = defaultPackageName;
+    if (!defaultPackageName) {
+      defaultPackageName = `com.example.${projectName}`;
+      const res = await prompt([
+        {
+          type: 'input',
+          name: 'packageName',
+          message: '请输入包名:',
+          default: defaultPackageName || `com.example.${projectName}`,
+          validate: validatePackageName
+        }
+      ]);
+      packageName = res.packageName;
+    }
 
 
-    // 获取项目存放路径
-    let desktopPath;
+
+    // 获取父目录
+    let parentDir = defaultParentDir;
     if (!defaultParentDir) {
-      desktopPath = await getDesktopPath();
+      defaultParentDir = process.cwd();
+      const res = await prompt([
+        {
+          type: 'input',
+          name: 'parentDir',
+          message: '请输入项目存放路径:',
+          default: defaultParentDir
+        }
+      ]);
+      parentDir = res.parentDir;
     }
-    const { parentDir } = await inquirer.prompt([
-      {
-        type: 'input',
-        name: 'parentDir',
-        message: '请输入项目存放路径:',
-        default: defaultParentDir || desktopPath
-      }
-    ]);
 
-    const targetDir = path.join(parentDir, projectName);
-    console.log('flutterPath:', flutterPath);
+    const targetDir = join(parentDir, projectName);
+    console.log('flutterPath:', flutterSdkPath);
     return {
       projectName,
       packageName,
       parentDir,
       targetDir,
-      flutterSdkPath: flutterPath
+      flutterSdkPath
     };
   },
 
@@ -146,7 +185,7 @@ const getUserInteraction = {
   confirmOverwrite: async (targetDir) => {
     printColored(`\n警告: 目标目录 ${targetDir} 已存在!`, 'yellow');
 
-    const { overwrite } = await inquirer.prompt([
+    const { overwrite } = await prompt([
       {
         type: 'confirm',
         name: 'overwrite',
@@ -170,7 +209,7 @@ const getUserInteraction = {
    * @returns {Promise<string>} IDE类型
    */
   getIdeChoice: async () => {
-    const { ideChoice } = await inquirer.prompt([
+    const { ideChoice } = await prompt([
       {
         type: 'list',
         name: 'ideChoice',
@@ -190,17 +229,46 @@ const getUserInteraction = {
 };
 
 async function getFlutterSdkPath () {
-  const { path: sdkPath } = await inquirer.prompt([{
+  const { path: sdkPath } = await prompt([{
     type: 'input',
     name: 'path',
 
     message: '请输入Flutter SDK路径（留空使用系统默认）:',
-    validate: input => !input || fs.existsSync(path.join(input, 'bin/flutter'))
+    validate: input => !input || existsSync(join(input, 'bin/flutter'))
   }]);
   return sdkPath || 'flutter';
 }
 
-module.exports = {
+/**
+ * 获取默认项目名称
+ * 
+ * @param {string} projectType - 项目类型 ('app'或'module')
+ * @returns {string} 默认项目名称
+ */
+function getDefaultProjectName (projectType) {
+  let defaultProjectName = 'project';
+  switch (projectType) {
+    case 'app':
+      defaultProjectName = 'project';
+      break;
+    case 'module':
+      defaultProjectName = 'module';
+      break;
+    case 'package':
+      defaultProjectName = 'package';
+      break;
+    case 'plugin':
+      defaultProjectName = 'plugin';
+      break;
+    default:
+      defaultProjectName = 'example';
+      break;
+  }
+  return "hzy_example_" + defaultProjectName;
+}
+
+export default {
   getFlutterSdkPath,
+  getDefaultProjectName,
   getUserInteraction
 };

package/lib/utils.js

@@ -1,40 +1,67 @@
 /**
  * 工具函数模块
  * 
- * 包含各种实用工具函数
+ * 包含项目创建过程中所需的各种实用工具函数，如模板分支计算、彩色输出、
+ * 验证函数、README生成和IDE打开等功能
  */
 
-const chalk = require('chalk');
-const fs = require('fs-extra');
-const path = require('path');
-const { exec } = require('child_process');
+import chalk from 'chalk';
+const { red: _red, green: _green, yellow: _yellow, blue: _blue, magenta, cyan: _cyan, bold } = chalk;
+import fsExtra from 'fs-extra';
+const { writeFileSync } = fsExtra;
+import { join, resolve } from 'path';
+import { exec } from 'child_process';
+
 
 /**
- * 打印彩色文本
+ * 计算模板分支名称
+ * 
+ * 根据模板类型和状态管理组合生成Git仓库分支名称
+ * 用于从Git仓库获取对应类型的项目模板
+ * 
+ * @param {string} templateType - 模板类型 (only, min, normal, pro)
+ * @param {string} stateManager - 状态管理类型 (state, GetX, Provider等)
+ * @returns {string} 组合后的模板分支名称
+ */
+export function getTemplateBranch (templateType, stateManager) {
+  if (stateManager == '') {
+    return templateType;
+  }
+  return templateType + "-" + stateManager;
+}
+
+/**
+ * 打印彩色文本到控制台
+ * 
+ * 支持多种颜色输出，用于区分不同类型的提示信息（成功、错误、警告等）
+ * 使用chalk库实现颜色渲染，并自动添加粗体效果
  * 
- * @param {string} text - 要打印的文本
- * @param {string} color - 颜色名称
+ * @param {string} text - 要打印的文本内容
+ * @param {string} color - 文本颜色，可选值: red, green, yellow, blue, purple, cyan
  */
-function printColored (text, color) {
+export function printColored (text, color) {
   const colorMap = {
-    red: chalk.red,
-    green: chalk.green,
-    yellow: chalk.yellow,
-    blue: chalk.blue,
-    purple: chalk.magenta,
-    cyan: chalk.cyan
+    red: _red,
+    green: _green,
+    yellow: _yellow,
+    blue: _blue,
+    purple: magenta,
+    cyan: _cyan
   };
 
-  console.log(chalk.bold(colorMap[color] ? colorMap[color](text) : text));
+  console.log(bold(colorMap[color] ? colorMap[color](text) : text));
 }
 
 /**
  * 验证项目名称是否符合Flutter项目命名规范
  * 
- * @param {string} name - 项目名称
- * @returns {boolean|string} 验证结果
+ * Flutter要求项目名称必须以小写字母开头，只能包含小写字母、数字和下划线
+ * 不符合规范时返回具体错误信息，符合时返回true
+ * 
+ * @param {string} name - 待验证的项目名称
+ * @returns {boolean|string} 验证结果，true表示有效，字符串表示错误信息
  */
-function validateProjectName (name) {
+export function validateProjectName (name) {
   if (!name.match(/^[a-z][a-z0-9_]*$/)) {
     return '错误: 项目名称必须以小写字母开头，只能包含小写字母、数字和下划线';
   }
@@ -44,10 +71,13 @@ function validateProjectName (name) {
 /**
  * 验证包名是否符合Java包名规范
  * 
- * @param {string} name - 包名
- * @returns {boolean|string} 验证结果
+ * 包名必须以小写字母开头，可包含小写字母、数字、下划线和点号，点号用于分隔层级
+ * 不符合规范时返回具体错误信息，符合时返回true
+ * 
+ * @param {string} name - 待验证的包名
+ * @returns {boolean|string} 验证结果，true表示有效，字符串表示错误信息
  */
-function validatePackageName (name) {
+export function validatePackageName (name) {
   if (!name.match(/^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*$/)) {
     return '错误: 包名必须符合Java包名规范，如com.example.myapp';
   }
@@ -55,51 +85,76 @@ function validatePackageName (name) {
 }
 
 /**
- * 更新README.md文件
+ * 生成并更新项目的README.md文件
+ * 
+ * 创建包含项目基本信息和快速开始指南的README文件
+ * 包含项目名称、创建日期、包名和基本命令说明
  * 
- * @param {string} targetDir - 目标目录路径
+ * @param {string} targetDir - 项目根目录路径
  * @param {string} projectName - 项目名称
- 
+ * @param {string} packageName - 项目包名
  */
-function updateReadme (targetDir, projectName) {
+export function updateReadme (targetDir, projectName, packageName) {
   const currentDate = new Date().toISOString().split('T')[0];
-  const readmePath = path.join(targetDir, 'README.md');
+  const readmePath = join(targetDir, 'README.md');
 
-  const readmeContent = `#  
+  const readmeContent = `# ${projectName}
 
-基于火之夜工作室 Flutter 通用项目框架创建
+基于火之夜工作室 Flutter 通用项目框架创建的应用
 
 ## 项目信息
 
 - 项目名称: ${projectName}
+- 包名: ${packageName}
 - 创建日期: ${currentDate}
 
+## 项目结构
+
+- lib/: 主要代码目录
+- assets/: 静态资源目录
+- pubspec.yaml: 项目依赖配置
+
 ## 快速开始
 
 \`\`\`bash
 # 安装依赖
 flutter pub get
 
-# 运行项目
+# 运行项目 (默认调试模式)
 flutter run
+
+# 构建发布版本
+flutter build appbundle
 \`\`\`
+
+## 功能特性
+
+- 完整的项目结构
+- 路由管理
+- 主题管理
+- 状态管理
+- 网络请求封装
+- 本地存储
 `;
 
-  fs.writeFileSync(readmePath, readmeContent, 'utf8');
+  writeFileSync(readmePath, readmeContent, 'utf8');
 }
 
 /**
- * 在IDE中自动打开项目
+ * 在指定IDE中自动打开项目
+ * 
+ * 根据用户选择的IDE类型和当前操作系统，执行相应的命令打开项目
+ * 支持VS Code、Android Studio、文件管理器或手动打开
  * 
- * @param {string} targetDir - 项目目录路径
- * @param {string} ideType - IDE类型
+ * @param {string} targetDir - 项目根目录绝对路径
+ * @param {string} [ideType="vscode"] - IDE类型，可选值: vscode, android_studio, open_folder, manual
  */
-function openProjectInIde (targetDir, ideType = "vscode") {
+export function openProjectInIde (targetDir, ideType = "vscode") {
   const platform = process.platform;
   let command = null;
 
   // 确保路径是绝对路径
-  targetDir = path.resolve(targetDir);
+  targetDir = resolve(targetDir);
 
   switch (ideType) {
     case 'vscode':
@@ -111,7 +166,7 @@ function openProjectInIde (targetDir, ideType = "vscode") {
       } else if (platform === 'win32') { // Windows
         // 在Windows上查找Android Studio路径会比较复杂
         // 这里简化处理，实际应用中可能需要更复杂的逻辑
-        command = `"C:\\Program Files\\Android\\Android Studio\\bin\\studio64.exe" "${targetDir}"`;
+        command = '"C:\\Program Files\\Android\\Android Studio\\bin\\studio64.exe" "${targetDir}"';
       } else if (platform === 'linux') { // Linux
         command = `studio "${targetDir}"`;
       }
@@ -143,10 +198,3 @@ function openProjectInIde (targetDir, ideType = "vscode") {
   }
 }
 
-module.exports = {
-  printColored,
-  validateProjectName,
-  validatePackageName,
-  updateReadme,
-  openProjectInIde
-};

package/package.json

@@ -1,8 +1,9 @@
 {
     "name": "flu-cli",
-    "version": "0.0.1",
+    "version": "0.0.4",
     "description": "火之夜工作室 Flutter 项目创建工具",
     "main": "index.js",
+    "type": "module",
     "bin": {
         "flu-cli": "./index.js"
     },
@@ -20,11 +21,13 @@
     "license": "MIT",
     "dependencies": {
         "chalk": "^4.1.2",
-        "cli-progress": "^3.12.0",
         "commander": "^11.1.0",
         "fs-extra": "^11.2.0",
         "inquirer": "^8.2.6",
         "ora": "^5.4.1",
         "path": "^0.12.7"
+    },
+    "devDependencies": {
+        "@types/fs-extra": "^11.0.4"
     }
 }

package/publish.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -e
+
+# 检查是否有未提交的更改
+if [[ -n $(git status -s) ]]; then
+  echo "Error: There are uncommitted changes. Please commit or stash them first."
+  exit 1
+fi
+
+# 更新版本号 (patch版本，如需其他类型可改为minor或major)
+npm version patch --no-git-tag-version -m "chore: bump version to %s"
+
+# 获取版本号并创建git tag
+VERSION=$(node -p "require('./package.json').version")
+git tag -a "v$VERSION" -m "Release v$VERSION"
+
+# 获取当前分支名
+BRANCH_NAME=$(git rev-parse --abbrev-ref HEAD)
+if [[ -z "$BRANCH_NAME" ]]; then
+  echo "Error: Unable to determine current branch."
+  exit 1
+fi
+
+# 推送提交和标签到当前分支对应的远程分支
+# 使用双引号防止通配符扩展和单词分割
+git push origin "$BRANCH_NAME" --tags
+
+# 发布到npm
+npm publish

package/lib/desktopPath.js

@@ -1,85 +0,0 @@
-/**
- * 桌面路径获取模块
- * 
- * 用于获取不同操作系统下的桌面路径
- */
-
-const os = require('os');
-const path = require('path');
-const fs = require('fs-extra');
-
-/**
- * 获取用户桌面路径，支持多操作系统
- * 
- * @returns {Promise<string>} 桌面路径
- */
-async function getDesktopPath () {
-  const platform = process.platform;
-  let desktopPath = '';
-
-  if (platform === 'darwin') { // macOS
-    desktopPath = path.join(os.homedir(), 'Desktop');
-  } else if (platform === 'win32') { // Windows
-    try {
-      // 尝试从环境变量获取桌面路径
-      const userProfile = process.env.USERPROFILE || os.homedir();
-      desktopPath = path.join(userProfile, 'Desktop');
-
-      // 如果路径不存在，尝试其他可能的位置
-      if (!fs.existsSync(desktopPath)) {
-        desktopPath = path.join(os.homedir(), 'Desktop');
-      }
-    } catch (error) {
-      // 如果获取失败，使用默认路径
-      desktopPath = path.join(os.homedir(), 'Desktop');
-    }
-  } else if (platform === 'linux') { // Linux
-    // 首先尝试从环境变量获取
-    desktopPath = process.env.XDG_DESKTOP_DIR;
-
-    if (!desktopPath || !fs.existsSync(desktopPath)) {
-      // 尝试获取XDG_DESKTOP_DIR环境变量
-      const xdgConfig = path.join(os.homedir(), '.config/user-dirs.dirs');
-
-      if (fs.existsSync(xdgConfig)) {
-        try {
-          const content = fs.readFileSync(xdgConfig, 'utf8');
-          const lines = content.split('\n');
-
-          for (const line of lines) {
-            if (line.startsWith('XDG_DESKTOP_DIR=')) {
-              // 提取路径并处理引号和$HOME
-              let extractedPath = line.split('=')[1].trim().replace(/"/g, '');
-              extractedPath = extractedPath.replace('$HOME', os.homedir());
-
-              if (fs.existsSync(extractedPath)) {
-                desktopPath = extractedPath;
-                break;
-              }
-            }
-          }
-        } catch (error) {
-          // 如果读取配置文件失败，使用默认路径
-          desktopPath = path.join(os.homedir(), 'Desktop');
-        }
-      }
-
-      // 如果仍然没有找到，使用默认路径
-      if (!desktopPath || !fs.existsSync(desktopPath)) {
-        desktopPath = path.join(os.homedir(), 'Desktop');
-      }
-    }
-  } else {
-    // 其他操作系统，使用默认路径
-    desktopPath = path.join(os.homedir(), 'Desktop');
-  }
-
-  // 确保路径存在，如果不存在则使用用户主目录
-  if (!fs.existsSync(desktopPath)) {
-    desktopPath = os.homedir();
-  }
-
-  return desktopPath;
-}
-
-module.exports = { getDesktopPath };