From df122b1f1fa86a234b20c8fac557a419b392c938 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B4=94=E7=BA=A2=E4=BF=9D?= Date: Thu, 10 Feb 2022 17:56:07 +0800 Subject: [PATCH] =?UTF-8?q?=E8=A1=A5=E5=85=85CLI=E5=B7=A5=E5=85=B7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/worktile/CLI.md | 103 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 102 insertions(+), 1 deletion(-) diff --git a/docs/worktile/CLI.md b/docs/worktile/CLI.md index 8eb882a1b..1338a59c9 100644 --- a/docs/worktile/CLI.md +++ b/docs/worktile/CLI.md @@ -1 +1,102 @@ -### cli 工具 \ No newline at end of file + +`uni-app`提供有完整的`cli` 脚手架，可以通过 `vue-cli` 创建、运行、发行 `uni-app` 项目。 + + +## 环境安装 + +全局安装vue-cli + +```shell +npm install -g @vue/cli +``` + +## 创建uni-app + +* 使用正式版（对应HBuilderX最新正式版） + + ```shell + vue create -p dcloudio/uni-preset-vue my-project + ``` + +* 使用alpha版（对应HBuilderX最新alpha版） + + ```shell + vue create -p dcloudio/uni-preset-vue#alpha my-alpha-project + ``` + +* 使用Vue3/Vite版 + * 创建以 javascript 开发的工程（如命令行创建失败，请直接访问 [gitee](https://gitee.com/dcloud/uni-preset-vue/repository/archive/vite.zip) 下载模板） + ```shell + npx degit dcloudio/uni-preset-vue#vite my-vue3-project + ``` + * 创建以 typescript 开发的工程（如命令行创建失败，请直接访问 [gitee](https://gitee.com/dcloud/uni-preset-vue/repository/archive/vite-ts.zip) 下载模板） + ```shell + npx degit dcloudio/uni-preset-vue#vite-ts my-vue3-project + ``` + +此时，会提示选择项目模板（使用Vue3/Vite版不会提示，目前只支持创建默认模板），初次体验建议选择 `hello uni-app` 项目模板，如下所示： + +
+ +
+ +#### 自定义模板 +选择自定义模板时，需要填写 uni-app 模板地址，这个地址其实就是托管在云端的仓库地址。以 GitHub 为例，地址格式为 `userName/repositoryName`，如 `dcloudio/uni-template-picture` 就是下载图片模板。 + +更多支持的下载方式，请参考这个插件的说明：[download-git-repo](https://www.npmjs.com/package/download-git-repo) + +#### 国内特殊情况 +模板项目存放于 Github，由于国内网络环境问题，可能下载失败。针对此问题可以尝试如下措施： +* 更换网络重试，比如使用 4g 网络 +* 在设备或路由器的网络设置中增加 DNS（如：8.8.8.8） +* 在设备中增加固定的 hosts（如：140.82.113.4 github.com） + +#### 修改依赖为指定版本@cliversion + +可以使用 [@dcloudio/uvm](https://www.npmjs.com/package/@dcloudio/uvm) 管理编译器的版本： + +* 更新到最新正式版 + ```shell + npx @dcloudio/uvm + ``` +* 更新到最新 alpha 版 + ```shell + npx @dcloudio/uvm alpha + ``` +* 更新到正式版指定版本 + ```shell + npx @dcloudio/uvm 3.2.12.20211029 + ``` +* 更新到 alpha 版指定版本 + ```shell + npx @dcloudio/uvm 3.2.14.20211112-alpha + ``` + +## 运行、发布uni-app + +```shell +# 运行uni-app项目，测试预览使用 +npm run dev:%PLATFORM% +# 正式发行uni-app项目 +npm run build:%PLATFORM% +``` + +``%PLATFORM%`` 可取值如下： + +|值|平台| +|---|---| +|app-plus|app平台生成打包资源（支持npm run build:app-plus，可用于持续集成。不支持run，运行调试仍需在HBuilderX中操作）| +|h5|H5| +|mp-alipay|支付宝小程序| +|mp-baidu|百度小程序| +|mp-weixin|微信小程序| +|mp-toutiao|字节跳动小程序| +|mp-lark|飞书小程序| +|mp-qq|qq 小程序| +|mp-360|360 小程序| +|mp-kuaishou|快手小程序| +|quickapp-webview|快应用(webview)| +|quickapp-webview-union|快应用联盟| +|quickapp-webview-huawei|快应用华为| + +可以自定义更多条件编译平台，比如钉钉小程序，参考[package.json文档](https://uniapp.dcloud.io/collocation/package)。 -- GitLab