@vtj / Modules / cli / CreatePluginViteConfigOptions

Interface: CreatePluginViteConfigOptions

cli.CreatePluginViteConfigOptions

createViteConfig函数参数

Hierarchy

• CreateViteConfigOptions

  ↳ CreatePluginViteConfigOptions

Table of contents

Properties

• alias
• babel
• base
• buildEnd
• copyPublicDir
• copyStatic
• debug
• defineConfig
• dts
• dtsOutputDir
• elementPlus
• emptyOutDir
• entry
• envPath
• exports
• external
• externalGlobals
• force
• formats
• host
• https
• isUmd
• legacy
• lib
• libFileName
• library
• loading
• manualChunks
• material
• node
• optimizeDeps
• outDir
• pages
• plugins
• polyfills
• port
• previewPort
• proxy
• staticDirs
• style
• targets
• version
• visualizer
• watchModules

Properties

alias

• Optional alias: Record<string, string>

别名

Inherited from

CreateViteConfigOptions.alias

Defined in

packages/cli/src/vite/types.ts:99

---

babel

• Optional babel: boolean

开启babel

Inherited from

CreateViteConfigOptions.babel

Defined in

packages/cli/src/vite/types.ts:184

---

base

• Optional base: string

开发或生产环境服务的公共基础路径

Inherited from

CreateViteConfigOptions.base

Defined in

packages/cli/src/vite/types.ts:49

---

buildEnd

• Optional buildEnd: (error?: any) => void

编译完成时触发回调函数

Type declaration

▸ (error?): void

Parameters

Name	Type
error?	any

Returns

void

Inherited from

CreateViteConfigOptions.buildEnd

Defined in

packages/cli/src/vite/types.ts:237

---

copyPublicDir

• Optional copyPublicDir: boolean

默认情况下，Vite 会在构建阶段将 publicDir 目录中的所有文件复制到 outDir 目录中。可以通过设置该选项为 false 来禁用该行为。

Inherited from

CreateViteConfigOptions.copyPublicDir

Defined in

packages/cli/src/vite/types.ts:242

---

copyStatic

• Optional copyStatic: boolean

打包复制静态目录

Inherited from

CreateViteConfigOptions.copyStatic

Defined in

packages/cli/src/vite/types.ts:204

---

debug

• Optional debug: boolean

打印最终 vite.config

Inherited from

CreateViteConfigOptions.debug

Defined in

packages/cli/src/vite/types.ts:39

---

defineConfig

• Optional defineConfig: (config: UserConfig) => UserConfigExport

自定义配置 vite 配置

Type declaration

▸ (config): UserConfigExport

Parameters

Name	Type
config	UserConfig

Returns

UserConfigExport

Inherited from

CreateViteConfigOptions.defineConfig

Defined in

packages/cli/src/vite/types.ts:64

---

dts

• Optional dts: boolean

生成定义文件, 在库模式有效

Inherited from

CreateViteConfigOptions.dts

Defined in

packages/cli/src/vite/types.ts:104

---

dtsOutputDir

• Optional dtsOutputDir: string

定义文件输出文件夹

Inherited from

CreateViteConfigOptions.dtsOutputDir

Defined in

packages/cli/src/vite/types.ts:109

---

elementPlus

• Optional elementPlus: boolean | Record<string, any>

开启 unplugin-element-plus

Inherited from

CreateViteConfigOptions.elementPlus

Defined in

packages/cli/src/vite/types.ts:194

---

emptyOutDir

• Optional emptyOutDir: boolean

清空输出目录

Inherited from

CreateViteConfigOptions.emptyOutDir

Defined in

packages/cli/src/vite/types.ts:59

---

entry

• Optional entry: string

lib 入口文件

Inherited from

CreateViteConfigOptions.entry

Defined in

packages/cli/src/vite/types.ts:129

---

envPath

• Optional envPath: string

环境配置文件目录位置

Inherited from

CreateViteConfigOptions.envPath

Defined in

packages/cli/src/vite/types.ts:219

---

exports

• Optional exports: "default" | "auto" | "named" | "none"

类库导出名称模式， 默认 auto https://rollupjs.org/configuration-options/#output-exports

Inherited from

CreateViteConfigOptions.exports

Defined in

packages/cli/src/vite/types.ts:230

---

external

• Optional external: string[]

不打包的依赖

Inherited from

CreateViteConfigOptions.external

Defined in

packages/cli/src/vite/types.ts:134

---

externalGlobals

• Optional externalGlobals: Record<string, string>

从全局引用的依赖

Inherited from

CreateViteConfigOptions.externalGlobals

Defined in

packages/cli/src/vite/types.ts:139

---

force

• Optional force: boolean

强制更新依赖

Inherited from

CreateViteConfigOptions.force

Defined in

packages/cli/src/vite/types.ts:164

---

formats

• Optional formats: string[]

库模式输入格式

Inherited from

CreateViteConfigOptions.formats

Defined in

packages/cli/src/vite/types.ts:149

---

host

• Optional host: string

主机头

Inherited from

CreateViteConfigOptions.host

Defined in

packages/cli/src/vite/types.ts:79

---

https

• Optional https: boolean

开启https

Inherited from

CreateViteConfigOptions.https

Defined in

packages/cli/src/vite/types.ts:84

---

isUmd

• Optional isUmd: boolean

Defined in

packages/cli/src/vite/types.ts:320

---

legacy

• Optional legacy: boolean

适配传统浏览器, 在非库模式下有效

Inherited from

CreateViteConfigOptions.legacy

Defined in

packages/cli/src/vite/types.ts:114

---

lib

• Optional lib: boolean

库模式

Inherited from

CreateViteConfigOptions.lib

Defined in

packages/cli/src/vite/types.ts:44

---

libFileName

• Optional libFileName: string

库模式编译输出文件名

Inherited from

CreateViteConfigOptions.libFileName

Defined in

packages/cli/src/vite/types.ts:154

---

library

• Optional library: string

库模式在umd文件导出变量名称

Inherited from

CreateViteConfigOptions.library

Defined in

packages/cli/src/vite/types.ts:144

---

loading

• Optional loading: boolean

生成 loading html

Inherited from

CreateViteConfigOptions.loading

Defined in

packages/cli/src/vite/types.ts:214

---

manualChunks

• Optional manualChunks: (id: string) => string | void

自定义 chunk name, 在库模式无效

Type declaration

▸ (id): string | void

Parameters

Name	Type
id	string

Returns

string | void

Inherited from

CreateViteConfigOptions.manualChunks

Defined in

packages/cli/src/vite/types.ts:159

---

material

• Optional material: string

Defined in

packages/cli/src/vite/types.ts:321

---

node

• Optional node: boolean | PolyfillOptions

开启 nodePolyfills

Inherited from

CreateViteConfigOptions.node

Defined in

packages/cli/src/vite/types.ts:224

---

optimizeDeps

• Optional optimizeDeps: string[]

预构建依赖

Inherited from

CreateViteConfigOptions.optimizeDeps

Defined in

packages/cli/src/vite/types.ts:169

---

outDir

• Optional outDir: string

打包输出文件夹

Inherited from

CreateViteConfigOptions.outDir

Defined in

packages/cli/src/vite/types.ts:54

---

pages

• Optional pages: Record<string, string>

多页面模式

Inherited from

CreateViteConfigOptions.pages

Defined in

packages/cli/src/vite/types.ts:209

---

plugins

• Optional plugins: PluginOption[]

插件

Inherited from

CreateViteConfigOptions.plugins

Defined in

packages/cli/src/vite/types.ts:179

---

polyfills

• Optional polyfills: boolean | string[]

设置 polyfills，在非库模式下有效，默认为true

Inherited from

CreateViteConfigOptions.polyfills

Defined in

packages/cli/src/vite/types.ts:124

---

port

• Optional port: number

开发端口

Inherited from

CreateViteConfigOptions.port

Defined in

packages/cli/src/vite/types.ts:69

---

previewPort

• Optional previewPort: number

预览端口

Inherited from

CreateViteConfigOptions.previewPort

Defined in

packages/cli/src/vite/types.ts:74

---

proxy

• Optional proxy: ProxyConfig

代理

Inherited from

CreateViteConfigOptions.proxy

Defined in

packages/cli/src/vite/types.ts:89

---

staticDirs

• Optional staticDirs: (string | StaticPluginOption)[]

静态服务目录

Inherited from

CreateViteConfigOptions.staticDirs

Defined in

packages/cli/src/vite/types.ts:199

---

style

• Optional style: string

Defined in

packages/cli/src/vite/types.ts:322

---

targets

• Optional targets: string | string[]

编译目标浏览器

Inherited from

CreateViteConfigOptions.targets

Defined in

packages/cli/src/vite/types.ts:119

---

version

• Optional version: boolean

开启生成版本号文件

Inherited from

CreateViteConfigOptions.version

Defined in

packages/cli/src/vite/types.ts:189

---

visualizer

• Optional visualizer: boolean

生成报告

Inherited from

CreateViteConfigOptions.visualizer

Defined in

packages/cli/src/vite/types.ts:174

---

watchModules

• Optional watchModules: string[]

Vite 服务器默认会忽略对 .git/ 和 node_modules/ 目录的监听。如果你需要对 node_modules/ 内的包进行监听

Inherited from

CreateViteConfigOptions.watchModules

Defined in

packages/cli/src/vite/types.ts:94