dzunke/panaly-markdown-report

A Panaly plugin that delivers the capability to generate a markdown report.

dev-main 2024-04-15 18:46 UTC

Requires

• php: ^8.2
• dzunke/panaly: dev-main

Requires (Dev)

• doctrine/coding-standard: ^12.0
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-strict-rules: ^1.5
• phpunit/phpunit: ^11.1
• symfony/var-dumper: ^7.0

MIT

• Denis Zunke

README

The plugin to the Panaly Project Analyzer delivers a markdown reporting. The rendering engine for the report is currently very basic. It prints the date of the report and all metrics that are not of type Integer just as a single line within the document. The Integers in a group are collected and printed as a table.

Example Report

# Metric Report

> [!NOTE]
> This report was generated at `2024-04-11T16:00:03+00:00`

# First Title
| Metric         | Value |
|----------------|-------|
| A Metric       | 1     |
| Another Metric | 2000  |
| Wow! A Metric  | 12    |

Example Configuration

# panaly.dist.yaml
plugins:
    DZunke\PanalyMarkdownReport\MarkdownPlugin: ~ # no options available

reporting:
    markdown:
        targetFile: my-markdown-report.md

Thanks and License

Panaly Project Analyzer - Markdown Report © 2024+, Denis Zunke. Released utilizing the MIT License.

GitHub @dzunke  ·  Twitter @DZunke