Skip to content

Commit 26d732e

Browse files
fix readme types (#192)
1 parent dec8398 commit 26d732e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,15 @@ This circular hierarchical diagram can help you find huge pieces of code (aka th
9494

9595
### Treemap
9696

97-
This rectangular hierarchical diagram can help you find huge pieces. Just look on biggest reclangle. But also it can help you find modules included several times, they will have the same topology and relative size. If you click on reclangle it will increase in size for further inspection.
97+
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.
9898

9999
### Network
100100

101-
This digram should help you answer for the question 'why it is included?'. After force layout stabilize all nodes, you can move it back and forth by dragging with your mouse. Gray circles are treeshakened out files.
101+
This diagram should help you answer for the question 'why it is included?'. After force layout stabilize all nodes, you can move it back and forth by dragging with your mouse. Gray circles are treeshaken out files.
102102

103-
In real life scenarious, sometimes you will see terribly connected diagrams. There is no 100% working solution for everyone, it is expected you topology will look 'terrible' and not hold on screen. To make it still visually ispectable, first remove all highly connected nodes that you see (typical examples: commonjsHelpers, tslib, react etc, basically if tooltip for the node is not hold on the screen - exclude this node), after layout stabilization you will see, your layout is not that terrible anymore and most of dependencies cluster together. Move layout to find pieces you looked for.
103+
In real life scenarios, sometimes you will see terribly connected diagrams. There is no 100% working solution for everyone, it is expected you topology will look 'terrible' and not hold on screen. To make it still visually inspectable, first remove all highly connected nodes that you see (typical examples: commonjsHelpers, tslib, react etc, basically if tooltip for the node is not hold on the screen - exclude this node), after layout stabilization you will see, your layout is not that terrible anymore and most of dependencies cluster together. Move layout to find pieces you looked for.
104104

105-
When you click on node it will hightlight nodes that are listed in tooltip (the files that imports current node).
105+
When you click on node it will highlight nodes that are listed in tooltip (the files that imports current node).
106106

107107
### Raw-data
108108

@@ -128,7 +128,7 @@ Output yml file with all the data, could be good idea to commit this file to tra
128128

129129
### Advanced options (touch only if you really need it):
130130

131-
`emitFile` (boolean, default `false`) - Use rollup's `emitFile` to generate file. Useful if you want to control all output in one place (via rollup output options). This also could be usefull with svelte as it calls vite several times.
131+
`emitFile` (boolean, default `false`) - Use rollup's `emitFile` to generate file. Useful if you want to control all output in one place (via rollup output options). This also could be useful with svelte as it calls vite several times.
132132

133133
`sourcemap` (boolean, default `false`) - Use sourcemaps to calculate sizes (e.g. after UglifyJs or Terser). **Always add plugin as last option.**
134134

@@ -162,7 +162,7 @@ This plugin provides cli util `rollup-plugin-visualizer`. Add `--help` to check
162162
rollup-plugin-visualizer [OPTIONS] stat1.json stat2.json ../stat3.json
163163
```
164164

165-
This can be usefull in case you have different config files in the same project and you want to display all of them in the same chart.
165+
This can be useful in case you have different config files in the same project and you want to display all of them in the same chart.
166166

167167
## Build plugin
168168

0 commit comments

Comments
 (0)