Vui Cli

Vui Cli 是一个 Vue 组件库构建工具，通过 Vui Cli 可以快速搭建一套功能完备的 Vue 组件库。

特性

• 提供丰富的命令，涵盖从开发测试到构建发布的完整流程
• 基于约定的目录结构，自动生成优雅的文档站点和组件示例
• 内置 ESlint、Stylelint 校验规则，提交代码时自动执行校验
• 构建后的组件库默认支持按需引入、主题定制、Tree Shaking

快速上手

手动安装

# 通过 npm 安装
npm i @vui/cli -D

# 通过 yarn 安装
yarn add @vui/cli --dev

安装完成后，请将以下配置添加到 package.json 文件中

{
  "scripts": {
    "dev": "vui-cli dev",
    "test": "vui-cli test",
    "lint": "vui-cli lint",
    "build": "vui-cli build",
    "prepare": "husky install",
    "release": "vui-cli release",
    "build-site": "vui-cli build-site"
  },
  "lint-staged": {
    "*.md": "prettier --write",
    "*.{ts,tsx,js,vue,less,scss}": "prettier --write",
    "*.{ts,tsx,js,vue}": "eslint --fix",
    "*.{vue,css,less,scss}": "stylelint --fix"
  },
  "eslintConfig": {
    "root": true,
    "extends": ["@vui"]
  },
  "stylelint": {
    "extends": ["@vui/stylelint-config"]
  },
  "prettier": {
    "singleQuote": true
  },
  "browserslist": ["Chrome >= 51", "iOS >= 10"]
}

详细文档

• [命令] /docs/commands.md
• [配置指南] /docs/config.md
• [目录结构] /docs/directory.md
• [桌面端组件] /docs/desktop.md