From 06dc0e80f0611e47f780caa4869dd4d84b577ca4 Mon Sep 17 00:00:00 2001 From: JellyBrick Date: Thu, 9 Nov 2023 11:35:43 +0900 Subject: [PATCH] feat: rename plugins to clarify context (#1392) --- electron.vite.config.ts | 4 ++-- readme.md | 8 ++++---- src/index.ts | 20 +++++++++---------- src/menu.ts | 2 +- src/plugins/adblocker/{back.ts => main.ts} | 0 .../album-color-theme/{back.ts => main.ts} | 0 .../{front.ts => renderer.ts} | 0 src/plugins/ambient-mode/{back.ts => main.ts} | 0 .../ambient-mode/{front.ts => renderer.ts} | 0 .../{front.ts => renderer.ts} | 0 src/plugins/blur-nav-bar/{back.ts => main.ts} | 0 .../{front.ts => renderer.ts} | 0 .../captions-selector/{back.ts => main.ts} | 0 .../{front.ts => renderer.ts} | 0 .../compact-sidebar/{front.ts => renderer.ts} | 0 src/plugins/crossfade/{back.ts => main.ts} | 0 .../crossfade/{front.ts => renderer.ts} | 0 .../{front.ts => renderer.ts} | 0 src/plugins/discord/{back.ts => main.ts} | 0 src/plugins/discord/menu.ts | 2 +- src/plugins/downloader/{back.ts => main.ts} | 2 +- src/plugins/downloader/menu.ts | 2 +- .../downloader/{front.ts => renderer.ts} | 0 .../{front.ts => renderer.ts} | 0 src/plugins/in-app-menu/{back.ts => main.ts} | 0 .../in-app-menu/{front.ts => renderer.ts} | 0 src/plugins/last-fm/{back.ts => main.ts} | 0 src/plugins/lumiastream/{back.ts => main.ts} | 0 .../lyrics-genius/{back.ts => main.ts} | 0 src/plugins/lyrics-genius/menu.ts | 2 +- .../lyrics-genius/{front.ts => renderer.ts} | 0 src/plugins/navigation/{back.ts => main.ts} | 0 .../no-google-login/{back.ts => main.ts} | 0 .../notifications/{back.ts => main.ts} | 0 .../picture-in-picture/{back.ts => main.ts} | 0 src/plugins/picture-in-picture/menu.ts | 2 +- .../{front.ts => renderer.ts} | 0 .../playback-speed/{front.ts => renderer.ts} | 0 .../precise-volume/{back.ts => main.ts} | 0 src/plugins/precise-volume/menu.ts | 2 +- .../precise-volume/{front.ts => renderer.ts} | 0 .../quality-changer/{back.ts => main.ts} | 0 .../quality-changer/{front.ts => renderer.ts} | 0 src/plugins/shortcuts/{back.ts => main.ts} | 0 .../skip-silences/{front.ts => renderer.ts} | 0 src/plugins/sponsorblock/{back.ts => main.ts} | 0 .../sponsorblock/{front.ts => renderer.ts} | 0 .../taskbar-mediacontrol/{back.ts => main.ts} | 0 src/plugins/touchbar/{back.ts => main.ts} | 0 src/plugins/tuna-obs/{back.ts => main.ts} | 0 src/plugins/video-toggle/{back.ts => main.ts} | 0 .../video-toggle/{front.ts => renderer.ts} | 2 +- src/plugins/visualizer/{back.ts => main.ts} | 0 .../visualizer/{front.ts => renderer.ts} | 0 src/preload.ts | 6 +++--- src/renderer.ts | 6 +++--- src/virtual-module.d.ts | 8 ++++---- .../plugin-virtual-module-generator.ts | 4 ++-- 58 files changed, 36 insertions(+), 36 deletions(-) rename src/plugins/adblocker/{back.ts => main.ts} (100%) rename src/plugins/album-color-theme/{back.ts => main.ts} (100%) rename src/plugins/album-color-theme/{front.ts => renderer.ts} (100%) rename src/plugins/ambient-mode/{back.ts => main.ts} (100%) rename src/plugins/ambient-mode/{front.ts => renderer.ts} (100%) rename src/plugins/audio-compressor/{front.ts => renderer.ts} (100%) rename src/plugins/blur-nav-bar/{back.ts => main.ts} (100%) rename src/plugins/bypass-age-restrictions/{front.ts => renderer.ts} (100%) rename src/plugins/captions-selector/{back.ts => main.ts} (100%) rename src/plugins/captions-selector/{front.ts => renderer.ts} (100%) rename src/plugins/compact-sidebar/{front.ts => renderer.ts} (100%) rename src/plugins/crossfade/{back.ts => main.ts} (100%) rename src/plugins/crossfade/{front.ts => renderer.ts} (100%) rename src/plugins/disable-autoplay/{front.ts => renderer.ts} (100%) rename src/plugins/discord/{back.ts => main.ts} (100%) rename src/plugins/downloader/{back.ts => main.ts} (99%) rename src/plugins/downloader/{front.ts => renderer.ts} (100%) rename src/plugins/exponential-volume/{front.ts => renderer.ts} (100%) rename src/plugins/in-app-menu/{back.ts => main.ts} (100%) rename src/plugins/in-app-menu/{front.ts => renderer.ts} (100%) rename src/plugins/last-fm/{back.ts => main.ts} (100%) rename src/plugins/lumiastream/{back.ts => main.ts} (100%) rename src/plugins/lyrics-genius/{back.ts => main.ts} (100%) rename src/plugins/lyrics-genius/{front.ts => renderer.ts} (100%) rename src/plugins/navigation/{back.ts => main.ts} (100%) rename src/plugins/no-google-login/{back.ts => main.ts} (100%) rename src/plugins/notifications/{back.ts => main.ts} (100%) rename src/plugins/picture-in-picture/{back.ts => main.ts} (100%) rename src/plugins/picture-in-picture/{front.ts => renderer.ts} (100%) rename src/plugins/playback-speed/{front.ts => renderer.ts} (100%) rename src/plugins/precise-volume/{back.ts => main.ts} (100%) rename src/plugins/precise-volume/{front.ts => renderer.ts} (100%) rename src/plugins/quality-changer/{back.ts => main.ts} (100%) rename src/plugins/quality-changer/{front.ts => renderer.ts} (100%) rename src/plugins/shortcuts/{back.ts => main.ts} (100%) rename src/plugins/skip-silences/{front.ts => renderer.ts} (100%) rename src/plugins/sponsorblock/{back.ts => main.ts} (100%) rename src/plugins/sponsorblock/{front.ts => renderer.ts} (100%) rename src/plugins/taskbar-mediacontrol/{back.ts => main.ts} (100%) rename src/plugins/touchbar/{back.ts => main.ts} (100%) rename src/plugins/tuna-obs/{back.ts => main.ts} (100%) rename src/plugins/video-toggle/{back.ts => main.ts} (100%) rename src/plugins/video-toggle/{front.ts => renderer.ts} (99%) rename src/plugins/visualizer/{back.ts => main.ts} (100%) rename src/plugins/visualizer/{front.ts => renderer.ts} (100%) diff --git a/electron.vite.config.ts b/electron.vite.config.ts index 40b14c58..d939b08f 100644 --- a/electron.vite.config.ts +++ b/electron.vite.config.ts @@ -11,7 +11,7 @@ export default defineConfig({ const commonConfig: UserConfig = { plugins: [ viteResolve({ - 'virtual:MainPlugins': pluginVirtualModuleGenerator('back'), + 'virtual:MainPlugins': pluginVirtualModuleGenerator('main'), 'virtual:MenuPlugins': pluginVirtualModuleGenerator('menu'), }), ], @@ -85,7 +85,7 @@ export default defineConfig({ const commonConfig: UserConfig = { plugins: [ viteResolve({ - 'virtual:RendererPlugins': pluginVirtualModuleGenerator('front'), + 'virtual:RendererPlugins': pluginVirtualModuleGenerator('renderer'), }), ], root: './src/', diff --git a/readme.md b/readme.md index f5ceb48c..85b4acbd 100644 --- a/readme.md +++ b/readme.md @@ -207,7 +207,7 @@ Create a folder in `plugins/YOUR-PLUGIN-NAME`: - if you need to manipulate the BrowserWindow, create a file with the following template: ```typescript -// file: back.ts +// file: main.ts export default (win: Electron.BrowserWindow, config: ConfigType<'YOUR-PLUGIN-NAME'>) => { // something }; @@ -229,7 +229,7 @@ const mainPlugins = { - if you need to change the front, create a file with the following template: ```typescript -// file: front.ts +// file: renderer.ts export default (config: ConfigType<'YOUR-PLUGIN-NAME'>) => { // This function will be called as a preload script // So you can use front features like `document.querySelector` @@ -269,7 +269,7 @@ export default { import path from 'node:path'; import style from './style.css'; -// back.ts +// main.ts export default (win: Electron.BrowserWindow) => { injectCSS(win.webContents, style); }; @@ -278,7 +278,7 @@ export default (win: Electron.BrowserWindow) => { - changing the HTML: ```typescript -// front.ts +// renderer.ts export default () => { // Remove the login button document.querySelector(".sign-in-link.ytmusic-nav-bar").remove(); diff --git a/src/index.ts b/src/index.ts index 95174336..1d2db004 100644 --- a/src/index.ts +++ b/src/index.ts @@ -21,9 +21,9 @@ import { restart, setupAppControls } from './providers/app-controls'; import { APP_PROTOCOL, handleProtocol, setupProtocolHandler } from './providers/protocol-handler'; // eslint-disable-next-line import/order -import { pluginList as mainPluginList } from 'virtual:MainPlugins'; +import { mainPlugins } from 'virtual:MainPlugins'; -import { setOptions as pipSetOptions } from './plugins/picture-in-picture/back'; +import { setOptions as pipSetOptions } from './plugins/picture-in-picture/main'; import youtubeMusicCSS from './youtube-music.css'; @@ -83,18 +83,18 @@ function onClosed() { mainWindow = null; } -export const mainPluginNames = Object.keys(mainPluginList); +export const mainPluginNames = Object.keys(mainPlugins); if (is.windows()) { - delete mainPluginList['touchbar']; + delete mainPlugins['touchbar']; } else if (is.macOS()) { - delete mainPluginList['taskbar-mediacontrol']; + delete mainPlugins['taskbar-mediacontrol']; } else { - delete mainPluginList['touchbar']; - delete mainPluginList['taskbar-mediacontrol']; + delete mainPlugins['touchbar']; + delete mainPlugins['taskbar-mediacontrol']; } -ipcMain.handle('get-main-plugin-names', () => Object.keys(mainPluginList)); +ipcMain.handle('get-main-plugin-names', () => Object.keys(mainPlugins)); async function loadPlugins(win: BrowserWindow) { injectCSS(win.webContents, youtubeMusicCSS); @@ -123,9 +123,9 @@ async function loadPlugins(win: BrowserWindow) { for (const [plugin, options] of config.plugins.getEnabled()) { try { - if (Object.hasOwn(mainPluginList, plugin)) { + if (Object.hasOwn(mainPlugins, plugin)) { console.log('Loaded plugin - ' + plugin); - const handler = mainPluginList[plugin as keyof typeof mainPluginList]; + const handler = mainPlugins[plugin as keyof typeof mainPlugins]; if (handler) { await handler(win, options as never); } diff --git a/src/menu.ts b/src/menu.ts index 51f733d2..f302c12d 100644 --- a/src/menu.ts +++ b/src/menu.ts @@ -8,7 +8,7 @@ import { startingPages } from './providers/extracted-data'; import promptOptions from './providers/prompt-options'; // eslint-disable-next-line import/order -import { pluginList as menuList } from 'virtual:MenuPlugins'; +import { menuPlugins as menuList } from 'virtual:MenuPlugins'; import { getAvailablePluginNames } from './plugins/utils/main'; diff --git a/src/plugins/adblocker/back.ts b/src/plugins/adblocker/main.ts similarity index 100% rename from src/plugins/adblocker/back.ts rename to src/plugins/adblocker/main.ts diff --git a/src/plugins/album-color-theme/back.ts b/src/plugins/album-color-theme/main.ts similarity index 100% rename from src/plugins/album-color-theme/back.ts rename to src/plugins/album-color-theme/main.ts diff --git a/src/plugins/album-color-theme/front.ts b/src/plugins/album-color-theme/renderer.ts similarity index 100% rename from src/plugins/album-color-theme/front.ts rename to src/plugins/album-color-theme/renderer.ts diff --git a/src/plugins/ambient-mode/back.ts b/src/plugins/ambient-mode/main.ts similarity index 100% rename from src/plugins/ambient-mode/back.ts rename to src/plugins/ambient-mode/main.ts diff --git a/src/plugins/ambient-mode/front.ts b/src/plugins/ambient-mode/renderer.ts similarity index 100% rename from src/plugins/ambient-mode/front.ts rename to src/plugins/ambient-mode/renderer.ts diff --git a/src/plugins/audio-compressor/front.ts b/src/plugins/audio-compressor/renderer.ts similarity index 100% rename from src/plugins/audio-compressor/front.ts rename to src/plugins/audio-compressor/renderer.ts diff --git a/src/plugins/blur-nav-bar/back.ts b/src/plugins/blur-nav-bar/main.ts similarity index 100% rename from src/plugins/blur-nav-bar/back.ts rename to src/plugins/blur-nav-bar/main.ts diff --git a/src/plugins/bypass-age-restrictions/front.ts b/src/plugins/bypass-age-restrictions/renderer.ts similarity index 100% rename from src/plugins/bypass-age-restrictions/front.ts rename to src/plugins/bypass-age-restrictions/renderer.ts diff --git a/src/plugins/captions-selector/back.ts b/src/plugins/captions-selector/main.ts similarity index 100% rename from src/plugins/captions-selector/back.ts rename to src/plugins/captions-selector/main.ts diff --git a/src/plugins/captions-selector/front.ts b/src/plugins/captions-selector/renderer.ts similarity index 100% rename from src/plugins/captions-selector/front.ts rename to src/plugins/captions-selector/renderer.ts diff --git a/src/plugins/compact-sidebar/front.ts b/src/plugins/compact-sidebar/renderer.ts similarity index 100% rename from src/plugins/compact-sidebar/front.ts rename to src/plugins/compact-sidebar/renderer.ts diff --git a/src/plugins/crossfade/back.ts b/src/plugins/crossfade/main.ts similarity index 100% rename from src/plugins/crossfade/back.ts rename to src/plugins/crossfade/main.ts diff --git a/src/plugins/crossfade/front.ts b/src/plugins/crossfade/renderer.ts similarity index 100% rename from src/plugins/crossfade/front.ts rename to src/plugins/crossfade/renderer.ts diff --git a/src/plugins/disable-autoplay/front.ts b/src/plugins/disable-autoplay/renderer.ts similarity index 100% rename from src/plugins/disable-autoplay/front.ts rename to src/plugins/disable-autoplay/renderer.ts diff --git a/src/plugins/discord/back.ts b/src/plugins/discord/main.ts similarity index 100% rename from src/plugins/discord/back.ts rename to src/plugins/discord/main.ts diff --git a/src/plugins/discord/menu.ts b/src/plugins/discord/menu.ts index 8efbe83f..def34b2f 100644 --- a/src/plugins/discord/menu.ts +++ b/src/plugins/discord/menu.ts @@ -1,6 +1,6 @@ import prompt from 'custom-electron-prompt'; -import { clear, connect, isConnected, registerRefresh } from './back'; +import { clear, connect, isConnected, registerRefresh } from './main'; import { setMenuOptions } from '../../config/plugins'; import promptOptions from '../../providers/prompt-options'; diff --git a/src/plugins/downloader/back.ts b/src/plugins/downloader/main.ts similarity index 99% rename from src/plugins/downloader/back.ts rename to src/plugins/downloader/main.ts index bcd6fb05..815262b6 100644 --- a/src/plugins/downloader/back.ts +++ b/src/plugins/downloader/main.ts @@ -32,7 +32,7 @@ import { YoutubeFormatList, type Preset, DefaultPresetList } from './types'; import style from './style.css'; -import { fetchFromGenius } from '../lyrics-genius/back'; +import { fetchFromGenius } from '../lyrics-genius/main'; import { isEnabled } from '../../config/plugins'; import { cleanupName, getImage, SongInfo } from '../../providers/song-info'; import { injectCSS } from '../utils/main'; diff --git a/src/plugins/downloader/menu.ts b/src/plugins/downloader/menu.ts index d96ded15..199612a4 100644 --- a/src/plugins/downloader/menu.ts +++ b/src/plugins/downloader/menu.ts @@ -1,6 +1,6 @@ import { dialog } from 'electron'; -import { downloadPlaylist } from './back'; +import { downloadPlaylist } from './main'; import { defaultMenuDownloadLabel, getFolder } from './utils'; import { DefaultPresetList } from './types'; import config from './config'; diff --git a/src/plugins/downloader/front.ts b/src/plugins/downloader/renderer.ts similarity index 100% rename from src/plugins/downloader/front.ts rename to src/plugins/downloader/renderer.ts diff --git a/src/plugins/exponential-volume/front.ts b/src/plugins/exponential-volume/renderer.ts similarity index 100% rename from src/plugins/exponential-volume/front.ts rename to src/plugins/exponential-volume/renderer.ts diff --git a/src/plugins/in-app-menu/back.ts b/src/plugins/in-app-menu/main.ts similarity index 100% rename from src/plugins/in-app-menu/back.ts rename to src/plugins/in-app-menu/main.ts diff --git a/src/plugins/in-app-menu/front.ts b/src/plugins/in-app-menu/renderer.ts similarity index 100% rename from src/plugins/in-app-menu/front.ts rename to src/plugins/in-app-menu/renderer.ts diff --git a/src/plugins/last-fm/back.ts b/src/plugins/last-fm/main.ts similarity index 100% rename from src/plugins/last-fm/back.ts rename to src/plugins/last-fm/main.ts diff --git a/src/plugins/lumiastream/back.ts b/src/plugins/lumiastream/main.ts similarity index 100% rename from src/plugins/lumiastream/back.ts rename to src/plugins/lumiastream/main.ts diff --git a/src/plugins/lyrics-genius/back.ts b/src/plugins/lyrics-genius/main.ts similarity index 100% rename from src/plugins/lyrics-genius/back.ts rename to src/plugins/lyrics-genius/main.ts diff --git a/src/plugins/lyrics-genius/menu.ts b/src/plugins/lyrics-genius/menu.ts index 09664f38..d96e686d 100644 --- a/src/plugins/lyrics-genius/menu.ts +++ b/src/plugins/lyrics-genius/menu.ts @@ -1,6 +1,6 @@ import { BrowserWindow, MenuItem } from 'electron'; -import { LyricGeniusType, toggleRomanized } from './back'; +import { LyricGeniusType, toggleRomanized } from './main'; import { setOptions } from '../../config/plugins'; import { MenuTemplate } from '../../menu'; diff --git a/src/plugins/lyrics-genius/front.ts b/src/plugins/lyrics-genius/renderer.ts similarity index 100% rename from src/plugins/lyrics-genius/front.ts rename to src/plugins/lyrics-genius/renderer.ts diff --git a/src/plugins/navigation/back.ts b/src/plugins/navigation/main.ts similarity index 100% rename from src/plugins/navigation/back.ts rename to src/plugins/navigation/main.ts diff --git a/src/plugins/no-google-login/back.ts b/src/plugins/no-google-login/main.ts similarity index 100% rename from src/plugins/no-google-login/back.ts rename to src/plugins/no-google-login/main.ts diff --git a/src/plugins/notifications/back.ts b/src/plugins/notifications/main.ts similarity index 100% rename from src/plugins/notifications/back.ts rename to src/plugins/notifications/main.ts diff --git a/src/plugins/picture-in-picture/back.ts b/src/plugins/picture-in-picture/main.ts similarity index 100% rename from src/plugins/picture-in-picture/back.ts rename to src/plugins/picture-in-picture/main.ts diff --git a/src/plugins/picture-in-picture/menu.ts b/src/plugins/picture-in-picture/menu.ts index e8f877d6..f62a9763 100644 --- a/src/plugins/picture-in-picture/menu.ts +++ b/src/plugins/picture-in-picture/menu.ts @@ -2,7 +2,7 @@ import prompt from 'custom-electron-prompt'; import { BrowserWindow } from 'electron'; -import { setOptions } from './back'; +import { setOptions } from './main'; import promptOptions from '../../providers/prompt-options'; diff --git a/src/plugins/picture-in-picture/front.ts b/src/plugins/picture-in-picture/renderer.ts similarity index 100% rename from src/plugins/picture-in-picture/front.ts rename to src/plugins/picture-in-picture/renderer.ts diff --git a/src/plugins/playback-speed/front.ts b/src/plugins/playback-speed/renderer.ts similarity index 100% rename from src/plugins/playback-speed/front.ts rename to src/plugins/playback-speed/renderer.ts diff --git a/src/plugins/precise-volume/back.ts b/src/plugins/precise-volume/main.ts similarity index 100% rename from src/plugins/precise-volume/back.ts rename to src/plugins/precise-volume/main.ts diff --git a/src/plugins/precise-volume/menu.ts b/src/plugins/precise-volume/menu.ts index 708b27cb..fb0ec9c0 100644 --- a/src/plugins/precise-volume/menu.ts +++ b/src/plugins/precise-volume/menu.ts @@ -2,7 +2,7 @@ import prompt, { KeybindOptions } from 'custom-electron-prompt'; import { BrowserWindow, MenuItem } from 'electron'; -import { enabled } from './back'; +import { enabled } from './main'; import { setMenuOptions } from '../../config/plugins'; import promptOptions from '../../providers/prompt-options'; diff --git a/src/plugins/precise-volume/front.ts b/src/plugins/precise-volume/renderer.ts similarity index 100% rename from src/plugins/precise-volume/front.ts rename to src/plugins/precise-volume/renderer.ts diff --git a/src/plugins/quality-changer/back.ts b/src/plugins/quality-changer/main.ts similarity index 100% rename from src/plugins/quality-changer/back.ts rename to src/plugins/quality-changer/main.ts diff --git a/src/plugins/quality-changer/front.ts b/src/plugins/quality-changer/renderer.ts similarity index 100% rename from src/plugins/quality-changer/front.ts rename to src/plugins/quality-changer/renderer.ts diff --git a/src/plugins/shortcuts/back.ts b/src/plugins/shortcuts/main.ts similarity index 100% rename from src/plugins/shortcuts/back.ts rename to src/plugins/shortcuts/main.ts diff --git a/src/plugins/skip-silences/front.ts b/src/plugins/skip-silences/renderer.ts similarity index 100% rename from src/plugins/skip-silences/front.ts rename to src/plugins/skip-silences/renderer.ts diff --git a/src/plugins/sponsorblock/back.ts b/src/plugins/sponsorblock/main.ts similarity index 100% rename from src/plugins/sponsorblock/back.ts rename to src/plugins/sponsorblock/main.ts diff --git a/src/plugins/sponsorblock/front.ts b/src/plugins/sponsorblock/renderer.ts similarity index 100% rename from src/plugins/sponsorblock/front.ts rename to src/plugins/sponsorblock/renderer.ts diff --git a/src/plugins/taskbar-mediacontrol/back.ts b/src/plugins/taskbar-mediacontrol/main.ts similarity index 100% rename from src/plugins/taskbar-mediacontrol/back.ts rename to src/plugins/taskbar-mediacontrol/main.ts diff --git a/src/plugins/touchbar/back.ts b/src/plugins/touchbar/main.ts similarity index 100% rename from src/plugins/touchbar/back.ts rename to src/plugins/touchbar/main.ts diff --git a/src/plugins/tuna-obs/back.ts b/src/plugins/tuna-obs/main.ts similarity index 100% rename from src/plugins/tuna-obs/back.ts rename to src/plugins/tuna-obs/main.ts diff --git a/src/plugins/video-toggle/back.ts b/src/plugins/video-toggle/main.ts similarity index 100% rename from src/plugins/video-toggle/back.ts rename to src/plugins/video-toggle/main.ts diff --git a/src/plugins/video-toggle/front.ts b/src/plugins/video-toggle/renderer.ts similarity index 99% rename from src/plugins/video-toggle/front.ts rename to src/plugins/video-toggle/renderer.ts index 7ddfb3c4..c64be509 100644 --- a/src/plugins/video-toggle/front.ts +++ b/src/plugins/video-toggle/renderer.ts @@ -2,7 +2,7 @@ import buttonTemplate from './templates/button_template.html?raw'; import { ElementFromHtml } from '../utils/renderer'; -import { moveVolumeHud as preciseVolumeMoveVolumeHud } from '../precise-volume/front'; +import { moveVolumeHud as preciseVolumeMoveVolumeHud } from '../precise-volume/renderer'; import { YoutubePlayer } from '../../types/youtube-player'; import { ThumbnailElement } from '../../types/get-player-response'; diff --git a/src/plugins/visualizer/back.ts b/src/plugins/visualizer/main.ts similarity index 100% rename from src/plugins/visualizer/back.ts rename to src/plugins/visualizer/main.ts diff --git a/src/plugins/visualizer/front.ts b/src/plugins/visualizer/renderer.ts similarity index 100% rename from src/plugins/visualizer/front.ts rename to src/plugins/visualizer/renderer.ts diff --git a/src/preload.ts b/src/preload.ts index 73047713..dd9e6826 100644 --- a/src/preload.ts +++ b/src/preload.ts @@ -4,7 +4,7 @@ import is from 'electron-is'; import config from './config'; // eslint-disable-next-line import/order -import { pluginList as preloadPluginList } from 'virtual:PreloadPlugins'; +import { preloadPlugins } from 'virtual:PreloadPlugins'; import type { ConfigType, OneOfDefaultConfigKey } from './config/dynamic'; @@ -19,8 +19,8 @@ export type PluginMapper = { const enabledPluginNameAndOptions = config.plugins.getEnabled(); enabledPluginNameAndOptions.forEach(async ([plugin, options]) => { - if (Object.hasOwn(preloadPluginList, plugin)) { - const handler = preloadPluginList[plugin]; + if (Object.hasOwn(preloadPlugins, plugin)) { + const handler = preloadPlugins[plugin]; try { await handler?.(options); } catch (error) { diff --git a/src/renderer.ts b/src/renderer.ts index cd4bb8ac..4397899f 100644 --- a/src/renderer.ts +++ b/src/renderer.ts @@ -3,7 +3,7 @@ import { setupSongControls } from './providers/song-controls-front'; import { startingPages } from './providers/extracted-data'; // eslint-disable-next-line import/order -import { pluginList as rendererPluginList } from 'virtual:RendererPlugins'; +import { rendererPlugins } from 'virtual:RendererPlugins'; const enabledPluginNameAndOptions = window.mainConfig.plugins.getEnabled(); @@ -93,8 +93,8 @@ function onApiLoaded() { (() => { enabledPluginNameAndOptions.forEach(async ([pluginName, options]) => { - if (Object.hasOwn(rendererPluginList, pluginName)) { - const handler = rendererPluginList[pluginName]; + if (Object.hasOwn(rendererPlugins, pluginName)) { + const handler = rendererPlugins[pluginName]; try { await handler?.(options as never); } catch (error) { diff --git a/src/virtual-module.d.ts b/src/virtual-module.d.ts index 77d4ef6d..56daf491 100644 --- a/src/virtual-module.d.ts +++ b/src/virtual-module.d.ts @@ -2,7 +2,7 @@ declare module 'virtual:MainPlugins' { import type { BrowserWindow } from 'electron'; import type { ConfigType } from './config/dynamic'; - export const pluginList: Record Promise>; + export const mainPlugins: Record Promise>; } declare module 'virtual:MenuPlugins' { @@ -10,17 +10,17 @@ declare module 'virtual:MenuPlugins' { import type { MenuTemplate } from './menu'; import type { ConfigType } from './config/dynamic'; - export const pluginList: Record void) => MenuTemplate>; + export const menuPlugins: Record void) => MenuTemplate>; } declare module 'virtual:PreloadPlugins' { import type { ConfigType } from './config/dynamic'; - export const pluginList: Record Promise>; + export const preloadPlugins: Record Promise>; } declare module 'virtual:RendererPlugins' { import type { ConfigType } from './config/dynamic'; - export const pluginList: Record Promise>; + export const rendererPlugins: Record Promise>; } diff --git a/vite-plugins/plugin-virtual-module-generator.ts b/vite-plugins/plugin-virtual-module-generator.ts index 4ebdb6b7..4355bff2 100644 --- a/vite-plugins/plugin-virtual-module-generator.ts +++ b/vite-plugins/plugin-virtual-module-generator.ts @@ -5,7 +5,7 @@ import { globSync } from 'glob'; const snakeToCamel = (text: string) => text.replace(/-(\w)/g, (_, letter: string) => letter.toUpperCase()); -export const pluginVirtualModuleGenerator = (mode: 'back' | 'preload' | 'front' | 'menu') => { +export const pluginVirtualModuleGenerator = (mode: 'main' | 'preload' | 'renderer' | 'menu') => { const srcPath = resolve(__dirname, '..', 'src'); const plugins = globSync(`${srcPath}/plugins/*`) @@ -18,7 +18,7 @@ export const pluginVirtualModuleGenerator = (mode: 'back' | 'preload' | 'front' result += `import ${snakeToCamel(name)}Plugin from "./${relative(resolve(srcPath, '..'), path).replace(/\\/g, '/')}/${mode}";\n`; } - result += 'export const pluginList = {\n'; + result += `export const ${mode}Plugins = {\n`; for (const { name } of plugins) { result += ` "${name}": ${snakeToCamel(name)}Plugin,\n`; }