# 配置文件

提示

以下选项既可用于命令行，又可以用于配置文件。

Vapper 会寻找项目根目录中的 vapper.config.js 文件，并加载该文件导出的对象作为配置选项：

// vapper.config.js
module.exports = {
  // ...
}

# mode

类型：string
默认值：'production'

指定 Vapper 的启动模式，生产模式还是开发模式，可选值为 'development' 和 'production'

# vueCliMode Vue CLI only

类型：string
默认值：null

指定 Vue CLI 的 --mode (opens new window) 选项，主要用于加载 .env.[mode] 文件。

# entry

类型：string
默认值：'src/main'

指定项目的入口文件，默认遵守 Vue CLI 的约定，把 src/main.js 文件作为入口文件。如果你使用 Poi (opens new window)，那么你需要修改该选项为：'src/index.js'。

提示

entry 选项需要与 vue.config.js(或 poi.config.js) 配置文件中的 entry 选项保持一致。

# ssr

类型：boolean
默认值：true

是否开启 SSR 模式，默认为开启，所有的页面都会在服务端渲染，可以通过路由 Meta 控制具体的路由规则是否启用 SSR。

# enableCustomErrorPage

类型：boolean
默认值：false

是否使用自定义错误页面，默认关闭。即无论什么情况下，只要有错误发生就会回退 SPA 模式。更多内容请阅读：错误处理-自定义错误页面。

# template

类型：string
默认值：''

自定义 html 模板，例如：

// vapper.config.js
module.exports = {
  template: fs.readFileSync('/path/to/your/template', 'utf-8')
}

默认的模板是：

<!DOCTYPE html>
<html data-vue-meta-server-rendered lang="en" {{{ meta.inject().htmlAttrs.text() }}}>
  <head {{{ meta.inject().headAttrs.text() }}}>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no, minimal-ui" />
    {{{ meta.inject().meta.text() }}}
    {{{ meta.inject().title.text() }}}
    {{{ meta.inject().link.text() }}}
    {{{ meta.inject().style.text() }}}
    {{{ meta.inject().script.text() }}}
    {{{ meta.inject().noscript.text() }}}
  </head>
  <body {{{ meta.inject().bodyAttrs.text() }}}>
    <!--vue-ssr-outlet-->
    {{{ meta.inject().script.text({ body: true }) }}}
  </body>
</html>

# templatePath 1.5.0+

类型：string
默认值：''

与 template 选项一样，用来自定义模板，不同的是 template 选项指定模板的内容，而 templatePath 选项指定模板的路径。使用 templatePath 的好处的是：在开发模式下，模板文件的改动会实时生效。

# port

类型：number
默认值：4000

服务器端口号。

# host

类型：string
默认值：0.0.0.0

服务器主机。

# https 1.11.0+

类型：object
默认值：{}

这个对象会作为 options 直接传递给 nodejs 的 require('https').reateServer([options][, requestListener])。

例子：

// vapper.config.js
module.exports = {
  https: {
    key: fs.readFileSync('/path/to/server.key'),
    cert: fs.readFileSync('/path/to/server.crt')
  }
}

# logger

类型：function
默认值：console.log

自定义日志打印函数，默认为 console.log，你可以使用它自定义日志打印函数，例如：

// vapper.config.js
module.exports = {
  // 自定义 logger
  logger (...args) {
    console.log(...args)
  }
}

# logLevel

类型：number
默认值：5

设置日志级别：

logLevel === 0 ----> silent
logLevel === 1 ----> error
logLevel === 2 ----> error/warn
logLevel === 3 ----> error/warn/debug
logLevel === 4 ----> error/warn/debug/tip
logLevel === 5 ----> error/warn/debug/tip/info

# static

类型：object
默认值：

{
  dotfiles: 'allow',
  index: false,
  maxAge: '1d'
}

Vapper 内部使用 serve-static (opens new window) 服务静态资源。该选项就是 serve-static (opens new window) 的选项。

# plugins

类型：array
默认值：[]

指定要加载的插件，请查看：使用插件。

# htmlMinifier (Prod Only)

类型：boolean | object
默认值：false

Vapper 允许压缩服务端渲染的 html 内容，该选项仅在生产环境可用，默认不压缩。你可以将 htmlMinifier 设置为 true，这样 Vapper 将使用默认的压缩选项压缩 html 内容。你也可以设置 htmlMinifier 选项为一个对象，手动指定相应的压缩选项。Vapper 使用 html-minifier (opens new window) 对 html 字符串进行压缩，如果 htmlMinifier 为 true，那么默认的压缩选项为：

{
  collapseWhitespace: true,
  removeRedundantAttributes: true,
  removeScriptTypeAttributes: true,
  removeStyleLinkTypeAttributes: true,
  useShortDoctype: true,
  minifyCSS: true
}

# fallBackSpa

类型：boolean
默认值：true

当错误发生时是否回退 SPA 模式，默认为 true，即回退 SPA 模式。阅读回退 SPA 模式了解详情。

# fallbackSpaHandler

Type: function
Default: null

自定义回退 SPA 的逻辑，详情请查看：自定义 fallback 逻辑

# serverBundleFileName

类型：string
默认值：'vue-ssr-server-bundle.json'

指定 Server Bundle 的文件名。

# clientManifestFileName

类型：string
默认值：'vue-ssr-client-manifest.json'

指定 Client Manifest 的文件名。

# nodeExternalsWhitelist

类型：array
默认值：[/\.css$/, /\?vue&type=style/]

webpack-node-externals (opens new window) 插件的 whitelist (opens new window) 选项。

nodeExternalsWhitelist 选项的合并策略是“追加”，例如：

// vapper.config.js
module.exports = {
  nodeExternalsWhitelist: [/some/]
}

最终的 whitelist (opens new window) 选项为：[/\.css$/, /\?vue&type=style/, /some/]。

# pageCache

类型：object
默认值：

{
  cacheOptions = {
    max: 100,
    maxAge: 1000
  },
  cacheable = () => false,
  getCacheKey = req => req.url
}

设置页面级缓存，详情请查看：页面级缓存 Micro Caching。

# rendererOptions

类型：object
默认值：{}

设置 vue-server-renderer (opens new window) 的选项。

# runtimeCompiler

类型：boolean
默认值：false

是否使用包含运行时编译器的 Vue，设置为 true 意味着你可以在组件中使用 template 选项，但这会导致你你用的体积增加大约 10kb。

← State Injection