前端基础工具包 - 专为前端应用设计的强大工具集合

👉 中文文档 | English Docs

• 项目简介
• 特性
• 快速开始
• 包列表
• 开发指南
  • 项目构建系统
  • 依赖管理策略
  • 打包格式指南
  • 提交规范
  • 项目发布
  • 如何增加一个子包
  • 测试指南
  • 代码注释指南

fe-base 是一个专为前端应用设计的工具包集合，采用 monorepo 架构，提供模块化的前端解决方案。项目包含了从核心工具库到开发脚本、从日志系统到代码生成等多个实用工具包。

• 🎯 模块化设计 - 基于 pnpm workspace 的 monorepo 架构
• 🔧 TypeScript 支持 - 完整的类型定义和智能提示
• 📦 独立发布 - 每个包可独立安装和使用
• 🚀 现代化工具链 - 使用 Vite、ESLint、Prettier 等现代工具
• 🔄 自动化发布 - 基于 Changesets 的版本管理和发布流程
• 🧪 测试覆盖 - 集成 Vitest 测试框架
• 🛠️ 开发工具 - 提供完整的开发工具链和脚本

• Node.js >= 18.19.0
• pnpm >= 8.0.0

# 安装核心工具包
npm install @qlover/fe-corekit

# 安装开发脚本工具
npm install @qlover/fe-scripts

# 安装日志工具
npm install @qlover/logger

# 或使用 pnpm
pnpm add @qlover/fe-corekit @qlover/fe-scripts @qlover/logger

# 克隆项目
git clone https://github.com/qlover/fe-base.git
cd fe-base

# 安装依赖
pnpm install

# 构建所有包
pnpm build

包名	版本	描述
@qlover/fe-corekit		前端核心工具包，提供存储、序列化、请求等功能
@qlover/fe-scripts		前端开发脚本工具集，包含清理、提交、检查等命令
@qlover/code2markdown		代码转 Markdown 文档生成工具
@qlover/fe-release		项目发布管理工具
@qlover/logger		灵活的日志记录系统
@qlover/env-loader		环境变量加载工具
@qlover/fe-standard		前端开发标准和规范
@qlover/eslint-plugin		前端开发 ESLint 插件
@qlover/scripts-context		脚本执行上下文工具
@qlover/corekit-bridge		核心工具包桥接器
@qlover/corekit-node		Node.js 环境核心工具
@qlover/create-app		应用脚手架生成工具

• 🇨🇳 中文文档 - 完整的中文开发文档
• 🇺🇸 English Documentation - Complete English development documentation

• 🏗️ 构建系统指南 - monorepo 架构和构建流程
• 📝 开发规范 - 提交规范和代码标准
• 🚀 项目发布 - 版本管理和发布流程
• ➕ 如何增加子包 - 新包创建指南

# 构建所有包
pnpm build

# 代码检查和格式化
pnpm lint
pnpm prettier

# 运行测试
pnpm test

# 清理构建产物
pnpm clean:build

# 提交代码（使用 commitizen）
pnpm commit

# 发布版本
pnpm changeset
pnpm changeset version
pnpm changeset publish

我们欢迎各种形式的贡献：

1. Fork 本仓库
2. 创建特性分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (pnpm commit)
4. 推送到分支 (git push origin feature/amazing-feature)
5. 创建 Pull Request

ISC