PHPackages chippyash/testdox-converter - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Testing & Quality](/categories/testing) 4. / 5. chippyash/testdox-converter ActiveLibrary[Testing & Quality](/categories/testing) chippyash/testdox-converter =========================== Converts Testdox html into Markdown format 1.0.2(8y ago)16521GPL-3.0-or-laterPHP Since Mar 22Pushed 8y ago1 watchersCompare [ Source](https://github.com/chippyash/Testdox-Converter)[ Packagist](https://packagist.org/packages/chippyash/testdox-converter)[ Docs](http://zf4.biz/packages?utm_source=packagist&utm_medium=web&utm_campaign=blinks&utm_content=testdoxconverter)[ RSS](/packages/chippyash-testdox-converter/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (1)Versions (4)Used By (1) chippyash/testdox-converter =========================== [](#chippyashtestdox-converter) What? ----- [](#what) Testdox html to Markdown conversion utility. A Utility that will convert Testdox formatted html output from PHPUnit into Markdown format Why? ---- [](#why) To provide markdown formatted test contract files for inclusion in public files for a PHP library or application. See [the Monad library test contract](https://github.com/chippyash/Monad/blob/master/docs/Test-Contract.md) as an example When ---- [](#when) Additions to the utility are time dependent. If you want more, either suggest it, or better still, fork it and provide a pull request. Check out [ZF4 Packages](http://zf4.biz/packages?utm_source=github&utm_medium=web&utm_campaign=blinks&utm_content=testdoxconverter) for more packages How --- [](#how) Install the package: See below. Assuming that you have installed into your home directory at ~/tdconv, then the command is available at ~/tdconv/bin/tdconv. Usage: tdconv \[-t|title="..."\] sourceHtmlTestDoxFile targetMarkdownTestContractFile e.g. ~/tdconv/bin/tdconv -t "This is the title" myLibTest.html contract.md To create the testdox file, you would run phpunit with the --testdox-html option This is a typical build script by way of example: 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 ``` ### Changing the library [](#changing-the-library) 1. fork it 2. write the test 3. amend it 4. do a pull request Found a bug you can't figure out? 1. fork it 2. write the test 3. do a pull request NB. Make sure you rebase to HEAD before your pull request Where? ------ [](#where) The library is hosted at [Github](https://github.com/chippyash/Testdox-Converter). It is available at [Packagist.org](https://packagist.org/packages/chippyash/testdox-converter) ### Installation [](#installation) Caveat: These instructions assume a Linux OS. (If you are a Windows/Mac user, please consider adding installation and usage instructions to this repo by way of a pull request.) Install [Composer](https://getcomposer.org/) Install the PHP XSL extension e.g. For debian based Linux ``` apt-get install php5-xsl ``` PHP normally has the XML extension built-in, but you may need to install it manually. #### For production [](#for-production) Assumes Linux OS. (If you are a Windows/Mac user, please consider adding installation and usage instructions to this repo by way of a pull request.) composer.phar create-project -sdev chippyash/testdox-converter tdconv This will download the package and install it into the ./tdconv directory. ./tdconv/bin/tdconv is a symlink to the executable. If you have a ~/bin directory in you path you might want to move or copy the link to it, or add the bin path to your $PATH variable. If prompted with a "Do you want to remove the existing VCS (.git, .svn..) history?" message, then answer "Y" (the default answer.) #### For development [](#for-development) Clone this repo, and then run Composer in local repo root to pull in dependencies ``` git clone git@github.com:chippyash/Testdox-Converter.git TDConv cd TDConv composer install ``` ### History [](#history) V1.0.0 Initial release V1.0.1 Doc update V1.0.2 update composer - forced by packagist composer.json format change ### Health Score 30 — LowBetter than 64% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity12 Limited adoption so far Community13 Small or concentrated contributor base Maturity65 Established project with proven stability Bus Factor1 Top contributor holds 71.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~343 days Total 3 Last Release 3012d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/198575568597b367c8b285de16d278018c8cf292c6c75c535270135c1eea0561?d=identicon)[chippyash](/maintainers/chippyash) --- Top Contributors [![akitson-fu](https://avatars.githubusercontent.com/u/19702356?v=4)](https://github.com/akitson-fu "akitson-fu (10 commits)")[![chippyash](https://avatars.githubusercontent.com/u/983560?v=4)](https://github.com/chippyash "chippyash (4 commits)") --- Tags phpunittestmarkdowncontracttestdox ### Embed Badge ![Health badge](/badges/chippyash-testdox-converter/health.svg) ``` [![Health](https://phpackages.com/badges/chippyash-testdox-converter/health.svg)](https://phpackages.com/packages/chippyash-testdox-converter) ``` ### Alternatives [ta-tikoma/phpunit-architecture-test Methods for testing application architecture 10745.9M13](/packages/ta-tikoma-phpunit-architecture-test)[kenjis/ci-phpunit-test An easier way to use PHPUnit with CodeIgniter 3.x 5861.2M3](/packages/kenjis-ci-phpunit-test)[php-mock/php-mock-phpunit Mock built-in PHP functions (e.g. time()) with PHPUnit. This package relies on PHP's namespace fallback policy. No further extension is needed. 1718.2M397](/packages/php-mock-php-mock-phpunit)[ergebnis/phpunit-slow-test-detector Provides facilities for detecting slow tests in phpunit/phpunit. 1468.1M72](/packages/ergebnis-phpunit-slow-test-detector)[zenstruck/assert Standalone, lightweight, framework agnostic, test assertion library. 8114.9M8](/packages/zenstruck-assert)[wp-phpunit/wp-phpunit WordPress core PHPUnit library 803.7M205](/packages/wp-phpunit-wp-phpunit) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)