README

是什么？

Testdox html 到 Markdown 转换工具。一个将 PHPUnit 的 Testdox 格式化 html 输出转换为 Markdown 格式的工具

为什么？

为了提供一个 Markdown 格式的测试合同文件，以便将其包含在 PHP 库或应用程序的公共文件中。

参见 Monad 库的测试合同作为示例

何时

工具的添加依赖于时间。

如果你想要更多，要么建议，要么最好是分支它并提供一个 pull request。

查看 ZF4 Packages 了解更多包

如何

安装包：请参见以下内容。

假设你已经安装到你的家目录 ~/tdconv 中，那么命令就可用在 ~/tdconv/bin/tdconv。

用法：tdconv [-t|title="..."] 源HtmlTestDox文件目标MarkdownTestContract文件

例如：~/tdconv/bin/tdconv -t "这是标题" myLibTest.html contract.md

要创建测试 dox 文件，你需要使用 phpunit 并带上 --testdox-html 选项

这是一个典型的构建脚本示例：build.sh

#!/bin/bash
cd ~/Projects/chippyash/source/Monad
vendor/phpunit/phpunit/phpunit -c test/phpunit.xml --testdox-html contract.html test/
tdconv -t "Chippyash Monad" contract.html docs/Test-Contract.md
rm contract.html

修改库

分支它
编写测试
修改它
发起一个 pull request

发现了你无法解决的问题吗？

分支它
编写测试
发起一个 pull request

注意：在发起 pull request 之前，请确保你将代码回滚到 HEAD

在哪里？

该库托管在 Github 上。它可在 Packagist.org 上找到

安装

注意：以下说明假设使用 Linux OS。如果您是 Windows/Mac 用户，请考虑通过 pull request 向此存储库添加安装和使用说明。

安装 Composer

为 Debian 基础的 Linux 安装 PHP XSL 扩展

    apt-get install php5-xsl

PHP 通常内置 XML 扩展，但您可能需要手动安装它。

生产环境

假设使用 Linux OS。如果您是 Windows/Mac 用户，请考虑通过 pull request 向此存储库添加安装和使用说明。

composer.phar create-project -sdev chippyash/testdox-converter tdconv

这将下载包并将其安装到 ./tdconv 目录。./tdconv/bin/tdconv 是可执行文件的符号链接。如果您在路径中有一个 ~/bin 目录，您可能想要将其移动或复制到那里，或者将 bin 路径添加到您的 $PATH 变量中。

如果您收到一条 "是否要删除现有的 VCS (.git, .svn..) 历史记录？" 的消息，那么请回答 "Y"（默认答案）。

开发环境

克隆此存储库，然后在本地存储库根目录中运行 Composer 以拉取依赖项

    git clone git@github.com:chippyash/Testdox-Converter.git TDConv
    cd TDConv
    composer install

历史记录

V1.0.0 初次发布

V1.0.1 文档更新

V1.0.2 更新 composer - 由于 Packagist composer.json 格式更改而强制执行

chippyash / testdox-converter

维护者

详细信息