Electronのmain processで直接動作するコード以外からelectronに関する型を排除する (#1278)

Co-authored-by: Hiroshiba <[email protected]>

.eslintrc.js

@@ -64,5 +64,28 @@ module.exports = {
         "no-console": "off",
       },
     },
+    // Electronのメインプロセス以外でelectronのimportを禁止する
+    {
+      files: ["./src/**/*.ts", "./src/**/*.vue"],
+      excludedFiles: [
+        "./src/background.ts",
+        "./src/background/*.ts",
+        "./src/electron/*.ts",
+      ],
+      rules: {
+        "no-restricted-imports": [
+          "error",
+          {
+            patterns: [
+              {
+                group: ["electron"],
+                message:
+                  "このファイル内でelectronはimportできません。許可されているファイル内へ移すか、ESLintの設定を見直してください",
+              },
+            ],
+          },
+        ],
+      },
+    },
   ],
 };

src/electron/preload.ts

@@ -5,7 +5,12 @@ import {
   IpcRendererEvent,
 } from "electron";
 
-import { Sandbox, ElectronStoreType, EngineId } from "@/type/preload";
+import {
+  Sandbox,
+  ElectronStoreType,
+  EngineId,
+  SandboxKey,
+} from "@/type/preload";
 import { IpcIHData, IpcSOData } from "@/type/ipc";
 
 function ipcRendererInvoke<T extends keyof IpcIHData>(
@@ -286,4 +291,4 @@ const api: Sandbox = {
   },
 };
 
-contextBridge.exposeInMainWorld("electron", api);
+contextBridge.exposeInMainWorld(SandboxKey, api);

src/type/globals.d.ts

@@ -1,8 +1,13 @@
 // Include global variables to build immer source code
 export * from "immer/src/types/globals";
+import { SandboxKey } from "./preload";
 
 declare global {
   interface HTMLAudioElement {
     setSinkId(deviceID: string): Promise<undefined>; // setSinkIdを認識してくれないため
   }
+
+  interface Window {
+    readonly [SandboxKey]: import("./preload").Sandbox;
+  }
 }

src/type/ipc.ts

@@ -11,6 +11,7 @@ import {
   NativeThemeType,
   EngineSetting,
   EngineId,
+  MessageBoxReturnValue,
 } from "@/type/preload";
 
 /**
@@ -110,7 +111,7 @@ export type IpcIHData = {
         message: string;
       }
     ];
-    return: Electron.MessageBoxReturnValue;
+    return: MessageBoxReturnValue;
   };
 
   SHOW_QUESTION_DIALOG: {
@@ -134,7 +135,7 @@ export type IpcIHData = {
         message: string;
       }
     ];
-    return: Electron.MessageBoxReturnValue;
+    return: MessageBoxReturnValue;
   };
 
   SHOW_ERROR_DIALOG: {
@@ -144,7 +145,7 @@ export type IpcIHData = {
         message: string;
       }
     ];
-    return: Electron.MessageBoxReturnValue;
+    return: MessageBoxReturnValue;
   };
 
   OPEN_TEXT_EDIT_CONTEXT_MENU: {

src/type/preload.ts

@@ -1,4 +1,3 @@
-import { IpcRenderer, IpcRendererEvent, nativeTheme } from "electron";
 import { z } from "zod";
 import { IpcSOData } from "./ipc";
 
@@ -187,8 +186,8 @@ export interface Sandbox {
   isMaximizedWindow(): Promise<boolean>;
   onReceivedIPCMsg<T extends keyof IpcSOData>(
     channel: T,
-    listener: (event: IpcRendererEvent, ...args: IpcSOData[T]["args"]) => void
-  ): IpcRenderer;
+    listener: (event: unknown, ...args: IpcSOData[T]["args"]) => void
+  ): void;
   closeWindow(): void;
   minimizeWindow(): void;
   maximizeWindow(): void;
@@ -436,7 +435,8 @@ export type ToolbarButtonTagType = z.infer<typeof toolbarButtonTagSchema>;
 export const toolbarSettingSchema = toolbarButtonTagSchema;
 export type ToolbarSetting = z.infer<typeof toolbarSettingSchema>[];
 
-export type NativeThemeType = typeof nativeTheme["themeSource"];
+// base: typeof electron.nativeTheme["themeSource"];
+export type NativeThemeType = "system" | "light" | "dark";
 
 export type MoraDataType =
   | "consonant"
@@ -619,3 +619,12 @@ export type EngineDirValidationResult =
   | "alreadyExists";
 
 export type VvppFilePathValidationResult = "ok" | "fileNotFound";
+
+// base: Electron.MessageBoxReturnValue
+// FIXME: MessageBoxUIの戻り値として使用したい値が決まったら書き換える
+export interface MessageBoxReturnValue {
+  response: number;
+  checkboxChecked: boolean;
+}
+
+export const SandboxKey = "electron" as const;

src/type/shims-vue.d.ts

@@ -5,7 +5,3 @@ declare module "*.vue" {
 
   export default component;
 }
-
-interface Window {
-  readonly electron: import("./preload").Sandbox;
-}