feat: plugin auto-importer with vite-plugin-resolve (#1385)

src/index.ts

@@ -11,6 +11,7 @@ import electronDebug from 'electron-debug';
 import { parse } from 'node-html-parser';
 
 import config from './config';
+
 import { refreshMenu, setApplicationMenu } from './menu';
 import { fileExists, injectCSS, injectCSSAsFile } from './plugins/utils';
 import { isTesting } from './utils/testing';
@@ -19,31 +20,10 @@ import { setupSongInfo } from './providers/song-info';
 import { restart, setupAppControls } from './providers/app-controls';
 import { APP_PROTOCOL, handleProtocol, setupProtocolHandler } from './providers/protocol-handler';
 
-import adblocker from './plugins/adblocker/back';
-import albumColorTheme from './plugins/album-color-theme/back';
-import ambientMode from './plugins/ambient-mode/back';
-import blurNavigationBar from './plugins/blur-nav-bar/back';
-import captionsSelector from './plugins/captions-selector/back';
-import crossfade from './plugins/crossfade/back';
-import discord from './plugins/discord/back';
-import downloader from './plugins/downloader/back';
-import inAppMenu from './plugins/in-app-menu/back';
-import lastFm from './plugins/last-fm/back';
-import lumiaStream from './plugins/lumiastream/back';
-import lyricsGenius from './plugins/lyrics-genius/back';
-import navigation from './plugins/navigation/back';
-import noGoogleLogin from './plugins/no-google-login/back';
-import notifications from './plugins/notifications/back';
-import pictureInPicture, { setOptions as pipSetOptions } from './plugins/picture-in-picture/back';
-import preciseVolume from './plugins/precise-volume/back';
-import qualityChanger from './plugins/quality-changer/back';
-import shortcuts from './plugins/shortcuts/back';
-import sponsorBlock from './plugins/sponsorblock/back';
-import taskbarMediaControl from './plugins/taskbar-mediacontrol/back';
-import touchbar from './plugins/touchbar/back';
-import tunaObs from './plugins/tuna-obs/back';
-import videoToggle from './plugins/video-toggle/back';
-import visualizer from './plugins/visualizer/back';
+// eslint-disable-next-line import/order
+import { pluginList as mainPluginList } from 'virtual:MainPlugins';
+
+import { setOptions as pipSetOptions } from './plugins/picture-in-picture/back';
 
 import youtubeMusicCSS from './youtube-music.css';
 
@@ -103,47 +83,18 @@ function onClosed() {
   mainWindow = null;
 }
 
-const mainPlugins = {
-  'adblocker': adblocker,
-  'album-color-theme': albumColorTheme,
-  'ambient-mode': ambientMode,
-  'blur-nav-bar': blurNavigationBar,
-  'captions-selector': captionsSelector,
-  'crossfade': crossfade,
-  'discord': discord,
-  'downloader': downloader,
-  'in-app-menu': inAppMenu,
-  'last-fm': lastFm,
-  'lumiastream': lumiaStream,
-  'lyrics-genius': lyricsGenius,
-  'navigation': navigation,
-  'no-google-login': noGoogleLogin,
-  'notifications': notifications,
-  'picture-in-picture': pictureInPicture,
-  'precise-volume': preciseVolume,
-  'quality-changer': qualityChanger,
-  'shortcuts': shortcuts,
-  'sponsorblock': sponsorBlock,
-  'taskbar-mediacontrol': undefined as typeof taskbarMediaControl | undefined,
-  'touchbar': undefined as typeof touchbar | undefined,
-  'tuna-obs': tunaObs,
-  'video-toggle': videoToggle,
-  'visualizer': visualizer,
-};
-export const mainPluginNames = Object.keys(mainPlugins);
+export const mainPluginNames = Object.keys(mainPluginList);
 
 if (is.windows()) {
-  mainPlugins['taskbar-mediacontrol'] = taskbarMediaControl;
-  delete mainPlugins['touchbar'];
+  delete mainPluginList['touchbar'];
 } else if (is.macOS()) {
-  mainPlugins['touchbar'] = touchbar;
-  delete mainPlugins['taskbar-mediacontrol'];
+  delete mainPluginList['taskbar-mediacontrol'];
 } else {
-  delete mainPlugins['touchbar'];
-  delete mainPlugins['taskbar-mediacontrol'];
+  delete mainPluginList['touchbar'];
+  delete mainPluginList['taskbar-mediacontrol'];
 }
 
-ipcMain.handle('get-main-plugin-names', () => Object.keys(mainPlugins));
+ipcMain.handle('get-main-plugin-names', () => Object.keys(mainPluginList));
 
 async function loadPlugins(win: BrowserWindow) {
   injectCSS(win.webContents, youtubeMusicCSS);
@@ -172,9 +123,9 @@ async function loadPlugins(win: BrowserWindow) {
 
   for (const [plugin, options] of config.plugins.getEnabled()) {
     try {
-      if (Object.hasOwn(mainPlugins, plugin)) {
+      if (Object.hasOwn(mainPluginList, plugin)) {
         console.log('Loaded plugin - ' + plugin);
-        const handler = mainPlugins[plugin as keyof typeof mainPlugins];
+        const handler = mainPluginList[plugin as keyof typeof mainPluginList];
         if (handler) {
           await handler(win, options as never);
         }
@@ -262,7 +213,6 @@ async function createMainWindow() {
 
   type PiPOptions = typeof config.defaultConfig.plugins['picture-in-picture'];
   const setPiPOptions = config.plugins.isEnabled('picture-in-picture')
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
     ? (key: string, value: unknown) => pipSetOptions({ [key]: value })
     : () => {};
 

src/preload.ts

@@ -3,7 +3,8 @@ import is from 'electron-is';
 
 import config from './config';
 
-import adblockerPreload from './plugins/adblocker/preload';
+// eslint-disable-next-line import/order
+import { pluginList as preloadPluginList } from 'virtual:PreloadPlugins';
 
 import type { ConfigType, OneOfDefaultConfigKey } from './config/dynamic';
 
@@ -15,15 +16,11 @@ export type PluginMapper<Type extends 'renderer' | 'preload' | 'backend'> = {
   )
 };
 
-const preloadPlugins: PluginMapper<'preload'> = {
-  'adblocker': adblockerPreload,
-};
-
 const enabledPluginNameAndOptions = config.plugins.getEnabled();
 
 enabledPluginNameAndOptions.forEach(async ([plugin, options]) => {
-  if (Object.hasOwn(preloadPlugins, plugin)) {
-    const handler = preloadPlugins[plugin];
+  if (Object.hasOwn(preloadPluginList, plugin)) {
+    const handler = preloadPluginList[plugin];
     try {
       await handler?.();
     } catch (error) {

src/renderer.ts

@@ -2,55 +2,8 @@ import setupSongInfo from './providers/song-info-front';
 import { setupSongControls } from './providers/song-controls-front';
 import { startingPages } from './providers/extracted-data';
 
-import albumColorThemeRenderer from './plugins/album-color-theme/front';
-import ambientModeRenderer from './plugins/ambient-mode/front';
-import audioCompressorRenderer from './plugins/audio-compressor/front';
-import bypassAgeRestrictionsRenderer from './plugins/bypass-age-restrictions/front';
-import captionsSelectorRenderer from './plugins/captions-selector/front';
-import compactSidebarRenderer from './plugins/compact-sidebar/front';
-import crossfadeRenderer from './plugins/crossfade/front';
-import disableAutoplayRenderer from './plugins/disable-autoplay/front';
-import downloaderRenderer from './plugins/downloader/front';
-import exponentialVolumeRenderer from './plugins/exponential-volume/front';
-import inAppMenuRenderer from './plugins/in-app-menu/front';
-import lyricsGeniusRenderer from './plugins/lyrics-genius/front';
-import navigationRenderer from './plugins/navigation/front';
-import noGoogleLogin from './plugins/no-google-login/front';
-import pictureInPictureRenderer from './plugins/picture-in-picture/front';
-import playbackSpeedRenderer from './plugins/playback-speed/front';
-import preciseVolumeRenderer from './plugins/precise-volume/front';
-import qualityChangerRenderer from './plugins/quality-changer/front';
-import skipSilencesRenderer from './plugins/skip-silences/front';
-import sponsorblockRenderer from './plugins/sponsorblock/front';
-import videoToggleRenderer from './plugins/video-toggle/front';
-import visualizerRenderer from './plugins/visualizer/front';
-
-import type { PluginMapper } from './preload';
-
-const rendererPlugins: PluginMapper<'renderer'> = {
-  'album-color-theme': albumColorThemeRenderer,
-  'ambient-mode': ambientModeRenderer,
-  'audio-compressor': audioCompressorRenderer,
-  'bypass-age-restrictions': bypassAgeRestrictionsRenderer,
-  'captions-selector': captionsSelectorRenderer,
-  'compact-sidebar': compactSidebarRenderer,
-  'crossfade': crossfadeRenderer,
-  'disable-autoplay': disableAutoplayRenderer,
-  'downloader': downloaderRenderer,
-  'exponential-volume': exponentialVolumeRenderer,
-  'in-app-menu': inAppMenuRenderer,
-  'lyrics-genius': lyricsGeniusRenderer,
-  'navigation': navigationRenderer,
-  'no-google-login': noGoogleLogin,
-  'picture-in-picture': pictureInPictureRenderer,
-  'playback-speed': playbackSpeedRenderer,
-  'precise-volume': preciseVolumeRenderer,
-  'quality-changer': qualityChangerRenderer,
-  'skip-silences': skipSilencesRenderer,
-  'sponsorblock': sponsorblockRenderer,
-  'video-toggle': videoToggleRenderer,
-  'visualizer': visualizerRenderer,
-};
+// eslint-disable-next-line import/order
+import { pluginList as rendererPluginList } from 'virtual:RendererPlugins';
 
 const enabledPluginNameAndOptions = window.mainConfig.plugins.getEnabled();
 
@@ -140,8 +93,8 @@ function onApiLoaded() {
 
 (() => {
   enabledPluginNameAndOptions.forEach(async ([pluginName, options]) => {
-    if (Object.hasOwn(rendererPlugins, pluginName)) {
-      const handler = rendererPlugins[pluginName];
+    if (Object.hasOwn(rendererPluginList, pluginName)) {
+      const handler = rendererPluginList[pluginName];
       try {
         await handler?.(options as never);
       } catch (error) {

src/virtual-module.d.ts

@@ -0,0 +1,16 @@
+declare module 'virtual:MainPlugins' {
+  import type { BrowserWindow } from 'electron';
+  import type { ConfigType } from './config/dynamic';
+
+  export const pluginList: Record<string, (win: BrowserWindow, options: ConfigType) => Promise<void>>;
+}
+
+declare module 'virtual:PreloadPlugins' {
+  export const pluginList: Record<string, () => Promise<void>>;
+}
+
+declare module 'virtual:RendererPlugins' {
+  import type { ConfigType } from './config/dynamic';
+
+  export const pluginList: Record<string, (options: ConfigType) => Promise<void>>;
+}