PatternSphere
备注:韩语版本可用: README_KR.md
软件设计模式的统一知识库
版本1.0.0 -生产就绪
  
概述
PatternSphere是一个强大的命令行工具,用于搜索、浏览和探索软件设计模式。第一阶段的重点是 面向对象的再造模式(OORP) 共有8个类别的61种综合模式。
主要特点
- 快速关键字搜索:相关结果的加权现场评分(\=2.0.0(数据验证)
- 复制设置>=2.0.0(配置) - pyyaml>=6.0(支持YAML) - typer>=0.9.0(CLI框架) - rich>=13.0.0(终端格式化)
发展:
- pytest>=7.4.0
- pytest冠状病毒>=4.1.0
- 黑色>=23.0.0
- mypy >= 1.5.0
- 薄片8>=6.1.0
路线图
第一阶段(完成)✅
- OORP模式加载
- 加权评分关键字搜索
- 带有5个命令的CLI界面
- 61个带有全面标签的OORP模式
- 基于文件的存储,具有原子写入功能
- 248项综合测试
- 完整的文件
第二阶段(未来-规划在珠三角)
- PDF集成:
- PDF模式提取 - 四人帮(GoF)模式 - 企业集成模式 - 面向模式的软件体系结构(POSA) - 手动模式定义工作流程 - PDF页面链接
- 多源架构:
- 知识源抽象层 - 源插件架构 - 冲突解决 - 多个来源同时
第三阶段(未来)
- 基于嵌入的语义搜索
- 模式关系可视化
- 网络界面
- 基于代码分析的模式推荐
- 代码示例集成
第四阶段(未来)
- 用户贡献模式
- 模式比较工具
- 导出为各种格式
- IDE插件
- 协同模式策划
贡献
PatternSphere旨在实现可扩展性:
添加新模式源:
- 在中创建加载器
patternsphere/loaders/ - 机具装载机跟随
OORPLoader结构 - 添加图案
data/sources// - 在配置中注册源
添加新命令:
- 在中添加命令功能
patternsphere/cli/commands.py - 使用
@app.command()装饰器 - 遵循现有的命令模式
- 在中添加测试
tests/integration/test_cli.py
添加测试:
- 单元测试:
tests/unit/ - 集成测试:
tests/integration/ - 性能测试:
tests/performance/ - 遵循现有的测试结构
许可证
MIT许可证-有关详细信息,请参阅许可证文件
致谢
图案来源:
- OORP:Serge Demeyer、Stéphane Ducasse和Oscar Nierstrasz的《面向对象的再造模式》(2003)
技术:
支持
获取帮助:
# Main help
patternsphere --help
# Command help
patternsphere search --help
# System info
patternsphere info文档:
- 检查 CLI 参考 获取详细的命令帮助
- 查看中的测试示例
tests/目录 - 请参阅中的演示脚本
scripts/demos/:demo_sprint1.py、demo_sprint2.py、demo_siprint3.py
______________________________________________________________________
PatternSphere v1.0.0 *软件设计模式的统一知识库*
建于❤️ 遵循SOLID原则和干净的架构。
