VOICEVOX / voicevox_core

無料で使える中品質なテキスト読み上げソフトウェア、VOICEVOXのコア
https://voicevox.hiroshiba.jp/
MIT License
866 stars 117 forks source link

downloadクレートの名称をdownloaderにする #607

Closed Hiroshiba closed 1 year ago

Hiroshiba commented 1 year ago

内容

voicevox_coreクレートは、自身を意味するvoicevox_coreを名乗っていますが、downloaderはdownloadクレートになっています。 現downloadクレートも自身を意味するdownloaderに変えたほうがわかりやすい気がしました。

Pros 良くなる点

クレート内容とクレート名が同じになる。 補助的な効果としてcargo -p downloadなど初学者にとってちょっと分かりにくいコマンドじゃなくなる。

Cons 悪くなる点

実現方法

クレート名を変更してREADMEなども変更。

その他

downloadコマンドの名称をdownloadからdownloaderにすべきかはちょっと分かりませんでした。 それでもいいと思うけれども変えるほどではないかも。

Hiroshiba commented 1 year ago

@qryxip さん、 @y-chan さん的にはどうでしょう・・・?

y-chan commented 1 year ago

確かに、クレート名と本来の名前が合致していないので、変えちゃっていいのでは無いかなと思いました! 他所から依存されているライブラリではないですし、名称変更を行うのは特に問題は無いかなという感じです。

qryxip commented 1 year ago

よいと思います。

Hiroshiba commented 1 year ago

タイトル変えておきます! 📝 docsのファイル名も変える必要がありそう。

Hiroshiba commented 1 year ago

こちらやっちゃおうと思います!

Hiroshiba commented 1 year ago

@qryxip @y-chan その他のとこに書いてたのですが、この際にdownload.exedownloader.exeにしてしまおうか迷ってます 😇

実行バイナリの名称は、何をするかではなく、何をするものなのかを書いた方が良いと思ってます。 例えば喋る機械の名称は「スピーカー」であり「スピーク」ではないし、インストールする実行ファイルは「インストーラー」であり「インストール」ではない。 ので、どちらかというと正しいのはdownloaderかなと。

ただ、破壊的変更するべきもののほどなのかが若干自信が無く・・・。 API側は0.15のタイミングで破壊的変更OKで進めているので、この際にやっちゃった方がいいかなと個人的には思ってます。 ちなみに置き換え作業の面では、全部downloaderにしちゃった方が間違えにくいと思います 😇

まあでもわりとどっちでもいいと思うので、意見いただいたら素直にそっちに倒そうかなと思います!

qryxip commented 1 year ago

個人的にはバイナリ名はdownload(.exe)のままでよいのではと思っています。

"builder.sh"のような名前より"build.sh"の方が多数ですし、Windows/Unix両方において、バイナリ名は"コマンド名"と捉えた方がよいのではと思っています。

Hiroshiba commented 1 year ago

なるほどです! 確かにこのバイナリがもっと物感がある(例えばguiがあるとか)んだったらダウンローダーの方が正しそうですが、これはコマンド感が強いのでUnixの慣習に倣ってdownload.exeでも良さそうに思いました。

今ドキュメントではdownlaodコマンド(あるいはdownload実行バイナリ)を指してダウンローダーと呼んでいてどっちやねんっていう感じなのですが、まあ引き続きその感じでドキュメントを書いていけば問題なさそうですかね。

Hiroshiba commented 1 year ago

downloadコマンド(=download実行バイナリ)を指して「ダウンローダー」と呼ぶ形で良さそうに感じたので、そっちに合わせようと思います!