Update to fix esdoc support using esdoc-standard-plugin format.

mrsteele · Jun 21, 2018 · 99c000c · 99c000c
1 parent c14a5ae
commit 99c000c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 9 deletions.
diff --git a/config/doc.json b/config/doc.json
@@ -1,8 +1,13 @@
 {
  "source": "./src",
  "destination": "./docs",
- "test": {
- "type": "mocha",
- "source": "./test"
- }
+ "plugins": [{
+ "name": "esdoc-standard-plugin",
+ "option": {
+ "test": {
+ "type": "mocha",
+ "source": "./test"
+ }
+ }
+ }]
 }
diff --git a/package.json b/package.json
@@ -52,6 +52,7 @@
  "babel-register": "^6.26.0",
  "chai": "^4.1.2",
  "esdoc": "^1.0.4",
+ "esdoc-standard-plugin": "^1.0.0",
  "husky": "^0.14.3",
  "mocha": "^5.0.1",
  "nyc": "^12.0.1",

diff --git a/src/index.js b/src/index.js
@@ -7,9 +7,9 @@ class Dotenv {
  * The dotenv-webpack plugin.
  * @param {Object} options - The parameters.
  * @param {String} [options.path=./.env] - The location of the environment variable.
- * @param {Bool|String} [options.safe=false] - If false ignore safe-mode, if true load `'./.env.example'`, if a string load that file as the sample.
- * @param {Bool} [options.systemvars=false] - If true, load system environment variables.
- * @param {Bool} [options.silent=false] - If true, suppress warnings, if false, display warnings.
+ * @param {Boolean|String} [options.safe=false] - If false ignore safe-mode, if true load `'./.env.example'`, if a string load that file as the sample.
+ * @param {Boolean} [options.systemvars=false] - If true, load system environment variables.
+ * @param {Boolean} [options.silent=false] - If true, suppress warnings, if false, display warnings.
  * @returns {webpack.DefinePlugin}
  */
  constructor ({
@@ -65,7 +65,7 @@ class Dotenv {
  /**
  * Load and parses a file.
  * @param {String} file - The file to load.
- * @param {Bool} silent - If true, suppress warnings, if false, display warnings.
+ * @param {Boolean} silent - If true, suppress warnings, if false, display warnings.
  * @returns {Object}
  */
  loadFile (file, silent) {
@@ -80,7 +80,7 @@ class Dotenv {
  /**
  * Displays a console message if 'silent' is falsey
  * @param {String} msg - The message.
- * @param {Bool} silent - If true, display the message, if false, suppress the message.
+ * @param {Boolean} silent - If true, display the message, if false, suppress the message.
  */
  warn (msg, silent) {
  !silent && console.warn(msg)