├── .gitignore
├── LICENSE
├── README.md
├── mockData
├── fiber.js
├── ticTacToe.js
├── ticTacToeFiberRoot.js
├── tinyFlameGraph.js
└── treeGraph.js
├── package-lock.json
├── package.json
├── package
├── JSONStringify.js
├── README.md
├── ReactWorkTags.js
├── compareStateAndProps.js
├── containerWrapper.js
├── createTree.js
├── deleteParent.js
├── deleteParent.test.js
├── makeTreeCreator.js
├── makeTreeCreator.test.js
├── newNode.js
├── package-lock.json
├── package.json
├── sendContentScript.js
├── treeGraphFactory.js
└── treeGraphFactory.test.js
├── src
├── app
│ ├── App.js
│ ├── components
│ │ ├── d3tree.js
│ │ ├── flameChart.js
│ │ ├── helperFunctions.js
│ │ ├── mainContainer.js
│ │ ├── playButton.js
│ │ ├── record.js
│ │ ├── stateChange.js
│ │ └── timeTravel.js
│ ├── index.html
│ └── style.scss
├── assets
│ ├── readmeDemo.gif
│ ├── rm-icon-128.png
│ ├── rm-icon-48.png
│ └── rm-icon16.png
└── extension
│ ├── backgroundScript.js
│ ├── contentScript.js
│ ├── devtools.html
│ ├── devtools.js
│ └── manifest.json
├── uml
├── devtools.plantuml
├── highLevelDiagram.plantuml
└── treeCreator.plantuml
└── webpack.config.js
/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | /dist
3 | .vscode/
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2020 OSLabs Beta
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ReactMonitor
2 | Quickly visualize React's component tree performance for improved onboarding and debugging
3 |
4 | ## What does it do
5 | By using the ReactMonitor Chrome DevTool, beginning and experienced developers alike are able to get a visual representation of an existing codebase that they are working on. Built with React, this tool will dynamically traverse the fiber root object behind the scenes, displaying state, props, render times and the type of components on the page.
6 |
7 | 
8 |
9 | ## How to install and run
10 |
11 | To be able to use the application, users can:
12 |
13 | - Download the 'ReactMonitor' Google Chrome extension from [The Chrome Web Store](https://chrome.google.com/webstore/detail/reactmonitor)
14 |
15 | - Navigate to the domain of your React application that you will be running React Monitor on
16 |
17 | - Open your Chrome Developer Tools and select React Monitor
18 |
19 | - You are now able to view state changes on your application in real time!
20 |
21 | ### Method 2: Clone this repository
22 |
23 | - in the root directory of the clone run `npm build`
24 |
25 | - in Chrome -> extensions, enable developer mode
26 |
27 | - select add new unpackaged extension
28 |
29 | - in the folder selection window, select the _dist_ folder
30 |
31 | Requirements:
32 |
33 | - reactmonitor will only search in children (depth 1) of `` for the HTML element where a React DOM is rendered only ([issue #10](https://github.com/React-Monitor-2-0/ReactMonitor/issues/10))
34 |
35 | - app to be tested needs to include React versions that use Fiber Tree (such as React 16)
36 |
37 | - app to be tested need to be in a development build of React or a Production build with React Profiler enabled
38 |
39 | ## Contributing
40 |
41 | As an open-sourced project, ReactMonitor gladly accepts help whenever possible. If you have suggestions for improvements or run into any bugs, please feel free to open a github issue after checking whether no such issue has been filed yet. When you file a github issue, please include the following information:
42 |
43 | #### Description
44 | ##### Steps to Reproduce
45 | ###### 1.
46 | ###### 2.
47 | ###### 3.
48 | ##### Expected behavior:
49 | ##### Actual behavior:
50 | ##### Reproduces how often:
51 | ##### Versions: x.x
52 | ##### Additional Information:
53 |
54 | ## Authors
55 |
56 | **Rudo Hengst:** [@RudoH](https://github.com/RudoH)\
57 | **Lia Pham:** [@lpham598](https://github.com/lpham598)\
58 | **Tommy Han:** [@simple-sifu](https://github.com/simple-sifu)
59 | **Nay:**
60 | **Philip:**
61 | **Hamoud:**
62 | **Dan:**
63 |
64 | ## License
65 |
66 | This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details
67 |
--------------------------------------------------------------------------------
/mockData/fiber.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | type: {
3 | name: "h1"
4 | },
5 | tag: 5,
6 | effectTag: 1,
7 | actualDuration: 9.00,
8 | actualStartTime: 400,
9 | memorizedProps: {},
10 | memorizedState: null,
11 | child: {
12 | type: { name: "div"},
13 | tag: 1,
14 | effectTag: 0,
15 | actualDuration: 8.00,
16 | actualStartTime: 300,
17 | memorizedProps: {},
18 | memorizedState: null,
19 | child: {
20 | type: "div",
21 | tag: 1,
22 | effectTag: 2,
23 | actualDuration: 8.00,
24 | actualStartTime: 300,
25 | memorizedProps: {},
26 | memorizedState: null,
27 | }
28 | },
29 | }
30 |
--------------------------------------------------------------------------------
/mockData/ticTacToe.js:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 |
3 | function TicTacToe() {
4 | return (
5 |