Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/activeguild/react-component-analyzer
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.
https://github.com/activeguild/react-component-analyzer
analyze diagram react typescript visualize
Last synced: 27 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/activeguild/react-component-analyzer
- Owner: activeguild
- License: mit
- Created: 2022-01-01T18:16:31.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-01-13T14:14:36.000Z (almost 2 years ago)
- Last Synced: 2024-10-05T14:26:22.510Z (about 1 month ago)
- Topics: analyze, diagram, react, typescript, visualize
- Language: HTML
- Homepage:
- Size: 656 KB
- Stars: 22
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://hardcore-fermat-22326b.netlify.app/)
## 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](https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/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](https://github.com/PrismJS/prism/), 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
```bash
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
```js
const path = require('path')
module.exports = {
alias: [
{
find: '@',
replacement: path.resolve(__dirname, 'src'),
},
],
}
```
## Principles of conduct
Please see [the principles of conduct](https://github.com/activeguild/react-component-analyzer/blob/master/.github/CONTRIBUTING.md) when building a site.
## License
This library is licensed under the [MIT license](https://github.com/activeguild/react-component-analyzer/blob/master/LICENSE).