Doc sweep (#827)

* Makes a few classes private that shouldn't have been exposed

* removing jsdoc async and await

* Addressing PR feedback

* Updating package lock

.gitignore

@@ -7,3 +7,4 @@ packages/**/LICENSE
 temp
 tmp-*
 !packages/workbox-cli/test/static/example-project-1/node_modules
+docs

jsdoc.conf

@@ -0,0 +1,11 @@
+{
+  "source": {
+    "include": [
+      "packages"
+    ],
+    "excludePattern": "((^|\\/|\\\\)build(\\/|\\\\)|(^|\\/|\\\\)test(\\/|\\\\)|(^|\\/|\\\\)node_modules(\\/|\\\\)|(^|\\/|\\\\)demo(\\/|\\\\))"
+  },
+  "opts": {
+    "recurse": true
+  }
+}

package.json

@@ -4,7 +4,8 @@
     "node": ">=6.0.0"
   },
   "scripts": {
-    "local-lerna": "lerna"
+    "local-lerna": "lerna",
+    "docs": "rm -rf ./docs/ && jsdoc --version && jsdoc -c jsdoc.conf -d ./docs/"
   },
   "version": "0.0.0",
   "description": "Top-level scripts and dependencies for the workbox monorepo. Not meant to be published to npm.",
@@ -47,6 +48,7 @@
     "gulp-rename": "^1.2.2",
     "gulp-spawn-mocha": "^3.1.0",
     "handlebars": "^4.0.6",
+    "jsdoc": "^3.5.5",
     "jsdoc-strip-async-await": "^0.1.0",
     "lerna": "2.0.0-rc.5",
     "minimist": "^1.2.0",

packages/workbox-build/src/lib/utils/modify-url-prefix-transform.js

@@ -8,6 +8,7 @@ const errors = require('../errors');
  *
  * From https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
  *
+ * @private
  * @param  {string} string The string to be used as part of a regular
  *                         expression
  * @return {string}        A string that is safe to use in a regular

packages/workbox-build/src/lib/utils/runtime-caching-converter.js

@@ -5,7 +5,7 @@ const errors = require('../errors');
 /**
  * Given a set of options that configures `sw-toolbox`'s behavior, convert it
  * into a string that would configure equivalent `workbox-sw` behavior.
- *
+ * @private
  * @param {Object} options See
  *        https://googlechrome.github.io/sw-toolbox/api.html#options
  * @return {String} A JSON string representing the equivalent options.

packages/workbox-build/test/node/utils-runtime-caching-converter.js

@@ -10,6 +10,7 @@ const expect = chai.expect;
 /**
  * Validates the method calls for a given set of runtimeCachingOptions.
  *
+ * @private
  * @param {Array<Object>} runtimeCachingOptions
  * @param {Array<String>} convertedOptions
  */

packages/workbox-cli/src/index.js

@@ -36,6 +36,7 @@ const askForExtensionsToCache =
 /**
  * This class is a wrapper to make test easier. This is used by
  * ./bin/index.js to pass in the args when the CLI is used.
+ * @private
  */
 class SWCli {
   /**