You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# vue-component-analyzer
2
2
3
-
This tool can Analyze dependency tree for Vue.js SFC (Single File Component).
3
+
This tool can Analyze dependency tree for Vue.js SFC (Single File Component). You can see [GitHub Pages](https://tkskto.github.io/vue-component-analyzer/dist/) for a demo.
4
4
5
5
Also, you can see Props of Component.
6
6
@@ -12,9 +12,9 @@ or you can see simple text pattern.
12
12
13
13
## Why?
14
14
15
-
When you try to change the behavior of components, it will help you to investigate the influence range. Because it is hard to know where the component is used.
15
+
When you try to change the behavior of components, it is hard to know where the component is used.
16
16
17
-
When you join a new big project using Vue.js, it will help you to understand dependencies.
17
+
When you join a new big project using Vue.js, it is hard to understand dependencies.
18
18
19
19
## installation and usage
20
20
@@ -32,18 +32,19 @@ Then put command on npm scripts.
32
32
}
33
33
```
34
34
35
-
Or you can use npx(after npm install):
35
+
Or you can use npm exec(after npm install):
36
36
37
37
```
38
-
npx vca --dir pages
38
+
npm exec vca -- --dir .
39
39
```
40
40
41
41
### CLI Options
42
42
43
-
-`--dir` : analyze target directory. default is `src`.
44
-
-`-f` or `--format` : report type. choose one from [browser | json | both]. default is `browser`.
45
-
-`-o` or `--out` : output directory. JSON file will output here.
46
-
-`-p` or `--port` : select a port number for the local server.
43
+
*`--dir` : analyze target directory. default is `src`. `node_modules` will be ignored by default.
44
+
*`--silent` : running without almost logs.
45
+
*`-f` or `--format` : report type. choose one from [browser | json | both]. default is `browser`.
46
+
*`-o` or `--out` : output directory. JSON file will output here.
47
+
*`-p` or `--port` : select a port number for the local server.
0 commit comments