CodeCharta
a beautiful tool to help you visualize and understand code in 3D.
Key Features β’ Experimental Features β’ How To Use β’ Feedback β’ Further Info β’ About
Key Features
-
- CC visualizes code bases as 3D cities, so that you can understand it - view the Web Demo.
- It uses code metrics from
.cc.jsonfiles. - The imported files are validated using JSON Schema as defined in generatedSchema.json.
- You can change the way the file is displayed and save and later load it as a Custom View.
-
- CC Analysis is used to calculate or to import metrics from third party tools for a code base.
- It generates
.cc.jsonfiles for CC Visualization through a Command-Line-Tool. - It includes some pre-defined importers for e.g. SonarQube, SourceMonitor, Git, generic CSV data
- It also includes commands to validate and merge multiple
.cc.jsonfiles.
Experimental Features
-
In CodeCharta Visualization:
- Suspicious Metrics: Highlight files with suspicious metrics and a risk profile analysis of the code based on the cyclomatic complexity.
NOTE: You can enable them from the settings panel.
Requirements
For using CodeCharta the following needs to be installed on your system:
- Node >= 16
- Java >= 11
How To Use
How to use Visualization?
- Online: You can try the web visualization without any installation and explore the CodeCharta code (shown by default).
- Local: See here.
How to use Analysis?
- Analysis is split into different parsers that generate
.cc.jsonfiles. To run these parsers you need the CodeCharta Shell.
In this example we will generate a .cc.json from JUnit4 using the Source Code Parser (that parses java projects).
# Install codecharta-analysis globally
$ npm i -g codecharta-analysis
# Clone the junit4 repository
$ git clone https://github.com/junit-team/junit4
# Parse sources with CodeCharta Shell
$ ccsh sourcecodeparser junit4 -p junit4 -o junit4.source.cc.json
# Now you can upload `junit4.source.cc.json` to CodeCharta VisualizationNote If you want to be guided through selecting the arguments. Just execute
ccshand you can run the parsers interactively with dialogs.
Feedback
Have a bug, a feature request or any question? Please open a new issue. Feedback is always welcome.
Want to know what we are working on? Please check out our board or install the Zenhub Firefox/Chrome plugin.
Want to have even more information? Please check our news.
Further Information
About CodeCharta
License
MIT
maibornwolff.de Β Β·Β GitHub @MaibornWolff