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
- Tested extensively with C, and Python
- Using language agnostic apis provided by VS code sdk
- Removed file parsing, as implementation needs to be
as simple as possible
- Updated README.md
Copy file name to clipboardExpand all lines: README.md
+20-15Lines changed: 20 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,23 +2,24 @@
2
2
3
3
## Introduction 👨🏫
4
4
5
-
Thanks for checking out Code Visualizer! 🎉 This extension helps developers visualize their code by generating flowcharts that represent the call hierarchy of functions and methods in your codebase. It transforms the often complex structure of code into an easy-to-understand visual format, making it simpler to navigate large projects. 🗺️
5
+
Thanks for checking out Code Visualizer! 🎉 This extension helps developers visualize their code by generating a flowchart that represents the call hierarchy of functions and methods in your codebase. It transforms the often complex structure of code into an easy-to-understand visual format, making it simpler to navigate large projects. 🗺️
6
6
7
7
## Features 🌟
8
-
-**Flowchart Generation:** 📊 Right-click on any function or method, and select 'Generate Flowchart' to create a visual representation of its call hierarchy.
8
+
-**Flowchart Generation:** 📊 Right-click on any function or method, and select 'Visualize' to create a visual representation of its call hierarchy.
9
9
-**Interactive Visuals:** 🖱️ Zoom in, zoom out, and interact with the flowchart to explore different parts of your code.
10
10
-**Customizable Views:** 🎨 Tailor the flowchart to focus on specific function calls, and adjust the layout for better readability.
11
+
-**Searchable:** 🔍 Search for any function or method in the flowchart to quickly navigate to it.
11
12
-**Multi-Language Support:** 🌐 Currently supports C, C++, Python.
12
-
* At least that's the goal of the project. Contributions are welcome! 🤝
13
+
* At least that's the goal of this project. Contributions are welcome! 🤝
13
14
14
15
## How It Works 🛠️
15
16
16
-
1.Select a function in your code ✅
17
-
2.Run the "Visualize" command 🏃♂️
18
-
3. Watch as CodeFlow creates an interactive diagram of function calls 🎭
17
+
1.Install the extension from the VS Code Marketplace.
18
+
2.Right-click on any function or method, and select 'Visualize' to create a visual representation of its call hierarchy.
19
+
3. Watch as the extension creates an interactive diagram of function calls 🎭
19
20
4. Click on nodes to explore deeper into the call hierarchy 🕵️♂️
20
21
21
-
CodeFlow uses VS Code's built-in call hierarchy API, making it language-agnostic and powerful across various programming languages. 💪
22
+
Code Visualizer uses VS Code's built-in call hierarchy API, making it language-agnostic and powerful across various programming languages. 💪
22
23
23
24
## Features 🚀
24
25
@@ -28,7 +29,7 @@ CodeFlow uses VS Code's built-in call hierarchy API, making it language-agnostic
28
29
29
30
## How to Contribute 🤝
30
31
31
-
We're excited to welcome contributors to the CodeFlow project! Here's how you can get involved:
32
+
We're excited to welcome contributors to the Code Visualizer project! Here's how you can get involved:
32
33
33
34
1. Fork the repository 🍴
34
35
2. Clone your fork: `https://github.com/Ganjai-Labs/code-visualizer.git` 📥
@@ -37,26 +38,30 @@ We're excited to welcome contributors to the CodeFlow project! Here's how you ca
37
38
5. Run tests: `npm test` 🧪
38
39
6. Commit your changes: `git commit -m "Add some feature"` 💾
39
40
7. Push to the branch: `git push origin your-feature-name` 🚀
40
-
8. Submit a pull request 🙏
41
+
8. Submit a pull request with the description of your changes 🙏
41
42
42
43
Before contributing, please read our [Contributing Guidelines](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md). 📚
43
44
44
45
## Features to be Implemented 🔮
45
46
46
-
We're always looking to improve CodeFlow. Here are some features we'd love to see:
47
+
We're always looking to improve Code Visualizer. Here are some features we'd love to see:
47
48
48
49
1. Detect cycles in the generated diagrams, and highlight them in red 🔴
49
-
2. Conditional highlighting of nodes based on certain conditions 🎨
50
-
3. Export diagrams as images or SVGs 📸
50
+
2. Draw multiple connections between nodes when a function is called multiple times 🔄
51
+
52
+
3. Export diagrams as images or SVGs. Currently, the generated diargams are html files that are not viewable outside of VS Code. 📸
51
53
4. Integration with version control to show changes in call hierarchy over time 🕰️
52
54
5. Performance optimizations for large codebases ⚡
53
55
6. Enhanced filtering options for complex diagrams 🔍
54
56
57
+
### Moon shot 🌙
58
+
59
+
- Conditional highlighting of nodes based on certain conditions 🎨
60
+
- Integration with LLMs to provide more context for the generated diagrams 🤖
61
+
55
62
Feel free to tackle any of these or propose your own ideas! 💡
56
63
57
64
## Get Started 🚀
58
65
59
-
Ready to dive in? Install CodeFlow from the VS Code Marketplace and start visualizing your code today! 🎊
60
-
61
-
Join us in making code comprehension a joyful experience. Happy coding! 😊👨💻👩💻
66
+
Ready to dive in? Install Code Visualizer from the VS Code Marketplace and start visualizing your code today! 😊👨💻👩💻
0 commit comments