Skip to content

Welcome画面関連:小さな修正リスト #2927

@Hiroshiba

Description

@Hiroshiba

内容

変更量が小さい複数の修正のリストissueです。
1つ1つ変更してPRするのもよし、ある程度まとめるも良し。

修正項目

ファイル名・命名関連

  1. ファイル名の誤字

  2. RemoteとLocalの命名がわかりにくい

docstring・コメント関連

  1. launch関数のdocstring

    • src/backend/electron/appStateController.ts:32
    • 関数が担当する責務範囲のdocstringを追加する
    • launchするだけなら一旦launch専用の関数名で良さそう
    • ref: feat: Welcome画面を追加 #2866 (comment)
  2. ipc.tsの設計思想のdocstring

ロジック移動・整理

  1. defaultEngineExistsの取得ロジック移動

  2. vueからbackend/electronをimportしている問題

    • src/welcome/components/App.vueからbackend/electron/engineAndVvppControllerを直接importしている
    • vueコンポーネントはbackend/electronを直接参照すべきではない
    • ref: feat: Welcome画面を追加 #2866 (comment)

型安全性・コード品質

  1. ipc.tsのas stringまみれ

  2. ipc.tsのunreachableの使用

  3. ipc.tsのpushじゃなくてset

  4. BaseIpcDataの目的明確化

    • src/backend/electron/ipcType.ts:235
    • 何のための型かわからない、ipc.tsからしか使われていない
    • 目的をはっきりさせて、1箇所からしか使わないならprivateにする
    • ref: feat: Welcome画面を追加 #2866 (comment)

コンポーネント関連

  1. EngineCardのpropsをひとまとめ

  2. 表示条件と表示内容の不一致

    • src/welcome/components/EngineCard.vue:124-128
    • 「パッケージが選ばれてない」=「読み込み中」がわかりづらい
    • remoteがundefinedのときに読み込み中になるのが自然
    • selectedPackageInfo側はcomputed内でassertNonNullableする
    • ref: feat: Welcome画面を追加 #2866 (comment)

preload.ts関連

  1. return voidの不一致

  2. 直接呼び出しと?.の不一致

Pros 良くなる点

  • コードの一貫性が向上する
  • 誤字が修正される
  • 型安全性が向上する

Cons 悪くなる点

(なし)

実現方法

各修正項目に従ってコードを修正する。

VOICEVOXのバージョン

mainブランチ

その他

(参考)変更対象ファイル:

  • src/domain/defaultEngine/latetDefaultEngine.ts
  • src/backend/electron/appStateController.ts
  • src/backend/electron/ipc.ts
  • src/backend/electron/ipcType.ts
  • src/welcome/components/App.vue
  • src/welcome/components/EngineCard.vue
  • src/welcome/preload.ts

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions