LCOV - code coverage report
Current view: top level - designdoc - document.go Coverage Total Hit
Test: coverage.lcov Lines: 100.0 % 10 10
Test Date: 2026-11-19 00:25:22 Functions: - 0 0

            Line data    Source code
       1              : package designdoc
       2              : 
       3              : // Status は設計ドキュメントの進行状態を表す。GitHub Issue の open/closed に相当する。
       4              : type Status string
       5              : 
       6              : const (
       7              :         // StatusDraft は下書き。まだ着手していない。
       8              :         StatusDraft Status = "draft"
       9              :         // StatusAccepted は方針合意済みだが未着手。
      10              :         StatusAccepted Status = "accepted"
      11              :         // StatusInProgress は実装途中。進捗に未完タスクが残る。
      12              :         StatusInProgress Status = "in-progress"
      13              :         // StatusDone は完了。open なタスクが無い。進捗を持たない意思決定ドキュメントも該当する。
      14              :         StatusDone Status = "done"
      15              :         // StatusSuperseded は後続ドキュメントに置き換えられた。
      16              :         StatusSuperseded Status = "superseded"
      17              :         // StatusDropped は不採用として打ち切った。
      18              :         StatusDropped Status = "dropped"
      19              : )
      20              : 
      21              : // Valid は status が定義済みの値かを返す。
      22              : func (s Status) Valid() bool {
      23            1 :         switch s {
      24              :         case StatusDraft, StatusAccepted, StatusInProgress, StatusDone, StatusSuperseded, StatusDropped:
      25            1 :                 return true
      26              :         }
      27              : 
      28            1 :         return false
      29              : }
      30              : 
      31              : // IsOpen は未完了、すなわちバックログとして着手対象かを返す。アクションが要るかの単一の基準で、
      32              : // README の未完了一覧に載せる範囲もこれで決める。done・superseded・dropped は閉じた状態とみなす。
      33              : func (s Status) IsOpen() bool {
      34            1 :         switch s {
      35              :         case StatusDraft, StatusAccepted, StatusInProgress:
      36            1 :                 return true
      37              :         case StatusDone, StatusSuperseded, StatusDropped:
      38            1 :                 return false
      39              :         }
      40              : 
      41            1 :         return false
      42              : }
      43              : 
      44              : // Auto はルーチンが無人で着手してよいかの分類を表す。
      45              : type Auto string
      46              : 
      47              : const (
      48              :         // AutoMechanical は意思決定不要の機械的タスク。無人ルーチンの対象にできる。
      49              :         AutoMechanical Auto = "mechanical"
      50              :         // AutoNeedsDecision は人の判断を要するタスク。無人着手しない。
      51              :         AutoNeedsDecision Auto = "needs-decision"
      52              : )
      53              : 
      54              : // Valid は auto が定義済みの値かを返す。
      55              : func (a Auto) Valid() bool {
      56            1 :         switch a {
      57              :         case AutoMechanical, AutoNeedsDecision:
      58            1 :                 return true
      59              :         }
      60              : 
      61            1 :         return false
      62              : }
      63              : 
      64              : // KnownTags は tags に使える語彙。ここに無いタグは Validate が弾く。表記ゆれを構造的に防ぐため、
      65              : // タグを増やすときはここに追加する。
      66              : var KnownTags = []string{
      67              :         "refactor",   // リファクタリング、責務分割、用語統一
      68              :         "ecs",        // Ark ECS、コンポーネント、シングルトン
      69              :         "worldgen",   // マップ生成、シームレスワールド、チャンク
      70              :         "combat",     // 戦闘、AI行動、遠距離、ボス
      71              :         "ui",         // UIテーマ、ゴールデンテスト、HUD
      72              :         "item",       // アイテム、収納、スタック、運搬
      73              :         "movement",   // 移動、走り、マクロ移動
      74              :         "save",       // セーブ、永続化、ユーザー設定
      75              :         "ci",         // CI、linter、キャッシュ、コード生成
      76              :         "perf",       // パフォーマンス、ベンチマーク、プロファイル
      77              :         "gamedesign", // ゲーム方向性、バランス、ラン構造
      78              :         "member",     // 隊員、隊マネジメント
      79              :         "narrative",  // オープニング、ナレーション、コンセプト
      80              :         "steam",      // Steamリリース、ストアグラフィック
      81              :         "meta",       // 開発ワークフロー、設計ドキュメント運用
      82              : }
      83              : 
      84              : // Frontmatter は設計ドキュメント冒頭の YAML メタ情報を表す。
      85              : type Frontmatter struct {
      86              :         Status Status   `yaml:"status"`
      87              :         Tags   []string `yaml:"tags"`
      88              :         Auto   Auto     `yaml:"auto"`
      89              : }
      90              : 
      91              : // Document は1つの設計ドキュメントの解析結果を表す。
      92              : type Document struct {
      93              :         // Path は docs/design からの、あるいは呼び出し側が渡したファイルパス。
      94              :         Path string
      95              :         // Title は本文冒頭の `# ` 見出し。無ければ空。
      96              :         Title string
      97              :         // Front は解析した frontmatter。HasFront が false のときはゼロ値。
      98              :         Front Frontmatter
      99              :         // HasFront は frontmatter を持つかどうか。
     100              :         HasFront bool
     101              :         // HasProgress は `## 進捗` セクションを持つかどうか。
     102              :         HasProgress bool
     103              :         // OpenTasks は進捗の未完タスク数。`- [ ]`。
     104              :         OpenTasks int
     105              :         // DoneTasks は進捗の完了タスク数。`- [x]`。
     106              :         DoneTasks int
     107              :         // SkippedTasks は意図的に着手しないタスク数。`- [~]`。open にも done にも数えない。
     108              :         SkippedTasks int
     109              :         // Body は frontmatter を除いた本文。
     110              :         Body string
     111              : }
        

Generated by: LCOV version 2.0-1