https://github.com/testomatio/php-list-tests
List & import PHP tests
https://github.com/testomatio/php-list-tests
Last synced: 8 months ago
JSON representation
List & import PHP tests
- Host: GitHub
- URL: https://github.com/testomatio/php-list-tests
- Owner: testomatio
- License: mit
- Created: 2020-08-10T19:43:07.000Z (almost 6 years ago)
- Default Branch: 0.2.x
- Last Pushed: 2025-01-22T13:57:29.000Z (over 1 year ago)
- Last Synced: 2025-08-31T12:00:35.344Z (10 months ago)
- Language: PHP
- Size: 25.4 KB
- Stars: 3
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌀 List Tests by [Testomat.io](https://testomat.io)
> List tests currently support PHP 8+, for PHP 7 look into 0.1.x branch
This CLI utility prints all tests in PHP project **without executing them**.
Easily check the number tests and get live documentation for your tests in markdown format!
> Supports PHPUnit & Codeception.
This CLI script is also used to import tests into Testomat.io application.
## Installation
```
composer require testomatio/list-tests --dev
```
## Usage
To print all tests execute `list-tests` script pointing to directory with tests:
```
php vendor/bin/list-tests test/
```
This will print output similar to this:
To print tests into a file execute command with `--markdown` option providing a filename to save info into:
```
php vendor/bin/list-tests tests --markdown test-docs.md
```
This command will save test list into "tests.md" file.
To show test list with links to corresponding files on GitHub/GitLab/BitBucket
use `PREPEND_URL` environment variable and set a base URL for tests files.
```
PREPEND_URL=https://github.com/testomatio/php-list-tests/tests php vendor/bin/list-tests tests --markdown tests.md
```
This will generate a file similar to [test-docs.md](https://github.com/testomatio/php-list-tests/blob/0.2.x/test-docs.md) in this repository.
## Import into [Testomat.io](https://testomat.io)
This script can also import tests from PHP project into the testomat.io project.
Pass in TESTOMATIO API KEY of your project to import tests:
```
TESTOMATIO={api-key} php vendor/bin/list-tests tests
```