Merge pull request #1401 from organization/feat/refactor-plugin-system

Author: JellyBrick

.eslintrc.js

@@ -26,7 +26,7 @@ module.exports = {
     'import/newline-after-import': 'error',
     'import/no-default-export': 'off',
     'import/no-duplicates': 'error',
-    'import/no-unresolved': ['error', { ignore: ['^virtual:', '\\?inline$', '\\?raw$', '\\?asset&asarUnpack', '^youtubei.js$'] }],
+    'import/no-unresolved': ['error', { ignore: ['^virtual:', '\\?inline$', '\\?raw$', '\\?asset&asarUnpack'] }],
     'import/order': [
       'error',
       {
@@ -67,4 +67,14 @@ module.exports = {
     es6: true,
   },
   ignorePatterns: ['dist', 'node_modules'],
+  root: true,
+  settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts']
+    },
+    'import/resolver': {
+      typescript: {},
+      exports: {},
+    },
+  },
 };

.gitignore

@@ -12,3 +12,4 @@ electron-builder.yml
 !.yarn/releases
 !.yarn/sdks
 !.yarn/versions
+.vite-inspect

electron.vite.config.ts

@@ -1,18 +1,27 @@
+import { resolve } from 'node:path';
+
 import { defineConfig, defineViteConfig } from 'electron-vite';
 import builtinModules from 'builtin-modules';
 import viteResolve from 'vite-plugin-resolve';
+import Inspect from 'vite-plugin-inspect';
 
-import { pluginVirtualModuleGenerator } from './vite-plugins/plugin-virtual-module-generator';
+import { pluginVirtualModuleGenerator } from './vite-plugins/plugin-importer';
+import pluginLoader from './vite-plugins/plugin-loader';
 
 import type { UserConfig } from 'vite';
 
+const resolveAlias = {
+  '@': resolve(__dirname, './src'),
+  '@assets': resolve(__dirname, './assets'),
+};
+
 export default defineConfig({
   main: defineViteConfig(({ mode }) => {
     const commonConfig: UserConfig = {
       plugins: [
+        pluginLoader('backend'),
         viteResolve({
-          'virtual:MainPlugins': pluginVirtualModuleGenerator('main'),
-          'virtual:MenuPlugins': pluginVirtualModuleGenerator('menu'),
+          'virtual:plugins': pluginVirtualModuleGenerator('main'),
         }),
       ],
       publicDir: 'assets',
@@ -30,9 +39,15 @@ export default defineConfig({
           input: './src/index.ts',
         },
       },
+      resolve: {
+        alias: resolveAlias,
+      },
     };
 
     if (mode === 'development') {
+      commonConfig.plugins?.push(
+        Inspect({ build: true, outputDir: '.vite-inspect/backend' }),
+      );
       return commonConfig;
     }
 
@@ -48,8 +63,9 @@ export default defineConfig({
   preload: defineViteConfig(({ mode }) => {
     const commonConfig: UserConfig = {
       plugins: [
+        pluginLoader('preload'),
         viteResolve({
-          'virtual:PreloadPlugins': pluginVirtualModuleGenerator('preload'),
+          'virtual:plugins': pluginVirtualModuleGenerator('preload'),
         }),
       ],
       build: {
@@ -64,11 +80,17 @@ export default defineConfig({
         rollupOptions: {
           external: ['electron', 'custom-electron-prompt', ...builtinModules],
           input: './src/preload.ts',
-        }
+        },
+      },
+      resolve: {
+        alias: resolveAlias,
       },
     };
 
     if (mode === 'development') {
+      commonConfig.plugins?.push(
+        Inspect({ build: true, outputDir: '.vite-inspect/preload' }),
+      );
       return commonConfig;
     }
 
@@ -84,8 +106,9 @@ export default defineConfig({
   renderer: defineViteConfig(({ mode }) => {
     const commonConfig: UserConfig = {
       plugins: [
+        pluginLoader('renderer'),
         viteResolve({
-          'virtual:RendererPlugins': pluginVirtualModuleGenerator('renderer'),
+          'virtual:plugins': pluginVirtualModuleGenerator('renderer'),
         }),
       ],
       root: './src/',
@@ -104,9 +127,15 @@ export default defineConfig({
           input: './src/index.html',
         },
       },
+      resolve: {
+        alias: resolveAlias,
+      },
     };
 
     if (mode === 'development') {
+      commonConfig.plugins?.push(
+        Inspect({ build: true, outputDir: '.vite-inspect/renderer' }),
+      );
       return commonConfig;
     }
 

package.json

@@ -94,11 +94,12 @@
     "test": "playwright test",
     "test:debug": "cross-env DEBUG=pw:*,-pw:test:protocol playwright test",
     "build": "electron-vite build",
+    "vite:inspect": "pnpm clean && electron-vite build --mode development && pnpm exec serve .vite-inspect",
     "start": "electron-vite preview",
     "start:debug": "cross-env ELECTRON_ENABLE_LOGGING=1 pnpm start",
     "dev": "electron-vite dev",
     "dev:debug": "cross-env ELECTRON_ENABLE_LOGGING=1 pnpm dev",
-    "clean": "del-cli dist && del-cli pack",
+    "clean": "del-cli dist && del-cli pack && del-cli .vite-inspect",
     "dist": "pnpm clean && pnpm build && electron-builder --win --mac --linux -p never",
     "dist:linux": "pnpm clean && pnpm build && electron-builder --linux -p never",
     "dist:mac": "pnpm clean && pnpm build && electron-builder --mac dmg:x64 -p never",
@@ -117,7 +118,7 @@
   },
   "pnpm": {
     "overrides": {
-      "rollup": "4.4.1",
+      "rollup": "4.6.0",
       "node-gyp": "10.0.1",
       "xml2js": "0.6.2",
       "node-fetch": "3.3.2",
@@ -128,7 +129,8 @@
   "dependencies": {
     "@cliqz/adblocker-electron": "1.26.12",
     "@cliqz/adblocker-electron-preload": "1.26.12",
-    "@fastify/deepmerge": "1.3.0",
+    "@electron-toolkit/tsconfig": "1.0.1",
+    "@electron/remote": "2.1.0",
     "@ffmpeg.wasm/core-mt": "0.12.0",
     "@ffmpeg.wasm/main": "0.12.0",
     "@foobar404/wave": "2.0.4",
@@ -138,35 +140,39 @@
     "async-mutex": "0.4.0",
     "butterchurn": "3.0.0-beta.4",
     "butterchurn-presets": "3.0.0-beta.4",
-    "conf": "12.0.0",
+    "conf": "10.2.0",
     "custom-electron-prompt": "1.5.7",
     "dbus-next": "0.10.2",
+    "deepmerge-ts": "5.1.0",
     "electron-debug": "3.2.0",
     "electron-is": "3.0.0",
     "electron-localshortcut": "3.2.1",
     "electron-store": "8.1.0",
     "electron-unhandled": "4.0.1",
     "electron-updater": "6.1.7",
     "fast-average-color": "9.4.0",
+    "fast-equals": "^5.0.1",
     "filenamify": "6.0.0",
     "howler": "2.2.4",
     "html-to-text": "9.0.5",
     "keyboardevent-from-electron-accelerator": "2.0.0",
     "keyboardevents-areequal": "0.2.2",
     "node-html-parser": "6.1.11",
     "node-id3": "0.2.6",
+    "serve": "^14.2.1",
     "simple-youtube-age-restriction-bypass": "git+https://github.com/organization/Simple-YouTube-Age-Restriction-Bypass.git#v2.5.8",
+    "ts-morph": "^20.0.0",
     "vudio": "2.1.1",
     "x11": "2.3.0",
     "youtubei.js": "7.0.0"
   },
   "devDependencies": {
-    "@playwright/test": "1.40.0",
+    "@playwright/test": "1.40.1",
     "@total-typescript/ts-reset": "0.5.1",
     "@types/electron-localshortcut": "3.1.3",
     "@types/howler": "2.2.11",
     "@types/html-to-text": "9.0.4",
-    "@typescript-eslint/eslint-plugin": "6.12.0",
+    "@typescript-eslint/eslint-plugin": "6.13.0",
     "bufferutil": "4.0.8",
     "builtin-modules": "^3.3.0",
     "cross-env": "7.0.3",
@@ -176,15 +182,18 @@
     "electron-devtools-installer": "3.2.0",
     "electron-vite": "1.0.29",
     "eslint": "8.54.0",
+    "eslint-import-resolver-exports": "1.0.0-beta.5",
+    "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-import": "2.29.0",
     "eslint-plugin-prettier": "5.0.1",
     "glob": "10.3.10",
     "node-gyp": "10.0.1",
-    "playwright": "1.40.0",
+    "playwright": "1.40.1",
     "rollup": "4.6.0",
     "typescript": "5.3.2",
     "utf-8-validate": "6.0.3",
     "vite": "4.5.0",
+    "vite-plugin-inspect": "^0.7.42",
     "vite-plugin-resolve": "2.5.1",
     "ws": "8.14.2"
   },