ファイルの書き出し時の名前設定にプロジェクトファイル名を含められるようにする

[jdkfx]

内容

• 設定で書き出しファイル名パターンにプロジェクトファイル名を設定できるようにしました
  • プロジェクトファイル名がない場合、ある場合のそれぞれに対応させました
  • プロジェクトファイル名がない場合は空文字にしています
• READMEの軽微な修正をしました

関連 Issue

close #2075
close #2136

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

画像1

画像2

画像1の書き出しファイル名パターンを使用し、音声を書き出した際、

• 画像2における001_.wavはプロジェクトファイル名を設定していない音声ファイル
• 画像2における001_開発テスト用.wav、002_開発テスト用.wavはプロジェクトファイル名を設定した上で書き出したファイル
  となっています。

その他

[Hiroshiba]

PRありがとうございます！！

[Hiroshiba]

あ！　store->utilityへの参照がすでにあるので、可能ならutility->storeへの参照は避けられると嬉しそうです！
（プログラミング的に言うと、依存関係を綺麗にしておきたい感じです）

buildAudioFileNameFromRawDataのvarsにprojectName的なのを増やし、buildAudioFileNameFromRawDataを呼んでいるところでstore.getters.PROJECT_NAMEを使ってvarsにprojectNameをいれるとかどうでしょう？

[jdkfx]

store->utilityへの参照がすでにあるので、可能ならutility->storeへの参照は避けられると嬉しそうです！
（プログラミング的に言うと、依存関係を綺麗にしておきたい感じです）

こちらについては依存関係について把握していなかったため、

import { store } from "./index";

は削除します。

buildAudioFileNameFromRawDataのvarsにprojectName的なのを増やし

varsにDEFAULT_AUDIO_FILE_NAME_VARIABLESが代入されているので、DEFAULT_AUDIO_FILE_NAME_VARIABLESに以下のような形でprojectNameを増やします。

const DEFAULT_AUDIO_FILE_NAME_VARIABLES = {
  index: 0,
  characterName: "四国めたん",
  text: "テキストテキストテキスト",
  styleName: DEFAULT_STYLE_NAME,
  date: currentDateString(),
  projectName: "VOICEVOXプロジェクト",
};

buildAudioFileNameFromRawDataを呼んでいるところでstore.getters.PROJECT_NAMEを使ってvarsにprojectNameをいれるとかどうでしょう？

この件に関しては、src/store/audio.tsのように、buildAudioFileNameFromRawDataを呼び出している箇所で

const projectName = getter.projectName;

      return buildAudioFileNameFromRawData(fileNamePattern, {
        characterName: character.metas.speakerName,
        index,
        styleName,
        text: audioItem.text,
        date: currentDateString(),
        projectName,
      });

のような形をとるのかな？と考えております。

実際に動かしていないので動くかどうかは分からないのですが、考え方というか認識がこれであっているのか確認させていただきたいです。

[Hiroshiba]

あ、ですです！　多分あってると思います！！

[Hiroshiba]

ほかで使う機会は今のところなさそう？なので、関数にせずconst projectName = removeExtension(store.getters.PROJECT_NAME);の部分に組み込んでしまっても良いかも？

というよりそもそもgetters.PROJECT_NAMEが拡張子なしの値を返すべきな気がしますね！！
ちょっとこっちはDiscordで意見募集してみます。とりあえず拡張子ありの実装で進めていただけると･･･！ 🙇

[Hiroshiba]

お待たせしました！

とりあえず今の拡張子を返す方をPROJECT_NAME_WITH_EXTに名前変更して、別でPROJECT_NAMEを作ってそっちは拡張子なしのを返すとかどうでしょう！
プロジェクトファイルを拡張子が複数になった時、拡張子があった方が便利な時もあるな～と。
で、ファイル名パターンはPROJECT_NAMEの方を使う感じに･･･！

もしその更新の場合、ファイル全体検索した感じPROJECT_NAMEを使ってる箇所が一箇所だけあったのでそちらも変更が必要かもです。
ちなみにそっちは拡張子なしの方を必要としてそうでした･･･！

[jdkfx]

こちらについて、認識が合っているのか確認したいため、質問させていただきたいです。

• 現状あるPROJECT_NAMEは拡張子が無しのものにする。
• PROJECT_NAME_WITH_EXTを新しく作成する。中身は現状のPROJECT_NAMEと同じものである。
• 拡張子を除いたPROJECT_NAMEを返すために関数をどこかに書く必要がある。
• PROJECT_NAMEを返すための関数はPR内で書いたremoveExtension()を利用する。

ということであっていますでしょうか？

また、現状VOICEVOX全体のコードを追えることができず、拡張子を除いたPROJECT_NAMEを返すための関数をかいてもいいコードの場所がどこにあたるのか分からないのですが、ここに書くといいという場所がありましたら教えていただきたいです。

[Hiroshiba]

あっ分かりづらくてすみません！！

src\store\project.tsにPROJECT_NAME・PROJECT_NAME_WITH_EXTの実装を書いて、
src\store\type.tsにPROJECT_NAME・PROJECT_NAME_WITH_EXTの型を書く感じになると思います！

removeExtensionはおそらくここでしか使わないので、関数のコードをPROJECT_NAME内に移動するとスリムかもです！
雰囲気、実装はこんな感じ･･･？

export const projectStore = createPartialStore<ProjectStoreTypes>({
  PROJECT_NAME_WITH_EXT: {
    getter(state) {
      return state.projectFilePath
        ? getBaseName(state.projectFilePath)
        : undefined;
    },
  },

  PROJECT_NAME: {
    getter(state) {
      return state.projectFilePath
        ? getBaseName(state.projectFilePath).replace(".vvproj", "")
        : undefined;
    },
  },

不明な点あれば何でも聞いてください･･･！ 🙏

[jdkfx]

@Hiroshiba
レビュー後の修正内容として、下記の実装を行いました。

• 依存関係の修正
• buildAudioFileNameFromRawDataを呼び出している箇所でprojectNameを追加
• 既存のPROJECT_NAMEを拡張子なしのものに
• PROJECT_NAME_WITH_EXTを新しく追加

出力結果はPRの画像2と変わりません。
再度、レビューをお願いいたします。