Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/open-southeners/phpunit-todo-markdown-printer

Print your failed tests as a to do list in Markdown format
https://github.com/open-southeners/phpunit-todo-markdown-printer

Last synced: 2 days ago
JSON representation

Print your failed tests as a to do list in Markdown format

Host: GitHub
URL: https://github.com/open-southeners/phpunit-todo-markdown-printer
Owner: open-southeners
License: mit
Created: 2022-12-20T12:38:50.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2022-12-21T13:31:02.000Z (almost 2 years ago)
Last Synced: 2024-09-21T10:04:54.893Z (6 days ago)
Language: PHP
Size: 16.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        # PHPUnit ToDo Markdown Printer

Print your failed tests as a to do list in Markdown format

## Status

[![latest tag](https://img.shields.io/github/v/tag/open-southeners/phpunit-todo-markdown-printer?label=latest&sort=semver)](https://github.com/open-southeners/phpunit-todo-markdown-printer/releases/latest) [![packagist version](https://img.shields.io/packagist/v/open-southeners/phpunit-todo-markdown-printer)](https://packagist.org/packages/open-southeners/phpunit-todo-markdown-printer) [![required php version](https://img.shields.io/packagist/php-v/open-southeners/phpunit-todo-markdown-printer)](https://www.php.net/supported-versions.php) [![phpstan](https://github.com/open-southeners/phpunit-todo-markdown-printer/actions/workflows/phpstan.yml/badge.svg)](https://github.com/open-southeners/phpunit-todo-markdown-printer/actions/workflows/phpstan.yml) [![Laravel Pint](https://img.shields.io/badge/code%20style-pint-orange?logo=laravel)](https://github.com/open-southeners/phpunit-todo-markdown-printer/actions/workflows/pint.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/ef6857df707f469ca808719b833ebe74)](https://www.codacy.com/gh/open-southeners/phpunit-todo-markdown-printer/dashboard?utm_source=github.com&utm_medium=referral&utm_content=open-southeners/phpunit-todo-markdown-printer&utm_campaign=Badge_Grade) [![Edit on VSCode online](https://img.shields.io/badge/vscode-edit%20online-blue?logo=visualstudiocode)](https://vscode.dev/github/open-southeners/phpunit-todo-markdown-printer)

## Getting started

```bash

composer require open-southeners/phpunit-todo-markdown-printer

```

### Configuration

Add the following to your `phpunit.xml`:

```xml

  

    

      

        todo_failed_tests.md

        true

        true

        true

      

    

  

```

And that's all you need to do, from now on your `todo_failed_tests.md` will have the markdown similar as the one below.

## Example output

### Code

````markdown

# Failed tests

A summary of tests that failed. **Total of 1 failed within 1 files**.

## CommentControllerTest

- [ ] test_that_fails_mostly

```

Call to a member function getKey() on null

at /Users/my_user/Projects/my_project/app/Notifications/Notification.php:34

----------

#0 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestCase.php(904): PHPUnit\Framework\TestResult->run(Object(Tests\Integration\Http\Controllers\Api\CommentControllerTest))

#1 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestCase->run(Object(PHPUnit\Framework\TestResult))

#2 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))

#3 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))

#4 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/TestRunner.php(661): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))

#5 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(144): PHPUnit\TextUI\TestRunner->run(Object(PHPUnit\Framework\TestSuite), Array, Array, true)

#6 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(97): PHPUnit\TextUI\Command->run(Array, true)

#7 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/phpunit(98): PHPUnit\TextUI\Command::main()

#8 {main}

```

````

### Preview

# Failed tests

A summary of tests that failed. **Total of 1 failed within 1 files**.

## CommentControllerTest

- [ ] test_that_fails_mostly

```

Call to a member function getKey() on null

at /Users/my_user/Projects/my_project/app/Notifications/Notification.php:34

----------

#0 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestCase.php(904): PHPUnit\Framework\TestResult->run(Object(Tests\Integration\Http\Controllers\Api\CommentControllerTest))

#1 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestCase->run(Object(PHPUnit\Framework\TestResult))

#2 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))

#3 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/Framework/TestSuite.php(675): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))

#4 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/TestRunner.php(661): PHPUnit\Framework\TestSuite->run(Object(PHPUnit\Framework\TestResult))

#5 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(144): PHPUnit\TextUI\TestRunner->run(Object(PHPUnit\Framework\TestSuite), Array, Array, true)

#6 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/src/TextUI/Command.php(97): PHPUnit\TextUI\Command->run(Array, true)

#7 /Users/my_user/Projects/my_project/vendor/phpunit/phpunit/phpunit(98): PHPUnit\TextUI\Command::main()

#8 {main}

```