From 31790bf08f904a807787f1865ce3947d9eb86bfb Mon Sep 17 00:00:00 2001 From: chenjiahan Date: Mon, 16 Mar 2020 20:23:27 +0800 Subject: [PATCH] docs(cli): add commands intro --- packages/vant-cli/README.md | 24 +-------------- packages/vant-cli/docs/commands.md | 48 ++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 23 deletions(-) create mode 100644 packages/vant-cli/docs/commands.md diff --git a/packages/vant-cli/README.md b/packages/vant-cli/README.md index ffa75564a..b5bf3e37e 100644 --- a/packages/vant-cli/README.md +++ b/packages/vant-cli/README.md @@ -70,29 +70,7 @@ yarn add @vant/cli --dev ## 命令 -### dev - -本地开发,dev 命令会启动一个本地服务器,用于在开发过程中对文档和示例进行预览 - -### build - -构建组件库,在`es`和`lib`目录生成可用于生产环境的组件代码 - -### build-site - -构建文档站点,在`site`目录生成可用于生产环境的文档站点代码 - -### release - -发布组件库,发布前会自动执行 build 和 changelog 命令 - -### changelog - -基于 commit 记录生成更新日志 - -### commit-lint - -校验 commit message 的格式是否符合规范,需要配合`husky`在提交 commit 时触发 +参见[命令](https://github.com/youzan/vant/tree/dev/packages/vant-cli/docs/commands.md)。 ## 配置 diff --git a/packages/vant-cli/docs/commands.md b/packages/vant-cli/docs/commands.md new file mode 100644 index 000000000..bfed5489f --- /dev/null +++ b/packages/vant-cli/docs/commands.md @@ -0,0 +1,48 @@ +# 命令 + +Vant Cli 中内置了一系列的命令,可以将命令添加到 npm scripts 中进行使用。 + +```json +// 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](https://github.com/npm/npx) 直接执行某个命令: + +```bash +npx vant-cli dev +``` + +### dev + +运行本地开发环境。 + +运行 dev 命令时,Vant Cli 会通过 [webpack-dev-server](https://github.com/webpack/webpack-dev-server) 启动一个本地服务器,用于在开发过程中对文档和示例进行预览。 + +### build + +构建组件库,在 `es` 和 `lib` 目录生成可用于生产环境的组件代码。 + +### build-site + +构建文档站点,在 `site` 目录生成可用于生产环境的文档站点代码。 + +### release + +发布组件库,发布前会自动执行 build 和 changelog 命令。 + +## changelog + +基于 commit 记录生成更新日志。 + +## commit-lint + +校验 commit message 的格式是否符合规范,需要配合`husky`在提交 commit 时触发。