flu-cli-core 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,644 @@
+interface Logger {
+    info(message: string): void;
+    success(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+    title(message: string): void;
+    newLine(): void;
+}
+declare class ConsoleLogger implements Logger {
+    info(message: string): void;
+    success(message: string): void;
+    warn(message: string): void;
+    error(message: string): void;
+    title(message: string): void;
+    newLine(): void;
+}
+declare const logger: ConsoleLogger;
+
+/**
+ * 字符串工具函数
+ */
+/**
+ * 转换为 PascalCase
+ * home_page -> HomePage
+ */
+declare function toPascalCase(str: string): string;
+/**
+ * 转换为 snake_case
+ * HomePage -> home_page
+ */
+declare function toSnakeCase(str: string): string;
+/**
+ * 转换为 camelCase
+ * home_page -> homePage
+ */
+declare function toCamelCase(str: string): string;
+/**
+ * 转换为 Title Case
+ * home_page -> Home Page
+ */
+declare function toTitleCase(str: string): string;
+/**
+ * 转换为 kebab-case
+ * HomePage -> home-page
+ */
+declare function toKebabCase(str: string): string;
+
+/**
+ * 项目类型检测工具
+ * 职责：基于目录结构识别 lite/modular/clean 模板，并提供生成路径解析
+ */
+/**
+ * 检测项目模板类型
+ * @param {string} projectDir - 项目目录
+ * @returns {'lite'|'modular'|'clean'|string|null} 模板类型
+ */
+type ProjectTemplate$1 = 'lite' | 'modular' | 'clean' | string;
+declare function detectProjectTemplate(projectDir?: string): ProjectTemplate$1 | null;
+/**
+ * 检测是否为自定义模板项目
+ * @param {string} projectDir - 项目目录
+ * @returns {boolean} 是否为自定义模板项目
+ */
+declare function isCustomTemplateProject(projectDir?: string): boolean;
+declare function getStateManager(projectDir?: string): 'default' | 'provider' | 'getx' | 'riverpod';
+/**
+ * 获取页面生成路径
+ * @param {string} projectDir - 项目目录
+ * @param {string} moduleName - 模块名称
+ * @returns {string} 页面目录路径
+ */
+declare function getPagePath(projectDir: string, moduleName: string): string;
+/**
+ * 获取 ViewModel 生成路径
+ */
+declare function getViewModelPath(projectDir: string, moduleName: string): string;
+/**
+ * 获取 Widget 生成路径
+ */
+declare function getWidgetPath(projectDir: string, moduleName?: string | null): string;
+/**
+ * 获取 Service 生成路径
+ */
+declare function getServicePath(projectDir: string, moduleName?: string | null): string;
+/**
+ * 获取 Model 生成路径
+ */
+declare function getModelPath(projectDir: string, moduleName?: string | null): string;
+/**
+ * 获取相对导入路径
+ * @param {string} fromPath - 源文件路径
+ * @param {string} toPath - 目标文件路径
+ * @returns {string} 相对路径
+ */
+declare function getRelativeImportPath(fromPath: string, toPath: string): string;
+
+declare function loadProjectSnippets(projectDir: string): any;
+declare function renderSnippet(bodyLines: string[] | string, variables: Record<string, any>): string;
+declare function getSnippetContent(projectDir: string, key: string, variables: Record<string, any>): string | null;
+
+/**
+ * 模板生成器
+ * 负责生成各种类型的代码内容，供 Generator 和 Snippets 复用
+ */
+declare class TemplateGenerator {
+    /**
+     * 生成 Stateful Page (BasePage)
+     */
+    /**
+     * 生成 Stateful Page (BasePage)
+     */
+    static generateStatefulPageWithBase(namePascal: string, nameTitle: string, options?: {
+        vmImportPath?: string;
+        coreImportPath?: string;
+        baseClass?: string;
+        extraImports?: string[];
+    }): string;
+    /**
+     * 生成 Simple Stateful Page
+     */
+    static generateSimpleStatefulPage(namePascal: string, nameTitle: string): string;
+    /**
+     * 生成 Simple Stateless Page
+     */
+    static generateSimpleStatelessPage(namePascal: string, nameTitle: string): string;
+    /**
+     * 生成 ViewModel
+     */
+    static generateViewModel(namePascal: string, options?: {
+        coreImportPath?: string;
+        baseClass?: string;
+        extraImports?: string[];
+    }): string;
+    /**
+     * 生成 Service
+     */
+    static generateService(namePascal: string): string;
+    /**
+     * 生成 Widget (Stateful)
+     */
+    static generateStatefulWidget(namePascal: string): string;
+    /**
+     * 生成 Widget (Stateless)
+     */
+    static generateStatelessWidget(namePascal: string): string;
+    /**
+     * 生成 Component (Stateless)
+     */
+    static generateComponent(namePascal: string): string;
+    /**
+     * 生成 Component (Stateful)
+     */
+    static generateStatefulComponent(namePascal: string): string;
+    /**
+     * 生成 Model
+     */
+    static generateModel(namePascal: string): string;
+}
+
+/**
+ * index.dart 更新工具
+ * 自动更新目录的 index.dart 导出文件
+ */
+/**
+ * 更新 index.dart 文件
+ * @param {string} dirPath - 目录路径
+ * @param {string} fileName - 要添加的文件名
+ */
+declare function updateIndexFile(dirPath: string, fileName: string): boolean;
+
+/**
+ * 获取模板根目录
+ * 兼容 ESM 和打包后的场景
+ */
+declare function getTemplatesRootDir(): string;
+/**
+ * 获取 core_files 模板目录
+ */
+declare function getCoreFilesDir(): string;
+/**
+ * 复制 core 文件到项目
+ * @param projectPath 项目根目录
+ * @param options 配置选项
+ */
+declare function copyCoreFiles(projectPath: string, options?: {
+    includeNetworkLayer?: boolean;
+    templateType?: 'lite' | 'modular' | 'clean';
+    projectName?: string;
+    stateManager?: string;
+}): Promise<void>;
+/**
+ * 获取 network 模板目录
+ */
+declare function getNetworkDir(): string;
+/**
+ * 复制 network 文件到项目
+ * @param projectPath 项目根目录
+ * @param targetDir 目标目录（相对于项目根目录），默认为 'lib/core/network'
+ * @param includeExamples 是否包含示例文件，默认为 false
+ */
+declare function copyNetworkFiles(projectPath: string, options?: {
+    targetDir?: string;
+    includeExamples?: boolean;
+}): Promise<void>;
+/**
+ * 复制完整的基础设施层（core files）
+ * @param projectPath 项目根目录
+ * @param includeExamples 是否包含示例文件（已废弃，保留兼容性）
+ * @param includeNetwork 是否包含网络层
+ */
+declare function copyInfrastructure(projectPath: string, includeExamples?: boolean, includeNetworkLayer?: boolean, templateType?: 'lite' | 'modular' | 'clean'): Promise<void>;
+/**
+ * 移除模板后缀并复制模板
+ */
+declare function copyTemplate(templatePath: string, targetPath: string, options?: {
+    excludes?: string[];
+}): Promise<boolean>;
+/**
+ * 注入网络层示例代码
+ * @param projectPath 项目根目录
+ * @param contextData 渲染上下文数据
+ */
+declare function injectNetworkExamples(projectPath: string, contextData?: any): Promise<void>;
+/**
+ * 自动生成目录下的 index.dart 导出文件
+ */
+declare function generateIndexFile(dir: string): Promise<void>;
+/**
+ * 复制自定义模板（仅 lib, assets, .vscode 等）
+ */
+declare function copyCustomTemplate(templatePath: string, targetPath: string): Promise<boolean>;
+/**
+ * 变量替换
+ */
+declare function replaceVariables(projectDir: string, variables: any): Promise<boolean>;
+/**
+ * 递归移除目录中所有文件的 .template 后缀
+ */
+declare function removeTemplateSuffix(dir: string): Promise<void>;
+/**
+ * 强制校正 pubspec.yaml 的 name 字段为项目名
+ */
+declare function ensurePubspecName(projectDir: string, projectName: string): Promise<void>;
+/**
+ * 清理模板特有文件
+ */
+declare function cleanupTemplateFiles(projectDir: string): Promise<void>;
+
+/**
+ * 页面生成器
+ */
+
+/**
+ * 生成页面文件
+ */
+declare function generatePage(name: string, options?: any, logger?: Logger): Promise<boolean>;
+
+/**
+ * ViewModel 生成器
+ */
+
+/**
+ * 生成 ViewModel 文件
+ */
+declare function generateViewModel(name: string, options?: any, logger?: Logger): Promise<boolean>;
+
+/**
+ * Model 生成器
+ */
+
+/**
+ * 生成 Model 文件
+ */
+declare function generateModel(name: string, options?: any, logger?: Logger): Promise<boolean>;
+
+/**
+ * Widget 生成器
+ */
+
+/**
+ * 生成 Widget 文件
+ */
+declare function generateWidget(name: string, options?: any, logger?: Logger): Promise<boolean>;
+
+/**
+ * Component 生成器
+ */
+
+/**
+ * 生成 Component 文件
+ */
+declare function generateComponent(name: string, options?: any, logger?: Logger): Promise<boolean>;
+
+/**
+ * Service 生成器
+ */
+/**
+ * 生成 Service 文件
+ */
+declare function generateService(name: string, options?: any, customLogger?: any): Promise<boolean>;
+
+/**
+ * 模块生成器
+ * 用于创建完整的功能模块结构
+ */
+
+/**
+ * 生成模块
+ */
+declare function generateModule(name: string, options?: any, logger?: Logger): Promise<boolean>;
+
+/**
+ * 升级项目中的 snippets 文件
+ */
+
+/**
+ * 升级项目中的 snippets
+ */
+declare function upgradeSnippets(options?: {
+    projectDir?: string;
+    force?: boolean;
+}, logger?: Logger): Promise<boolean>;
+/**
+ * 检查项目 snippets 是否需要更新
+ */
+declare function checkSnippetsVersion(projectDir?: string): 'up-to-date' | 'outdated' | 'missing';
+
+interface CustomTemplate {
+    id: string;
+    name: string;
+    type: 'git' | 'local';
+    url?: string;
+    path?: string;
+    branch?: string;
+    description?: string;
+    lastUsedAt?: number;
+}
+interface FluConfig {
+    templates: CustomTemplate[];
+    authorName?: string;
+    defaultTemplate?: {
+        type: 'builtin' | 'custom';
+        idOrName: string;
+    };
+    locale?: string;
+}
+declare class ConfigManager {
+    private static instance;
+    private configPath;
+    private config;
+    private constructor();
+    static getInstance(): ConfigManager;
+    private loadConfig;
+    private saveConfig;
+    getTemplates(): CustomTemplate[];
+    addTemplate(template: CustomTemplate): void;
+    removeTemplate(id: string): boolean;
+    getTemplate(id: string): CustomTemplate | undefined;
+    getAuthorName(): string;
+    setAuthorName(name: string): void;
+    getDefaultTemplate(): {
+        type: "builtin" | "custom";
+        idOrName: string;
+    };
+    setDefaultTemplate(type: 'builtin' | 'custom', idOrName: string): void;
+    getLocale(): string;
+    setLocale(locale: string): void;
+}
+
+type ProjectTemplate = string | CustomTemplate;
+interface ProjectOptions {
+    templateType?: string;
+    template?: string;
+    stateManager: 'default' | 'provider' | 'getx' | 'riverpod';
+    packageName: string;
+    outputDir: string;
+    includeNetworkLayer?: boolean;
+}
+/**
+ * ProjectGenerator (V6.0)
+ * 采用 Task Pipeline 架构，极简核心，逻辑拆分至各原子 Task。
+ */
+declare class ProjectGenerator {
+    /**
+     * 生成项目
+     * @param {string} name 项目名称
+     * @param {object} options 选项
+     * @param {Logger} logger 日志工具
+     */
+    generate(name: string, options?: any, logger?: Logger): Promise<boolean>;
+    /**
+     * 检查项目目录是否存在
+     */
+    checkProjectExists(projectPath: string): boolean;
+}
+
+/**
+ * 项目配置管理器
+ * 职责：读取和管理项目级别的 .flu-cli.json 配置文件
+ */
+/**
+ * 生成器配置接口
+ */
+interface GeneratorConfig {
+    path?: string;
+    defaultType?: 'stateful' | 'stateless';
+    fileSuffix?: string;
+    fileName?: string;
+    withBasePage?: boolean;
+    basePageClass?: string;
+    basePageImport?: string;
+    withViewModel?: boolean;
+    viewModelPath?: string;
+    withBaseViewModel?: boolean;
+    baseViewModelClass?: string;
+    baseViewModelImport?: string;
+    withBaseWidget?: boolean;
+    baseWidgetClass?: string;
+    baseWidgetImport?: string;
+    withBaseModel?: boolean;
+    baseModelClass?: string;
+    baseModelImport?: string;
+    template?: 'network' | 'simple' | 'auto' | string;
+    snippetKey?: string;
+    mockLevel?: 'global' | 'instance';
+}
+/**
+ * 项目配置接口
+ */
+interface ProjectConfig {
+    template?: 'lite' | 'modular' | 'clean' | string;
+    packageName?: string;
+    generators?: {
+        page?: GeneratorConfig;
+        viewModel?: GeneratorConfig;
+        widget?: GeneratorConfig;
+        model?: GeneratorConfig;
+        component?: GeneratorConfig;
+        service?: GeneratorConfig;
+        module?: {
+            path?: string;
+        };
+    };
+}
+/**
+ * 项目配置管理器
+ */
+declare class ProjectConfigManager {
+    private static CONFIG_FILE_NAME;
+    /**
+     * 加载项目配置
+     * @param projectDir 项目目录
+     * @returns 配置对象，如果不存在则返回 null
+     */
+    static loadConfig(projectDir: string): ProjectConfig | null;
+    /**
+     * 检查项目是否有配置文件
+     * @param projectDir 项目目录
+     * @returns 是否存在配置文件
+     */
+    static hasConfig(projectDir: string): boolean;
+    /**
+     * 获取指定生成器的配置
+     * @param projectDir 项目目录
+     * @param generatorType 生成器类型
+     * @returns 生成器配置，如果不存在则返回 null
+     */
+    static getGeneratorConfig(projectDir: string, generatorType: 'page' | 'viewModel' | 'widget' | 'model' | 'component'): GeneratorConfig | null;
+    /**
+     * 获取默认配置模板
+     * @param templateType 模板类型
+     * @returns 配置模板对象
+     */
+    static getDefaultConfigTemplate(templateType: 'lite' | 'modular' | 'clean' | 'custom' | string): ProjectConfig;
+}
+
+/**
+ * 应用资源选择接口
+ */
+interface AppAssetConfig {
+    appIcon?: string;
+    splashLogo?: string;
+    splashBackground?: string;
+    splashBackgroundColor?: string;
+    enableDarkMode?: boolean;
+    splashLogoDark?: string;
+    splashBackgroundDark?: string;
+    splashBackgroundColorDark?: string;
+}
+/**
+ * 应用资源管理器
+ * 负责配置应用图标和启动图
+ */
+declare class AppAssetsManager {
+    /**
+     * 设置应用资源
+     * @param projectPath 项目路径
+     * @param assets 资源配置
+     * @param logger 日志工具
+     */
+    setupAppAssets(projectPath: string, assets: AppAssetConfig, logger: Logger): Promise<boolean>;
+    /**
+     * 复制文件（当源路径与目标路径相同时跳过）
+     */
+    private copyIfDifferent;
+    /**
+     * 更新 pubspec.yaml
+     */
+    private updatePubspec;
+    /**
+     * 移除已存在的配置块（如 flutter_launcher_icons:, flutter_native_splash:）
+     */
+    private removeExistingConfigBlocks;
+    /**
+     * 执行命令
+     */
+    private runCommand;
+}
+
+/**
+ * 模板元数据接口
+ */
+interface TemplateMetadata {
+    name: string;
+    displayName: string;
+    description: string;
+    repo: string;
+    branch: string;
+    complexity: number;
+    teamSize: string;
+    codeSize: string;
+    features: string[];
+    structure: string;
+}
+/**
+ * 模板类型定义
+ */
+type TemplateType = 'builtin' | 'git' | 'local';
+/**
+ * 内置模板配置
+ */
+declare const BUILTIN_TEMPLATES: Record<string, TemplateMetadata>;
+/**
+ * 模板管理器：负责模板的下载、缓存、管理
+ */
+declare class TemplateManager {
+    private static instance;
+    private configManager;
+    private cacheDir;
+    private constructor();
+    static getInstance(): TemplateManager;
+    /**
+     * 获取模板缓存目录
+     */
+    getCacheDir(): string;
+    /**
+     * 确保缓存目录存在
+     */
+    private ensureCacheDir;
+    /**
+     * 获取模板本地路径
+     * @param templateName 模板名称
+     * @param isCustom 是否为自定义模板
+     */
+    getTemplatePath(templateName: string, isCustom?: boolean): string;
+    /**
+     * 准备模板（确保已缓存且为最新）
+     *
+     * 支持以下模板源（优先级从高到低）：
+     * 1. 环境变量指定的本地模板目录 (FLU_CLI_USE_LOCAL_TEMPLATES=true + FLU_CLI_LOCAL_TEMPLATES_DIR)
+     * 2. 自定义模板配置 (ConfigManager)
+     * 3. 内置模板 (lite/modular/clean)
+     */
+    prepareTemplate(templateId: string, logger?: Logger, forceUpdate?: boolean): Promise<string | undefined>;
+    /**
+     * 通用 Git 仓库缓存逻辑
+     */
+    private ensureGitRepoCached;
+    /**
+     * 克隆仓库
+     */
+    private cloneRepo;
+    /**
+     * 检查模板更新状态
+     */
+    checkUpdate(templateId: string): Promise<{
+        hasUpdate: boolean;
+        message: string;
+    }>;
+}
+
+declare class I18nManager {
+    private static instance;
+    private locales;
+    private locale;
+    private localesDir;
+    private constructor();
+    private resolveLocalesDir;
+    static getInstance(): I18nManager;
+    private loadLocales;
+    setLocale(locale: string): void;
+    getLocale(): string;
+    t(key: string, params?: Record<string, any>): string;
+}
+declare const t: (key: string, params?: Record<string, any>) => string;
+
+/**
+ * Flutter 辅助工具
+ * 职责：封装 flutter create/pub get/版本检测等命令调用
+ */
+/**
+ * 运行 flutter create 命令
+ * @param {string} projectDir - 项目目录
+ * @param {string} projectName - 项目名称
+ * @param {string} packageName - 包名
+ * @returns {Promise<boolean>} 是否成功
+ */
+/**
+ * 运行 flutter create 命令
+ * @param {string} projectDir - 项目目录
+ * @param {string} projectName - 项目名称
+ * @param {string} packageName - 包名
+ * @param {string} flutterTemplate - Flutter 官方模板 (app, module, package, plugin)
+ * @returns {Promise<boolean>} 是否成功
+ */
+declare function runFlutterCreate(projectDir: string, projectName: string, packageName: string, flutterTemplate?: string): Promise<boolean>;
+/**
+ * 运行 flutter pub get
+ * @param {string} projectDir - 项目目录
+ * @returns {Promise<boolean>} 是否成功
+ */
+declare function runFlutterPubGet(projectDir: string): Promise<boolean>;
+/**
+ * 检查 Flutter 是否安装
+ * @returns {Promise<boolean>} 是否已安装
+ */
+declare function checkFlutterInstalled(): Promise<boolean>;
+/**
+ * 获取 Flutter 版本
+ * @returns {Promise<string|null>} Flutter 版本
+ */
+declare function getFlutterVersion(): Promise<string | null>;
+
+export { type AppAssetConfig, AppAssetsManager, BUILTIN_TEMPLATES, ConfigManager, ConsoleLogger, type CustomTemplate, type FluConfig, type GeneratorConfig, I18nManager, type Logger, type ProjectConfig, ProjectConfigManager, ProjectGenerator, type ProjectOptions, type ProjectTemplate, TemplateGenerator, TemplateManager, type TemplateType, checkFlutterInstalled, checkSnippetsVersion, cleanupTemplateFiles, copyCoreFiles, copyCustomTemplate, copyInfrastructure, copyNetworkFiles, copyTemplate, detectProjectTemplate, ensurePubspecName, generateComponent, generateIndexFile, generateModel, generateModule, generatePage, generateService, generateViewModel, generateWidget, getCoreFilesDir, getFlutterVersion, getModelPath, getNetworkDir, getPagePath, getRelativeImportPath, getServicePath, getSnippetContent, getStateManager, getTemplatesRootDir, getViewModelPath, getWidgetPath, injectNetworkExamples, isCustomTemplateProject, loadProjectSnippets, logger, removeTemplateSuffix, renderSnippet, replaceVariables, runFlutterCreate, runFlutterPubGet, t, toCamelCase, toKebabCase, toPascalCase, toSnakeCase, toTitleCase, updateIndexFile, upgradeSnippets };