Table of Contents
About The Project
CodeInsights analyzes your repository and extracts insights about your code.
The goal of the project is to help developers overcome the challenge of not being able to gain a high-level overview of their codebase.
This is useful for any project, but particularly useful for large projects consisting of thousands of files, where it can be difficult to identify specific problematic areas, detect anomalies in the code, or obtain a macroscopic understanding of the codebase health.
Features
CodeInsightsJS analyzes your repository and generates metrics using built-in plugins that output raw data. You can obtain a wide range of information, including:
- Number of imports and import information, which can be used to generate the top imports
- File and line of code data to determine the largest files and functions
- Angular support, providing the number of components
- HTML analysis, giving tag information to determine the most used tags by searching for specific prefixes (e.g., if your design system component library prefix is "mat-", you can identify the top component usage in the component library)
- Ability to create custom plugins and generate any desired metrics from the code
Getting Started
Check out the docs to get started: https://www.codeinsightsjs.com/
Roadmap
- [ ] Improved Angular support for services, pipes, directives
- [ ] React support
- [ ] Vue support
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the GNU General Public License (GPL). See LICENSE.txt for more information.
Contact
Yair Cohen - @YairDev - yaircohenth@gmail.com
Project Link: https://github.com/yaircohendev/codeinsightsjs
Acknowledgments
- A special mention to harelba for providing valuable insights on architecture and contributing to the overall planning of the project.