|
1 | 1 |
|
2 |
| -# Visualize Source Code |
| 2 | +# Source Code Visualizer |
3 | 3 |
|
4 |
| -Visualize how code is distributed among a project's files and folders |
| 4 | +Visualize the code distribution in a project. |
5 | 5 |
|
6 |
| -## Todo |
| 6 | + |
7 | 7 |
|
8 |
| -- [ ] change to better treemap lib that displays folders too |
9 |
| -- [ ] change tooltip to not overflow on right or bottom |
10 |
| -- [ ] correctly resize chart when window size changes |
| 8 | +## Applications |
11 | 9 |
|
12 |
| -## Done |
| 10 | +Applications include: |
13 | 11 |
|
14 |
| -- [X] add option to set custom source code file extensions |
15 |
| -- [x] give appropiate message if no source files found |
16 |
| -- [x] enter target path in webui |
17 |
| -- [x] Start http server and automatically update |
18 |
| -- [x] Add title, explentation, link to top of webpage |
19 |
| -- [x] try designing header w/info that won't ruin tree map |
20 |
| -- [x] automatically open browswer when ready |
| 12 | +* Visualizing code distribution for more educated development and managment plans |
| 13 | +* Helping identify needlessly complex code modules |
| 14 | +* Mapping the attack surface from a vulnerability analysis perspective |
| 15 | + |
| 16 | +## Current Features |
| 17 | + |
| 18 | +- [X] Visualize how a projects source code is distributed among files and folders |
| 19 | +- [X] Zoom, hover and drag to explore the source code map |
| 20 | +- [X] Set a custom file extension filter to only view relevant source code files |
| 21 | + |
| 22 | +## Road Map |
| 23 | + |
| 24 | +- [ ] Improve the treemap display to better show folders |
| 25 | +- [ ] Implement CSRF Tokens to mitigate possible information disclosure |
| 26 | +- [ ] Implement autocomplete in the directory input field (according to available files on computer) |
| 27 | +- [ ] Allow custom file extension filters |
0 commit comments