@squadbase/vantage-template 0.0.2 → 0.1.0-dev.0faf4cb

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/README.md +9 -7
  2. package/base-template/.squadbase/skills/project-storage/SKILL.md +157 -0
  3. package/base-template/.squadbase/skills/vantage-app/SKILL.md +6 -6
  4. package/base-template/.squadbase/skills/vantage-design/SKILL.md +127 -0
  5. package/base-template/.squadbase/skills/vantage-design/references/extract.md +110 -0
  6. package/base-template/.squadbase/skills/vantage-design/references/format.md +172 -0
  7. package/base-template/.squadbase/skills/vantage-design/references/presets.md +82 -0
  8. package/base-template/.squadbase/skills/vantage-design/scripts/contrast.mjs +166 -0
  9. package/base-template/.squadbase/skills/vantage-pitfalls/SKILL.md +22 -0
  10. package/base-template/AGENTS.md +98 -218
  11. package/base-template/DESIGN.md +108 -0
  12. package/base-template/agents/api.md +49 -0
  13. package/base-template/agents/csv.md +32 -0
  14. package/base-template/agents/doc.md +73 -0
  15. package/base-template/agents/page.md +187 -0
  16. package/base-template/agents/slide.md +41 -0
  17. package/base-template/agents/xlsx.md +33 -0
  18. package/base-template/automations/.gitkeep +0 -0
  19. package/base-template/bun.lock +907 -0
  20. package/base-template/package.json +3 -3
  21. package/base-template/pipelines/pyproject.toml +5 -0
  22. package/base-template/squadbase.yml +1 -0
  23. package/base-template/src/_error.tsx +7 -11
  24. package/base-template/src/_layout.tsx +8 -1
  25. package/base-template/src/components/build-recovery.tsx +219 -0
  26. package/base-template/src/styles.css +19 -0
  27. package/dist/index.js +16 -7
  28. package/package.json +18 -12
  29. package/ui-templates/chart-grid/pages/index.tsx +1 -1
  30. package/ui-templates/chart-grid/preview-square.png +0 -0
  31. package/ui-templates/chart-grid/preview-wide.png +0 -0
  32. package/ui-templates/chart-grid-ja/pages/index.tsx +1 -1
  33. package/ui-templates/chart-grid-ja/preview-square.png +0 -0
  34. package/ui-templates/chart-grid-ja/preview-wide.png +0 -0
  35. package/ui-templates/funnel/pages/index.tsx +2 -2
  36. package/ui-templates/funnel/preview-square.png +0 -0
  37. package/ui-templates/funnel/preview-wide.png +0 -0
  38. package/ui-templates/funnel-ja/pages/index.tsx +2 -2
  39. package/ui-templates/funnel-ja/preview-square.png +0 -0
  40. package/ui-templates/funnel-ja/preview-wide.png +0 -0
  41. package/ui-templates/kpi-chart-advanced/preview-square.png +0 -0
  42. package/ui-templates/kpi-chart-advanced/preview-wide.png +0 -0
  43. package/ui-templates/kpi-chart-advanced-ja/preview-square.png +0 -0
  44. package/ui-templates/kpi-chart-advanced-ja/preview-wide.png +0 -0
  45. package/ui-templates/kpi-chart-simple/preview-square.png +0 -0
  46. package/ui-templates/kpi-chart-simple/preview-wide.png +0 -0
  47. package/ui-templates/kpi-chart-simple-ja/preview-square.png +0 -0
  48. package/ui-templates/kpi-chart-simple-ja/preview-wide.png +0 -0
  49. package/ui-templates/table-focus/preview-square.png +0 -0
  50. package/ui-templates/table-focus/preview-wide.png +0 -0
  51. package/ui-templates/table-focus-ja/preview-square.png +0 -0
  52. package/ui-templates/table-focus-ja/preview-wide.png +0 -0
@@ -0,0 +1,82 @@
1
+ # 初期デザインのプリセット
2
+
3
+ プロジェクト作成時に選ぶ 4 つの出発点。**id(`default` / `calm` / `vivid` / `mono`)はプロジェクト
4
+ 作成のワークフローが参照するので変えないこと。** どれも「チャートのプリセット 1 つ + 必要なら
5
+ `--primary` の上書き + `DESIGN.md` の差分」でできている。
6
+
7
+ 適用の手順は共通:
8
+
9
+ 1. `npx @squadbase/vantage-template chart <チャートのプリセット>` で `styles.css` のマーカーブロックを
10
+ 差し替える。**マーカーブロックの中(`--chart-1..5`)は手で編集しない** ― コマンドの生成物で、
11
+ 次の適用で消える。
12
+ 2. `--primary` の上書きがあるプリセットは、`styles.css` のマーカーの**外**(先頭の `:root` ブロック)に
13
+ `:root` と `.dark, [data-theme="dark"]` の両方を書く。
14
+ 3. `DESIGN.md` を `format.md` の雛形から作り、下の「DESIGN.md の差分」の行だけを書き換える。
15
+ 4. `scripts/contrast.mjs` で `--primary-foreground` / `--primary` をライトとダークで確かめる。
16
+
17
+ | id | トーン | チャートのプリセット | `--primary` |
18
+ | --- | --- | --- | --- |
19
+ | `default` | 中立・無彩色のベース。データだけが色を持つ | `blue` | 上書きしない(既定の無彩色) |
20
+ | `calm` | 落ち着いた寒色。報告書・経営向け | `ocean` | 任意で深い青 |
21
+ | `vivid` | 明るい暖色。営業・マーケティング向け | `sunset` | 濃いオレンジ |
22
+ | `mono` | モノクロ。印刷・資料への貼り付け向け | `mono` | 上書きしない |
23
+
24
+ ## `default`
25
+
26
+ - トーン: 落ち着いた無彩色のベースに、データだけが色を持つ業務ダッシュボード。装飾より読みやすさ。
27
+ - チャート: `blue`(青 → ティール → フクシア → バイオレット → グレー)。
28
+ - `styles.css`: チャートのブロックだけ。`--primary` は触らない。
29
+ - `DESIGN.md`: 雛形そのまま(`format.md` の雛形は `default` を説明している)。
30
+
31
+ ## `calm`
32
+
33
+ - トーン: 寒色でまとめた静かな画面。強調は控えめにし、数字と罫線で読ませる。
34
+ - チャート: `ocean`(スカイ → シアン → インディゴ → ティール → スレート)。
35
+ - `--primary`(任意。ボタンにも色を持たせたいときだけ):
36
+
37
+ ```css
38
+ :root {
39
+ --primary: var(--color-sky-700);
40
+ --primary-foreground: oklch(0.985 0 0);
41
+ }
42
+ .dark,
43
+ [data-theme="dark"] {
44
+ --primary: var(--color-sky-300);
45
+ --primary-foreground: oklch(0.205 0 0);
46
+ }
47
+ ```
48
+
49
+ - `DESIGN.md` の差分: 「全体のトーン」を上の文に。チャートの色味を「スカイ → シアン → インディゴ →
50
+ ティール → スレート」に。良い = `--chart-4`(ティール)。1 系列の強調は `--chart-1` + 残り `--chart-5`。
51
+ 禁止: `--chart-1` と `--chart-2` を隣り合う細い線で並べる(どちらも明るい青系)。
52
+
53
+ ## `vivid`
54
+
55
+ - トーン: 明るく勢いのある暖色。KPI とトレンドを大きく見せ、強調色をはっきり使う。
56
+ - チャート: `sunset`(オレンジ → アンバー → ローズ → イエロー → ストーン)。
57
+ - `--primary`(オレンジ 600 は白文字で 4.5:1 に届かないので 700 を使う):
58
+
59
+ ```css
60
+ :root {
61
+ --primary: var(--color-orange-700);
62
+ --primary-foreground: oklch(0.985 0 0);
63
+ }
64
+ .dark,
65
+ [data-theme="dark"] {
66
+ --primary: var(--color-orange-400);
67
+ --primary-foreground: oklch(0.205 0 0);
68
+ }
69
+ ```
70
+
71
+ - `DESIGN.md` の差分: トーンを上の文に。主色の行を「濃いオレンジ」に。良い = 専用色なし(▲ と
72
+ `--foreground`)、悪い = `--destructive`。禁止: `--chart-3`(ローズ)と `--destructive` を同じ
73
+ チャートに置く(悪い値と区別できない)。1 系列の強調は `--chart-1` + 残り `--chart-5`。
74
+
75
+ ## `mono`
76
+
77
+ - トーン: 白黒と灰色だけ。色で意味を運ばず、太さ・順番・ラベルで読ませる。
78
+ - チャート: `mono`(ジンク 900 → 200。ダークでは反転)。
79
+ - `styles.css`: チャートのブロックだけ。`--primary` は触らない(既定が無彩色)。
80
+ - `DESIGN.md` の差分: トーンを上の文に。強調 = `--chart-1`(最も濃い灰)。良い = 専用色なし(▲ と
81
+ 符号)、悪い = `--destructive`(**画面で唯一の有彩色**として使う)。チャートは系列を 3 つまでにし、
82
+ それ以上は直接ラベルを付ける。禁止: 隣り合う `--chart-4` と `--chart-5`(明度差が小さい)。
@@ -0,0 +1,166 @@
1
+ #!/usr/bin/env node
2
+ // WCAG 2.x contrast ratio between two CSS colours. No dependencies.
3
+ //
4
+ // node contrast.mjs <foreground> <background>
5
+ // node contrast.mjs '#ffffff' 'oklch(0.205 0 0)'
6
+ // node contrast.mjs 'oklch(0.985 0 0)' 'var(--color-sky-700)'
7
+ //
8
+ // Accepts: #rgb / #rgba / #rrggbb / #rrggbbaa, rgb()/rgba(), oklch(), and
9
+ // Tailwind palette references `var(--color-<name>-<step>)` (resolved from
10
+ // node_modules/tailwindcss/theme.css, searched upward from the cwd).
11
+ // A translucent foreground is composited over the background first; the
12
+ // background is treated as opaque.
13
+
14
+ import { existsSync, readFileSync } from "node:fs"
15
+ import { dirname, join } from "node:path"
16
+
17
+ function usage(message) {
18
+ if (message) console.error(`error: ${message}`)
19
+ console.error("usage: node contrast.mjs <foreground> <background>")
20
+ console.error(" colours: #hex, rgb(), oklch(), var(--color-<name>-<step>)")
21
+ process.exit(2)
22
+ }
23
+
24
+ // --- parsing ---------------------------------------------------------------
25
+
26
+ function parseNumber(token, percentScale = 1) {
27
+ const t = token.trim()
28
+ if (t === "none") return 0
29
+ if (t.endsWith("%")) return (Number.parseFloat(t) / 100) * percentScale
30
+ const n = Number.parseFloat(t)
31
+ if (Number.isNaN(n)) throw new Error(`not a number: ${token}`)
32
+ return n
33
+ }
34
+
35
+ function splitArgs(body) {
36
+ const [main, alpha] = body.split("/")
37
+ const parts = main.trim().split(/[\s,]+/).filter(Boolean)
38
+ return { parts, alpha: alpha === undefined ? 1 : parseNumber(alpha, 1) }
39
+ }
40
+
41
+ function srgbToLinear(c) {
42
+ return c <= 0.04045 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4
43
+ }
44
+
45
+ function linearToSrgb(c) {
46
+ const v = Math.min(1, Math.max(0, c))
47
+ return v <= 0.0031308 ? v * 12.92 : 1.055 * v ** (1 / 2.4) - 0.055
48
+ }
49
+
50
+ // Returns gamma-encoded sRGB channels in [0, 1] plus alpha.
51
+ function parseHex(input) {
52
+ let hex = input.slice(1)
53
+ if (![3, 4, 6, 8].includes(hex.length) || /[^0-9a-f]/i.test(hex)) {
54
+ throw new Error(`bad hex colour: ${input}`)
55
+ }
56
+ if (hex.length <= 4) hex = [...hex].map((c) => c + c).join("")
57
+ const n = (i) => Number.parseInt(hex.slice(i, i + 2), 16) / 255
58
+ return { r: n(0), g: n(2), b: n(4), a: hex.length === 8 ? n(6) : 1 }
59
+ }
60
+
61
+ function parseRgb(body) {
62
+ const { parts, alpha } = splitArgs(body)
63
+ if (parts.length === 4) return parseRgb(`${parts.slice(0, 3).join(" ")} / ${parts[3]}`)
64
+ if (parts.length !== 3) throw new Error(`bad rgb(): ${body}`)
65
+ const [r, g, b] = parts.map((p) => parseNumber(p, 255) / 255)
66
+ return { r, g, b, a: alpha }
67
+ }
68
+
69
+ function parseOklch(body) {
70
+ const { parts, alpha } = splitArgs(body)
71
+ if (parts.length !== 3) throw new Error(`bad oklch(): ${body}`)
72
+ const L = parseNumber(parts[0], 1)
73
+ const C = parseNumber(parts[1], 0.4)
74
+ const H = (Number.parseFloat(parts[2]) || 0) * (Math.PI / 180)
75
+ const a = C * Math.cos(H)
76
+ const bb = C * Math.sin(H)
77
+ const l_ = (L + 0.3963377774 * a + 0.2158037573 * bb) ** 3
78
+ const m_ = (L - 0.1055613458 * a - 0.0638541728 * bb) ** 3
79
+ const s_ = (L - 0.0894841775 * a - 1.291485548 * bb) ** 3
80
+ const r = 4.0767416621 * l_ - 3.3077115913 * m_ + 0.2309699292 * s_
81
+ const g = -1.2684380046 * l_ + 2.6097574011 * m_ - 0.3413193965 * s_
82
+ const b = -0.0041960863 * l_ - 0.7034186147 * m_ + 1.707614701 * s_
83
+ return { r: linearToSrgb(r), g: linearToSrgb(g), b: linearToSrgb(b), a: alpha }
84
+ }
85
+
86
+ let tailwindTheme
87
+ function findTailwindTheme() {
88
+ if (tailwindTheme !== undefined) return tailwindTheme
89
+ tailwindTheme = null
90
+ let dir = process.cwd()
91
+ for (;;) {
92
+ for (const rel of [
93
+ "node_modules/tailwindcss/theme.css",
94
+ "node_modules/@squadbase/vantage/node_modules/tailwindcss/theme.css",
95
+ ]) {
96
+ const file = join(dir, rel)
97
+ if (existsSync(file)) {
98
+ tailwindTheme = readFileSync(file, "utf8")
99
+ return tailwindTheme
100
+ }
101
+ }
102
+ const parent = dirname(dir)
103
+ if (parent === dir) return tailwindTheme
104
+ dir = parent
105
+ }
106
+ }
107
+
108
+ function resolveVar(input) {
109
+ const name = input.match(/^var\(\s*(--color-[a-z]+-\d+)\s*\)$/)?.[1]
110
+ if (!name) throw new Error(`only var(--color-<name>-<step>) can be resolved: ${input}`)
111
+ const theme = findTailwindTheme()
112
+ if (!theme) throw new Error(`tailwindcss/theme.css not found from ${process.cwd()}; pass the value instead`)
113
+ const value = theme.match(new RegExp(`${name}:\\s*([^;]+);`))?.[1]
114
+ if (!value) throw new Error(`${name} is not in tailwindcss/theme.css`)
115
+ return value.trim()
116
+ }
117
+
118
+ function parseColor(raw) {
119
+ const input = raw.trim().toLowerCase()
120
+ if (input.startsWith("#")) return parseHex(input)
121
+ if (input.startsWith("var(")) return parseColor(resolveVar(input))
122
+ const fn = input.match(/^([a-z]+)\((.*)\)$/)
123
+ if (fn) {
124
+ if (fn[1] === "rgb" || fn[1] === "rgba") return parseRgb(fn[2])
125
+ if (fn[1] === "oklch") return parseOklch(fn[2])
126
+ }
127
+ throw new Error(`unsupported colour: ${raw}`)
128
+ }
129
+
130
+ // --- contrast --------------------------------------------------------------
131
+
132
+ function composite(fg, bg) {
133
+ const mix = (f, b) => f * fg.a + b * (1 - fg.a)
134
+ return { r: mix(fg.r, bg.r), g: mix(fg.g, bg.g), b: mix(fg.b, bg.b), a: 1 }
135
+ }
136
+
137
+ function luminance({ r, g, b }) {
138
+ return 0.2126 * srgbToLinear(r) + 0.7152 * srgbToLinear(g) + 0.0722 * srgbToLinear(b)
139
+ }
140
+
141
+ function toHex({ r, g, b }) {
142
+ const h = (c) => Math.round(Math.min(1, Math.max(0, c)) * 255).toString(16).padStart(2, "0")
143
+ return `#${h(r)}${h(g)}${h(b)}`
144
+ }
145
+
146
+ const [fgArg, bgArg] = process.argv.slice(2)
147
+ if (!fgArg || !bgArg) usage()
148
+
149
+ let fg
150
+ let bg
151
+ try {
152
+ bg = { ...parseColor(bgArg), a: 1 }
153
+ fg = composite(parseColor(fgArg), bg)
154
+ } catch (error) {
155
+ usage(error.message)
156
+ }
157
+
158
+ const [hi, lo] = [luminance(fg), luminance(bg)].sort((x, y) => y - x)
159
+ const ratio = (hi + 0.05) / (lo + 0.05)
160
+ const verdict = (min) => (ratio >= min ? "PASS" : "FAIL")
161
+
162
+ console.log(`foreground ${fgArg} (${toHex(fg)})`)
163
+ console.log(`background ${bgArg} (${toHex(bg)})`)
164
+ console.log(`contrast ${ratio.toFixed(2)}:1`)
165
+ console.log(`AA normal text (>= 4.5:1): ${verdict(4.5)}`)
166
+ console.log(`AA large text / UI (>= 3:1): ${verdict(3)}`)
@@ -35,6 +35,28 @@ Base UI の `SelectValue` は選択中の **value をそのまま描き**、`Sel
35
35
 
36
36
  トリガーに `kanto` や `/sales` と生の値が出たら、まずこれを疑う。
37
37
 
38
+ ## 配色:素のパレット + `dark:` ではなく、セマンティックトークンで書く
39
+
40
+ 色は `text-foreground` / `text-muted-foreground` / `bg-card` / `border-border` などの
41
+ トークンで書く。トークンはライト / ダークの両方を持っているので、`dark:` を並べる必要が無い。
42
+
43
+ `text-slate-900 dark:text-slate-100` のような素の Tailwind パレット + `dark:` の組は、
44
+ **トークンで塗られた周囲と食い違う**。ダークトークンが効くのは祖先に `.dark` /
45
+ `[data-theme="dark"]` が付いているときだけで、`dark:` ユーティリティも同じスイッチに
46
+ 繋がっている(`theme.css` の `@custom-variant dark`)。つまり自分でクラスを付けない限り
47
+ アプリは常にライトで動くのに、素のパレットを使うとその 1 か所だけ手動で両モードを
48
+ 管理することになる。
49
+
50
+ ```tsx
51
+ // ✗ 手動で 2 モードを管理することになる
52
+ <div className="font-medium text-slate-900 dark:text-slate-100">{name}</div>
53
+ // ✓ トークンなら 1 つで済む
54
+ <div className="font-medium text-foreground">{name}</div>
55
+ ```
56
+
57
+ `--muted` / `--accent` / `--secondary` / `--border` は**背景・境界用**で、ライトではほぼ白。
58
+ 文字色に使うと読めなくなる ― 弱い文字色は `text-muted-foreground`。
59
+
38
60
  ## チャート:`EChart` の配色はトークン追従。上書きは `option.color`
39
61
 
40
62
  系列色は `--chart-1..5`、軸・凡例・ツールチップは文字色/境界色のトークンから組まれる
@@ -1,17 +1,18 @@
1
1
  # AGENTS.md — Vantage アプリの地図
2
2
 
3
3
  このファイルは、**Vantage(`@squadbase/vantage`)アプリを作るコーディングエージェント**が
4
- 最初に読むための地図です。アプリ作者(= `index.tsx` を書く側)が守るべき規約・不変条件・
5
- 最小レシピを 1 ページに集約しています。ここに書かれた規約だけで、最小のダッシュボードアプリを
6
- 正しく組めます。
7
-
8
- > このファイルは **Vantage フレームワークが所有する正本**のコピーです。手で書き換えても、
9
- > `vantage upgrade` を実行するとフレームワーク同梱の正本から再同期されて上書きされます。
10
- > アプリ固有のメモは別ファイル(例: `README.md`)に書いてください。
4
+ 最初に読むための地図です。アプリ作者(= `index.tsx` を書く側)が守るべき規約・不変条件を
5
+ 1 ページに集約し、種類ごとの詳しいレシピは `agents/` 配下の知識ファイルに分けています。
6
+
7
+ > このファイルと `agents/*.md` は、いずれも **Vantage フレームワークが所有する正本**の
8
+ > コピーです。手で書き換えても、`vantage upgrade` を実行するとフレームワーク同梱の正本から
9
+ > 再同期されて上書きされます。アプリ固有のメモは別ファイル(例: `README.md`)に書いてください。
10
+ > 例外はプロジェクトルートの `DESIGN.md` で、これは**ユーザーが所有**します(`vantage upgrade` も
11
+ > `vantage add agents` も触らない。→「デザインの意図(DESIGN.md)」)。
11
12
  >
12
13
  > 手順を伴う踏み込んだワークフローは、同梱の Claude Code Skill に分かれています。このファイルは
13
- > 「地図」、Skill は「手順書」という役割分担です。**配置済みの Skill を先に探す**手順は
14
- > 末尾の「さらに詳しく(同梱 Skill)」にあります。
14
+ > 「地図」、`agents/*.md` は「種類ごとの静的リファレンス」、Skill は「手順書」という役割分担です。
15
+ > **配置済みの Skill を先に探す**手順は末尾の「さらに詳しく(同梱 Skill)」にあります。
15
16
 
16
17
  ## Vantage とは
17
18
 
@@ -36,6 +37,11 @@ UI キット・開発サーバー・API サーバー・ビルドはすべて Van
36
37
  - **クライアントに届く env は `PUBLIC_` 接頭辞のものだけ。** `import.meta.env.PUBLIC_FOO`。
37
38
  それ以外を `import.meta.env` で読むと `PUBLIC_ENV_MISUSE` 警告。シークレットは
38
39
  `ApiContext.env`(server/ 内)にだけ届く。
40
+ - **色はセマンティックトークンで書く。** `text-foreground`・`text-muted-foreground`・`bg-card`・
41
+ `border-border`。トークンがライト / ダークの両方を持つので `dark:` を並べる必要が無い。
42
+ 素のパレット + `dark:`(`text-slate-900 dark:text-slate-100`)を混ぜると、その 1 か所だけ
43
+ 手動で 2 モードを管理することになる(→ `agents/page.md` の「ダークモードは opt-in」)。
44
+ `--muted`・`--accent`・`--secondary`・`--border` は背景・境界用で、文字色に使うと読めない。
39
45
  - **`.vantage/` と `dist/` は生成物。** 編集しない・読みにいかない(gitignore 済み)。任意の CLI
40
46
  コマンド、または `vantage upgrade` で再生成される。
41
47
  - **`definePage` の値はリテラルで書く。** title/description/navLabel はビルド時に静的抽出される
@@ -88,6 +94,9 @@ root/
88
94
  | `@squadbase/vantage/query` | `useApiQuery`・`useApiMutation`・`apiJson`・`apiFetch`・`apiUrl`・`ApiError`、ほか `useQuery`/`useMutation` など TanStack Query の再エクスポート |
89
95
  | `@squadbase/vantage/ui` | shadcn/ui(Base UI バリアント)プリミティブ(`Button`・`Loading`・`ErrorState`・`Empty` ほか) |
90
96
  | `@squadbase/vantage/components` | 複合パーツ(`PageShell`・`DashboardCardPreset`・`DataTablePreset`・`EChart` ほか) |
97
+ | `@squadbase/vantage/table` | `FilePageView`・`TableViewer`(データファイルページの表ビューア) |
98
+ | `@squadbase/vantage/slide` | `SlideDeck`・`Slide`・`Steps`・`Step`・`MorphElement`・`useSlideNumber`・`useIsActiveSlide`(スライド専用。1920×1080 の固定キャンバス) |
99
+ | `@squadbase/vantage/doc` | `Document`(ドキュメント専用。中の素の HTML 要素に見出し・表などのスタイルが当たる) |
91
100
  | `@squadbase/vantage/markdown` | `MarkdownRenderer`(Shiki を隔離するための専用サブパス) |
92
101
  | `@squadbase/vantage/server` | `ApiContext`・`ApiHandler`・`HttpError`・`isHttpError`・`json`(server/ 側でのみ使う) |
93
102
 
@@ -96,207 +105,37 @@ root/
96
105
  `server/` ディレクトリがあれば **fullstack**、無ければ **SPA**。`vantage-manifest.json` の
97
106
  `mode` はここから自動で決まり、手で書く設定は無い。**SPA から始めて fullstack へ「昇格」する
98
107
  必要はない** ― テンプレートから始めた場合は最初から `server/` があり、その時点で fullstack。
99
- 下の 2 節は段階ではなく、いま自分がどちらにいるかを確かめるための地図として読む。
100
-
101
- - `server/` が**ある** → 「API を持つ(fullstack モード)」を見る。データは自前の `/api/*` から
102
- `useApiQuery` で取る。
103
- - `server/` が**無い** → 「最小アプリ(2 ファイル)」の構成。外部 API を直接叩くなら `useQuery`。
104
- 自前の API が要るようになったら `server/api/*.ts` を足すだけでよい(設定変更は不要)。
105
-
106
- ## 最小アプリ(2 ファイル)
107
-
108
- `package.json` と `index.tsx` の 2 ファイルだけで動く。
109
-
110
- `package.json`:
111
-
112
- ```json
113
- {
114
- "name": "my-dashboard",
115
- "private": true,
116
- "type": "module",
117
- "scripts": {
118
- "dev": "vantage dev",
119
- "build": "vantage build",
120
- "preview": "vantage preview",
121
- "check": "vantage check",
122
- "routes": "vantage routes"
123
- },
124
- "dependencies": {
125
- "@squadbase/vantage": "^0.5.0",
126
- "react": "^19.2.7",
127
- "react-dom": "^19.2.7"
128
- }
129
- }
130
- ```
108
+ 下の 2 つは段階ではなく、いま自分がどちらにいるかを確かめるための地図として読む。
131
109
 
132
- `index.tsx`(ルートのデフォルトエクスポートが `/` ページになる):
110
+ - `server/` が**ある** → データは自前の `/api/*` から `useApiQuery` で取る(→ `agents/api.md`)。
111
+ - `server/` が**無い** → 外部 API を直接叩くなら `useQuery`(→ `agents/page.md`)。自前の API が
112
+ 要るようになったら `server/api/*.ts` を足すだけでよい(設定変更は不要)。
133
113
 
134
- ```tsx
135
- export default function Dashboard() {
136
- return (
137
- <main className="p-6">
138
- <h1 className="text-2xl font-semibold">Dashboard</h1>
139
- </main>
140
- )
141
- }
142
- ```
114
+ ## デザインの意図(DESIGN.md)
143
115
 
144
- ```bash
145
- pnpm install
146
- pnpm dev # → http://localhost:5173(HMR)
147
- pnpm check # 静的診断(エラーがあれば exit 1)
148
- pnpm routes # ページ/API の URL マップ
149
- ```
116
+ プロジェクトルートに `DESIGN.md` があれば、**UI(ページ・スライド・コンポーネント)を書く前に
117
+ 読む。** 色・チャート・書体・レイアウトの使い分けがトークン名で書いてあるので、それに従って
118
+ トークンで書く(値は `styles.css` にあり、`DESIGN.md` には色コードを書かない)。
150
119
 
151
- `server/` ディレクトリが無いので、この構成は **SPA モード**。ページを直下に置く形だが、
152
- `src/` を作ってその中に集めてもよい(テンプレートから始めた場合は最初から `src/` がある)。
153
- どちらか一方に寄せること(→「ディレクトリ構造」)。
120
+ - **会話中の指示は `DESIGN.md` より優先する。** 同じ指示が繰り返されたら、`DESIGN.md` への
121
+ 反映をユーザーに提案する。
122
+ - **「色を変えて」「ブランドに合わせて」などデザイン全体の変更は、ファイルごとに直さない。**
123
+ Skill `vantage-design` の手順で `DESIGN.md` と `styles.css` をまとめて更新する。
124
+ - `DESIGN.md` はユーザーの持ち物。`vantage upgrade` は書き換えない。
154
125
 
155
- ## ルーティング規約(ファイル名 → ルート)
126
+ ## 何を書くか → どのファイルを読むか
156
127
 
157
- ページルート(`src/` があればその中、無ければプロジェクトルート)からの相対パスが、そのまま
158
- URL になる。各ページは**デフォルトエクスポートの React コンポーネントが必須**(無いと
159
- `MISSING_DEFAULT_EXPORT`)。以下の「ファイル」列はページルートからの相対パス。
128
+ **書こうとしている種類のファイルだけを開けばよい。** まず該当する 1 ファイルを readFiles で
129
+ 読んでから書き始める。
160
130
 
161
- | ファイル | ルート |
131
+ | 書こうとしているもの | 読むファイル |
162
132
  | --- | --- |
163
- | `index.tsx` | `/` |
164
- | `monthly-analysis.tsx` | `/monthly-analysis` |
165
- | `sales/index.tsx` | `/sales` |
166
- | `sales/[customerId].tsx` | `/sales/:customerId`(動的パラメータ) |
167
- | `_layout.tsx` | そのディレクトリ配下を包むネストレイアウト(`Outlet` で子を描く) |
168
- | `_404.tsx` | Not Found ページ |
169
- | `_error.tsx` | ルートが throw したときのエラーページ |
170
-
171
- `components/`・`hooks/`・`lib/`・`server/`・`public/` はどの階層でもルート走査の対象外
172
- (ページにならない)。それ以外のディレクトリ名は URL のセグメントになる(→「ディレクトリ構造」)。
173
-
174
- ```tsx
175
- import { definePage } from "@squadbase/vantage"
176
-
177
- // title は document.title、navLabel は useRoutes() で組むナビの表示名(既定は title)
178
- export const page = definePage({ title: "Monthly Analysis · Acme", navLabel: "Monthly" })
179
-
180
- export default function MonthlyAnalysis() {
181
- return <main className="p-6">…</main>
182
- }
183
- ```
184
-
185
- ### ナビはルート一覧から組む
186
-
187
- `useRoutes()` がページルート一覧(スキャン順)を返すので、リンク配列を手で持たない。
188
- `useCurrentRoute()` は現在のルート(404 なら `undefined`)。
189
-
190
- ```tsx
191
- import { Link, useCurrentRoute, useRoutes } from "@squadbase/vantage/router"
192
-
193
- // 動的ルートは URL が定まらないので外す。label は navLabel → title → path の順
194
- const routes = useRoutes().filter((r) => !r.dynamic)
195
- const current = useCurrentRoute()
196
-
197
- routes.map((r) => (
198
- <Link key={r.path} to={r.to} activeClassName="font-semibold">
199
- {r.label}
200
- </Link>
201
- ))
202
- ```
203
-
204
- `RouteInfo`: `path`(`/sales/:id`)・`to`(`/sales/$id`)・`params`・`dynamic`・`index`・`label`・
205
- `title`・`description`・`navLabel`。
206
-
207
- ### フィルタ状態は URL に置く
208
-
209
- リロードで消えず、URL をそのまま共有できる。`useState` と同じ形。
210
-
211
- ```tsx
212
- import { useSearchParam, useSearchState } from "@squadbase/vantage/router"
213
-
214
- const [region, setRegion] = useSearchParam("region", "all") // 常に string
215
- const [segments, setSegments] = useSearchState<string[]>("segments", []) // JSON になる値
216
- ```
217
-
218
- デフォルト値(または `null`)を書くとキーは URL から消える。履歴は既定で `replace`
219
- (`{ replace: false }` で push)。
220
-
221
- ### 動的パラメータの「3 つの綴り」を同期させる
222
-
223
- 崩すと静かにマッチしなくなる不変条件:
224
-
225
- - ファイル名 `sales/[customerId].tsx`
226
- - 表示ルート `/sales/:customerId`
227
- - リンクトークン `to="/sales/$customerId"` + `params={{ customerId }}`
228
-
229
- ```tsx
230
- import { Link, useParams } from "@squadbase/vantage/router"
231
-
232
- <Link to="/sales/$customerId" params={{ customerId: row.id }}>{row.name}</Link>
233
-
234
- // 詳細ページ側で取り出す
235
- const { customerId } = useParams()
236
- ```
237
-
238
- ## データ取得(server を持たない fetch)
239
-
240
- 外部 API を叩くだけなら `server/` は不要。`@squadbase/vantage/query` の `useQuery` を使う:
241
-
242
- ```tsx
243
- import { useQuery } from "@squadbase/vantage/query"
244
- import { Loading, ErrorState } from "@squadbase/vantage/ui"
245
-
246
- const q = useQuery({ queryKey: ["stats"], queryFn: () => fetch("/…").then((r) => r.json()) })
247
- if (q.isPending) return <Loading />
248
- if (q.isError) return <ErrorState message={(q.error as Error).message} />
249
- ```
250
-
251
- `QueryClient` は Vantage が 1 つだけ管理する(staleTime 30s・retry 1・
252
- refetchOnWindowFocus false・networkMode "always")。挙動を変えたいときはクエリ側のオプションで
253
- 上書きする。
254
- 自分の `server/api` を叩くときは `useQuery` ではなく `useApiQuery`(→「API を持つ(fullstack
255
- モード)」)。
256
-
257
- ## API を持つ(fullstack モード)
258
-
259
- **`server/` ディレクトリがあれば fullstack モード**(無いアプリに足せば、その時点で切り替わる)。
260
- `server/api/**` の各ファイルが API ルートになる。
261
-
262
- `server/api/monthly-analysis.ts` → `GET /api/monthly-analysis`:
263
-
264
- ```ts
265
- import type { ApiContext } from "@squadbase/vantage/server"
266
- import { HttpError } from "@squadbase/vantage/server"
267
-
268
- export async function GET({ params, env }: ApiContext) {
269
- if (!env.API_KEY) throw new HttpError(500, "API_KEY missing")
270
- return Response.json({ ok: true })
271
- }
272
- ```
273
-
274
- - API モジュールは**大文字の HTTP メソッド**(`GET`/`POST`/`PUT`/`PATCH`/`DELETE`/`OPTIONS`)を
275
- エクスポートする。それ以外の名前は `INVALID_API_EXPORT` エラー。
276
- - 動的 API も `[id].ts` 記法: `server/api/customers/[id].ts` → `GET /api/customers/:id`。
277
- `params.id` で取り出す(`noUncheckedIndexedAccess` が効くので narrowing が要る)。
278
- - **クライアントに見せたいエラーは `HttpError(status, msg)` を throw する。** それ以外の throw は
279
- ログに記録され汎用の 500 に丸められる。
280
- - **シークレットは `ApiContext.env` にだけ届く**(クライアントには決して届かない)。
281
-
282
- クライアント側からは `useApiQuery` で `/api/*` を叩く。ベース URL の解決・JSON パース・
283
- 非 2xx の `ApiError` 化・クエリキー(`["api", url]`)が入っている:
284
-
285
- ```tsx
286
- import { useApiQuery, useApiMutation } from "@squadbase/vantage/query"
287
-
288
- const q = useApiQuery<Customer>(`/api/customers/${customerId}`)
289
- if (q.isError) return <ErrorState message={q.error.message} /> // HttpError のメッセージ
290
-
291
- // クエリ文字列は search で。undefined の項目は落ちる
292
- const rows = useApiQuery<Row[]>("/api/customers", { search: { segment } })
293
-
294
- // 書き込み。変数がそのまま JSON ボディになる
295
- const save = useApiMutation<Customer, Payload>("/api/customers", { method: "POST" })
296
- ```
297
-
298
- `ApiError` は `message`・`status`・`body`・`requestId` を持つ。hook が使えない場所では
299
- `apiJson(path, init)`、生の `Response` が要るときは `apiFetch`。
133
+ | ダッシュボード / 通常ページ(`.tsx`) | `agents/page.md` |
134
+ | API(`server/`) | `agents/api.md` |
135
+ | スライド(`.slide.tsx`) | `agents/slide.md` |
136
+ | ドキュメント(`.doc.tsx`) | `agents/doc.md` |
137
+ | `.xlsx` ページ | `agents/xlsx.md` |
138
+ | `.csv` ページ | `agents/csv.md` |
300
139
 
301
140
  ## 環境変数
302
141
 
@@ -304,20 +143,6 @@ const save = useApiMutation<Customer, Payload>("/api/customers", { method: "POST
304
143
  のみ。** `VITE_` 系の公開 API は無い。
305
144
  - サーバー側のシークレットは `ApiContext.env.MY_SECRET` で読む(`server/` 内のみ)。
306
145
 
307
- ## 組み込み UI / コンポーネントの入口
308
-
309
- - **プリミティブ**は `@squadbase/vantage/ui` から import する(`Button`・`Loading`・
310
- `ErrorState`・`Empty`・`Select`・`Checkbox` ほか)。
311
- - **複合パーツ**は `@squadbase/vantage/components` から(`PageShell`・`DashboardCardPreset`・
312
- `DataTablePreset`・`EChart` ほか)。
313
- - **どの名前が import 可能か / props の詳細は `vantage docs` で引く。** ガイドとコンポーネント
314
- リファレンスはパッケージに同梱されていて、オフラインでも読める(→「ドキュメントを引く」)。
315
- **名前が分からないとき**はやりたいことで `vantage search` する(→ 同節)。
316
- - **UI は import して使うのが既定。取り出す(eject)必要はない。** `vantage add ui|block` は
317
- ソースを手元にコピーして**改造したいとき専用**のコマンドで、取り出せるのは
318
- `ui: data-table` と `block: sales-overview` の 2 つだけ。それ以外の名前は import 専用で
319
- `add` の対象ではない(未知名で実行すると候補が一覧表示される)。
320
-
321
146
  ## ドキュメントを引く(`vantage docs` / `vantage search`)
322
147
 
323
148
  ```bash
@@ -363,7 +188,10 @@ body・レスポンスの status と形)まで出る。`vantage check --json` /
363
188
 
364
189
  - **`vantage-app`** — アプリを一から作る / 構成を広げるときの進め方と検証の順序
365
190
  - **`vantage-add-feature`** — 既存アプリに page / api / ui を 1 つ足す定型
191
+ - **`vantage-slide`** — `.slide.tsx` でスライドデッキを書く(キャンバスの予算・段階表示・pptx 書き出し)
192
+ - **`vantage-design`** — `DESIGN.md` と `styles.css` をまとめて作る / 直す(配色・書体・ブランド合わせ)
366
193
  - **`vantage-pitfalls`** — Base UI(≠ Radix)の癖など、静かに壊れる落とし穴のリファレンス
194
+ - **`project-storage`** — Squadbase の Project Storage(アップロード済みファイル)をブラウザから読み書きする
367
195
 
368
196
  手順書の本体は `SKILL.md` というファイルで、置き場所はアプリによって違う(ルート直下・
369
197
  `.claude/skills/`・`.squadbase/skills/` など)。**探す必要はない ― CLI が探す:**
@@ -383,6 +211,9 @@ vantage add skill --all --dir .claude/skills # 置き場所を指定(既定は
383
211
  配置済みのコピーを新しいバージョンに更新したいときだけ `--force` を付ける(見つかった場所を
384
212
  そのまま書き換える)。
385
213
 
214
+ **役割分担:** Skill = 手順書(踏み込んだワークフロー) / `agents/*.md` = 種類ごとの静的
215
+ リファレンス / `AGENTS.md`(このファイル) = 地図。
216
+
386
217
  ---
387
218
 
388
219
  # テンプレート固有の規約(Squadbase テンプレート)
@@ -391,8 +222,9 @@ vantage add skill --all --dir .claude/skills # 置き場所を指定(既定は
391
222
  > フレームワーク規約と矛盾する場合は**こちらが優先**します。
392
223
  >
393
224
  > `vantage upgrade` はこのファイルをフレームワーク同梱の正本で丸ごと上書きするため、
394
- > このセクションは消えます。消えたら squadbase-templates リポジトリの `agents/vantage/`
395
- > から貼り直してください(リポジトリ側では `npm run agents` が正本と結合して再生成します)。
225
+ > このセクションは消えます。消えたら squadbase-monorepo の
226
+ > `packages/vantage-template/agents/vantage/` から貼り直してください
227
+ > (リポジトリ側では `npm run agents` が正本と結合して再生成します)。
396
228
 
397
229
  ## Squadbase の Connection / Query からデータを読む
398
230
 
@@ -469,3 +301,51 @@ const res = await fetch(`${baseUrl}/queries/${QUERY_ID}?since=2026-01-01`, {
469
301
  body: JSON.stringify({ customerId: "c_123" }),
470
302
  })
471
303
  ```
304
+
305
+ ## 構築中の一時的なエラーを「進行中」に見せる(`components/build-recovery.tsx`)
306
+
307
+ ページを書いている途中は、ファイルが書き終わる順番の都合で一瞬だけページが throw する
308
+ (まだ存在しないモジュールの import、書きかけのコンポーネント)。これを受け止めるのは
309
+ **Vantage の既定エラー画面**(`Something went wrong`)で、**テンプレートからは差し替えられない** —
310
+ `_error.tsx` はルートルート専用で、ページごとの `errorComponent` は現行プロトタイプでは
311
+ まだ結線されていない。しかも掴んでいるのは TanStack の CatchBoundary なので、HMR で
312
+ ソースが差し替わってもリセットされず、**リロードするまでエラー画面が貼り付く**。
313
+
314
+ `components/build-recovery.tsx` の `BuildRecovery` が、その画面を DOM から検知して
315
+ `Working on it…` 表示を被せ、dev では 1.2 秒待ってから自動でリロードして復帰させる
316
+ (上限 3 回。使い切ったら「再読み込み」の案内に降格し、無事に描けたら残数が戻る)。
317
+ 降格した画面にはエラー本文をそのまま出し、`Copy log` でコピーできるようにしてある —
318
+ 自力で直らないときに本文をそのまま貼り戻してもらうため。
319
+ `_error.tsx` も同じ `RecoveringState` を描くので、ルートレイアウトが throw したときの
320
+ 見た目と復帰の仕方は揃っている。
321
+
322
+ ### 追加の不変条件
323
+
324
+ - **`_layout.tsx` の `<BuildRecovery>` を外さない。** `<Outlet />` を包む形で 1 回だけ使う。
325
+ 外すと、書き込み途中の一瞬のエラーが `Something went wrong` のまま残る。
326
+ - **`components/build-recovery.tsx` と `_error.tsx` を消さない・作り直さない。** ページ側に
327
+ 独自のエラー UI を足す必要はない(足しても既定エラー画面より内側には入れない)。
328
+ - **`role="alert"` の中に `h2` を置かない。** これが既定エラー画面の目印なので、ページが
329
+ 同じ形を描くと `BuildRecovery` が誤検知して中身を覆ってしまう。UI キットの `Alert` /
330
+ `ErrorState` は見出しを `div` / `p` で描くのでそのまま使ってよい。
331
+ - **データ取得の失敗は各ページが `ErrorState` で出す。** `BuildRecovery` が拾うのは
332
+ 「レンダリングが throw した」場合だけで、`useApiQuery` の `isError` はページの責任
333
+ (→ `agents/page.md` の「データ取得」)。
334
+
335
+ ## 依存の追加とスクリプトの実行は bun で
336
+
337
+ このプロジェクトの package manager は **bun** です(`squadbase.yml` の `package_manager: bun`、
338
+ lockfile は `bun.lock`)。Squadbase のサンドボックスは bun と依存のキャッシュを持っており、
339
+ `bun install` はキャッシュだけで終わります。上のフレームワーク規約に出てくる
340
+ `pnpm install` / `pnpm dev` / `pnpm check` は、そのまま `bun install` / `bun run dev` /
341
+ `bun run check` に読み替えてください。
342
+
343
+ ### 追加の不変条件
344
+
345
+ - **依存を足すときは `bun add <pkg>`(開発用は `bun add -d <pkg>`)。** `npm install` や
346
+ `pnpm add` を使わない — `package-lock.json` / `pnpm-lock.yaml` が生えて `bun.lock` と別の断面に
347
+ なり、次回起動時の install が lockfile を作り直す。
348
+ - **`bun.lock` を消さない・手で編集しない。** `package.json` の依存を直接書き換えたときは
349
+ `bun install` を一度走らせて `bun.lock` を追従させ、両方を同じコミットに入れる。
350
+ - スクリプトは `bun run <script>`(`bun run dev` / `bun run build` / `bun run check` /
351
+ `bun run routes`)。`npm run <script>` でも動くが、install に npm を使わないこと。