跳到主要内容

核心包

核心包提供前端应用的基础功能和工具,是所有应用和共享包的基础依赖。

功能特性

基础工具

  • 类型定义
  • 工具函数
  • 常量定义
  • 错误处理

通用组件

  • 基础组件
  • 布局组件
  • 业务组件
  • 高阶组件

插件系统

  • Vue 插件
  • 路由插件
  • 状态插件
  • 工具插件

开发指南

安装使用

# 在应用中安装
pnpm add @jingyun/core

# 在组件中使用
import { utils } from '@jingyun/core'

开发调试

cd packages/core
pnpm dev
pnpm build

项目结构

packages/core/
├── src/
│ ├── types/ # 类型定义
│ ├── utils/ # 工具函数
│ ├── constants/ # 常量定义
│ ├── components/ # 通用组件
│ ├── plugins/ # 插件
│ ├── composables/ # 组合式函数
│ └── index.ts # 入口文件
├── tests/ # 测试文件
├── docs/ # 文档
└── package.json # 包配置

API 文档

工具函数

  • formatDate(): 日期格式化
  • formatNumber(): 数字格式化
  • deepClone(): 深拷贝
  • debounce(): 防抖
  • throttle(): 节流

组合式函数

  • useRequest(): 请求处理
  • useStorage(): 存储管理
  • useWebSocket(): WebSocket
  • usePermission(): 权限管理

插件

  • install(): 插件安装
  • config(): 配置管理
  • router(): 路由配置
  • store(): 状态配置

开发规范

代码规范

  • TypeScript 严格模式
  • ESM 模块化
  • 函数式编程
  • 测试驱动

版本管理

  • 语义化版本
  • 变更日志
  • 发布流程
  • 向后兼容

测试策略

单元测试

  • 函数测试
  • 组件测试
  • 插件测试
  • 覆盖率要求

集成测试

  • 应用集成
  • 端到端测试
  • 性能测试
  • 兼容性测试