VOICEVOX / voicevox

無料で使える中品質なテキスト読み上げソフトウェア、VOICEVOXのエディター
https://voicevox.hiroshiba.jp/
Other
2.52k stars 305 forks source link

保存している設定をVuex側に持ってくる関数名をGETからLOADに変える #1020

Open Hiroshiba opened 2 years ago

Hiroshiba commented 2 years ago

内容

ボイボエディタのコード上で、「保存情報を取ってきてVuex Storeの中に情報を入れる」という操作をする関数は「GET」となっています。

↓例 https://github.com/VOICEVOX/voicevox/blob/96439685f1e8ddd7bf48c23f24ca1d0ac4116561/src/store/ui.ts#L392-L398

GETだとGETTERのことだと勘違いするので、こちらのPRに倣ってHYDRATEこちらの議論の通りLOADとしたいです。

2022/11/23 14:23追記 また、それに合わせてVuexのstoreにsetしつつelectron-storeに保存する関数名も、SETからSAVEとしたいです。

Pros 良くなる点

勘違いが起きづらくなる

Cons 悪くなる点

その他

もし更に良い命名があればぜひコメントください!

k-chop commented 2 years ago

もし更に良い命名があればぜひコメントください!

シンプルに LOAD_*** でもいいのかもしれないと思いました(最初にHYDRATE使っておいてなんですが) HYDRATE は使われる文脈が狭い(web development only)ので 見た人がどんな処理?とピンと来ない可能性があるかもしれません

あとissueには直接関係ないのですが、window.electron.getConfig/setConfigもファイルの読み書きが発生するので load/save or read/writeの方がふさわしい気がしてきました・・・

Hiroshiba commented 2 years ago

なるほどです!!HYDRATEだとたしかにsetするとに困りますね・・・。 LOADだとプロジェクトファイルのロードなど、ファイルロードもあるので混乱しちゃうかもと思いました。 といっても対案が思いつかないのですが・・・。 store/restore・・・?

k-chop commented 1 year ago

なるほど、store/restoreはアリかもですね・・・

setするときに困る

SET_**** という名のactionには以下の2パターンがありますが、

  1. storeに格納
  2. storeに格納しつつ同じ内容を設定ファイルにも書き込む

2の名前も一緒に変えたくて、それが DEHYDRATE だと変では?という話でしょうか? これ変えるなら別に対の単語じゃなくても良い気がします。HYDRATE/SAVEでも。 storeの内容を設定ファイルに書き出す、なら対になっていて欲しいですが、storeに値を格納して設定ファイルにも同じ内容を書き込む、なのでちょっと違う気がします・・・個人の感覚かもしれませんが・・・

Hiroshiba commented 1 year ago

2の名前も一緒に変えたくて、それが DEHYDRATE だと変では?という話でしょうか?

あ、HYDRATEの逆の単語を何にするか困るという意図でした!! 素直に考えるとDEHYDRATEですね・・・!

たしかにstoreに格納しつつ同じ内容を設定ファイルにも書き込むは「setしてsaveする」って感じで、HYDRATEと非対称に感じました。

うーーーーーん!難しいですが、素直にload/saveが良いかもと思いました! プロジェクトファイルのloadとかと被りますが、まあ後ろに続く単語でわかるはず・・・!

問題なさそうであればタイトルを「GET/SETからLOAD/SAVEに」というふうに変更したいと思います 🙏

k-chop commented 1 year ago

いやあ命名難しいですね・・・

問題なさそうであればタイトルを「GET/SETからLOAD/SAVEに」というふうに変更したいと思います 🙏

了解です!問題ないと思います。

現状で困っているのは、同じGET/SETという名前でそれ以上のことをしているactionがある、というところだと思うので それらに別の名前さえつけられればいったんそこは解消されそうです。 変えた上でLOADがファイルロードと混同しちゃうのでつらい、という話が出てきたら改めてふさわしい名前を議論できればよいのかなと思いました!! :bow:

Hiroshiba commented 1 year ago

ありがとうございます! タイトル変えて内容にも訂正入れてみます!