用途
indexion-plan-solid 用于生成"固化(solidification)计划",即在多个目录之间识别公共代码,并规划将其抽取为共享包。它属于代码重构与整合类工具,而非单目录内部的重复清理。
适用时机:
- 用户希望把共享代码提取到一个公共包中;
- 用户询问"这些目录之间有哪些重复代码?";
- 计划从多个包中抽取共享库;
- 用户希望合并相似的实现。
与 plan refactor 的区别
- plan refactor:作用域为单个或多个目录(查找内部重复),目标是在同一代码库内整合,输入为 <path>。
- plan solid:作用域为跨目录(查找指定目录之间的重叠),目标是把共享代码抽取为新包,输入为 --from=dirA,dirB(多个源目录)。
官方建议先使用 plan refactor 清理每一个目录,然后再用 plan solid 找出跨目录的抽取候选。
使用方式
基本调用:
# 从多个源目录中提取公共代码
indexion plan solid --from=src/a,src/b
# 指定抽取的目标目录
indexion plan solid --from=src/a,src/b --to=src/common
# 使用规则文件
indexion plan solid --from=src/a,src/b --rules=.solidrc
# 内联规则
indexion plan solid --from=src/a,src/b --rule="ignore:*_test.mbt"
# 更严格的匹配阈值
indexion plan solid --from=src/a,src/b --threshold=0.95
# 使用树编辑距离进行精确的函数级匹配
indexion plan solid --from=src/a,src/b --strategy=apted
# GitHub Issue 格式输出
indexion plan solid --from=src/a,src/b --format=github-issue
# 过滤文件
indexion plan solid --from=src/a,src/b --include='*.mbt' --exclude='*_test.mbt'
# 输出到文件
indexion plan solid --from=src/a,src/b -o=solid-plan.md
可用选项
- --from=DIRS:源目录(逗号分隔或可重复指定),必填。
- --to=DIR:抽取的目标目录,默认无。
- --rules=FILE:规则文件(.solidrc),默认无。
- --rule=RULE:内联规则,可重复,默认无。
- --threshold=FLOAT:最小相似度阈值,默认 0.9。
- --strategy=NAME:相似度策略,可选 tfidf、apted、tsed,默认 tfidf。
- --include=PATTERN:包含模式,可重复,默认无。
- --exclude=PATTERN:排除模式,可重复,默认无。
- --format=FORMAT:输出格式,可选 md、json、github-issue,默认 md。
- -o, --output=FILE:输出文件路径,默认 stdout。
- --specs-dir=DIR:KGF specs 目录,默认 kgfs。
工作流程
- 确定疑似存在重复逻辑的目录;
- 运行 indexion plan solid --from=dirA,dirB 获取固化计划;
- 审阅识别出的公共代码候选;
- 按计划的建议抽取共享代码;
- 使用 indexion grep "TypeIdent:SharedType" 验证所有引用都已更新。
实践经验(Dogfooding Lessons)
- 先分别对每个目录运行 plan refactor,清理内部重复,然后再跨目录运行 plan solid,以获得更干净的跨目录结果。
- --from 标志既接受逗号分隔的目录,也可重复指定:--from=src/a --from=src/b 等价于 --from=src/a,src/b。
限制
除上述命令、选项与工作流信息外,资料未提供其它功能、平台、收费、价格或效果方面的说明。