# Flutter_Skill 技能 **Repository Path**: MyBabyEar/flutter_skill ## Basic Information - **Project Name**: Flutter_Skill 技能 - **Description**: 本库是flutter项目，用于训练skill技能，根据项目情况逐步训练完善中 - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 8 - **Created**: 2026-03-23 - **Last Updated**: 2026-04-10 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # OpenHarmony Flutter 第三方库技能包 > 面向开源与合规交付的 OpenHarmony / 鸿蒙 Flutter 文档工具链，基于 SKILL.md 规范，在 Cursor/Trae 及兼容智能体环境中即装即用。采用 Apache-2.0 许可证，可免费用于个人项目。 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE) ## 介绍 本仓库提供标准化规格书、交付用 README、HTML 导出、pub.dev 预检以及 Android→OpenHarmony 代码/资源迁移能力，帮助团队在 **Flutter 项目** 场景下快速产出符合规范的交付物。主要能力包括： - **生成项目规格书**：根据项目配置与 README 生成 `[项目名称]_spec.md`，仅总结鸿蒙平台功能。 - **生成交付用 README**：按模板生成 OpenHarmony 交付所需的四类文档——**中文说明** `README.OpenHarmony_CN.md`、**英文说明** `README.OpenHarmony.md`、**开源说明** `README.OpenSource.md`（含 pub.dev 版本/协议/Owner 等占位填充），以及**仅含鸿蒙适配历史的** `CHANGELOG.md`；支持分支名替换、二进制段落按需保留/删除、协议与 API 表格占位符自动填充。 - **规格书 HTML 导出**：从 `[项目名称]_spec.md` 按固定模板导出为 `[项目名称]_spec.html`（用户场景表、API 表等）。 - **pub.dev 预发布检查**：在发布到 pub.dev 前，对 `pubspec.yaml`、README、LICENSE 等进行基础规范检查。 - **Android→鸿蒙自动迁移**：在已有 `ohos/` 骨架的前提下，按目录 1:1 将 `android/src/main/**` 的代码与资源迁移到 `ohos/src/main/**`，生成 ArkTS/ETS 与资源文件，支撑 Flutter 仓库迁移；迁移前需要能访问本机知识库 `E:\flutter_skill.wiki\Flutter鸿蒙化三方库知识库\索引.md`，否则应提示缺少知识库而不是继续自动翻译。 - **交付件生成**：当用户明确提出“交付件/接口文档/拼写检查报告”等目标时，自动生成 `readme检查结论 docx`、codespell 拼写检查报告、基于 README API 表格与固定 Excel 模板生成的接口文档 `xlsx`，以及 `源代码.txt`（含固定 URL）。 - **Android example APK 构建与安装运行**：在含 `example/` 的 Flutter 仓库中构建 Debug/Release APK，通过 `adb install -r` 安装到已连接设备后执行 `flutter run` 打开运行。 | 技能名称 | 说明 | 触发示例 | |----------|------|----------| | `flutter-ohos-spec` | 规格书与交付件生成（含 README 检查） | 生成规格书、鸿蒙规格书 | | `flutter-ohos-spechtml` | 从规格书 Markdown 导出 HTML 片段 | 生成 HTML 规格书、导出规格书 HTML、按模板导出 HTML | | `flutter-ohos-readme` | 仅创建/补全 OpenHarmony 中英文 README 及鸿蒙 CHANGELOG | 生成 OpenHarmony README、创建 README.OpenHarmony | | `flutter-ohos-pubdev-check` | pub.dev 预发布规范检查 | pub.dev 预检、检查 pub.dev 交付项 | | `flutter-ohos-generator` | 在现有 Flutter 插件项目中快速生成并抽取 ohos 工程骨架 | 生成鸿蒙插件工程、给 Flutter 插件加 ohos 平台、生成 ohos 插件骨架 | | `flutter-ohos-auto-adapt` | Android 代码/资源自动迁移到 OpenHarmony 目录 | 自动鸿蒙化 Android 代码、一键把 Android 端改成鸿蒙 | | `flutter-ohos-deliverables` | 总交付件生成（readme检查结论/codespell/接口文档/设计说明书/测试方案/自测试报告等） | 生成交付件、导出接口文档 xlsx、生成拼写检查报告、设计说明书、测试方案、自测试报告 | | `flutter-ohos-design-specification` | 生成/补全 Flutter 三方库鸿蒙化设计说明书（docx） | 生成设计说明书、鸿蒙化设计说明书、设计文档 | | `flutter-ohos-deliverables-testPlan` | 生成 Flutter 三方库鸿蒙化测试方案（docx） | 生成测试方案、测试计划、测试需求文档 | | `flutter-ohos-test-report-generator` | 生成 Flutter 三方库鸿蒙化自测试报告（docx） | 生成自测试报告、回归测试用例、测试报告 | | `flutter-ohos-plugin-feasibility` | Android 插件鸿蒙化可行性评估（HTML 报告、人天） | 鸿蒙化评估、接口梳理、代码量统计、网页版分析报告 | | `flutter-build-android-apk` | 编译 example 的 Debug/Release APK，adb 安装并 `flutter run` | 编译 apk、安装 apk 并运行、debug/release apk | --- ## 获取项目 从 Gitee 克隆本仓库（请将 `your-username/flutter_skill` 替换为实际仓库路径）： ```bash git clone https://gitee.com/your-username/flutter_skill.git cd flutter_skill ``` 若在 **Cursor** 的已有 Flutter 项目中使用，可将克隆后的 `skills/` 目录复制到目标项目的 `.cursor/skills/` 若在 **Trae** 的已有 Flutter 项目中使用，可将克隆后的 `skills/` 目录复制到目标项目的 `.trae/skills/` --- ## 使用说明 ### 方式一：在 Cursor 中使用（推荐） Cursor 会从 **项目目录** `.cursor/skills/` 下自动加载技能，本仓库已包含对应配置。 #### 步骤 1：打开项目 用 Cursor 打开**本仓库**或**已集成本技能包的项目**（即工作区根目录下存在 `.cursor/skills/` 或 `skills/`）。 #### 步骤 2：确认技能加载 - 项目技能路径：`.cursor/skills/<技能名>/SKILL.md` - 本仓库已提供： - `skills/flutter-ohos-spec/SKILL.md` — 规格书与交付件生成 - `skills/flutter-ohos-deliverables/SKILL.md` — 交付件生成（readme 检查结论/codespell/接口文档等） - `skills/flutter-ohos-readme/SKILL.md` — README 生成 - `skills/flutter-ohos-spechtml/SKILL.md` — 规格书 HTML 导出 - `skills/flutter-ohos-pubdev-check/SKILL.md` — pub.dev 预发布检查 - `skills/flutter-ohos-generator/SKILL.md` — 在现有 Flutter 插件工程中快速生成并抽取 ohos 工程骨架 - `skills/flutter-ohos-plugin-feasibility/SKILL.md` — Android 插件鸿蒙化可行性评估（HTML / 人天） - `skills/flutter-ohos-design-specification/SKILL.md` — 设计说明书生成（docx） - `skills/flutter-ohos-deliverables-testPlan/SKILL.md` — 测试方案生成（docx） - `skills/flutter-ohos-test-report-generator/SKILL.md` — 自测试报告生成（docx） - `skills/flutter-build-android-apk/SKILL.md` — Android example APK 构建、安装与运行 无需额外配置，Cursor 会在对话时根据描述自动匹配技能。 **路径约定**：文档与技能中的 `skills/<技能名>/` 表示本仓库内路径；若已将技能复制到目标工程，请改为 `.cursor/skills/<技能名>/`（与 `SKILL.md` 内说明一致）。 #### 步骤 3：在对话中触发技能 在 Cursor 的 AI 对话里直接说出你的需求，例如： - **生成规格书 / 交付件**： 「帮我生成一下规格书」「做一下交付件」「生成鸿蒙规格书」 → 触发 **`flutter-ohos-spec`**，按 `SKILL.md` 阶段执行（含 README 检查，缺失时会先走 **`flutter-ohos-readme`**）。 - **仅生成 README**： 「生成 OpenHarmony README」「创建 README.OpenHarmony」 → 触发 **`flutter-ohos-readme`**，按模板生成交付用 README 与鸿蒙 CHANGELOG。 - **规格书导出 HTML**： 「生成 HTML 规格书」「导出规格书 HTML」「按模板导出 HTML」 → 触发 **`flutter-ohos-spechtml`**，从已有 `规格书/` 或 `所有规格书/` 下的 `*_spec.md` 生成同名 `*_spec.html`（路径以 `flutter-ohos-spec` / `flutter-ohos-spechtml` 为准）。 - **pub.dev 预检**： 「帮我做一次 pub.dev 预检」「检查一下 pub.dev 发布规范」「看看 pubspec.yaml 和 README 有没有问题」 → 触发 **`flutter-ohos-pubdev-check`**，对 pub.dev 相关交付项做只读检查并给出修改建议。 - **鸿蒙化可行性评估（网页报告）**： 「鸿蒙化评估」「接口梳理」「代码量统计」「网页版分析报告」 → 触发 **`flutter-ohos-plugin-feasibility`**。 - **交付件生成（拼写检查/接口文档等）**： 「生成交付件」「导出接口文档 xlsx」「生成拼写检查报告」 → 触发 `flutter-ohos-deliverables`，按条件生成 `readme检查结论 docx`、codespell 报告、接口文档 `xlsx` 以及 `源代码.txt`。 - **生成设计说明书 / 测试方案 / 自测试报告（docx）**： 「生成设计说明书」「生成测试方案」「生成自测试报告」 → 分别触发 `flutter-ohos-design-specification` / `flutter-ohos-deliverables-testPlan` / `flutter-ohos-test-report-generator`。 - **编译 Android APK 并安装运行**： 「编译 debug apk 并安装」「release apk 安装到手机」「编译 apk 并打开运行」 → 触发 **`flutter-build-android-apk`**，在 `example/` 下构建 APK、`adb install -r` 后 `flutter run`（详见文末说明）。 #### 步骤 4：按提示完成 - **规格书输出路径**以 `skills/flutter-ohos-spec/SKILL.md` 为准：单项目一般在项目根目录下 **`规格书/[项目名称]_spec.md`**；多项目在 **`所有规格书/[项目名称]_spec.md`**。 - 若缺少 `README.OpenHarmony_CN.md` / `README.OpenHarmony.md`，规格书流程会先执行 **`flutter-ohos-readme`** 再继续。 - **交付件输出路径（设计/测试类 docx）**：统一为 `交付件//设计说明书`、`交付件//测试方案`、`交付件//自测试报告`（以对应技能 `SKILL.md` 为准）。 --- ### 方式二：在 Trae 中使用 若你使用 trae 等支持 SKILL.md 的智能体平台，可将本仓库中的技能引入后，通过技能名调用。 #### 步骤 1：打开 trae 功能设置 在trae 会从 **项目目录** `.trae/skills/` 下自动加载技能，本仓库已包含对应配置。 或在 trae 中打开技能/功能相关设置入口（通常位于「设置」-「技能」或「自定义能力」等菜单中）。 #### 步骤 2：引入 SKILL.md 技能 在「技能」或「自定义能力」中，添加本仓库的技能目录或 SKILL 文件： - **规格书技能**：`skills/flutter-ohos-spec/SKILL.md` - **交付件技能**：`skills/flutter-ohos-deliverables/SKILL.md` - **README 技能**：`skills/flutter-ohos-readme/SKILL.md` - **规格书 HTML 技能**：`skills/flutter-ohos-spechtml/SKILL.md` - **pub.dev 预检技能**：`skills/flutter-ohos-pubdev-check/SKILL.md` - **ohos 工程生成技能**：`skills/flutter-ohos-generator/SKILL.md` - **Android→ohos 自动迁移技能**：`skills/flutter-ohos-auto-adapt/SKILL.md` - **插件鸿蒙化可行性评估**：`skills/flutter-ohos-plugin-feasibility/SKILL.md` - **设计说明书生成**：`skills/flutter-ohos-design-specification/SKILL.md` - **测试方案生成**：`skills/flutter-ohos-deliverables-testPlan/SKILL.md` - **自测试报告生成**：`skills/flutter-ohos-test-report-generator/SKILL.md` - **Android APK 构建与运行**：`skills/flutter-build-android-apk/SKILL.md` 确保模板路径可用（例如本仓库的各 `skills/*/references/templates/` 目录），或根据你的环境调整技能内引用的模板路径，例如：确认技能配置中引用的模板路径与本地实际路径一致。 #### 步骤 3：调用技能 在智能体对话中输入要调用的技能名（下划线或短横线均可，以平台解析为准）： - **规格书与交付件**：`flutter-ohos-spec` - **交付件生成（readme 检查/codespell/接口文档等）**：`flutter-ohos-deliverables` - **仅 README**：`flutter-ohos-readme` - **规格书 HTML 导出**：`flutter-ohos-spechtml` - **pub.dev 预检**：`flutter-ohos-pubdev-check` - **生成 ohos 工程骨架**：`flutter-ohos-generator` - **Android→ohos 目录 1:1 迁移**：`flutter-ohos-auto-adapt` - **插件鸿蒙化可行性评估**：`flutter-ohos-plugin-feasibility` - **Android example APK 构建安装运行**：`flutter-build-android-apk` --- ## 技能与模板路径约定 - **技能目录**（本项目）：`skills/` 为源码，`.cursor/skills/` 为 Cursor 加载用。 - **模板与资产**（以各技能 `SKILL.md` 引用为准），例如： - README 模板：`skills/flutter-ohos-readme/assets/README.OpenHarmony_CN.md` - 规格书 HTML 参考：`skills/flutter-ohos-spechtml/assets/spec.html` - **规格书输出**：见 `flutter-ohos-spec`（单项目 `规格书/`、多项目 `所有规格书/`）；HTML 与对应 `*_spec.md` 同目录，文件名为 `[项目名称]_spec.html`。 按上述步骤即可在 Cursor 或 trae 中完成「使用技能」的完整流程；若某一步在你的环境中不同，可根据实际界面调整步骤描述。 --- ## 许可证与商用说明 - **许可证**：本项目采用 [Apache License 2.0](LICENSE)，允许商业使用、修改与再分发，需保留版权与许可证声明。 - **合规**：技能生成的 OpenHarmony 交付文档结构符合常见开源与商业交付规范，具体合规要求请以您所在组织或下游客户为准。 --- ## 贡献与反馈 欢迎通过 Gitee 提交 Issue 与 Pull Request 参与改进，或就使用问题与需求进行反馈。