From d7c35add15b2a837daf81a82eb6ec3373b699d25 Mon Sep 17 00:00:00 2001 From: EwdErna Date: Mon, 5 Oct 2026 08:16:14 +0900 Subject: [PATCH] =?UTF-8?q?chore:=20provisional/decisions.md=20=E3=81=ABMa?= =?UTF-8?q?rkdown=E3=81=AElint=E4=BF=AE=E6=AD=A3=E3=82=92=E3=81=8B?= =?UTF-8?q?=E3=81=91=E3=82=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 内容は変えない。見出し直後の空行と表の区切り行の書式だけ。 Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01Jmj4oW3phJrVNNcjMVqo8Q --- provisional/decisions.md | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/provisional/decisions.md b/provisional/decisions.md index db92a36..94efb75 100644 --- a/provisional/decisions.md +++ b/provisional/decisions.md @@ -6,14 +6,16 @@ ## A. モックの範囲と技術 ### T-1 モックの目的 + 配置を編集しても割り当てがずれないこと、全バリアントを保持したまま選択した構成を出力・往復できることを、動くもので確かめる。 完成品のツールにはしない。 ### T-2 対象範囲 + ブラウザで動く1つのアプリ。1画面でタブを切り替える。 | ツール | 作る範囲 | -|---|---| +| --- | --- | | PHY Editor | KLE JSONの新規取り込み、キー・部品の追加、移動・回転・サイズ編集、クラスター化・解除・reparent・数値入力のreframe、バリアントの編集・表示切替、KLE JSON出力 | | Key Indexer | 全バリアントのキーの一覧、`order` への登録・除外・並べ替え、選択構成での出力番号のプレビュー | | Wiring Editor | MCUの提供者と接点キーの端子のフォーム編集、配線の表示、未配線・衝突の表示、LEDチェーンの順序編集 | @@ -26,18 +28,21 @@ 後段(任意): 疑似デバイスとの往復(書き込み → 外部での変更を模擬 → 読み出し → 差分確認 → MAPへ取り込み)。着手する場合は T-24 に従う。 ### T-3 作る順番 + 1. 回転したクラスター内のキーのドラッグと、保存・再読み込みの往復(描画方式の確認を兼ねる) 2. IDX・MAPとの連携 3. ELCと出力の対応表 4. (任意)疑似デバイスとの往復 ### T-4 検証に使うデータ + `samples/kle/macropad-4x4.json`、`samples/kle/cr0wn60.json`(幾何のみ)、手作りの回転・入れ子バリアントのfixture。 実在の配線とVIAの適合は検証の対象にしない。 ### T-5 技術選定 (implementation-plan P-2) + | 項目 | 仮決定 | -|---|---| +| --- | --- | | 言語 | TypeScript(strict) | | UI | Vue 3(Composition API) + Vite。Nuxtは使わない(SSR・ルーティングが不要) | | 描画 | 素のSVG。PHYの階層を入れ子の `` に対応させ、ドラッグは親要素の `getScreenCTM()` の逆行列でローカル座標へ戻す | @@ -49,11 +54,13 @@ 理由: 描画の変換がPHYの `Translate · Rotate` と同じ定義で、座標の逆変換をブラウザに任せられる。Vueは既存の経験を使える。 ### T-6 リポジトリ構成 (implementation-plan P-3) + このリポジトリの `mock/` に単一のパッケージとして置く。 中は `domain/`(層のモデル・変換。Vue・DOMを参照しない)、`io/`(KLE・プロジェクトファイル)、`ui/` に分ける。 モノレポ化とパッケージの分割はモックの後に決める。 ### T-7 KLE JSONの読み書き (implementation-plan P-1) + kle-serial2 を使わず、読み書きともに自作する。ijprest/keyboard-layout-editor・kle-serial・過去のkbd-editorのコードも取り込まない。 KLE本家の挙動の確認は、既存の検証ハーネスで本家の `serial.js` を動かして比べる(コードは写さない)。 理由: 出自の確認を待たずに進められ、後からライブラリへ差し替えられる。 @@ -63,7 +70,7 @@ KLE本家の挙動の確認は、既存の検証ハーネスで本家の `serial ### 未確認事項 | 出典 | 仮決定 | -|---|---| +| --- | --- | | 全体 P-1 アナログ値の解釈の所属 | モック対象外。ELCにも仮置きしない | | MAP P-1 動作定義とキーごとの設定の保存形式 | モック対象外。MAPは現行Schemaの `layers[].keymap[]` だけを扱う。モック後の叩き台として: マクロ・Staticの動作は `map.definitions[]`(`name` で識別、`kind` と種別ごとの内容)に置き、キーごとの設定はPHYのキーIDに付ける(`map.keySettings[keyId]`) | | MAP P-2 VIAのコマンドは0.34.4のソースどおり[推測] | 推測に依存しない。実機通信を作らない。疑似デバイスはアプリ側の操作を模擬するだけで、VIAの動作とは扱わない | @@ -75,7 +82,7 @@ KLE本家の挙動の確認は、既存の検証ハーネスで本家の `serial ### backlog | 項目 | 仮決定 | -|---|---| +| --- | --- | | PHY-P-2 KLE取り込みの照合基準 | 新規PHYとしての取り込みだけ。照合・更新は作らない | | PHY-P-6 見た目情報の所属層 | 現行Schemaどおり、キー単位とファイル単位の `kleCompatibility` に退避し書き戻す。編集UIは作らない。ラベルと `a` の往復はT-20 | | PHY-P-8 ラベルのMAP適用 | 自動適用しない。ラベルは表示だけ | @@ -100,6 +107,7 @@ ELC本文にある「LEDのドライバIC方式」「デジタル側の提供者 仕様だけでは実装が一意にならない箇所。 ### T-10 プロジェクトファイル + 1ファイル `*.bkle.json` に束ねる。 ```ts @@ -116,55 +124,67 @@ type ProjectFile = { 各層を単独のJSONとして書き出す・読み込む機能も持つ。モック独自の拡張は各層の中に入れず、`ProjectFile` の直下に置く。 ### T-11 ID + 新規ノードは種別の接頭辞 + ランダム文字列(`key-`, `cl-`, `cmp-`, `vg-`, `v-` + `crypto.randomUUID()` の先頭12桁)。 プロファイル・提供者・LEDチェーンも同じ規則。PHY内の全ノードでIDを一意にする。 移動・並べ替え・reparentではIDを変えない。複製は配下も含めて新しいIDにし、ELC・MAP・IDXへの参照は複製しない。 KLEの取り込みは毎回新しいIDを振る。 ### T-12 phyReference + - `source`: プロジェクト内では `project:phy`。単独ファイルでは読み込んだPHYのファイル名(利用者がPHYを選び直せる) - `checksum`: PHY全体をJCS(RFC 8785)で正規化し、UTF-8のSHA-256を `sha256-jcs:` とする - 不一致は警告だけ。IDを付け替えず、参照の検証をやり直す。保存時に更新する ### T-13 version + モックが出力する各層とプロジェクトファイルは `0.1.0`。読み込みは `0.1.0` だけを受け付ける(文書の例にある `1.0.0` は互換の約束とは扱わない)。 ### T-14 読み込んだ未知のフィールド + 保持して書き戻す。新しく書き出すデータには追加しない。 ### T-15 ノードの削除 + IDX・ELC・MAP・LEDチェーンにある参照を一覧で示し、同じ操作(1回のUndo単位)で削除する。 Variantを削除したときは、VariantGroupの `default` を先頭のVariantへ移す。子が1つになるVariantGroupの削除は、確認して止める。 ### T-16 検証の段階 + - 保存を止めるもの: Schema違反、ID重複、参照先がない - 出力(`mock-target.json`)を止めるもの: IDXに未登録のキー、選択構成のキーの未配線・未割り当て、非排他キーの接続先の衝突 - どちらでも警告として一覧に出す。編集途中の状態は保存できる ### T-17 Undo/Redo + プロジェクト全体のスナップショットで持つ。ドラッグ1回を1操作にまとめる。 ### T-18 IDXの初期の並び + KLE取り込み時は、取り込んだファイルでのキーの出現順で `order` を1回だけ作る。手で置いたキーは作った順に末尾へ足す。 その後はPHYから作り直さない。IDXに未登録のキーは「未登録」と表示する。 `decal` と部品ノードは対象外、`ghost` は対象にする。 ### T-19 row/col の割り当て(Generatorのプレビュー) + 出力設定に順序付きの `rowPins` と `colPins` を利用者が指定し、その添字をrow/colとする。 各接点キーの両端子が、片方は `rowPins`、もう片方は `colPins` に属することを検査する。満たさない構成(charlieplexing、direct)は「未対応」と表示して出力しない。 端子の `a`/`b` の順、キーの位置、IDXの順からは推定しない。 ### T-20 KLEの入出力の細部 + - 入力は厳密なJSON(KLEの緩いJSONは読まない)。VIA定義の `layouts.keymap` は、KLE JSONとして幾何だけを取り込む - ラベルは欄の位置と空欄を保って保持する。`a` 等の属性の引き継ぎとリセットは入出力の処理で解決する - 書き出しは、同じ絶対角度のキーに共通の回転中心を使い、キーの順を固定する。座標は小数6桁に丸める(PHYの値は丸めない) - 書き出し時のバリアント選択は `output.variantSelection` を使い、指定のないものはPHYの `default` ### T-21 プロファイルと座標の単位 + モックで編集できるのは、全プロファイルの `unitSize` が同じ場合だけ。違うものは読み込んで保持するが、編集不可と表示する。 理由: 親の座標系のUを、どのプロファイルでmmへ換算するかが決まっていない([discrepancies.md](discrepancies.md) D-6)。 ### T-22 MAPの割り当て + - 未割り当ては `keymap` に要素がない状態で表す。`KC_NO`・`KC_TRNS` は明示の割り当てとして区別する - 同じレイヤーでの `keyId` の重複は禁止 - 新規MAPは名前 `Base` の空のレイヤー1枚から始める。レイヤー名は大文字小文字を区別し、MAP内で一意 @@ -173,10 +193,13 @@ KLE取り込み時は、取り込んだファイルでのキーの出現順で ` - 編集できるキーコードは、基本キー・修飾キー・`KC_NO`・`KC_TRNS`・上のレイヤー動作・修飾キー付き(`LCTL(kc)` 等)に限る。知らないコードは保持し、表示だけする ### T-23 キーコードの表示 + QMKの表記をそのまま出し、基本キーだけUS配列の文字を添える。表示用の小さな対応表はUI側に置き、HSTのデータ形式としては扱わない。 ### T-24 疑似デバイスとの対応(後段・任意) + MAP P-3 の問いを、モック用に次のように固定する。 + - 出力のたびに「出力記録」を作り、選択構成・キーID↔出力番号↔row/col・レイヤー名↔番号を保存する。疑似デバイスは記録のIDを持つ - 書き込みは選択構成のキーだけ。選択外のバリアントのキーの割り当てはMAPに残す - 読み出した値は、記録にある選択構成のキーだけへ戻す。通信上のアドレスからPHYキーを推定しない @@ -185,17 +208,21 @@ MAP P-3 の問いを、モック用に次のように固定する。 - 「現在のMAP」「出力時のMAP」「最後に読んだ値」を分けて持つ。読み出しは差分を見せてから取り込む。自動同期はしない ### T-25 非排他キーの接続先の衝突判定 + ダイオードがあれば、接続先を(アノード側のピン, カソード側のピン)の順序付きの組として比べる。ダイオードがなければ順序のない組として比べる。 理由: 順序のない組で比べると、Cr0wn60のようなcharlieplexingが常にエラーになる([discrepancies.md](discrepancies.md) D-5)。 ### T-26 MCUのピン名 + 提供者の `part` は1種類(RP2040)だけをモックに組み込み、ピン名(`GP0`〜`GP29`)を候補として出す。知らない `part` は自由入力にする。 提供者のIDに `.` を含めない(`PinRef` の区切りと衝突するため)。 ### T-27 reparentの計算 + ワールド変換を使って `新しいローカル変換 = (新しい親のワールド変換)⁻¹ · 旧ワールド変換` とする。 仕様の式を、親が兄弟でない場合にも当てはまる形で実装する([discrepancies.md](discrepancies.md) D-7)。 reparent・reframeの前後で、絶対位置の差が1e-9U以下であることをテストで確かめる。 ### T-28 スナップ + ドラッグと増減ボタンは、操作開始時の値から0.25U・15度刻み。数値の直接入力はグリッド外の値も受け付ける。計算結果は丸めない。