Extract React components and props usage from code.
CIreact-scanner is a powerful tool designed to simplify the analysis of React components within your codebase. By scanning your TypeScript files, it extracts information about components and their props, compiling this data into an easily digestible JSON report. This process not only helps developers understand component usage but also sheds light on prop utilization, facilitating better design decisions in your React applications.
With its ability to crawl directories and generate detailed insights, CIreact-scanner is ideal for teams that want to keep track of their component libraries and ensure they are effectively utilized. Whether it’s examining how often a component is used or assessing the variety of prop values, the tool provides essential information that can drive development and maintenance efforts.
Component Usage Analysis: Quickly identifies how often each React component appears in your codebase, helping you manage your design system effectively.
Prop Utilization Tracking: Enables tracking the frequency of prop usage in components, allowing for informed decisions about potential deprecations or modifications.
JSON Reporting: Outputs findings in JSON format, making it easy to manipulate and understand the data generated during scans.
Customizable Configurations: Offers a config file to tailor the scanner to your specific requirements, ensuring flexible usage across projects.
Programmatic Execution: Allows you to run the scanner programmatically, providing the opportunity to integrate it into your existing workflows seamlessly.
Directory Crawling: Efficiently crawls specified directories, scanning all relevant files and compiling a comprehensive report of the React components found.
Value Distribution Analysis: Assesses the distribution of prop values for given components, which can guide deprecation or enhancement decisions within your application.