genui-helper

GenUI 开发助手

此技能提供了适用于 genui 仓库的工作流和最佳实践。

工作流

1. 运行测试并修复问题

该仓库使用自定义工具在提交前运行测试、应用修复并格式化代码。 通常只应在提交前运行该工具，因为每次更改后都运行既低效又耗时。

该工具会对仓库中的所有软件包运行 dart fix --apply、dart format 和 flutter test。

命令：

dart run tool/test_and_fix/bin/test_and_fix.dart

使用时机：

• 提交更改前，确保项目状态良好。
• 用于替代逐个手动对仓库中的项目运行 flutter test。

2. 在 genui 软件包中创建新组件

在 genui 中创建新的 UI 组件时：

1. 位置：将组件文件放在 packages/genui/lib/src/components/ 中。
2. 继承：组件必须继承 UiComponent。
3. 符合 A2UI 规范：确保组件符合 A2UI 规范。
4. 文档：遵循严格的 Dart 文档规范。

3. 更新文档

• 文档的权威来源位于 docs/。
• 如果提到 mkdocs，请使用其上下文，但主要直接编辑 Markdown 文件。
• 严格遵循“自然写作”标准（避免 AI 式表达）。

关键常量和模式

• 当前 A2UI 版本：v0.9
• 状态管理：使用来自 genui 的 SurfaceController。

参考资料

• A2UI 规范
  • 可在子模块 @submodules/a2ui 中找到
  • 规范文档位于 @submodules/a2ui/specification/v0.9/docs
  • 规范架构位于 @submodules/a2ui/specification/v0.9/json
  • 由于它是子模块，你可能需要更新该子模块以获取最新规范。
• 若要了解特定 Dart 编译器诊断消息的详情，请使用以下 URL 格式查询：
  • https://dart.dev/tools/diagnostics/<message_id>
  • 示例：https://dart.dev/tools/diagnostics/ambiguous_import
• 若要了解特定分析器 lint 消息的详情，请使用以下 URL 格式查询：
  • https://dart.dev/tools/linter-rules/<lint_rule_id>
  • 示例：https://dart.dev/tools/linter-rules/always_declare_return_types

代码可见性

让每个代码元素（如类、函数、方法、属性、参数、变量）尽可能保持私有。