Skip to content

Commit 9f4152a

Browse files
committed
Bubbles chart: documentation
1 parent 94eb991 commit 9f4152a

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

.phpmetrics.yml.dist

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,6 @@ default:
1515
html: ./log/phpmetrics.html
1616
csv: ./log/phpmetrics.csv
1717
violations:
18-
xml: ./log/violations.xml
18+
xml: ./log/violations.xml
19+
chart:
20+
bubbles: ./log/bubbles.svg

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ The file should be a valid yaml file. For example:
107107
csv: ./log/phpmetrics.csv
108108
violations:
109109
xml: ./log/violations.xml
110+
chart:
111+
bubbles: ./log/bubbles.svg
110112

111113
# condition of failure
112114
failure: average.maintenabilityIndex < 50 or sum.loc > 10000

src/Hal/Application/Command/RunMetricsCommand.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ protected function configure()
6464
'report-json', null, InputOption::VALUE_REQUIRED, 'Path to save detailed report in JSON format. Example: /tmp/report.json'
6565
)
6666
->addOption(
67-
'chart-bubbles', null, InputOption::VALUE_REQUIRED, 'Path to save Bubbles chart, in SVG format. Example: /tmp/chart.svg'
67+
'chart-bubbles', null, InputOption::VALUE_REQUIRED, 'Path to save Bubbles chart, in SVG format. Example: /tmp/chart.svg. Graphviz **IS** required'
6868
)
6969
->addOption(
7070
'level', null, InputOption::VALUE_REQUIRED, 'Depth of summary report', 0

0 commit comments

Comments
 (0)