installed typedoc

Author: nmwenz90

package.json

@@ -62,7 +62,7 @@
     "@babel/preset-react": "^7.10.4",
     "@types/chrome": "^0.0.119",
     "@types/jest": "^26.0.4",
-    "@types/node": "^12.12.50",
+    "@types/node": "^14.0.23",
     "babel-loader": "^8.1.0",
     "core-js": "^3.6.5",
     "css-loader": "^3.6.0",
@@ -78,6 +78,7 @@
     "express": "^4.17.1",
     "jest": "^26.1.0",
     "jest-cli": "^26.1.0",
+    "jest-diff": "^26.1.0",
     "jest-puppeteer": "^4.4.0",
     "jest-runner-eslint": "^0.7.7",
     "node-sass": "^4.14.1",
@@ -88,6 +89,8 @@
     "style-loader": "^0.23.1",
     "ts-jest": "^26.1.1",
     "ts-loader": "^7.0.5",
+    "typedoc": "^0.17.8",
+    "typedoc-webpack-plugin": "^1.1.4",
     "typescript": "^3.9.6",
     "webpack": "^4.43.0",
     "webpack-chrome-extension-reloader": "^1.3.0",

src/backend/index.js

@@ -38,12 +38,12 @@ import 'core-js';
 // const componentActionsRecord = require('./masterState');
 import acorn from 'acorn'; // javascript parser
 import jsx from 'acorn-jsx';
-import Tree from './tree.ts';
+import Tree from './tree';
 import componentActionsRecord from './masterState';
 
 import { throttle, getHooksNames } from './helpers';
 
-let doWork: boolean = true;
+let doWork = true;
 const circularComponentTable = new Set();
 
 // module.exports = (snap, mode) => {
@@ -117,7 +117,7 @@ export default (snap, mode) => {
     } = currentFiber;
 
     let newState = null;
-    let componentData = {};
+    let componentData: any= {};
     let componentFound = false;
 
     // Check if node is a stateful setState component

src/backend/linkFiber.ts

@@ -1,2 +1,4 @@
 declare module 'core-js';
-declare module 'regenerator-runtime/runtime';
+declare module 'regenerator-runtime/runtime';
+declare module 'acorn-jsx'
+declare module 'acorn'

src/backend/module.d.ts

@@ -6,20 +6,35 @@ import 'core-js';
 // import * as reactWorkTags from './reactWorkTags';
 
 const Flatted = require('flatted');
-
+/**
+ * @var copyInstances : Number of copies of Instances
+ */
 let copyInstances: number = 0;
 const circularComponentTable = new Set<Tree> ();
-
-// removes unserializable state data such as functions
+/**
+ * @function scrubUnserializableMembers : Removes unserializable state data such as functions
+ */
+// 
 function scrubUnserializableMembers(tree: Tree): Tree {
   Object.entries(tree.state).forEach(keyValuePair => {
     if (typeof keyValuePair[1] === 'function') tree.state[keyValuePair[0]] = 'function';
   });
   return tree;
 }
 
-// this is the current snapshot that is being sent to the snapshots array.
+/**
+ * 
+ * This is the current snapshot that is being sent to the snapshots array.
+ * 
+ */
 class Tree {
+  /**
+   * Create a Tree
+   * @param state : the tree's current state
+   * @param name : the tree's name
+   * @param componentData : Data in the component tree
+   * @parent generates a new tree (recursive call)
+   */
   state: string | {};
   name: string;
   componentData: {};
@@ -32,23 +47,43 @@ class Tree {
     this.children = [];
     this.parent = null; // ref to parent so we can add siblings
   }
-
+  /**
+   * 
+   * @function addChild : Pushes a new child tree in the children array
+   * 
+   */
   addChild(state: string | {} , name: string, componentData: {}): Tree {
+    /**
+     * @var newChild creates a new Child Tree
+     */
     const newChild: Tree = new Tree(state, name, componentData);
     newChild.parent = this;
     this.children.push(newChild);
     return newChild;
   }
-
+  /**
+   * 
+   * @function addSibling : Adds a sibing to the current tree
+   * 
+   */
   addSibling(state: string | {} , name: string, componentData: {}): Tree {
+    /**
+     * @var newSibling: creates a new Sibling Tree
+     */
     const newSibling: Tree = new Tree(state, name, componentData);
     newSibling.parent = this.parent;
     this.parent.children.push(newSibling);
     return newSibling;
   }
-
+  /**
+   * @function cleanTreeCopy : Adds a sibing to the current tree
+   */
   cleanTreeCopy(): Tree {
-    // Clear circular component table only on first call, not recursive ones
+    /**
+     * @object circularComponentTable : Clears circular component table only on first call, not recursive ones
+     * @
+     */
+    // 
     if (copyInstances === 0) {
       copyInstances++;
       circularComponentTable.clear();

src/backend/tree.ts

@@ -5,7 +5,19 @@
     "target": "es5",
     "jsx": "react",
     "allowJs": true,
+    "typeRoots": [
+      "./node_modules/@types"
+    ],
     "types": ["chrome", "jest", "node"],
-    "esModuleInterop": true
-  }
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["./src/app", "./src/backend", "./src/extension"],
+  "exclude": ["./src/app/__tests__", "./src/backend/__tests__"],
+  "typeDocOptions": {
+    "mode": "modules",
+    "out": "docs"
+  },
 }

tsconfig.json

@@ -1,5 +1,7 @@
 const path = require('path');
 const ChromeExtensionReloader = require('webpack-chrome-extension-reloader'); // enable hot reloading while developing a chrome extension
+const TypedocWebpackPlugin = require('typedoc-webpack-plugin');
+
 
 const config = {
   // use a "multi-main entry" to inject multiple dependent files together and graph their dependencies into one "chunk"
@@ -62,7 +64,15 @@ const config = {
       },
     ],
   },
-  plugins: [],
+  plugins: [
+    new TypedocWebpackPlugin({
+      name: 'Contoso',
+      mode: 'file',
+      theme: './typedoc-theme/',
+      includeDeclarations: false,
+      ignoreCompilerErrors: true,
+    }),
+  ],
 };
 
 module.exports = (env, argv) => {