Code Analyzer README

Code Analyzer is an extension for Visual Studio Code that provides a statistical analysis tool for git repositories. It allows developers to directly analyze their source code from the IDE. The analysis is performed on a git repository specified by the user and can target a specific branch. This tool leverages the power of gitinspector, a statistical analysis tool for git repositories, to generate insightful reports.

The default analysis shows general statistics per author, which can be complemented with a timeline analysis that shows the workload and activity of each author. Under normal operation, it filters the results to only show statistics about a number of given extensions and by default only includes source files in the statistical analysis.

Features

• Source code analysis directly within the Visual Studio Code IDE.
• Supports both public and private git repositories.
• Generates HTML reports with the results of the analysis.
• Allows branch selection for analysis.
• The analysis reports are saved in the code-analyzer-report directory within the current workspace.
• Shows cumulative work by each author in the history.
• Filters results by extension (default: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql).
• Can display a statistical timeline analysis.
• Scans for all filetypes (by extension) found in the repository.
• Multi-threaded; uses multiple instances of git to speed up analysis when possible.
• Supports HTML, JSON, XML and plain text output (console).
• Can report violations of different code metrics.

Usage

Once installed, a new status bar item saying "$(play) Run Code Analyzer" will appear in VSCode. By clicking on this item, the analysis process is initiated.

To run an analysis, follow the steps below:

1. Click on the status bar item "$(play) Run Code Analyzer".
2. If the repository is private, you will be prompted to enter a valid access token.
3. Select the git repository branch you wish to analyze.
4. Wait for the analysis to complete.

Upon completion, an HTML report with the results will be generated. This report is saved in the code-analyzer-report directory at the root of your current workspace and is automatically opened in your default browser.

If you encounter any issues or have any suggestions, please feel free to open an issue on our GitHub.

Acknowledgements

I would like to express my deep gratitude to José Bocanegra for his invaluable mentoring, guidance, and support as the advisor for this graduation project. His expertise and dedication have been instrumental in the success of this project.

Thanks to the gitinspector project, which this extension leverages to generate analysis reports.