Skip to content

Commit 6acbe88

Browse files
author
Denis Bardadym
committed
Add flamegraph to docs
1 parent 899472c commit 6acbe88

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,10 @@ All charts refresh layout on window resize.
105105

106106
This circular hierarchical diagram can help you find huge pieces of code (aka that one huge thing). If you click on some arc it will increase its and all nested arcs size for better inspection.
107107

108+
### Flamegraph
109+
110+
This diagram is top down version of sunburst. It is used a lot by other JS developer tools and would be very familar to developers.
111+
108112
### Treemap
109113

110114
This rectangular hierarchical diagram can help you find huge pieces. Just look on biggest rectangle. But also it can help you find modules included several times, they will have the same topology and relative size. If you click on rectangle it will increase in size for further inspection.
@@ -133,7 +137,7 @@ Output yml file with all the data, could be good idea to commit this file to tra
133137

134138
`open` (boolean, default `false`) - Open generated file in default user agent
135139

136-
`template` (string, default `treemap`) - Which diagram type to use: `sunburst`, `treemap`, `network`, `raw-data`, `list`.
140+
`template` (string, default `treemap`) - Which diagram type to use: `sunburst`, `treemap`, `network`, `raw-data`, `list`, `flamegraph`.
137141

138142
`gzipSize` (boolean, default `false`) - Collect gzip size from source code and display it at chart.
139143

@@ -205,6 +209,6 @@ See CHANGELOG.md.
205209

206210
- Plugin backend (one appears in configs) are strictly follows SemVer
207211
- Plugin frontend (generated file):
208-
- `network`, `treemap`, `sunburst` can change does not matter of version (colors, texts, visual structure etc)
212+
- `network`, `treemap`, `sunburst`, `flamegraph` can change does not matter of version (colors, texts, visual structure etc)
209213
- `raw-data` format follows own `version` property
210214
- `list` follows semver

plugin/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ export interface PluginVisualizerOptions {
5858

5959
/**
6060
* Which diagram to generate. 'sunburst' or 'treemap' can help find big dependencies or if they are repeated.
61-
* 'network' can answer you why something was included
61+
* 'network' can answer you why something was included.
62+
* 'flamegraph' will be familar to tools that you know already.
6263
*
6364
* @default 'treemap'
6465
*/

0 commit comments

Comments
 (0)