https://github.com/brille24/markdown-formatter

A mattermost formatter for monolog
https://github.com/brille24/markdown-formatter

markdown symfony

Last synced: about 5 hours ago
JSON representation

A mattermost formatter for monolog

• Host: GitHub
• URL: https://github.com/brille24/markdown-formatter
• Owner: Brille24
• Created: 2020-06-16T08:53:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-10-13T19:39:07.000Z (over 2 years ago)
• Last Synced: 2024-12-04T01:09:55.302Z (about 2 months ago)
• Topics: markdown, symfony
• Language: PHP
• Size: 33.2 KB
• Stars: 0
• Watchers: 6
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Monolog Markdown Formatter

A formatter that prints the stack trace in markdown like so:

## :exclamation: Exception occurred here:

| Function                                 | Location                                                                   |

|------------------------------------------|----------------------------------------------------------------------------|

| MarkdownFormatterTest->testStackstrace() | markdown-formatter/vendor/phpunit/phpunit/src/Framework/TestCase.php:1545  |

| PHPUnit\Framework\TestCase->runTest()    | markdown-formatter/vendor/phpunit/phpunit/src/Framework/TestCase.php:1151  |

| PHPUnit\Framework\TestCase->runBare()    | markdown-formatter/vendor/phpunit/phpunit/src/Framework/TestResult.php:726 |

| PHPUnit\Framework\TestResult->run()      | markdown-formatter/vendor/phpunit/phpunit/src/Framework/TestCase.php:903   |

| PHPUnit\Framework\TestCase->run()        | markdown-formatter/vendor/phpunit/phpunit/src/Framework/TestSuite.php:677  |

| PHPUnit\Framework\TestSuite->run()       | markdown-formatter/vendor/phpunit/phpunit/src/Framework/TestSuite.php:677  |

| PHPUnit\Framework\TestSuite->run()       | markdown-formatter/vendor/phpunit/phpunit/src/TextUI/TestRunner.php:663    |

| PHPUnit\TextUI\TestRunner->run()         | markdown-formatter/vendor/phpunit/phpunit/src/TextUI/Command.php:143       |

| PHPUnit\TextUI\Command->run()            | markdown-formatter/vendor/phpunit/phpunit/src/TextUI/Command.php:96        |

| PHPUnit\TextUI\Command::main()           | markdown-formatter/vendor/phpunit/phpunit/phpunit:98                       |

**Context:**

```json

{

    "failed_test": "some tests failed."

}

```

## Usage

`composer require brille24/markdown-formatter`

Define the class `Brille24\MarkdownFormatter\MarkdownFormatter` as a service and use it (assuming that auto-wiring is on):

```yaml

monolog:

    type: 'service'

    id: "Brille24\\MarkdownFormatter\\MarkdownFormatter"

```

If you want to customize the base path that the location is relative to you can pass the first argument to the root of the project eg.

```yaml

service:

    Brille24\MarkdownFormatter\MarkdownFormatter:

        arguments:

            - '/some/path/to/the/project'

```