命令

Vant CLI 中内置了一系列的命令，可以将命令添加到 npm scripts 中进行使用。

// package.json
{
  "scripts": {
    "dev": "vant-cli dev",
    "test": "vant-cli test",
    "lint": "vant-cli lint",
    "release": "vant-cli release",
    "build-site": "vant-cli build-site"
  }
}

也可以通过 npm 自带的 npx 直接执行某个命令：

npx vant-cli dev

dev

运行本地开发环境。

运行 dev 命令时，Vant CLI 会通过启动一个本地服务器，用于在开发过程中对文档和示例进行预览。

build

构建组件库。

运行 build 命令会在 es 和 lib 目录下生成可用于生产环境的组件代码，详见目录结构。

发布 npm 时，请将以下配置加入到 package.json 中，使 npm 包能被正确识别:

// package.json
{
  "main": "lib/index.js",
  "module": "es/index.js",
  "files": ["es", "lib"]
}

build-site

构建文档站点，在 site 目录生成可用于生产环境的文档站点代码。

release

发布组件库，发布前会自动执行 build 和 changelog 命令，并通过 release-it 发布 npm 包。

changelog

基于 commit 记录生成更新日志，基于 conventional-changelog 实现。

commit-lint

校验 commit message 的格式是否符合规范，需要配合 husky 在提交 commit 时触发。

npx husky add .husky/commit-msg 'npx --no-install vant-cli commit-lint $1'

1.7 KiB Raw Blame History Unescape Escape

命令

dev

build

build-site

release

changelog

commit-lint

1.7 KiB

Raw Blame History