tasiaiso/electron-vite
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

refactor(config): defineConfig types

Browse source
This commit is contained in:
alex8088 2024-04-21 19:59:46 +08:00
parent c2c655367f
commit 1abedce6c2
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/config.ts
View file

@ -5,7 +5,7 @@ import { createRequire } from 'node:module'
import colors from 'picocolors' import colors from 'picocolors'
import { import {
type UserConfig as ViteConfig, type UserConfig as ViteConfig,
type UserConfigExport as UserViteConfigExport, type UserConfigExport as ViteConfigExport,
type ConfigEnv, type ConfigEnv,
type Plugin, type Plugin,
type LogLevel, type LogLevel,
@ -46,25 +46,25 @@ export interface UserConfig {
preload?: ViteConfig & { configFile?: string | false } preload?: ViteConfig & { configFile?: string | false }
} }
export interface UserConfigSchema { export interface ElectronViteConfig {
/** /**
* Vite config options for electron main process * Vite config options for electron main process
* *
* https://vitejs.dev/config/ * https://vitejs.dev/config/
*/ */
main?: UserViteConfigExport main?: ViteConfigExport
/** /**
* Vite config options for electron renderer process * Vite config options for electron renderer process
* *
* https://vitejs.dev/config/ * https://vitejs.dev/config/
*/ */
renderer?: UserViteConfigExport renderer?: ViteConfigExport
/** /**
* Vite config options for electron preload files * Vite config options for electron preload files
* *
* https://vitejs.dev/config/ * https://vitejs.dev/config/
*/ */
preload?: UserViteConfigExport preload?: ViteConfigExport
} }
export type InlineConfig = Omit<ViteConfig, 'base'> & { export type InlineConfig = Omit<ViteConfig, 'base'> & {
@ -73,16 +73,16 @@ export type InlineConfig = Omit<ViteConfig, 'base'> & {
ignoreConfigWarning?: boolean ignoreConfigWarning?: boolean
} }
export type UserConfigFn = (env: ConfigEnv) => UserConfigSchema | Promise<UserConfigSchema> export type ElectronViteConfigFn = (env: ConfigEnv) => ElectronViteConfig | Promise<ElectronViteConfig>
export type UserConfigExport = UserConfigSchema | Promise<UserConfigSchema> | UserConfigFn export type ElectronViteConfigExport = ElectronViteConfig | Promise<ElectronViteConfig> | ElectronViteConfigFn
/** /**
* Type helper to make it easier to use `electron.vite.config.*` * Type helper to make it easier to use `electron.vite.config.*`
* accepts a direct {@link UserConfig} object, or a function that returns it. * accepts a direct {@link ElectronViteConfig} object, or a function that returns it.
* The function receives a object that exposes two properties: * The function receives a object that exposes two properties:
* `command` (either `'build'` or `'serve'`), and `mode`. * `command` (either `'build'` or `'serve'`), and `mode`.
*/ */
export function defineConfig(config: UserConfigExport): UserConfigExport { export function defineConfig(config: ElectronViteConfigExport): ElectronViteConfigExport {
return config return config
} }
@ -390,7 +390,7 @@ async function loadConfigFormBundledFile(
configFile: string, configFile: string,
bundledCode: string, bundledCode: string,
isESM: boolean isESM: boolean
): Promise<UserConfigExport> { ): Promise<ElectronViteConfigExport> {
if (isESM) { if (isESM) {
const fileNameTmp = path.resolve(configRoot, `${CONFIG_FILE_NAME}.${Date.now()}.mjs`) const fileNameTmp = path.resolve(configRoot, `${CONFIG_FILE_NAME}.${Date.now()}.mjs`)
fs.writeFileSync(fileNameTmp, bundledCode) fs.writeFileSync(fileNameTmp, bundledCode)