Skip to content

miku straight conversion ガイド追加と関連設計文書の整理

Choose a tag to compare

@igapyon igapyon released this 21 Apr 22:54
· 37 commits to devel since this release
f52e4e4

miku straight conversion ガイド追加と関連設計文書の整理

概要

miku シリーズで Node.js / TypeScript 系 upstream を Java へ移す際の straight conversion migration 方針をまとめたガイドを追加しました。

あわせて、README と STEP1 初期設計メモを、現在の位置づけに合わせて更新しています。

変更内容

  • docs/miku-straight-conversion-guide.md を新規追加

    • straight conversion の目的、基本姿勢、開始時チェックリスト、作業の再現手順を整理
    • miku Java 版の固定前提として、source / binary 1.8 compatibility、Maven、JUnit Jupiter、mvn test、single fat jar を明記
    • upstream 参照方法、class / test / CLI 対応表、follow-up log、remaining items の扱いを整理
    • package / class / method 命名、public facade、helper class、result object、warning、CLI diagnostics、classpath resource、archive determinism などの実務ルールを整理
    • Apache POI を思いつきやすい xlsx 領域でも、必要範囲が限定される場合はスクラッチ実装を選びうる方針を明記
  • README.md を更新

    • Development Docs の参照順に docs/miku-straight-conversion-guide.md を追加
    • 同ガイドを、Java port を straight conversion first として扱う理由の文書として追加
  • docs/msprojectxml-import-design.md を更新

    • STEP1 初期の import 設計メモとしての位置づけを明確化
    • 現在の正本として参照すべき文書群を追加
    • 既存実装済み class 群を踏まえ、未実装候補ではなく upstream 対応を追うための関連 class 群として表現を調整
  • docs/projectmodel-first-cut.md を更新

    • STEP1 初期の ProjectModel 実装順序メモとしての位置づけを明確化
    • 現在は主要 POJO と codec / workbook / patch / xlsx / report / AI view 連携の導線が存在する前提に更新
    • 現在の正本として参照すべき文書群を追加
    • 初期移植時の優先対象として読めるよう表現を調整
  • docs/projectmodel-pojo-class-plan.md を更新

    • STEP1 初期の POJO class 対応設計メモとしての位置づけを明確化
    • 現在の正本として参照すべき文書群を追加
    • 候補未確定 を未実装 TODO と誤読しないよう、実装後方針への参照を追加

変更範囲

  • 変更ファイル数: 5
  • 追加行数: 1002
  • 削除行数: 40