Merge pull request #103 from googleinterns/jsdoc-infra

JSDoc Infrastructure

README.md

@@ -125,6 +125,17 @@ The Jest testing framework was installed as a dependency. From the command line,
 ### Backend:
 JUnit and Maven is used to run backend testing, following the same structure as Week 5 of the Google STEP Internship.
 
+## Generating JSDoc
+JSDoc 3 is used to generate documentation for all JS source code for this
+project. To generate the docs for this project, run (from anywhere inside the
+project directory):
+```
+npm run docs
+```
+The generated documentation will live in the directory `frontend/docs`.
+The configuration rules for the JSDoc generation are specified in
+`/frontend/.jsdoc.conf.json`.
+
 ## Running Locally
 First, ensure that you have installed and are using Node 10!
 ```

frontend/.gitignore

@@ -21,3 +21,6 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+# generated JSDoc
+/docs

frontend/.jsdoc.conf.json

@@ -0,0 +1,22 @@
+{
+  "plugins": ["plugins/markdown"],
+  "recurseDepth": 10,
+  "opts": {
+    "recurse": true,
+    "destination": "./docs/"
+  },
+  "source": {
+    "include": ["src"],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "excludePattern": "node_modules"
+  },
+  "sourceType": "module",
+  "tags": {
+    "allowUnknownTags": true,
+    "dictionaries": ["jsdoc", "closure"]
+  },
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false
+  }
+}

frontend/package.json

@@ -24,7 +24,8 @@
     "local": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test",
-    "eject": "react-scripts eject"
+    "eject": "react-scripts eject",
+    "docs": "./node_modules/.bin/jsdoc src -r -c ./.jsdoc.conf.json -d docs"
   },
   "engines": {
     "node": "10.x.x"
@@ -44,5 +45,8 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
+  },
+  "devDependencies": {
+    "jsdoc": "~3.6.5"
   }
 }