@mxmweb/zui-theme
v2.1.15
Published
一个用于快速初始化项目的工具库，提供了一系列常用的工具函数和组件。
Downloads
795
Readme
@mxmweb工具库开发环境说明文档
一个用于快速初始化项目的工具库，提供了一系列常用的工具函数和组件。
特性
- 🚀 快速初始化项目
- 📦 自动配置开发环境
- 🛠 提供常用工具函数
- 🎨 内置 UI 组件
- 📝 TypeScript 支持
- 🔧 可配置性强
开发指南
环境要求
- Node.js >= 18
- pnpm >= 8
本地开发
- 克隆仓库
git clone https://github.com/your-username/mxmweb.git
cd mxmweb/apps/init- 安装依赖
pnpm install- 启动开发服务器
pnpm dev 启动全部工程
pnpm --filter @mxmweb/fileviewer dev 启动指定开发工程构建
pnpm build代码规范
- 使用 TypeScript 编写代码
- 遵循 ESLint 和 Prettier 配置
- 使用 EditorConfig 保持一致的代码风格
- 编写清晰的提交信息，遵循 Conventional Commits
提交规范
提交信息应该遵循以下格式：
<type>(<scope>): <subject>
<body>
<footer>类型（type）：
- feat: 新功能
- fix: 修复
- docs: 文档
- style: 格式
- refactor: 重构
- test: 测试
- chore: 构建过程或辅助工具的变动
发布流程
- 确保代码已经提交并推送到 main 分支
- 运行发布命令：
pnpm release- 或者使用预发布测试：
pnpm release:dryGitHub Actions 配置
在 GitHub 仓库设置中添加以下 Secrets：
NPM_TOKEN: npm 发布令牌GITHUB_TOKEN: GitHub 令牌（自动提供）
确保仓库设置中启用了 Actions：
- 进入仓库的 Settings > Actions > General
- 在 "Actions permissions" 中选择 "Allow all actions and reusable workflows"
推送代码到 main 分支，Actions 将自动运行：
- 安装依赖
- 构建项目
- 运行测试
- 发布到 npm
- 创建 GitHub Release
- 更新 CHANGELOG.md
目录结构
src/
├── application/ # 应用入口
├── components/ # UI 组件
├── hooks/ # React Hooks
├── utils/ # 工具函数
└── types/ # 类型定义贡献指南
欢迎提交 Pull Request 或创建 Issue。在提交代码前，请确保：
- 代码符合项目规范
- 添加了必要的测试
- 更新了相关文档
- 提交信息符合规范
许可证
MIT