Line data Source code
1 : package designdoc
2 :
3 : import (
4 : "fmt"
5 : "regexp"
6 : "strings"
7 :
8 : "gopkg.in/yaml.v3"
9 : )
10 :
11 : // fence は frontmatter を囲むデリミタ。
12 : const fence = "---"
13 :
14 : var (
15 : reTitle = regexp.MustCompile(`(?m)^#\s+(.+?)\s*$`)
16 : // reProgressHeading は `## 進捗` 見出しにマッチする。\x{9032}\x{6357} は 進捗 のコードポイントで、
17 : // リテラルで書くと gosmopolitan が日本語リテラルとして検知するため escape している。
18 : reProgressHeading = regexp.MustCompile(`(?m)^##\s+\x{9032}\x{6357}\s*$`)
19 : reAnyHeading = regexp.MustCompile(`(?m)^##\s`)
20 : reOpenTask = regexp.MustCompile(`(?m)^- \[ \]`)
21 : reDoneTask = regexp.MustCompile(`(?m)^- \[x\]`)
22 : // reSkipTask は「意図的に着手しない」タスク。不採用・見送りを表す。open にも done にも数えない。
23 : reSkipTask = regexp.MustCompile(`(?m)^- \[~\]`)
24 : )
25 :
26 : // Parse は設計ドキュメントの内容を解析する。path は診断メッセージに使うだけで読み込みはしない。
27 : func Parse(path string, content string) (*Document, error) {
28 1 : doc := &Document{Path: path}
29 1 :
30 1 : front, body, hasFront, err := splitFrontmatter(content)
31 1 : if err != nil {
32 1 : return nil, fmt.Errorf("failed to parse frontmatter of %s: %w", path, err)
33 1 : }
34 1 : doc.HasFront = hasFront
35 1 : doc.Front = front
36 1 : doc.Body = body
37 1 :
38 1 : if m := reTitle.FindStringSubmatch(body); m != nil {
39 1 : doc.Title = m[1]
40 1 : }
41 1 : countProgress(doc)
42 1 :
43 1 : return doc, nil
44 : }
45 :
46 : // splitFrontmatter は先頭の YAML frontmatter と本文を分離する。frontmatter が無ければ hasFront が false になる。
47 : func splitFrontmatter(content string) (Frontmatter, string, bool, error) {
48 1 : if !strings.HasPrefix(content, fence+"\n") {
49 1 : return Frontmatter{}, content, false, nil
50 1 : }
51 :
52 1 : rest := content[len(fence)+1:]
53 1 : end := strings.Index(rest, "\n"+fence)
54 1 : if end < 0 {
55 1 : return Frontmatter{}, content, false, fmt.Errorf("closing delimiter %q not found", fence)
56 1 : }
57 :
58 1 : yamlPart := rest[:end]
59 1 : // 閉じデリミタの行を飛ばし、続く空行も落として本文が見出しから始まるようにする。
60 : // Render は frontmatter と本文の間に必ず空行を1つ入れるので、往復しても安定する。
61 1 : body := strings.TrimLeft(rest[end+1+len(fence):], "\n")
62 1 :
63 1 : var front Frontmatter
64 1 : if err := yaml.Unmarshal([]byte(yamlPart), &front); err != nil {
65 1 : return Frontmatter{}, content, false, fmt.Errorf("failed to unmarshal YAML: %w", err)
66 1 : }
67 :
68 1 : return front, body, true, nil
69 : }
70 :
71 : // countProgress は本文の `## 進捗` セクションからチェックボックス数を数える。
72 : func countProgress(doc *Document) {
73 1 : loc := reProgressHeading.FindStringIndex(doc.Body)
74 1 : if loc == nil {
75 1 : return
76 1 : }
77 1 : doc.HasProgress = true
78 1 :
79 1 : section := doc.Body[loc[1]:]
80 1 : // 次の `## ` 見出しがあればそこまでを進捗セクションとする。
81 1 : if next := reAnyHeading.FindStringIndex(section); next != nil {
82 1 : section = section[:next[0]]
83 1 : }
84 :
85 1 : doc.OpenTasks = len(reOpenTask.FindAllString(section, -1))
86 1 : doc.DoneTasks = len(reDoneTask.FindAllString(section, -1))
87 1 : doc.SkippedTasks = len(reSkipTask.FindAllString(section, -1))
88 : }
89 :
90 : // InferStatus は進捗チェックボックスから status を決定的に導出する。
91 : // LLM 推論を挟まないため、同じ入力に対して常に同じ結果を返す。
92 : //
93 : // - 進捗セクションが無い、または項目0件 → draft
94 : // - 未完タスクが残る → in-progress
95 : // - 全て完了 → done
96 : //
97 : // superseded・dropped・accepted は進捗からは判定できないため、人が個別に設定する。
98 : func InferStatus(doc *Document) Status {
99 1 : switch {
100 : case !doc.HasProgress:
101 1 : return StatusDraft
102 : case doc.OpenTasks > 0:
103 1 : return StatusInProgress
104 : case doc.DoneTasks > 0:
105 1 : return StatusDone
106 : default:
107 1 : return StatusDraft
108 : }
109 : }
110 :
111 : // Render は frontmatter と本文から、ファイルに書き戻す文字列を組み立てる。
112 : func Render(front Frontmatter, body string) (string, error) {
113 1 : yamlPart, err := yaml.Marshal(front)
114 1 : if err != nil {
115 0 : return "", fmt.Errorf("failed to marshal frontmatter: %w", err)
116 0 : }
117 :
118 1 : var b strings.Builder
119 1 : b.WriteString(fence + "\n")
120 1 : // strings.Builder.Write はエラーを返さない。
121 1 : _, _ = b.Write(yamlPart)
122 1 : b.WriteString(fence + "\n\n")
123 1 : b.WriteString(body)
124 1 :
125 1 : return b.String(), nil
126 : }
|