自动生成示例索引

Question

一个常见的情况是在文件层次结构和顶级索引中组织示例，从而生成报告摘要。

目前我们手动编写此索引文件，因此很容易忘记添加新的示例文件。

有没有办法从示例文件层次结构生成此索引文件？

Answer 1

我知道有些公司已经这样做了，但目前Concordion项目中没有任何公司可以做到这一点。

我一直在考虑的一个选项是runAll命令，它将运行索引的所有子项。这样的事情对你有用吗？

我们需要考虑实际运行的内容。不同的模式是：

1）我们只有一个应该运行所有后代的顶级索引规范。 2）我们在每个级别都有一个索引规范，应该运行兄弟姐妹和直接子索引规范。 3）也许我们在每个级别都有一个索引规范，并且应该运行所有直接的孩子，包括索引规范。

这可能导致多个命令，例如。 runSiblings，runChildren，runChildIndexes，runDescendants。

您怎么看？

Answer 2

我认为我们不需要将新文件类型作为索引文件引入。 在当前状态下，我们有一个md文件作为规范模块，以及可以调用其他模块的run命令。 我们遇到的问题是，在使用run时，我们为每个从属模块编写一个标题和相对路径。

使用

的运行命令的变体可以避免这种情况

• 获取一个glob表达式，该表达式将计算为要运行的模块列表
• 在报告中被替换为子模块的标题列表，关于各自执行的通过或失败状态的装饰信息

结果报告将等同于手写索引模块产生的报告。