README

Speculator 是一个小型自包含的 Web 服务器，用于展示软件规范及其覆盖这些规范的单元测试状态。

安装

使用 composer require gcdtech/speculator

用法

注意以下示例假设您的 bin 目录 composer 属性设置为 "bin/"。如果您的设置不同，请确保更改 speculator 的路径。

使用终端调用 speculator

bin/speculator [pathtospecs] [pathtotests] [bootstrap-php-file]

或在同一文件夹中创建一个 speculator.json 文件，例如。

{
  "specs-dir": "specs",
  "tests-dir": "tests/unit",
  "bootstrap": "tests/_bootstrap.php"
}

并以更简单的方式调用

bin/speculator

规范文档

规范文档是简单地存储在通常称为 specs 的文件夹中的 markdown 文件。

index.md 应作为根入口页面存在。

使用常规 markdown 方式在页面之间创建链接。

使用以下语法插入单元测试评估

(@Path/To/Unit/Test::testMethodName)

如果这存在于一个项目符号列表中，则项目符号样式将根据测试成功与否变为勾号或叉号。否则，将在测试标记的位置放置勾号或叉号。

扩展 markdown 语法

此项目使用 erusev/parsedown-extra 解析器进行 markdown，它提供了一系列额外的 markdown 功能。