Merge branch 'master' of https://github.com/webpack/webpack-cli

README.md

@@ -69,7 +69,7 @@ You will answer many questions when running the `init` so webpack CLI can provid
 
 With v3 of webpack CLI, we introduced scaffolding as an integral part of the CLI. Our goal is to simplify the creation of webpack configurations for different purposes. Additionally, sharing such solutions with the community is beneficial and with webpack webpack's we want to allow this. We provide `webpack-scaffold` as a utility suite for creating these scaffolds. It contains functions that could be of use for creating an scaffold yourself.
 
-You can read more about [Scaffolding](./SCAFFOLDING.md) or check out the example project [How do I compose a webpack-scaffold?](https://github.com/evenstensberg/webpack-scaffold-demo).
+You can read more about [Scaffolding](https://webpack.js.org/guides/scaffolding), learn [How to compose a webpack-scaffold?](https://webpack.js.org/contribute/writing-a-scaffold) or generate one with [webpack-scaffold-starter](https://github.com/rishabh3112/webpack-scaffold-starter).
 
 ## Contributing and Internal Documentation
 

packages/add/README.md

@@ -1,5 +1,7 @@
 # webpack-cli add
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/add.svg)](https://www.npmjs.com/package/@webpack-cli/add)
+
 ## Description
 
 This package contains the logic to add new properties in a webpack configuration file. It will run a generator that prompts the user for questions of which property to add to their webpack configuration file.

packages/generate-loader/README.md

@@ -1,5 +1,7 @@
 # webpack-cli generate-loader
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/generate-loader.svg)](https://www.npmjs.com/package/@webpack-cli/generate-loader)
+
 ## Description
 
 This package contains the logic to initiate new loader projects.
@@ -24,4 +26,4 @@ generateLoader();
 ### CLI (via `webpack-cli`)
 ```bash
 npx webpack-cli generate-loader
-```
+```

packages/generate-plugin/README.md

@@ -1,5 +1,7 @@
 # webpack-cli generate-plugin
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/generate-plugin.svg)](https://www.npmjs.com/package/@webpack-cli/generate-plugin)
+
 ## Description
 
 This package contains the logic to initiate new plugin projects.
@@ -23,4 +25,4 @@ generatePlugin();
 ### CLI (via `webpack-cli`)
 ```bash
 npx webpack-cli generate-plugin
-```
+```

packages/generators/README.md

@@ -1,5 +1,7 @@
 # webpack-cli generators
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/generators.svg)](https://www.npmjs.com/package/@webpack-cli/generators)
+
 ## Description
 
 This package contains all webpack-cli related yeoman generators. 

packages/info/README.md

@@ -1,5 +1,7 @@
 # webpack-cli info
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/info.svg)](https://www.npmjs.com/package/@webpack-cli/info)
+
 ## Description
 
 This pacakge returns a set of information related to the local enviroment.

packages/init/README.md

@@ -1,5 +1,7 @@
 # webpack-cli init
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/init.svg)](https://www.npmjs.com/package/@webpack-cli/init)
+
 ## Description
 
 This package contains the logic to create a new webpack configuration.

packages/migrate/README.md

@@ -1,5 +1,7 @@
 # webpack-cli migrate
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/migrate.svg)](https://www.npmjs.com/package/@webpack-cli/migrate)
+
 ## Description
 
 This package contains the logic to migrate a project from one version to the other.
@@ -25,4 +27,4 @@ migrate(null, null, inputPath, outputPath);
 ### CLI (via `webpack-cli`)
 ```bash
 npx webpack-cli migrate
-```
+```

packages/remove/README.md

@@ -1,5 +1,7 @@
 # webpack-cli remove
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/remove.svg)](https://www.npmjs.com/package/@webpack-cli/remove)
+
 ## Description
 
 This package contains the logic to remove  properties of a webpack configuration file. It will run a generator that prompts the user for questions of which property to remove in their webpack configuration file.
@@ -23,4 +25,4 @@ remove();
 ### CLI (via `webpack-cli`)
 ```bash
 npx webpack-cli remove
-```
+```

packages/serve/README.md

@@ -1,5 +1,7 @@
 # webpack-cli serve
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/serve.svg)](https://www.npmjs.com/package/@webpack-cli/serve)
+
 ## Description
 
 This package contains the logic to run webpack-serve without using webpack-serve directly.
@@ -23,4 +25,4 @@ serve();
 ### CLI (via `webpack-cli`)
 ```bash
 npx webpack-cli serve
-```
+```

packages/update/README.md

@@ -1,5 +1,7 @@
 # webpack-cli update
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/update.svg)](https://www.npmjs.com/package/@webpack-cli/update)
+
 ## Description
 
 This package contains the logic to update properties in a webpack configuration file. It will run a generator that prompts the user for questions of which property to update in their webpack configuration file.
@@ -23,4 +25,4 @@ update();
 ### CLI (via `webpack-cli`)
 ```bash
 npx webpack-cli update
-```
+```

packages/utils/README.md

@@ -1,5 +1,7 @@
 # webpack-cli utils (WIP, not yet published)
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/utils.svg)](https://www.npmjs.com/package/@webpack-cli/utils)
+
 ## Description
 
 This package contains the utilities used across the webpack-cli repositories.
@@ -26,4 +28,4 @@ npm i -D webpack-cli @webpack-cli/utils
 ```js
 const utils = require("@webpack-cli/utils");
 // API yet to be exposed
-```
+```

packages/utils/defineTest.ts

@@ -1,5 +1,6 @@
 import * as fs from "fs";
 import * as path from "path";
+
 import { IJSCodeshift, INode } from "./types/NodePath";
 
 interface IModule {

packages/utils/find-root.ts

@@ -1,6 +1,12 @@
 import * as findup from "findup-sync";
 import * as path from "path";
 
+/**
+ * Returns the absolute path of the project directory
+ * Finds the package.json, by using findup-sync
+ * @returns {String} path of project directory
+ */
+
 export function findProjectRoot(): string {
   const rootFilePath = findup(`package.json`);
   const projectRoot = path.dirname(rootFilePath);

packages/utils/scaffold.ts

@@ -90,22 +90,16 @@ export default function runTransform(transformConfig: ITransformConfig, action:
 				console.error(err.message ? err.message : err);
 			});
 	});
-
+	let successMessage: string = `Congratulations! Your new webpack configuration file has been created!\n`;
 	if (initActionNotDefined && transformConfig.config.item) {
-		process.stdout.write(
-			"\n" +
-				chalk.green(
-					`Congratulations! ${
-						transformConfig.config.item
-					} has been ${action}ed!\n`,
-				),
-		);
-	} else {
-		process.stdout.write(
-			"\n" +
-				chalk.green(
-					"Congratulations! Your new webpack configuration file has been created!\n",
-				),
-		);
+		successMessage = `Congratulations! ${
+			transformConfig.config.item
+		} has been ${action}ed!\n`;
 	}
+	process.stdout.write(
+		"\n" +
+			chalk.green(
+				successMessage,
+			),
+	);
 }

packages/webpack-scaffold/README.md

@@ -1,5 +1,7 @@
 # webpack-scaffold
 
+[![npm](https://img.shields.io/npm/dm/@webpack-cli/webpack-scaffold.svg)](https://www.npmjs.com/package/@webpack-cli/webpack-scaffold)
+
 This is the utility suite for creating a webpack `scaffold`, it contains utility functions to help you work with [Inquirer](https://github.com/SBoudrias/Inquirer.js/) prompting and scaffolding.
 
 # Installation
@@ -9,15 +11,20 @@ npm i -D webpack-cli @webpack-cli/webpack-scaffold
 ```
 
 # API
-
-1. [parseValue()](#parsevalue)
-2. [createArrowFunction()](#createarrowfunction)
-3. [createRegularFunction()](#createregularfunction)
-4. [createDynamicPromise()](#createdynamicpromise)
-5. [createAssetFilterFunction()](#createassetfilterfunction)
-6. [createExternalFunction()](#createexternalfunction)
-7. [createRequire()](#createrequire)
-8. Inquirer: [List](#list), [RawList](#rawlist), [CheckList](#checklist), [Input](#input), [InputValidate](#inputvalidate), [Confirm](#confirm)
+- [parseValue](#parsevalue)
+- [createArrowFunction](#createarrowfunction)
+- [createRegularFunction](#createregularfunction)
+- [createDynamicPromise](#createdynamicpromise)
+- [createAssetFilterFunction](#createassetfilterfunction)
+- [createExternalFunction](#createexternalfunction)
+- [createRequire](#createrequire)
+- [Inquirer](#inquirer)
+	- [List](#list)
+	- [RawList](#rawlist)
+	- [CheckList](#checklist)
+	- [Input](#input)
+	- [InputValidate](#inputvalidate)
+	- [Confirm](#confirm)
 
 ## parseValue