{"id":15022848,"url":"https://github.com/chippyash/testdox-converter","last_synced_at":"2025-10-30T11:43:35.153Z","repository":{"id":24265657,"uuid":"27659697","full_name":"chippyash/Testdox-Converter","owner":"chippyash","description":"Testdox html to Markdown conversion utility.","archived":false,"fork":false,"pushed_at":"2018-02-07T23:17:19.000Z","size":23,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-03T07:40:53.572Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chippyash.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-07T04:49:17.000Z","updated_at":"2018-08-13T07:52:39.000Z","dependencies_parsed_at":"2022-06-30T00:02:44.974Z","dependency_job_id":null,"html_url":"https://github.com/chippyash/Testdox-Converter","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chippyash%2FTestdox-Converter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chippyash%2FTestdox-Converter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chippyash%2FTestdox-Converter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chippyash%2FTestdox-Converter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chippyash","download_url":"https://codeload.github.com/chippyash/Testdox-Converter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222818719,"owners_count":17042228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T19:58:27.067Z","updated_at":"2025-10-30T11:43:30.098Z","avatar_url":"https://github.com/chippyash.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chippyash/testdox-converter\n\n\n## What?\n\nTestdox html to Markdown conversion utility. A Utility that will convert\nTestdox formatted html output from PHPUnit into Markdown format\n\n## Why?\n\nTo provide markdown formatted test contract files for inclusion in public files\nfor a PHP library or application.\n\nSee [the Monad library test contract](https://github.com/chippyash/Monad/blob/master/docs/Test-Contract.md) as an example\n\n## When\n\nAdditions to the utility are time dependent.\n\nIf you want more, either suggest it, or better still, fork it and provide a pull request.\n\nCheck out [ZF4 Packages](http://zf4.biz/packages?utm_source=github\u0026utm_medium=web\u0026utm_campaign=blinks\u0026utm_content=testdoxconverter) for more packages\n\n## How\n\nInstall the package: See below.\n\nAssuming that you have installed into your home directory at ~/tdconv, then the\ncommand is available at ~/tdconv/bin/tdconv.\n\nUsage:\ntdconv [-t|title=\"...\"] sourceHtmlTestDoxFile targetMarkdownTestContractFile\n\ne.g.\n~/tdconv/bin/tdconv -t \"This is the title\" myLibTest.html contract.md\n\nTo create the testdox file, you would run phpunit with the --testdox-html option\n\nThis is a typical build script by way of example: build.sh\n\n\u003cpre\u003e\n#!/bin/bash\ncd ~/Projects/chippyash/source/Monad\nvendor/phpunit/phpunit/phpunit -c test/phpunit.xml --testdox-html contract.html test/\ntdconv -t \"Chippyash Monad\" contract.html docs/Test-Contract.md\nrm contract.html\n\u003c/pre\u003e\n\n### Changing the library\n\n1.  fork it\n2.  write the test\n3.  amend it\n4.  do a pull request\n\nFound a bug you can't figure out?\n\n1.  fork it\n2.  write the test\n3.  do a pull request\n\nNB. Make sure you rebase to HEAD before your pull request\n\n## Where?\n\nThe library is hosted at [Github](https://github.com/chippyash/Testdox-Converter). It is\navailable at [Packagist.org](https://packagist.org/packages/chippyash/testdox-converter)\n\n### Installation\n\nCaveat: These instructions assume a Linux OS. (If you are a Windows/Mac user, \nplease consider adding installation and usage instructions to this repo by way \nof a pull request.)\n\nInstall [Composer](https://getcomposer.org/)\n\nInstall the PHP XSL extension e.g. For debian based Linux\n\u003cpre\u003e\n    apt-get install php5-xsl\n\u003c/pre\u003e\n\nPHP normally has the XML extension built-in, but you may need to install it manually.\n\n#### For production\n\nAssumes Linux OS. (If you are a Windows/Mac user, please consider adding installation\nand usage instructions to this repo by way of a pull request.)\n\ncomposer.phar create-project -sdev chippyash/testdox-converter tdconv\n\nThis will download the package and install it into the ./tdconv directory. \n./tdconv/bin/tdconv is a symlink to the executable.  If you have a ~/bin directory\nin you path you might want to move or copy the link to it, or add the bin path\nto your $PATH variable.\n\nIf prompted with a \"Do you want to remove the existing VCS (.git, .svn..) history?\"\nmessage, then answer \"Y\" (the default answer.)\n\n#### For development\n\nClone this repo, and then run Composer in local repo root to pull in dependencies\n\n\u003cpre\u003e\n    git clone git@github.com:chippyash/Testdox-Converter.git TDConv\n    cd TDConv\n    composer install\n\u003c/pre\u003e\n\n### History\n\nV1.0.0 Initial release\n\nV1.0.1 Doc update\n\nV1.0.2 update composer - forced by packagist composer.json format change\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchippyash%2Ftestdox-converter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchippyash%2Ftestdox-converter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchippyash%2Ftestdox-converter/lists"}