react-component-analyzer ⚡ Welcome 😀

Analyze the component tree of react and displays it as a diagram in the browser. You can refer to the corresponding code from the diagram.

Demo

Screenshots

Motivation

• It plays an auxiliary role in visualizing the component design during implementation and activating smooth discussions.
• It will lead to shrinking the cost of development.

Point

• Using the popular library, @typescript-eslint/typescript-estree AST to do the analysis.
• By using VSCode's schema in the Browser, you can quickly check the implementation of components you are interested in.If you do not have vscode installed, you can also check the code in your browser.
• If you are using vite without setting it in the config file, you can resolve the alias from vite.config.ts.
• It uses prismjs, which allows for code reading that is more like an IDE.

On Daiagram

• You can check the code of the component.
• Reference to VS Code allows code to be referenced in VS Code.
• New nodes can be added by double-clicking on a background other than the component.
• Links between each node can be removed by double-clicking.
• Dragging from the top and bottom of a node to another node to link to it.

Install

npm i -D react-component-analyzer

Usage

By specifying the React root file and the component files, it will parse them and output the stats.html file.

npx rca ./src/main.tsx

Config

The following options can be set in the configuration file. Prepare a rca.config.js file with the following properties.

Property	Type	Description
vscode	boolean	Use vscode schema to code jump to the target component. (default true)
alias	Array	Specify multiple aliases for entry points.
outputPath	string	Specify the absolute path of the file to be output after analysis.

alias Property

Property	Type	Description
find	String	Entry point alias.
replacement	String	Resolve aliases by specifying absolute paths.

Sample

const path = require('path')

module.exports = {
  alias: [
    {
      find: '@',
      replacement: path.resolve(__dirname, 'src'),
    },
  ],
}

Principles of conduct

Please see the principles of conduct when building a site.

License

This library is licensed under the MIT license.