zartui-charts

ZartUI-Charts 是数字政通悟空团队基于 Vue3.0 研发的一款面向政务场景的图表类组件库。

前端框架技术路线

Vite + Vue3 + TypeScript

包管理工具

pnpm

安装项目依赖

pnpm install

IDE 支持

推荐使用 Visual Studio Code

VSCode 插件

• Vue Language Features (Volar)
• TypeScript Vue Plugin (Volar)
• Prettier
• ESLint
• Stylelint

命令

开发

组件库的开发环境

pnpm dev

打包

库模式打包

pnpm build:lib

Lint with ESLint

# 检查修复
pnpm lint

pnpm lint:fix

pnpm lint:prettier

项目结构

project
├── .husky                          # Husky
│   └── pre-commit                  # Git 钩子
├── .vscode                         # VSCode
│   ├── extensions.json             # VSCode 推荐插件
│   ├── settings.json               # VSCode 配置
│   └── settings.json.recommend     # VSCode 配置文件备份
├── build                           # 运行与打包相关
├── core                            # 组件库代码
│   ├── _util                       # 组件库工具
│   │   ├── modules                 # 功能模块
│   │   ├── typings                 # 类型定义
│   ├── components                  # 组件库公共组件
├── lib                             # 打包产物
├── example                         # 组件库开发调试环境
├── .browserslistrc                 # 浏览器支持配置
├── .editorconfig                   # Editor 配置
├── .eslintrc.cjs                   # ESLint 配置
├── .huskyrc                        # Git 钩子配置
├── .prettierignore                 # Prettier 忽略配置
├── .prettierrc.js                  # Prettier 配置
├── README.md                       # 项目说明
├── package.json                    # 包管理
├── pnpm-lock.yaml                  # pnpm lock
├── pnpm-workspace.yaml             # pnpm workspace
├── tsconfig.json                   # TypeScript 配置
└── vite.config.ts                  # Vite 配置

开发说明

• ZartUI Charts 组件放在 core 文件夹下，请使用 TSX 模式开发组件库
• example 下是组件库的调试页面，如果是调试页面的依赖，请切换到 example 目录下安装
• 项目使用的是 pnpm workspace 管理开发与调试页面。如果在开发模式下安装依赖，请增加 -w。例如：pnpm add XXX -D -w

代码提交说明

git add .
pnpm commit

Select the type of change that you're committing:

• 提交类型参照.versionrc.json

What is the scope of this change (e.g. component or file name):

• 描述此次更改的范围，可以省略

Write a short, imperative tense description of the change:

• 必填项，commit 内容。格式依旧为：[M][案卷号]1、xxx;2、xxx;

Provide a longer description of the change:

• 为此次改变提供一个详细描述，可以省略

Are there any breaking changes?

• 是否有重大改变，可以省略

Does this change affect any open issues?

• 此更改是否影响一个 open 状态的 issues？可以省略

git push origin main