XYY Mirco Core

基于 Vue 3 + TypeScript + Vite 的现代化微前端核心库。

技术栈

• Vue 3 - 渐进式 JavaScript 框架
• TypeScript - JavaScript 的超集
• Vite - 下一代前端构建工具
• Vue Router - Vue.js 官方路由管理器
• Pinia - Vue 的状态管理库
• Element Plus - 基于 Vue 3 的组件库
• SCSS - CSS 预处理器
• ESLint - 代码检查工具
• Prettier - 代码格式化工具
• Axios - HTTP 客户端
• Ali OSS - 阿里云对象存储服务

功能特性

• 🚀 基于 Vue 3 + TypeScript 开发的微前端核心库
• 📦 使用 Vite 作为构建工具，支持 ESM 和 UMD 格式
• 🎨 集成 Element Plus UI 组件库
• 🔍 集成 ESLint + Prettier 代码规范
• 📦 使用 Pinia 进行状态管理
• 🛣️ 基于 Vue Router 的路由管理
• 🌐 支持主流现代浏览器
• 📤 支持阿里云 OSS 上传功能

浏览器兼容性

项目支持以下浏览器版本：

• Chrome >= 61
• Firefox >= 60
• Edge >= 16
• Opera >= 48
• Safari >= 11

开发环境要求

• Node.js >= 16.0.0
• npm >= 7.0.0 或 yarn >= 1.22.0

安装和使用

1. 安装依赖

npm install xyy-mirco-core
# 或
yarn add xyy-mirco-core

2. 在项目中使用

// ESM
import xyy from 'xyy-mirco-core'

// CommonJS
const xyy = require('xyy-mirco-core')

开发指南

1. 克隆项目

git clone [项目地址]
cd xyy-mirco-core

2. 安装依赖

npm install
# 或
yarn install

3. 启动开发服务器

npm run dev
# 或
yarn dev

4. 构建库

npm run build
# 或
yarn build

5. 代码检查

npm run lint
# 或
yarn lint

6. 代码格式化

npm run format
# 或
yarn format

项目结构

xyy-mirco-core/
├── dist/               # 构建输出目录
├── package/           # 包相关文件
├── public/            # 静态资源
├── release/           # 发布相关脚本
├── src/               # 源代码
│   ├── assets/       # 主题、字体等静态资源
│   ├── components/   # 组件
│   ├── router/       # 路由
│   ├── stores/       # Pinia 状态管理
│   ├── styles/       # 全局样式
│   ├── types/        # TypeScript 类型定义
│   └── utils/        # 工具函数
├── .eslintrc.js      # ESLint 配置
├── .prettierrc       # Prettier 配置
├── index.html        # HTML 模板
├── package.json      # 项目配置
├── tsconfig.json     # TypeScript 配置
└── vite.config.ts    # Vite 配置

构建输出

构建后的文件位于 dist 目录：

• mirco-core.es.js - ES Module 格式
• mirco-core.umd.js - UMD 格式
• types/ - TypeScript 类型定义文件

代码规范

项目使用 ESLint + Prettier 进行代码规范检查和格式化：

• ESLint 配置：.eslintrc.js
• Prettier 配置：.prettierrc

发布流程

1. 更新 package.json 中的版本号
2. 运行构建命令：npm run build
3. 发布到 npm：npm publish