# 配置参考

next.config.js 是一个可选的配置文件，如果项目的根目录中存在这个文件，那么它会被 @startdt/cli-service 自动加载。你也可以使用 package.json 中的 next 字段，但是注意这种写法需要你严格遵照 JSON 的语法格式。

这个文件应该导出一个包含了选项的对象：

/**
 * @type {import('@startdt/cli-service').ProjectOptions}
 */
module.exports = {
    // 配置选项...
};

# publicPath

类型：string
默认值：/

部署应用包时的基本 URL。用法和 webpack 本身的 output.publicPath 一致，但是 Next CLI 在一些其他地方也需要用到这个值，所以请始终使用 publicPath 而不要直接修改 webpack 的 output.publicPath。

这个值也可以被设置为空字符串（''）或是相对路径（'./'）。这样所有的资源都会被链接为相对路径，这样打出来的包可以被部署在任意路径，也可以用在类似 Cordova hybrid 应用的文件系统中。

相对 publicPath 的限制

以下情况应当避免使用相对 publicPath：

当使用基于 HTML5 history.pushState 的路由时
当使用 pages 选项构建多页面应用时

这个值在开发环境下同样生效。如果你想把开发服务器架设在根路径，你可以使用一个条件式的值：

module.exports = {
    publicPath: process.env.NODE_ENV === 'production'
        ? '/production-sub-path/'
        : '/',
};

# outputDir

类型：string
默认值：dist

当运行 next-cli-service build 时生成的生产环境构建文件的目录。注意目标目录在构建之前会被清除（构建时传入 --no-clean 可关闭该行为）。

提示

请始终使用 outputDir 而不要修改 webpack 的 output.path。

# assetsDir

类型：string
默认值：``

放置生成的静态资源（js、css、img、fonts）的（相对于 outputDir 的）目录。

提示

从生成的资源覆写 filename 或 chunkFilename 时，assetsDir 会被忽略。

# indexPath

类型：string
默认值：index.html

指定生成的 index.html 的输出路径（相对于 outputDir），也可以是一个绝对路径。

# filenameHashing

类型：boolean
默认值：true

默认情况下，生成的静态资源在它们的文件名中包含了 Hash 以便更好的控制缓存。然而，这也要求 index.html 是通过 Next CLI 自动生成的。

如果你无法使用 Next CLI 生成的 index.html，可以通过将这个选项设为 false 来关闭文件名哈希。

# pages

类型：Object
默认值：undefined

在 multi-page 模式下构建应用。每个页面应该有一个对应的 JavaScript 入口文件，其值应该是一个对象，对象的 key 是入口的名称，value 是：

一个指定了 entry、template、filename、title 和 chunks 的对象（除了 entry 之外都是可选的）
或一个指定其 entry 的字符串

module.exports = {
    pages: {
        index: {
            // 页面入口
            entry: 'src/index/main.js',
            // 模板来源
            template: 'public/index.html',
            // 在 dist/index.html 的输出
            filename: 'index.html',
            // 当使用 title 选项时，
            // template 中的 title 标签需要是 <title><%= htmlWebpackPlugin.options.title %></title>
            title: 'Index Page',
            // 在这个页面中包含的块，默认情况下会包含
            // 提取出来的通用 chunk 和 vendor chunk。
            chunks: ['chunk-vendors', 'chunk-common', 'index'],
        },
        // 当使用只有入口的字符串格式时，
        // 模板会被推导为 `public/subpage.html`
        // 并且如果找不到的话，就回退到 `public/index.html`。
        // 输出文件名会被推导为 `subpage.html`。
        subpage: 'src/subpage/main.js',
    },
};

# lintOnSave

类型：boolean | 'warning' | 'default' | 'error'
默认值：'default'

开发环境下是否在每次保存时格式化代码。这个值会在 @startdt/cli-plugin-eslint 被安装之后生效。

设置为 true 或 'warning' 时，会将 lint 错误输出为编译警告。默认情况下，警告仅仅会被输出到命令行，且不会使得编译失败。

如果你希望让 lint 错误在开发时直接显示在浏览器中，你可以使用 lintOnSave: 'default'。这会强制将 lint 错误输出为编译错误，同时也意味着 lint 错误将会导致编译失败。

设置为 'error' 将会把 lint 警告也输出为编译错误，这意味着 lint 警告将会导致编译失败。

或者，你也可以通过设置让浏览器显示全屏覆盖，同时输出警告和错误：

module.exports = {
    devServer: {
        overlay: {
            warnings: true,
            errors: true,
        },
    },
};

如果你想要在生产构建时禁用错误输出，可以使用以下配置：

module.exports = {
    lintOnSave: process.env.NODE_ENV !== 'production',
};

# runtimeCompiler

类型：boolean
默认值：false

是否使用包含运行时编译器的 Vue 构建版本。设置为 true 后你就可以在 Vue 组件中使用 template 选项了，但是这会让你的应用额外增加 10kb 左右。

# transpileDependencies

类型：Array<string | RegExp>
默认值：[]

默认情况下，babel-loader 会忽略所有 node_modules 中的文件。如果你想要通过 Babel 显式转译一个依赖，可以在这个选项中列出来。

# productionSourceMap

类型：boolean
默认值：true

如果你不需要生产环境的 Source Map，可以将其设置为 false 以加速生产环境构建。

# crossorigin

类型：string
默认值：undefined

设置生成的 HTML 中 <link rel="stylesheet"> 和 <script> 标签的 crossorigin 属性。

注意

该选项仅影响由 html-webpack-plugin 在构建时注入的标签 —— 直接写在模版中的标签不受影响。

# integrity

类型：boolean
默认值：false

在生成的 HTML 中的 <link rel="stylesheet"> 和 <script> 标签上启用子资源完整性 (opens new window)（SRI）。如果你构建后的文件是部署在 CDN 上的，启用该选项可以提供额外的安全性。

注意

该选项仅影响由 html-webpack-plugin 在构建时注入的标签 —— 直接写在模版中的标签不受影响。

# configureWebpack

类型：Object | Function

如果这个值是一个对象，则会通过 webpack-merge (opens new window) 合并到最终的配置中。

如果这个值是一个函数，则会接收被解析的配置作为参数。该函数既可以修改配置并不返回任何东西，也可以返回一个被克隆或合并过的配置版本。

# chainWebpack

类型：Function

这个值是一个函数，会接收一个基于 webpack-chain (opens new window) 的 ChainableConfig 实例。允许对内部的 webpack 配置进行更细粒度的修改。

# css.requireModuleExtension

类型：boolean
默认值：true

默认情况下，只有 *.module.[ext] 结尾的文件才会被视作 CSS Modules 模块。设置为 false 后你就可以去掉文件名中的 .module 并将所有的 *.(css|scss|sass|less|styl(us)?) 文件视为 CSS Modules 模块。

提示

如果你在 css.loaderOptions.css 里配置了自定义的 CSS Module 选项，则 css.requireModuleExtension 必须被显式地指定为 true 或者 false，否则我们无法确定你是否希望将这些自定义配置应用到所有 CSS 文件中。

# css.extract

类型：boolean | Object
默认值：生产环境下是 true，开发环境下是 false

是否将组件中的 CSS 提取至一个独立的 CSS 文件中（而不是动态注入到 JavaScript 中的内联代码）。

当构建 Web Components 组件时它总是会被禁用（样式是内联的并注入到了 shadowRoot 中）。

当作为一个库构建时，你也可以将其设置为 false 免得用户自己导入 CSS。

注意

提取 CSS 在开发环境模式下默认是关闭的，因为它和 CSS 热重载不兼容。

# css.sourceMap

类型：boolean
默认值：false

是否为 CSS 开启 Source Map。设置为 true 之后可能会影响构建的性能。

# css.loaderOptions

类型：Object
默认值：{}

向 CSS 相关的预处理器（loader）传递选项。例如：

module.exports = {
    css: {
        loaderOptions: {
            css: {
                // 这里的选项会传递给 css-loader
            },
            postcss: {
                // 这里的选项会传递给 postcss-loader
            },
        },
    },
};

支持的预处理器有：

另外，也可以使用 scss 选项，针对 scss 语法进行单独配置（区别于 sass 语法）。

提示

相比于使用 chainWebpack 手动指定预处理器，更推荐上面这样做。因为这些选项需要应用在使用了相应预处理器的多个地方。

# devServer

类型：Object

请参阅：webpack-dev-server (opens new window)

注意

有些值像 host、port 和 https 可能会被命令行参数覆写；
有些值像 publicPath 和 historyApiFallback 不应该被修改，因为它们需要和开发服务器的 publicPath 同步以保障正常的工作。

# devServer.proxy

类型：string | Object

如果你的前端应用和后端 API 服务器没有运行在同一个主机上，你需要在开发环境下将 API 请求代理到 API 服务器。这个问题可以通过 next.config.js 中的 devServer.proxy 选项来配置。

devServer.proxy 可以是一个指向开发环境 API 服务器的字符串：

module.exports = {
    devServer: {
        proxy: 'http://localhost:4000',
    },
};

这会告诉开发服务器将任何未知请求（没有匹配到静态文件的请求）代理到 http://localhost:4000。

如果你想要更多的代理控制行为，也可以使用一个 path: options 成对的对象。请参阅：http-proxy-middleware (opens new window)

# parallel

类型：boolean
默认值：require('os').cpus().length > 1

是否为 Babel 或 TypeScript 使用 thread-loader。该选项在系统的 CPU 有多于一个内核时自动启用，仅作用于生产构建。

# pluginOptions

类型：Object

这是一个不进行任何 Schema 验证的对象，因此它可以用来传递任何第三方插件选项。例如：

module.exports = {
    pluginOptions: {
        foo: {
            // 插件可以作为 `options.pluginOptions.foo` 访问这些选项。
        },
    },
};

开发服务插件开发