【问题标题】:Automatic generation of example index自动生成示例索引
【发布时间】:2018-05-29 12:21:35
【问题描述】:

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

目前我们手动编写这个索引文件,容易忘记添加新的示例文件。

有没有办法从示例文件层次结构中生成这个索引文件?

【问题讨论】:

    标签: concordion


    【解决方案1】:

    我知道有些公司已经这样做了,但目前 Concordion 项目中没有任何东西可以这样做。

    我一直在考虑的一个选项是 runAll 命令,它将运行索引的所有子项。这样的东西对你有用吗?

    我们需要考虑实际运行什么。不同的模式是:

    1) 我们只有一个应该运行所有后代的顶级索引规范。 2)我们在每个级别都有一个索引规范,应该运行兄弟和直接子索引规范。 3)也许我们在每个级别都有一个索引规范,应该运行所有直接子节点,包括索引规范。

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

    你怎么看?

    【讨论】:

      【解决方案2】:

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

      这可以通过运行命令的变体来避免

      • 采用 glob 表达式,计算结果为要运行的模块列表
      • 在报告中被替换为子模块的标题列表,装饰了它们各自执行的通过或失败状态的信息

      生成的报告等同于手写索引模块生成的报告。

      【讨论】:

      • 请您raise an issue 来解决这个问题,或者最好是带有updated spec 的拉取请求,它显示了所需行为的示例。使用 Java 7 的 FileMatcher 应该很容易实现(需要更新 Concordion 才能使用 Java 7)。
      猜你喜欢
      • 2019-05-06
      • 2011-01-05
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2011-08-24
      • 2023-03-15
      相关资源
      最近更新 更多