diff --git a/ROADMAP.md b/ROADMAP.md new file mode 100644 index 0000000..3724925 --- /dev/null +++ b/ROADMAP.md @@ -0,0 +1,55 @@ +# 路线图 + +本文档记录了 MockAddress Core 项目的未来计划与发展方向。计划可能会根据社区反馈和实际需求进行调整。 + +## 短期计划(未来 3-6 个月) + +### 类型定义与文档 +- [ ] 提供 TypeScript 类型定义文件(`.d.ts`) +- [ ] 完善 API 文档与使用示例 +- [ ] 添加更多集成示例(React、Vue、原生 JS 等) + +### 代码结构优化 +- [ ] 拆分各国地址生成逻辑为独立模块,支持按需引入 +- [ ] 优化数据加载与缓存机制 +- [ ] 改进错误处理与边界情况处理 + +### 功能扩展 +- [ ] 增加更多国家/地区的地址格式支持(根据社区反馈) +- [ ] 丰富导出格式选项(Excel、TSV 等) +- [ ] 改进 MAC 工具的 OUI 数据集更新机制 + +## 中期计划(6-12 个月) + +### 开发者体验 +- [ ] 提供 npm 包发布,方便通过包管理器安装 +- [ ] 支持通过配置文件自定义地址生成规则 +- [ ] 添加更多 CI/CD 集成示例(GitHub Actions、GitLab CI 等) + +### 性能与优化 +- [ ] 优化大数据量场景下的生成性能 +- [ ] 支持 Web Workers 进行后台生成 +- [ ] 改进移动端体验 + +### 社区与生态 +- [ ] 建立插件系统,允许社区贡献自定义地址格式 +- [ ] 提供更多语言版本的文档 +- [ ] 建立社区讨论区或 Discord/Slack + +## 长期愿景 + +- 成为前端测试数据生成领域的标准工具之一 +- 建立活跃的开源社区,共同维护和改进项目 +- 与更多开发工具和测试框架集成 +- 持续关注数据隐私与合规性 + +## 如何参与 + +如果你对某个计划感兴趣,或者有新的想法,欢迎: +- 在 Issues 中讨论 +- 提交 Pull Request +- 在 Discussions 中分享你的想法 + +--- + +*最后更新:2026-03-06*