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

コードの可視性

クラス、関数、メソッド、プロパティ、パラメーター、変数など、すべてのコード要素は可能な限りプライベートにしてください。