Merge: upstreamからマージ

.eslintrc.js

@@ -11,6 +11,7 @@ module.exports = {
     "@vue/prettier",
     "@vue/eslint-config-typescript/recommended",
     "@vue/eslint-config-prettier",
+    "plugin:@voicevox/all",
   ],
   plugins: ["import"],
   parser: "vue-eslint-parser",
@@ -25,6 +26,7 @@ module.exports = {
         ? ["error", "unix"]
         : "off",
     "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
+    "no-constant-condition": ["error", { checkLoops: false }], // while(true) などを許可
     "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
     "prettier/prettier": [
       "error",
@@ -49,47 +51,32 @@ module.exports = {
         ignoreRestSiblings: true,
       },
     ],
-    "vue/component-tags-order": [
+    "vue/component-name-in-template-casing": [
       "error",
+      "PascalCase",
       {
-        order: ["template", "script", "style"],
+        registeredComponentsOnly: false,
+        ignores: [],
       },
     ],
-    "import/order": "error",
-    "no-restricted-syntax": [
-      "warn",
-      {
-        selector:
-          "BinaryExpression[operator='==='][right.type='Literal'][right.value=null]",
-        message:
-          "'=== null'ではなく'== null'を使用してください。詳細: https://github.com/VOICEVOX/voicevox/issues/1513",
-      },
-      {
-        selector:
-          "BinaryExpression[operator='!=='][right.type='Literal'][right.value=null]",
-        message:
-          "'!== null'ではなく'!= null'を使用してください。詳細: https://github.com/VOICEVOX/voicevox/issues/1513",
-      },
+    "vue/component-tags-order": [
+      "error",
       {
-        selector:
-          "BinaryExpression[operator='==='][right.type='Identifier'][right.name=undefined]",
-        message:
-          "'=== undefined'ではなく'== undefined'を使用してください。詳細: https://github.com/VOICEVOX/voicevox/issues/1513",
+        order: ["template", "script", "style"],
       },
+    ],
+    "vue/multi-word-component-names": [
+      "error",
       {
-        selector:
-          "BinaryExpression[operator='!=='][right.type='Identifier'][right.name=undefined]",
-        message:
-          "'!== undefined'ではなく'!= undefined'を使用してください。詳細: https://github.com/VOICEVOX/voicevox/issues/1513",
+        ignores: ["Container", "Presentation"],
       },
     ],
+    "import/order": "error",
   },
   overrides: [
     {
       files: [
-        "./src/background.ts",
-        "./src/background/*.ts",
-        "./src/electron/*.ts",
+        "./src/backend/electron/**/*.ts",
         "./tests/**/*.ts",
         "./build/*.js",
         "./build/*.mts",
@@ -101,11 +88,7 @@ module.exports = {
     // Electronのメインプロセス以外でelectronのimportを禁止する
     {
       files: ["./src/**/*.ts", "./src/**/*.vue"],
-      excludedFiles: [
-        "./src/background.ts",
-        "./src/background/*.ts",
-        "./src/electron/*.ts",
-      ],
+      excludedFiles: ["./src/backend/electron/**/*.ts"],
       rules: {
         "no-restricted-imports": [
           "error",

.github/workflows/build.yml

@@ -27,8 +27,8 @@ on:
 
 env:
   VOICEVOX_ENGINE_REPO_URL: "https://github.com/VOICEVOX/voicevox_engine"
-  VOICEVOX_ENGINE_VERSION: 0.14.7
-  VOICEVOX_RESOURCE_VERSION: 0.15.0-preview.3
+  VOICEVOX_ENGINE_VERSION: 0.16.0
+  VOICEVOX_RESOURCE_VERSION: 0.16.0
   VOICEVOX_EDITOR_VERSION:
     |- # releaseタグ名か、workflow_dispatchでのバージョン名か、999.999.999-developが入る
     ${{ github.event.release.tag_name || github.event.inputs.version || '999.999.999-develop' }}
@@ -89,7 +89,7 @@ jobs:
             compressed_artifact_name: voicevox-windows-nvidia
             app_asar_dir: prepackage/resources
             installer_artifact_name: windows-nvidia-nsis-web
-            nsis_web_artifact_name: "VOICEVOX-CUDA Web Setup ${version}.${ext}"
+            nsis_web_artifact_name: "VOICEVOX-CUDA.Web.Setup.${version}.${ext}"
             os: windows-2019
           # Windows CPU
           - artifact_name: windows-cpu-prepackage
@@ -99,7 +99,7 @@ jobs:
             compressed_artifact_name: voicevox-windows-cpu
             app_asar_dir: prepackage/resources
             installer_artifact_name: windows-cpu-nsis-web
-            nsis_web_artifact_name: "VOICEVOX-CPU Web Setup ${version}.${ext}"
+            nsis_web_artifact_name: "VOICEVOX-CPU.Web.Setup.${version}.${ext}"
             os: windows-2019
           # Windows DirectML
           - artifact_name: windows-directml-prepackage
@@ -109,7 +109,7 @@ jobs:
             compressed_artifact_name: voicevox-windows-directml
             app_asar_dir: prepackage/resources
             installer_artifact_name: windows-directml-nsis-web
-            nsis_web_artifact_name: "VOICEVOX Web Setup ${version}.${ext}"
+            nsis_web_artifact_name: "VOICEVOX.Web.Setup.${version}.${ext}"
             os: windows-2019
           # macOS CPU
           - artifact_name: macos-cpu-prepackage
@@ -119,7 +119,7 @@ jobs:
             compressed_artifact_name: voicevox-macos-cpu
             app_asar_dir: prepackage/VOICEVOX.app/Contents/Resources
             installer_artifact_name: macos-cpu-dmg
-            macos_artifact_name: "VOICEVOX.${ext}"
+            macos_artifact_name: "VOICEVOX.${version}.${ext}"
             os: macos-11
 
     runs-on: ${{ matrix.os }}
@@ -294,7 +294,6 @@ jobs:
       - name: Recover file permissions for macOS build
         if: startsWith(matrix.artifact_name, 'macos-') # macOS
         run: |
-          chmod +x "prepackage/VOICEVOX.app/Contents/MacOS/${{ matrix.macos_executable_name }}"
           chmod +x "prepackage/VOICEVOX.app/Contents/MacOS/vv-engine/run"
           chmod +x "prepackage/VOICEVOX.app/Contents/Frameworks/VOICEVOX Helper (GPU).app/Contents/MacOS/VOICEVOX Helper (GPU)"
           chmod +x "prepackage/VOICEVOX.app/Contents/Frameworks/VOICEVOX Helper (Plugin).app/Contents/MacOS/VOICEVOX Helper (Plugin)"
@@ -471,31 +470,14 @@ jobs:
             dist_electron/*.dmg
           target_commitish: ${{ github.sha }}
 
-      - name: Create Windows NSIS Web artifact directory
-        if: endsWith(matrix.installer_artifact_name, '-nsis-web')
-        run: |
-          mkdir -p nsis-web-artifact
-          mv dist_electron/nsis-web/out/*.7z.* nsis-web-artifact/
-          mv dist_electron/nsis-web/*.exe nsis-web-artifact/
-
-      # Rename file name like "VOICEVOX Web Setup X.X.X.exe" to "VOICEVOX.Web.Setup.X.X.X.exe".
-      - name: Rename Windows NSIS Web Installer
-        if: endsWith(matrix.installer_artifact_name, '-nsis-web')
-        run: |
-          cd nsis-web-artifact
-          OLD_NAME=`find . -maxdepth 1 -name '*.exe'`
-          # replace space by dot(.)
-          NEW_NAME=${OLD_NAME// /.}
-          mv "${OLD_NAME}" $NEW_NAME
-
       - name: Upload Windows NSIS Web to Artifacts
         if: endsWith(matrix.installer_artifact_name, '-nsis-web') && github.event.inputs.upload_artifact
         uses: actions/upload-artifact@v3
         with:
           name: ${{ matrix.installer_artifact_name }}-release
           path: |-
-            nsis-web-artifact/*.7z.*
-            nsis-web-artifact/*.exe
+            dist_electron/nsis-web/out/*.7z.*
+            dist_electron/nsis-web/*.exe
 
       - name: Upload Windows NSIS Web to Release Assets
         if: endsWith(matrix.installer_artifact_name, '-nsis-web') && (github.event.release.tag_name || github.event.inputs.version) != ''
@@ -504,6 +486,6 @@ jobs:
           prerelease: ${{ github.event.inputs.prerelease }}
           tag_name: ${{ env.VOICEVOX_EDITOR_VERSION }}
           files: |-
-            nsis-web-artifact/*.7z.*
-            nsis-web-artifact/*.exe
+            dist_electron/nsis-web/out/*.7z.*
+            dist_electron/nsis-web/*.exe
           target_commitish: ${{ github.sha }}

.github/workflows/test.yml

@@ -16,6 +16,29 @@ defaults:
     shell: bash
 
 jobs:
+  config: # 全 jobs で利用する定数の定義. `env` が利用できないコンテキストでも利用できる.
+    runs-on: ubuntu-latest
+    outputs:
+      shouldUpdateSnapshots: ${{ steps.check-whether-to-update-snapshots.outputs.shouldUpdateSnapshots }}
+    steps:
+      - name: Check if commit message includes [update snapshots]
+        id: check-whether-to-update-snapshots
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const commits = ${{ toJson(github.event.commits) }};
+            if (!commits) {
+              // pull_request などでコミットがない場合はスキップ
+              core.setOutput("shouldUpdateSnapshots", false);
+              process.exit(0);
+            }
+            const shouldUpdateSnapshots = commits.some((commit) =>
+              commit.message.toLowerCase().includes("[update snapshots]")
+            );
+            core.setOutput("shouldUpdateSnapshots", shouldUpdateSnapshots);
+            console.log(`shouldUpdateSnapshots: ${shouldUpdateSnapshots}`);
+
   # ビルドのテスト
   build-test:
     runs-on: windows-latest
@@ -38,6 +61,7 @@ jobs:
   # e2e テスト
   e2e-test:
     runs-on: ${{ matrix.os }}
+    needs: [config]
     strategy:
       fail-fast: false
       matrix:
@@ -81,34 +105,19 @@ jobs:
           # .env
           sed -i -e 's|"074fc39e-678b-4c13-8916-ffca8d505d1d"|"208cf94d-43d2-4cf5-abc0-9783cac36d29"|' .env.test
           sed -i -e 's|"../voicevox_engine/run.exe"|"${{ steps.download-engine.outputs.run_path }}"|' .env.test
-          sed -i -e 's|"executionArgs": \[\],|"executionArgs": ["--port=50021"],|' .env.test
+          # GitHub Actions 環境だとたまに50021が封じられていることがあるので、ランダムなポートを使うようにする
+          PORT=$(node -r net -e "server=net.createServer();server.listen(0,()=>{console.log(server.address().port);server.close()})")
+          sed -i -e 's|"host": "http://127.0.0.1:50021"|"host": "http://127.0.0.1:'$PORT'"|' .env.test
+          sed -i -e 's|"executionArgs": \[\],|"executionArgs": ["--port='$PORT'"],|' .env.test
           cp .env.test .env
 
-      - name: Check if commit message includes [update snapshots]
-        id: check-whether-to-update-snapshots
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const commits = ${{ toJson(github.event.commits) }};
-            if (!commits) {
-              // pull_request などでコミットがない場合はスキップ
-              core.setOutput("shouldUpdateSnapshots", false);
-              process.exit(0);
-            }
-            const shouldUpdateSnapshots = commits.some((commit) =>
-              commit.message.toLowerCase().includes("[update snapshots]")
-            );
-            core.setOutput("shouldUpdateSnapshots", shouldUpdateSnapshots);
-            console.log(`shouldUpdateSnapshots: ${shouldUpdateSnapshots}`);
-
       - name: Run npm run test:browser-e2e
         run: |
           if [ -n "${{ runner.debug }}" ]; then
             export DEBUG="pw:browser*"
           fi
           ARGS=""
-          if [[ ${{ steps.check-whether-to-update-snapshots.outputs.shouldUpdateSnapshots }} == 'true' ]]; then
+          if [[ ${{ needs.config.outputs.shouldUpdateSnapshots }} == 'true' ]]; then
             ARGS="--update-snapshots"
           fi
           npm run test:browser-e2e -- $ARGS
@@ -131,35 +140,49 @@ jobs:
           name: playwright-report-${{ matrix.os }}
           path: playwright-report
 
-      - name: Upload updated snapshots to artifact
-        if: steps.check-whether-to-update-snapshots.outputs.shouldUpdateSnapshots == 'true'
+      - name: Collect patch for snapshots
+        if: needs.config.outputs.shouldUpdateSnapshots == 'true'
+        run: |
+          git add --intent-to-add tests/  # git diff に表示されるようにする
+          git diff tests/  # ロギング用
+          git diff --binary tests/ > patch-${{ matrix.os }}.diff
+
+      - name: Upload patch to artifact
+        if: needs.config.outputs.shouldUpdateSnapshots == 'true'
         uses: actions/upload-artifact@v4
         with:
           name: updated-snapshots-${{ matrix.os }}
-          path: tests/e2e/browser/*-snapshots/*
+          path: patch-${{ matrix.os }}.diff
 
   commit-snapshots:
     runs-on: ubuntu-latest
     permissions:
       contents: write
-    needs:
-      - e2e-test
+    needs: [config, e2e-test]
+    if: needs.config.outputs.shouldUpdateSnapshots == 'true'
     steps:
       - uses: actions/checkout@v3
 
       - name: Download artifacts
         uses: actions/download-artifact@v4
         with:
           pattern: updated-snapshots-*
-          path: tests/e2e/browser
+          path: patches
           merge-multiple: true
 
       - name: Commit updated snapshots
         run: |
-          git config --global user.name "github-actions[bot]"
-          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          # パッチを適用
+          for patch in patches/*.diff; do
+            git apply --allow-empty $patch
+            rm $patch
+          done
+
+          # 変更があるかチェック
           if [ -n "$(git status --porcelain)" ]; then
-            git add tests/e2e/browser
+            git config --global user.name "github-actions[bot]"
+            git config --global user.email "github-actions[bot]@users.noreply.github.com"
+            git add tests/
             git commit -m "（スナップショットを更新）"
             git push
           else

README.md

@@ -158,7 +158,7 @@ npm run electron:serve
 npm run browser:serve
 ```
 
-また、main ブランチのビルド結果がこちらにデプロイされています <https://voicevox-browser-dev.netlify.app/#/home>  
+また、main ブランチのビルド結果がこちらにデプロイされています <https://voicevox-browser-dev.netlify.app/#/talk>  
 今はローカル PC 上で音声合成エンジンを起動する必要があります。
 
 ## ビルド
@@ -174,6 +174,7 @@ npm run electron:build
 ```bash
 npm run test:unit
 npm run test-watch:unit # 監視モード
+npm run test:unit -- --update # スナップショットの更新
 ```
 
 ### ブラウザ End to End テスト
@@ -193,16 +194,19 @@ Playwright を使用しているためテストパターンを生成すること
 **ブラウザ版を起動している状態で**以下のコマンドを実行してください。
 
 ```bash
-npx playwright codegen http://localhost:5173/#/home  --viewport-size=800,600
+npx playwright codegen http://localhost:5173/#/talk  --viewport-size=800,600
 ```
 
 詳細は [Playwright ドキュメントの Test generator](https://playwright.dev/docs/codegen-intro) を参照してください。
 
 #### スクリーンショットの更新
 
 ブラウザ End to End テストでは Visual Regression Testing を行っています。
+現在 VRT テストは Windows のみで行っています。
 以下の手順でスクリーンショットを更新できます：
 
+##### Github Actions で更新する場合
+
 1. フォークしたリポジトリの設定で GitHub Actions を有効にします。
 2. リポジトリの設定の Actions > General > Workflow permissions で Read and write permissions を選択します。
 3. `[update snapshots]` という文字列をコミットメッセージに含めてコミットします。
@@ -213,6 +217,14 @@ npx playwright codegen http://localhost:5173/#/home  --viewport-size=800,600
 
 4. Github Workflow が完了すると、更新されたスクリーンショットがコミットされます。
 
+##### ローカルで更新する場合
+
+ローカル PC の OS に対応したもののみが更新されます。
+
+```bash
+npm run test:browser-e2e -- --update-snapshots
+```
+
 ### Electron End to End テスト
 
 Electron の機能が必要な、エンジン起動・終了などを含めた End to End テストを実行します。