From 80f57c8fe9cc3a48459b5e61d27cb853bffc3c06 Mon Sep 17 00:00:00 2001 From: Dhruvdutt Jadhav Date: Sat, 16 Jun 2018 19:21:19 +0530 Subject: [PATCH] docs: update jsdoc (#507) --- docs/AddGenerator.html | 6 +- docs/InitGenerator.html | 4 +- docs/LoaderGenerator.html | 4 +- docs/PluginGenerator.html | 4 +- docs/add_index.js.html | 19 +- docs/generate-loader_index.js.html | 4 +- docs/generate-plugin_index.js.html | 4 +- docs/generators_add-generator.js.html | 40 +++- docs/generators_addon-generator.js.html | 4 +- docs/generators_init-generator.js.html | 7 +- docs/generators_loader-generator.js.html | 4 +- docs/generators_plugin-generator.js.html | 4 +- docs/generators_utils_entry.js.html | 4 +- docs/generators_utils_module.js.html | 8 +- docs/generators_utils_plugins.js.html | 4 +- docs/generators_utils_tooltip.js.html | 4 +- docs/generators_utils_validate.js.html | 4 +- docs/global.html | 188 +++++++++++++++++- docs/index.html | 4 +- docs/info_index.js.html | 8 +- docs/init_index.js.html | 8 +- docs/init_init.js.html | 4 +- docs/make_index.js.html | 4 +- .../migrate_bannerPlugin_bannerPlugin.js.html | 4 +- ...xtractTextPlugin_extractTextPlugin.js.html | 4 +- docs/migrate_index.js.html | 4 +- ...rOptionsPlugin_loaderOptionsPlugin.js.html | 4 +- docs/migrate_loaders_loaders.js.html | 4 +- docs/migrate_migrate.js.html | 4 +- ...onPlugin_moduleConcatenationPlugin.js.html | 4 +- ...edModulesPlugin_namedModulesPlugin.js.html | 4 +- ...nErrorsPlugin_noEmitOnErrorsPlugin.js.html | 4 +- docs/migrate_outputPath_outputPath.js.html | 4 +- ...tedPlugins_removeDeprecatedPlugins.js.html | 4 +- ..._removeJsonLoader_removeJsonLoader.js.html | 4 +- docs/migrate_resolve_resolve.js.html | 4 +- ...rate_uglifyJsPlugin_uglifyJsPlugin.js.html | 4 +- docs/remove_index.js.html | 10 +- docs/serve_index.js.html | 4 +- docs/update_index.js.html | 10 +- docs/utils_ast-utils.js.html | 4 +- docs/utils_copy-utils.js.html | 4 +- docs/utils_defineTest.js.html | 4 +- docs/utils_is-local-path.js.html | 4 +- docs/utils_modify-config-helper.js.html | 45 ++++- docs/utils_npm-exists.js.html | 4 +- docs/utils_npm-packages-exists.js.html | 4 +- docs/utils_package-manager.js.html | 4 +- docs/utils_prop-types.js.html | 4 +- docs/utils_resolve-packages.js.html | 6 +- docs/utils_run-prettier.js.html | 4 +- docs/utils_scaffold.js.html | 4 +- 52 files changed, 376 insertions(+), 139 deletions(-) diff --git a/docs/AddGenerator.html b/docs/AddGenerator.html index e9eaa995c79..c0542bd0edf 100644 --- a/docs/AddGenerator.html +++ b/docs/AddGenerator.html @@ -93,7 +93,7 @@

new AddGe
Source:
@@ -186,13 +186,13 @@

Extends


diff --git a/docs/InitGenerator.html b/docs/InitGenerator.html index 62b1c584cfd..af12419cf2b 100644 --- a/docs/InitGenerator.html +++ b/docs/InitGenerator.html @@ -186,13 +186,13 @@

Extends


diff --git a/docs/LoaderGenerator.html b/docs/LoaderGenerator.html index 0733f3e11d6..df102497c76 100644 --- a/docs/LoaderGenerator.html +++ b/docs/LoaderGenerator.html @@ -166,13 +166,13 @@

Extends


diff --git a/docs/PluginGenerator.html b/docs/PluginGenerator.html index 7f6ac28a5f1..33f205b4a31 100644 --- a/docs/PluginGenerator.html +++ b/docs/PluginGenerator.html @@ -166,13 +166,13 @@

Extends


diff --git a/docs/add_index.js.html b/docs/add_index.js.html index 34586de947e..cf0fe74f61c 100644 --- a/docs/add_index.js.html +++ b/docs/add_index.js.html @@ -29,18 +29,25 @@

Source: add/index.js

"use strict";
 
 const defaultGenerator = require("@webpack-cli/generators/add-generator");
-const modifyHelper = require("@webpack-cli/utils/modify-config-helper");
+const modifyConfigHelper = require("@webpack-cli/utils/modify-config-helper");
 
 /**
  * Is called and returns a scaffolding instance, adding properties
  *
- * @returns {Function} modifyHelper - A helper function that uses the action
+ * @returns {Function} modifyConfigHelper - A helper function that uses the action
  * 	we're given on a generator
  *
  */
 
-module.exports = function add() {
-	return modifyHelper("add", defaultGenerator);
+module.exports = function add(...args) {
+	const DEFAULT_WEBPACK_CONFIG_FILENAME = "webpack.config.js";
+
+	const filePaths = args.slice(3);
+	let configFile = DEFAULT_WEBPACK_CONFIG_FILENAME;
+	if (filePaths.length) {
+		configFile = filePaths[0];
+	}
+	return modifyConfigHelper("add", defaultGenerator, configFile);
 };
@@ -52,13 +59,13 @@

Source: add/index.js


diff --git a/docs/generate-loader_index.js.html b/docs/generate-loader_index.js.html index c276e178f75..e1d29894801 100644 --- a/docs/generate-loader_index.js.html +++ b/docs/generate-loader_index.js.html @@ -54,13 +54,13 @@

Source: generate-loader/index.js


diff --git a/docs/generate-plugin_index.js.html b/docs/generate-plugin_index.js.html index a3f6161c41f..5a02e20261d 100644 --- a/docs/generate-plugin_index.js.html +++ b/docs/generate-plugin_index.js.html @@ -54,13 +54,13 @@

Source: generate-plugin/index.js


diff --git a/docs/generators_add-generator.js.html b/docs/generators_add-generator.js.html index 13651d0bb88..aad10e68488 100644 --- a/docs/generators_add-generator.js.html +++ b/docs/generators_add-generator.js.html @@ -29,9 +29,8 @@

Source: generators/add-generator.js

const Generator = require("yeoman-generator");
 const glob = require("glob-all");
 const path = require("path");
-const Confirm = require("@webpack-cli/webpack-scaffold").Confirm;
-const List = require("@webpack-cli/webpack-scaffold").List;
-const Input = require("@webpack-cli/webpack-scaffold").Input;
+const inquirerAutoComplete = require("inquirer-autocomplete-prompt");
+const { AutoComplete, Confirm, Input, List } = require("@webpack-cli/webpack-scaffold");
 
 const webpackSchema = require("./utils/optionsSchema.json");
 const webpackDevServerSchema = require("webpack-dev-server/lib/optionsSchema.json");
@@ -42,6 +41,8 @@ 
Source: generators/add-generator.js

 const npmExists = require("@webpack-cli/utils/npm-exists");
 const entryQuestions = require("./utils/entry");
 
+const PROPS = Array.from(PROP_TYPES.keys());
+
 /**
  *
  * Replaces the string with a substring at the given index
@@ -78,6 +79,25 @@ 
Source: generators/add-generator.js

 	return hasProp;
 };
 
+/**
+ *
+ * Search config properties
+ *
+ * @param {Object} answers	Prompt answers object
+ * @param {String} input	Input search string
+ *
+ * @returns {Promise} Returns promise which resolves to filtered props
+ *
+ */
+const searchProps = (answers, input) => {
+	input = input || "";
+	return Promise.resolve(
+		PROPS.filter(food =>
+			food.toLowerCase().includes(input.toLowerCase())
+		)
+	);
+};
+
 /**
  *
  * Generator for adding properties
@@ -97,6 +117,8 @@ 
Source: generators/add-generator.js

 				topScope: ["const webpack = require('webpack')"]
 			}
 		};
+		const { registerPrompt } = this.env.adapter.promptModule;
+		registerPrompt("autocomplete", inquirerAutoComplete);
 	}
 
 	prompting() {
@@ -110,10 +132,14 @@ 
Source: generators/add-generator.js

 		let isDeepProp = [false, false];
 
 		return this.prompt([
-			List(
+			AutoComplete(
 				"actionType",
 				"What property do you want to add to?",
-				Array.from(PROP_TYPES.keys())
+				{
+					pageSize: 7,
+					source: searchProps,
+					suggestOnly: false,
+				}
 			)
 		])
 			.then(actionTypeAnswer => {
@@ -492,13 +518,13 @@ 
Source: generators/add-generator.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_addon-generator.js.html b/docs/generators_addon-generator.js.html
index 31acff7232c..c59c9c526ca 100644
--- a/docs/generators_addon-generator.js.html
+++ b/docs/generators_addon-generator.js.html
@@ -113,13 +113,13 @@ 
Source: generators/addon-generator.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_init-generator.js.html b/docs/generators_init-generator.js.html
index 3776e41be0e..f065c3028ce 100644
--- a/docs/generators_init-generator.js.html
+++ b/docs/generators_init-generator.js.html
@@ -97,7 +97,6 @@ 
Source: generators/init-generator.js

 		this.configuration.config.webpackOptions.module = {
 			rules: []
 		};
-		this.configuration.config.webpackOptions.plugins = getDefaultPlugins();
 		this.configuration.config.topScope.push(
 			"const webpack = require('webpack')",
 			"const path = require('path')",
@@ -146,12 +145,12 @@ 
Source: generators/init-generator.js

 				}
 			})
 			.then(() => {
-				console.log(this.usingDefaults);
 				this.isProd = this.usingDefaults ? true : false;
 				this.configuration.config.configName = this.isProd ? "prod" : "dev";
 				this.configuration.config.webpackOptions.mode = this.isProd
 					? "'production'"
 					: "'development'";
+				this.configuration.config.webpackOptions.plugins = this.isProd ? [] : getDefaultPlugins();
 				return this.prompt([
 					Confirm("babelConfirm", "Will you be using ES2015?")
 				]);
@@ -456,13 +455,13 @@ 
Source: generators/init-generator.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_loader-generator.js.html b/docs/generators_loader-generator.js.html
index c0a49d9c569..cad043a94cb 100644
--- a/docs/generators_loader-generator.js.html
+++ b/docs/generators_loader-generator.js.html
@@ -95,13 +95,13 @@ 
Source: generators/loader-generator.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_plugin-generator.js.html b/docs/generators_plugin-generator.js.html
index f0c70dfa6a2..9a4bb2865ce 100644
--- a/docs/generators_plugin-generator.js.html
+++ b/docs/generators_plugin-generator.js.html
@@ -75,13 +75,13 @@ 
Source: generators/plugin-generator.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_utils_entry.js.html b/docs/generators_utils_entry.js.html
index 08ca6e5713f..2e784502954 100644
--- a/docs/generators_utils_entry.js.html
+++ b/docs/generators_utils_entry.js.html
@@ -136,13 +136,13 @@ 
Source: generators/utils/entry.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_utils_module.js.html b/docs/generators_utils_module.js.html
index 446d85cbee2..1ba7156d826 100644
--- a/docs/generators_utils_module.js.html
+++ b/docs/generators_utils_module.js.html
@@ -41,9 +41,7 @@ 
Source: generators/utils/module.js

 		include: ["path.resolve(__dirname, 'src')"],
 		loader: "'babel-loader'",
 		options: {
-			presets: ["'env'", {
-				modules: false
-			}],
+			presets: [["'env'", { "'modules'": false }]],
 			plugins: ["'syntax-dynamic-import'"]
 		}
 	};
@@ -58,13 +56,13 @@ 
Source: generators/utils/module.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_utils_plugins.js.html b/docs/generators_utils_plugins.js.html
index 74f60b78a56..d485dd69135 100644
--- a/docs/generators_utils_plugins.js.html
+++ b/docs/generators_utils_plugins.js.html
@@ -50,13 +50,13 @@ 
Source: generators/utils/plugins.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_utils_tooltip.js.html b/docs/generators_utils_tooltip.js.html
index 167ef35b8f1..d620eb2cc4e 100644
--- a/docs/generators_utils_tooltip.js.html
+++ b/docs/generators_utils_tooltip.js.html
@@ -96,13 +96,13 @@ 
Source: generators/utils/tooltip.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/generators_utils_validate.js.html b/docs/generators_utils_validate.js.html
index 17697e0e485..f1d3f3ad83f 100644
--- a/docs/generators_utils_validate.js.html
+++ b/docs/generators_utils_validate.js.html
@@ -53,13 +53,13 @@ 
Source: generators/utils/validate.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/global.html b/docs/global.html
index 6b0ccebdd9a..9edeb2dd84c 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -5735,7 +5735,7 @@ 
Parameters:

     
     
Source:

     

     
 
@@ -6789,6 +6789,186 @@ 
Returns:

     
 
     
+    
searchProps(answers, input) → {Promise}

+    
+
+    
+
+
+
+

+    Search config properties
+

+
+
+
+
+
+
+
+
+
+    
Parameters:

+    
+
+
+    
+    
+        
+        
+        
+
+        
+
+        
+
+        
+
+        
+    
+    
+
+    
+    
+
+        
+            
+                
+            
+
+            
+
+            
+
+            
+
+            
+        
+
+    
+
+        
+            
+                
+            
+
+            
+
+            
+
+            
+
+            
+        
+
+    
+    
+
NameTypeDescription
answers
+            
+                
+Object
+
+
+            
+            Prompt answers object
input
+            
+                
+String
+
+
+            
+            Input search string

+
+
+
+
+
+
+

+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
Source:

+    

+    
+
+    
+
+    
+
+    
+

+
+
+
+
+
+
+
+
+
+
+
+
+
+
Returns:

+
+        
+

+    Returns promise which resolves to filtered props
+

+
+
+
+

+    

+        Type
+    

+    

+        
+Promise
+
+
+    

+

+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
     
serve(args) → {function}

     
 
@@ -8129,7 +8309,7 @@ 
Parameters:

     
     
Source:

     

     
 
@@ -8196,13 +8376,13 @@ 
Returns:

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/index.html b/docs/index.html
index 2be970804a7..08ed9c6633d 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -50,13 +50,13 @@ 
 

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/info_index.js.html b/docs/info_index.js.html
index cc7937aa8cf..a4be5ba4887 100644
--- a/docs/info_index.js.html
+++ b/docs/info_index.js.html
@@ -34,9 +34,9 @@ 
Source: info/index.js

  * Prints debugging information for webpack issue reporting
  */
 
-module.exports = function info() {
+module.exports = async function info() {
 	console.log(
-		envinfo.run({
+		await envinfo.run({
 			System: ["OS", "CPU"],
 			Binaries: ["Node", "Yarn", "npm"],
 			Browsers: ["Chrome", "Firefox", "Safari"],
@@ -55,13 +55,13 @@ 
Source: info/index.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/init_index.js.html b/docs/init_index.js.html
index 27a6ab76063..bcace878d28 100644
--- a/docs/init_index.js.html
+++ b/docs/init_index.js.html
@@ -30,7 +30,7 @@ 
Source: init/index.js

 
 const npmPackagesExists = require("@webpack-cli/utils/npm-packages-exists");
 const defaultGenerator = require("@webpack-cli/generators/init-generator");
-const modifyHelper = require("@webpack-cli/utils/modify-config-helper");
+const modifyConfigHelper = require("@webpack-cli/utils/modify-config-helper");
 
 /**
  *
@@ -47,7 +47,7 @@ 
Source: init/index.js

 	const packages = args.slice(3);
 
 	if (packages.length === 0) {
-		return modifyHelper("init", defaultGenerator);
+		return modifyConfigHelper("init", defaultGenerator);
 	}
 	return npmPackagesExists(packages);
 };
@@ -61,13 +61,13 @@ 
Source: init/index.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/init_init.js.html b/docs/init_init.js.html
index ee693609ccb..c617b555a04 100644
--- a/docs/init_init.js.html
+++ b/docs/init_init.js.html
@@ -130,13 +130,13 @@ 
Source: init/init.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/make_index.js.html b/docs/make_index.js.html
index eabb34f0444..66e42a26e99 100644
--- a/docs/make_index.js.html
+++ b/docs/make_index.js.html
@@ -48,13 +48,13 @@ 
Source: make/index.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_bannerPlugin_bannerPlugin.js.html b/docs/migrate_bannerPlugin_bannerPlugin.js.html
index ca8ed1a974f..342f091186f 100644
--- a/docs/migrate_bannerPlugin_bannerPlugin.js.html
+++ b/docs/migrate_bannerPlugin_bannerPlugin.js.html
@@ -69,13 +69,13 @@ 
Source: migrate/bannerPlugin/bannerPlugin.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_extractTextPlugin_extractTextPlugin.js.html b/docs/migrate_extractTextPlugin_extractTextPlugin.js.html
index 6cb8c076275..bddb336c836 100644
--- a/docs/migrate_extractTextPlugin_extractTextPlugin.js.html
+++ b/docs/migrate_extractTextPlugin_extractTextPlugin.js.html
@@ -94,13 +94,13 @@ 
Source: migrate/extractTextPlugin/extractTextPlugin.js
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_index.js.html b/docs/migrate_index.js.html
index bde3b566827..83f7a4cd10c 100644
--- a/docs/migrate_index.js.html
+++ b/docs/migrate_index.js.html
@@ -240,13 +240,13 @@ 
Source: migrate/index.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_loaderOptionsPlugin_loaderOptionsPlugin.js.html b/docs/migrate_loaderOptionsPlugin_loaderOptionsPlugin.js.html
index 453c02d9cb7..8e5d61ba0ec 100644
--- a/docs/migrate_loaderOptionsPlugin_loaderOptionsPlugin.js.html
+++ b/docs/migrate_loaderOptionsPlugin_loaderOptionsPlugin.js.html
@@ -85,13 +85,13 @@ 
Source: migrate/loaderOptionsPlugin/loaderOptionsPlugin.j
 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_loaders_loaders.js.html b/docs/migrate_loaders_loaders.js.html
index 832791e0a30..5f24d61f64f 100644
--- a/docs/migrate_loaders_loaders.js.html
+++ b/docs/migrate_loaders_loaders.js.html
@@ -415,13 +415,13 @@ 
Source: migrate/loaders/loaders.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_migrate.js.html b/docs/migrate_migrate.js.html
index ce6b4361b00..2d34563bac3 100644
--- a/docs/migrate_migrate.js.html
+++ b/docs/migrate_migrate.js.html
@@ -117,13 +117,13 @@ 
Source: migrate/migrate.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_moduleConcatenationPlugin_moduleConcatenationPlugin.js.html b/docs/migrate_moduleConcatenationPlugin_moduleConcatenationPlugin.js.html
index 8b36a0f1772..4557801dc56 100644
--- a/docs/migrate_moduleConcatenationPlugin_moduleConcatenationPlugin.js.html
+++ b/docs/migrate_moduleConcatenationPlugin_moduleConcatenationPlugin.js.html
@@ -70,13 +70,13 @@ 
Source: migrate/moduleConcatenationPlugin/moduleConcatena
 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_namedModulesPlugin_namedModulesPlugin.js.html b/docs/migrate_namedModulesPlugin_namedModulesPlugin.js.html
index 8855ee7036e..a2c0f3223db 100644
--- a/docs/migrate_namedModulesPlugin_namedModulesPlugin.js.html
+++ b/docs/migrate_namedModulesPlugin_namedModulesPlugin.js.html
@@ -66,13 +66,13 @@ 
Source: migrate/namedModulesPlugin/namedModulesPlugin.js<
 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_noEmitOnErrorsPlugin_noEmitOnErrorsPlugin.js.html b/docs/migrate_noEmitOnErrorsPlugin_noEmitOnErrorsPlugin.js.html
index 43b39c593bb..f3c191c8f6e 100644
--- a/docs/migrate_noEmitOnErrorsPlugin_noEmitOnErrorsPlugin.js.html
+++ b/docs/migrate_noEmitOnErrorsPlugin_noEmitOnErrorsPlugin.js.html
@@ -70,13 +70,13 @@ 
Source: migrate/noEmitOnErrorsPlugin/noEmitOnErrorsPlugin
 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_outputPath_outputPath.js.html b/docs/migrate_outputPath_outputPath.js.html
index 302a327051e..2af5e2cd196 100644
--- a/docs/migrate_outputPath_outputPath.js.html
+++ b/docs/migrate_outputPath_outputPath.js.html
@@ -110,13 +110,13 @@ 
Source: migrate/outputPath/outputPath.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_removeDeprecatedPlugins_removeDeprecatedPlugins.js.html b/docs/migrate_removeDeprecatedPlugins_removeDeprecatedPlugins.js.html
index 4edf84ad47f..09e92dbc679 100644
--- a/docs/migrate_removeDeprecatedPlugins_removeDeprecatedPlugins.js.html
+++ b/docs/migrate_removeDeprecatedPlugins_removeDeprecatedPlugins.js.html
@@ -80,13 +80,13 @@ 
Source: migrate/removeDeprecatedPlugins/removeDeprecatedP
 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_removeJsonLoader_removeJsonLoader.js.html b/docs/migrate_removeJsonLoader_removeJsonLoader.js.html
index 2f8209d9f66..c653563f2c4 100644
--- a/docs/migrate_removeJsonLoader_removeJsonLoader.js.html
+++ b/docs/migrate_removeJsonLoader_removeJsonLoader.js.html
@@ -105,13 +105,13 @@ 
Source: migrate/removeJsonLoader/removeJsonLoader.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_resolve_resolve.js.html b/docs/migrate_resolve_resolve.js.html
index 983c2db310b..ccbf5036d74 100644
--- a/docs/migrate_resolve_resolve.js.html
+++ b/docs/migrate_resolve_resolve.js.html
@@ -108,13 +108,13 @@ 
Source: migrate/resolve/resolve.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/migrate_uglifyJsPlugin_uglifyJsPlugin.js.html b/docs/migrate_uglifyJsPlugin_uglifyJsPlugin.js.html
index fb1ec6d518e..4e42fbd411d 100644
--- a/docs/migrate_uglifyJsPlugin_uglifyJsPlugin.js.html
+++ b/docs/migrate_uglifyJsPlugin_uglifyJsPlugin.js.html
@@ -159,13 +159,13 @@ 
Source: migrate/uglifyJsPlugin/uglifyJsPlugin.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/remove_index.js.html b/docs/remove_index.js.html
index af1cf1d7aff..d397e184362 100644
--- a/docs/remove_index.js.html
+++ b/docs/remove_index.js.html
@@ -29,18 +29,18 @@ 
Source: remove/index.js

             
"use strict";
 
 const defaultGenerator = require("@webpack-cli/generators/remove-generator");
-const modifyHelper = require("@webpack-cli/utils/modify-config-helper");
+const modifyConfigHelper = require("@webpack-cli/utils/modify-config-helper");
 
 /**
  * Is called and returns a scaffolding instance, removing properties
  *
- * @returns {Function} modifyHelper - A helper function that uses the action
+ * @returns {Function} modifyConfigHelper - A helper function that uses the action
  * 	we're given on a generator
  *
  */
 
 module.exports = function() {
-	return modifyHelper("remove", defaultGenerator);
+	return modifyConfigHelper("remove", defaultGenerator);
 };
 

         
@@ -52,13 +52,13 @@ 
Source: remove/index.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/serve_index.js.html b/docs/serve_index.js.html
index adb683d7d8b..103a2d51563 100644
--- a/docs/serve_index.js.html
+++ b/docs/serve_index.js.html
@@ -210,13 +210,13 @@ 
Source: serve/index.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/update_index.js.html b/docs/update_index.js.html
index f0b3dcdd5a3..44e44894335 100644
--- a/docs/update_index.js.html
+++ b/docs/update_index.js.html
@@ -29,18 +29,18 @@ 
Source: update/index.js

             
"use strict";
 
 const defaultGenerator = require("@webpack-cli/generators/update-generator");
-const modifyHelper = require("@webpack-cli/utils/modify-config-helper");
+const modifyConfigHelper = require("@webpack-cli/utils/modify-config-helper");
 
 /**
  * Is called and returns a scaffolding instance, updating properties
  *
- * @returns {Function} modifyHelper - A helper function that uses the action
+ * @returns {Function} modifyConfigHelper - A helper function that uses the action
  * 	we're given on a generator
  *
  */
 
 module.exports = function() {
-	return modifyHelper("update", defaultGenerator);
+	return modifyConfigHelper("update", defaultGenerator);
 };
 

         
@@ -52,13 +52,13 @@ 
Source: update/index.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_ast-utils.js.html b/docs/utils_ast-utils.js.html
index 360828e3c7b..366eda1c7e0 100644
--- a/docs/utils_ast-utils.js.html
+++ b/docs/utils_ast-utils.js.html
@@ -595,13 +595,13 @@ 
Source: utils/ast-utils.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_copy-utils.js.html b/docs/utils_copy-utils.js.html
index 83ddc144f7a..16046f8a1f9 100644
--- a/docs/utils_copy-utils.js.html
+++ b/docs/utils_copy-utils.js.html
@@ -93,13 +93,13 @@ 
Source: utils/copy-utils.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_defineTest.js.html b/docs/utils_defineTest.js.html
index 37bd1b5e3d5..7b0c1086548 100644
--- a/docs/utils_defineTest.js.html
+++ b/docs/utils_defineTest.js.html
@@ -153,13 +153,13 @@ 
Source: utils/defineTest.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_is-local-path.js.html b/docs/utils_is-local-path.js.html
index 87bb73eaaad..45ec73a8e44 100644
--- a/docs/utils_is-local-path.js.html
+++ b/docs/utils_is-local-path.js.html
@@ -55,13 +55,13 @@ 
Source: utils/is-local-path.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_modify-config-helper.js.html b/docs/utils_modify-config-helper.js.html
index 27e0563c81a..55cb411abb1 100644
--- a/docs/utils_modify-config-helper.js.html
+++ b/docs/utils_modify-config-helper.js.html
@@ -32,8 +32,9 @@ 
Source: utils/modify-config-helper.js

 const path = require("path");
 const chalk = require("chalk");
 const yeoman = require("yeoman-environment");
-const runTransform = require("./scaffold");
 const Generator = require("yeoman-generator");
+const logSymbols = require("log-symbols");
+const runTransform = require("./scaffold");
 
 /**
  *
@@ -41,16 +42,42 @@ 
Source: utils/modify-config-helper.js

  * generator scaffold followed up by a transform
  *
  * @param {String} action — action to be done (add, remove, update, init)
- * @param {Class} name - Name for the given function
+ * @param {Class} generator - Yeoman generator class
+ * @param {String} configFile - Name of the existing/default webpack configuration file
+ * @param {Array} packages - List of packages to resolve
  * @returns {Function} runTransform - Returns a transformation instance
  */
 
-module.exports = function modifyHelperUtil(action, generator, packages) {
-	let configPath = path.resolve(process.cwd(), "webpack.config.js");
-	const webpackConfigExists = fs.existsSync(configPath);
-	if (!webpackConfigExists) {
-		configPath = null;
+module.exports = function modifyHelperUtil(action, generator, configFile, packages) {
+	let configPath = null;
+
+	if (action !== "init") {
+		configPath = path.resolve(process.cwd(), configFile);
+		const webpackConfigExists = fs.existsSync(configPath);
+		if (webpackConfigExists) {
+			process.stdout.write(
+				"\n" +
+					logSymbols.success +
+					chalk.green(" SUCCESS ") +
+					"Found config " +
+					chalk.cyan(configFile + "\n") +
+					"\n"
+			);
+		} else {
+			process.stdout.write(
+				"\n" +
+					logSymbols.error +
+					chalk.red(" ERROR ") +
+					chalk.cyan(configFile) +
+					" not found. Please specify a valid path to your webpack config like " +
+					chalk.white("$ ") +
+					chalk.cyan(`webpack-cli ${action} webpack.dev.js`) +
+					"\n"
+			);
+			return;
+		}
 	}
+
 	const env = yeoman.createEnv("webpack", null);
 	const generatorName = `webpack-${action}-generator`;
 
@@ -111,13 +138,13 @@ 
Source: utils/modify-config-helper.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_npm-exists.js.html b/docs/utils_npm-exists.js.html
index 07d07c976ad..568ba90288e 100644
--- a/docs/utils_npm-exists.js.html
+++ b/docs/utils_npm-exists.js.html
@@ -59,13 +59,13 @@ 
Source: utils/npm-exists.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_npm-packages-exists.js.html b/docs/utils_npm-packages-exists.js.html
index ac5f0c43a0c..ae3ae5e12e9 100644
--- a/docs/utils_npm-packages-exists.js.html
+++ b/docs/utils_npm-packages-exists.js.html
@@ -99,13 +99,13 @@ 
Source: utils/npm-packages-exists.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_package-manager.js.html b/docs/utils_package-manager.js.html
index 0415cfd27c4..9d510ccaf76 100644
--- a/docs/utils_package-manager.js.html
+++ b/docs/utils_package-manager.js.html
@@ -148,13 +148,13 @@ 
Source: utils/package-manager.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_prop-types.js.html b/docs/utils_prop-types.js.html
index 6e15a67401d..e9fc3a8069a 100644
--- a/docs/utils_prop-types.js.html
+++ b/docs/utils_prop-types.js.html
@@ -74,13 +74,13 @@ 
Source: utils/prop-types.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_resolve-packages.js.html b/docs/utils_resolve-packages.js.html
index c276cd54dd3..be34dfb8c3c 100644
--- a/docs/utils_resolve-packages.js.html
+++ b/docs/utils_resolve-packages.js.html
@@ -73,7 +73,7 @@ 
Source: utils/resolve-packages.js

 
 	function invokeGeneratorIfReady() {
 		if (packageLocations.length === pkg.length)
-			return modifyConfigHelper("init", null, packageLocations);
+			return modifyConfigHelper("init", null, null, packageLocations);
 	}
 
 	pkg.forEach(addon => {
@@ -134,13 +134,13 @@ 
Source: utils/resolve-packages.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_run-prettier.js.html b/docs/utils_run-prettier.js.html
index 7c9cf919f41..db6c851827d 100644
--- a/docs/utils_run-prettier.js.html
+++ b/docs/utils_run-prettier.js.html
@@ -80,13 +80,13 @@ 
Source: utils/run-prettier.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)
 

 
 
diff --git a/docs/utils_scaffold.js.html b/docs/utils_scaffold.js.html
index d41f4d87439..7a2fb8a3ecf 100644
--- a/docs/utils_scaffold.js.html
+++ b/docs/utils_scaffold.js.html
@@ -138,13 +138,13 @@ 
Source: utils/scaffold.js

 
 
 
 
 

 
 

-    Documentation generated by JSDoc 3.5.5 on Sat Jun 02 2018 17:44:07 GMT+0200 (CEST)
+    Documentation generated by JSDoc 3.5.5 on Sat Jun 16 2018 03:00:10 GMT+0530 (IST)