Skip to main content

构建应用

命令

使用skr build可以通过webpack来构建应用。

参数

--cwd [value]               指定当前工作目录,默认为当前目录
--mode [value] 设置构建的环境模式,可以为development或production,默认为production
--config [value] 使用指定的配置文件,默认查找reskript.config.{ts,mjs}
--env-file [value...] 提供一个或多个自定义的环境变量(.env)文件
--src-dir [value] 指定项目源码所在的目录,默认为src
--build-target [value] 指定构建的目标特性名称,如果有这个参数,最后会生成一个index.html包含该特性集
--feature-only [value] 只构建指定的特性名称,其它的特性名称不参与构建
--entries-only [entries...] 只构建指定的入口文件,可以指定多个入口
--strict 打开严格模式,会稍微影响编译速度,增加更多对源码和依赖的检测
--analyze 启用对构建产物的分析功能
--profile 在构建产出中加入性能追踪的能力
--no-source-maps 构建时不产出source map
--clean 构建前删除上一次构建的产出
--cache-dir 指定构建缓存的存放目录,默认为node_modules/.cache/webpack
--watch 启用变更监听,构建完成后不退出,文件变动时更新构建
-h, --help 显示帮助信息

除命令行参数外,项目配置文件中的build配置也会影响构建的行为。

指定目标特性集

reSKRipt中,我们支持了特性矩阵这一功能,可以支持一次性构建出多个版本。在这个模式下,构建的最终入口会是{entryName}-{featureName}.html的形式。

但有些项目的线上部署方式是固定的,且只能接受index.html这一命名,此时代可以用--build-target参数来额外生成一个index.html。例如:

skr build --build-target=stable

上面的命令会在完成所有版本的构建后,额外增加一个index.html,最终生成的结构类似于:

/assets
# 一堆依赖的资源
index-stable.html
index-insiders.html
index.html # 内容和index-stable.html一样

另一种情况是,你根本不希望一次性构建多个版本,或者你有一个更高效的并行执行的CI/CD服务,所以你希望并行地单独构建每一个版本。这时可以用--feature-only来控制,如:

skr build --feature-only=stable

上面的命令会只构建stable这一特性集,featureMatrix中其它的特性集均不参与本次构建。

仅构建指定入口

假设项目中有src/entries/index.tsxsrc/entries/foo.tsxsrc/entries/bar.tsx一共3个入口,如果想只构建其中的foobar两个入口,你可以使用这样的命令:

skr build --entries-only=foo --entries-only=bar

通过--entries-only参数,指定一个或多个入口进行构建。这在一个大型项目通过入口分割成多个可单独发布的小项目时能提升构建速度。但通常来说我们更推荐使用monorepo的形式组织多个子模块构成的大型项目,而不是通过--entries-only参数来处理。

严格模式

当使用--strict参数后,构建会进入严格模式,请参考配置解密 - 严格模式了解这个开关的作用。

Watch模式

使用skr build --watch可以在构建结束后监听文件变更并更新构建,但有以下限制:

  • 你需要通过--build-target参数指定构建的目标,假如没有指定则使用dev作为默认的目标,这一行为与skr dev相同。
  • 如果你有使用Service Worker生成,那么文件变更时会有一些警告信息。我们已知此问题,如果对你的使用有影响,请提交需求给我们

产出分析

如果你希望了解自己的项目构建后的产物情况,可以加上--analyze参数,这个参数必须与--build-target一起使用,指定分析某一个特性集的产物:

skr build --analyze --build-target=stable

在加上这一参数后,我们会对产物进行一系列的分析,当前提供的能力包括:

  • 使用webpack-bundle-analyzer生成一份产出的分析视图,并打开你的浏览器展示这个页面。
  • dist/assets中生成一个stats.json,里面包含了整个构建的详细信息。

我们有计划在后续增加更多的产出分析,如对初始加载大小的控制、未使用代码的分析等。

请不要在CI环境中使用--analyze参数,它不会给你带来什么作用,但会严重拖慢构建速度。