Skip to content

DevUI CLI 功能介绍

Kagol edited this page Dec 12, 2021 · 1 revision

devui-cli

为了提供开发者便利及更好的管理组件包产出,特意提供了 devui-cli 工具,目前包含快速生成组件模板和生成 vue-devui.ts 文件,后续还会持续集成新的便利功能。

Install

目前没有发布该工具为独立软件包,所以采用软链方式至全局进行使用。

// 安装依赖后在项目根目录,只需执行一次即可
npm link

Clean

// npm
npm run clean:cli

// yarn
yarn clean:cli

Commander

create

// 创建一个组件模板或配置文件
devui-cli create [options]

// options 参数
--type <type>      创建类型,可选值:component, vue-devui, vitepress/sidebar
--ignore-parse-error  忽略解析错误 (default: false)

尝试创建一个组件模板

devui-cli create

输入图片说明

执行命令后根据提示一步步填入信息即可成功生成组件目录。

生成 vue-devui.ts 文件

// -t 即 --type 配置创建类型
// --ignore-parse-error 即让解析组件时跳过解析错误的组件
devui-cli create -t vue-devui --ignore-parse-error

已配置 predev 命令,在运行 dev 时会先生成 vue-devui.ts 文件。

结束

devui-cli 目前还只是雏形工具,提供的命令和功能较少,如果大家还希望 devui-cli 提供哪些功能可在 issues 下告诉我们。