Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

キー割り当て画面からホットキー設定ダイアログを抜き出してコンポーネント化する #2209

Merged

Conversation

jdkfx
Copy link
Contributor

@jdkfx jdkfx commented Aug 8, 2024

内容

  • キー割り当て画面のホットキー設定ダイアログを抜き出してコンポーネント化
  • /components/Dialog/SetHotkeyDialog.vueを作成

関連 Issue

close #2002

スクリーンショット・動画など

その他

@jdkfx jdkfx requested a review from a team as a code owner August 8, 2024 02:34
@jdkfx jdkfx requested review from Hiroshiba and removed request for a team August 8, 2024 02:34
Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

コンポーネント切り出しありがとうございます!!
元のコードをそのまま移動してくださっていることが多くてレビューしやすかったです!

src/components/Dialog/HotkeySettingDialog.vue Outdated Show resolved Hide resolved
src/components/Dialog/SetHotkeyDialog.vue Outdated Show resolved Hide resolved
src/components/Dialog/HotkeySettingDialog.vue Outdated Show resolved Hide resolved
src/components/Dialog/SetHotkeyDialog.vue Outdated Show resolved Hide resolved
src/components/Dialog/SetHotkeyDialog.vue Outdated Show resolved Hide resolved
src/components/Dialog/SetHotkeyDialog.vue Outdated Show resolved Hide resolved
Comment on lines 121 to 125
<SetHotkeyDialog
:isHotkeyDialogOpened
:lastAction
:lastRecord
:duplicatedHotkey
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ちょっと相談が!

今このコンポーネントは表示専用になっていて、内部で処理を一切行なってない形になっています。
例えば「ショートカットキー入力を受け付ける」などの処理は親コンポーネントで行ってる形です。
そういった処理もこのコンポーネントの中に移動することもできそうですが、どの処理を親コンポーネントで行い、どの処理をコンポーネントで行うのが良さそうでしょうか?

結構ここのコンポーネントの切り分けは難しく、今のプルリクエストのよう表示だけを担わせるのもありだと思います。
もうちょっと踏み込んでショートカットキーの入力機構も切り分けたコンポーネントの方にあってもいいかもです。
というのどう思われるかお聞きしたいです!
もし移動した方が良さそうな場合であっても、移動を伴うプルリクエストなので、追加で移動をするのではなく一旦このプルリクエストをマージできると嬉しいです・・・!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

入力に関する処理も切り分けたコンポーネントに移し替えるのがいいのかなと考えています。

コンポーネントの責務として

  • 元々あったコンポーネント: ショートカットキーの表示、検索などの表示に関わる部分
  • 新しく切り出したコンポーネント: ショートカットキーの編集、入力、未設定にするなど入力に関わる部分

とすると、責務がはっきりしやすいのではないかと考えます!

ただ、Vueやフロントエンドの知識に精通しているわけではないので、もしかすると正しいことを言っていない可能性があります... 🙇

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

なるほどです、認識が揃って良かったです!

「本当はこうしたいけど、今はそうなってない」というのがわかるようにコメントを追加するのはどうでしょう?
例えばrecordCombination関数の辺りに「// FIXME: HotkeyRecordingDialog内に移動する」と書いとくとか!

で、もしよかったらぜひ入力部分を切り分ける部分も(あとあと)挑戦してみていただけると・・・!!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

recordCombination 以外にも、changeHotkeySettingsも新しく作成したコンポーネントに移動できそうだと考えているため、そちらについてもコメントを追加しておきました。

@jdkfx jdkfx requested a review from Hiroshiba August 9, 2024 13:23
Comment on lines +127 to +128
@deleteHotkey="deleteHotkey"
@changeHotkeySettings="changeHotkeySettings"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(ただのコメントです)

これちょっとコンポーネント分けの難しいところというか、僕の中でも結論が出てないのですが、一般的に言われていることをちょっとご紹介してみます 🙏

子コンポーネントから親コンポーネントの処理を実行したいとき、今の実装のように具体的な処理をする関数を渡す方法と、イベントのみやり取りする方法の2つがあります。
例えばイベントペースでやり取りする場合、「追加ボタンが押された」「上書きボタンが押された」というコールバックを受け取って、親コンポーネント側が具体的な処理を書く感じです。

イベントをやり取りする方が疎結合になってテストがやりやすいため、一般的にはこっちのがいいのですが、今回の場合みたく処理が複雑に絡み合ってる場合は直接関数を渡しても良いかもです。
「イベントのやり取りにできないか」という考え方に立つと何か見えてくるかもです。
まあ慣れてきたらぜひ・・・!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ありがとうございます!!今後の実装に活かしたいです!!

Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!!

実装ありがとうございます!!
一箇所だけコメント追加お願いさせていただきました!

@jdkfx jdkfx requested a review from Hiroshiba August 10, 2024 11:31
Copy link
Member

@Hiroshiba Hiroshiba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

コメント追加ありがとうございます、マージします!

HotkeyDialog周りは長い間入り組んだ状態のままで、メンテナンスに結構苦労していたのでコンポーネント分けとても助かります!!
もしHotkeyRecordingDialog内に機能を移す実装もご興味あれば、ぜひ!!
(今回のPRは表示部分の移動が主でしたが、次は処理部分もになるので難度が1つ違うかもです。もし挑戦してくださる際は、わからないことがあればissueなりdraft PRなりでお聞きいただければ・・・!)

@Hiroshiba Hiroshiba merged commit 8cd4ac2 into VOICEVOX:main Aug 10, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants