Webpack-CLI version 1

MIGRATE.md

@@ -0,0 +1 @@
+

README.md

@@ -11,13 +11,22 @@
 
 # Webpack CLI
 
-This project intends to be the main cli package of webpack. Here we will encapsulate all the features and code related to the command line. From sending options to the compiler, to initialize and migrate from version to version.
+Webpack CLI encapsulates all code related to CLI handling. It captures options and sends them to webpack compiler. You can also find functionality for initializing a project and migrating between versions. For the time being, it is backwards-compatible with the CLI included in webpack itself.
 
 **Note** The package is still in work in progress. In case you want to contribute, reach to us, so we can point you out how and when you can help us.
 
+## Migration from webpack v1 to v2
 
-# Roadmap to the first release
+The `migrate` feature eases the transition from [version 1](http://webpack.github.io/docs/) to [version 2](https://gist.github.com/sokra/27b24881210b56bbaff7). `migrate` also allows users to switch to the new version of webpack without having to extensively [refactor](https://webpack.js.org/guides/migrating/).
 
-- Migrate to webpack-cli all the current cli options available in webpack
-- Create a `webpack-cli init` command that serves to set a configuration of webpack to the user
-- create a `webpack-cli migrate` command that serves to migrate an existing configuration from webpack 1 to webpack 2.
+`webpack --migrate <config>`
+
+[Read more about migrating](MIGRATE.md)
+
+## Creating new webpack projects
+
+The `init` feature allows users to get started with webpack, fast. Through scaffolding, people can create their own configuration in order to faster initialize new projects for various of use cases.
+
+`webpack --init [webpack-addons-<package>]`
+
+[Read more about scaffolding](SCAFFOLDING.md)

SCAFFOLDING.md

@@ -0,0 +1,83 @@
+# Introduction
+
+Setting up webpack for the first time is hard. Writing advanced configurations to optimize performance is even harder. The `init` feature is designed to support people that want to create their own configuration or initializing other projects people create.
+
+Through [yeoman](http://yeoman.io/), the `webpack --init` feature allows people to create scaffolds and generate new projects quickly. An npm dependency that scaffolds a `webpack.config.js` through `webpack-cli` is what we refer to as an **addon**.
+
+## Writing a good scaffold
+
+Before writing a `webpack-cli` scaffold, think about what you're trying to achieve. Do you want a "general" scaffold that could be used by any project or type of app? Do you want something very focused - like a scaffold that writes both your `webpack.config.js` and your framework code? It's also useful to think about the user experience for your scaffold.
+
+`webpack-cli` offers an experience that is interactive and you can prompt users for questions (like, "What is your entry point?") to help customize the output accordingly.
+
+## webpack-addons
+
+[`webpack-addons`](https://github.com/webpack-contrib/webpack-addons) is a utility suite for creating addons. It contains functions that could be of use for creating an addon yourself.
+
+## webpack-addons-yourpackage
+
+In order for `webpack-cli` to compile your package, it relies on a prefix of `webpack-addons`. The package must also be published on npm. If you are curious about how you can create your very own `addon`, please read [How do I compose a webpack-addon?](https://github.com/ev1stensberg/webpack-addons-demo).
+
+## API
+
+To create an `addon`, you must create a [`yeoman-generator`](http://yeoman.io/authoring/). Because of that, you can optionally extend your generator to include methods from the [Yeoman API](http://yeoman.io/learning/). Its worth noting that we support all the properties of a regular webpack configuration. In order for us to do this, there's a thing you need to remember.
+
+Objects are made using strings, while strings are made using double strings. This means that in order for you to create an string, you have to wrap it inside another string for us to validate it correctly.
+
+
+### `opts.env.configuration`(Required)
+
+Initialized inside the constructor of your generator in order for the CLI to work.
+
+```js
+constructor(args, opts) {
+		super(args, opts);
+		opts.env.configuration = {};
+	}
+```
+### `opts.env.configuration.myObj` (required)
+
+`myObj` is your scaffold. This is where you will add options for the CLI to transform into a configuration. You can name it anything, and you can also add more objects, that could represent a `dev.config` or `prod.config`.
+
+```js
+constructor(args, opts) {
+		super(args, opts);
+		opts.env.configuration = {
+			dev: {},
+			prod: {}
+		};
+	}
+```
+
+### `myObj.webpackOptions` (required)
+
+As with a regular webpack configuration, this property behaves the same. Inside `webpackOptions` you can declare the properties you want to scaffold. You can for instance, scaffold `entry`, `output` and `context`.
+
+(Inside a yeoman method)
+```js
+this.options.env.configuration.dev.webpackOptions = {
+entry: '\'app.js\'',
+output: {....},
+merge: 'myConfig'
+};
+```
+If you want to use `webpack-merge`, you can supply `webpackOptions` with the merge property, and the configuration you want to merge it with. 
+
+### `myObj.topScope`(optional)
+
+The `topScope` property is a way for the authors to add special behaviours, like functions that could be called inside a configuration, or variable initializations and module imports. 
+
+```js
+this.options.env.configuration.dev.topScope = [
+'var webpack = require(\'webpack\');'
+'var path = require(\'path\');'
+];
+```
+
+### `myObj.configName`(optional)
+
+If you want to name your `webpack.config.js` something special, you can do that.
+
+```js
+this.options.env.configuration.dev.configName = 'base';
+```

bin/config-yargs.js

@@ -33,7 +33,7 @@ module.exports = function(yargs) {
 				requiresArg: true
 			},
 			'env': {
-				describe: 'Enviroment passed to the config, when it is a function',
+				describe: 'Environment passed to the config, when it is a function',
 				group: CONFIG_GROUP
 			},
 			'context': {
@@ -149,7 +149,7 @@ module.exports = function(yargs) {
 			},
 			'target': {
 				type: 'string',
-				describe: 'The targeted execution enviroment',
+				describe: 'The targeted execution environment',
 				group: ADVANCED_GROUP,
 				requiresArg: true
 			},
@@ -166,12 +166,6 @@ module.exports = function(yargs) {
 				describe: 'Watch the filesystem for changes',
 				group: BASIC_GROUP
 			},
-			'save': {
-				type: 'boolean',
-				alias: 's',
-				describe: 'Rebuilds on save regardless of changes in watch mode',
-				group: BASIC_GROUP
-			},
 			'watch-stdin': {
 				type: 'boolean',
 				alias: 'stdin',
@@ -185,7 +179,7 @@ module.exports = function(yargs) {
 			},
 			'watch-poll': {
 				type: 'boolean',
-				describe: 'The polling intervall for watching (also enable polling)',
+				describe: 'The polling interval for watching (also enable polling)',
 				group: ADVANCED_GROUP
 			},
 			'hot': {

bin/convert-argv.js

@@ -122,7 +122,7 @@ module.exports = function(yargs, argv, convertOptions) {
 	function processConfiguredOptions(options) {
 		if(options === null || typeof options !== 'object') {
 			console.error('Config did not export an object or a function returning an object.');
-			process.exit(-1);
+			process.exitCode = -1;
 		}
 
 		// process Promise
@@ -224,16 +224,10 @@ module.exports = function(yargs, argv, convertOptions) {
 					options[optionName || name] = false;
 			});
 		}
-		//eslint-disable-next-line
-		function mapArgToPath(name, optionName) {
-			ifArg(name, function(str) {
-				options[optionName || name] = path.resolve(str);
-			});
-		}
 
 		function loadPlugin(name) {
 			var loadUtils = require('loader-utils');
-			var args = null;
+			var args;
 			try {
 				var p = name && name.indexOf('?');
 				if(p > -1) {
@@ -242,7 +236,7 @@ module.exports = function(yargs, argv, convertOptions) {
 				}
 			} catch(e) {
 				console.log('Invalid plugin arguments ' + name + ' (' + e + ').');
-				process.exit(-1);
+				process.exitCode = -1;
 			}
 
 			var path;
@@ -251,7 +245,7 @@ module.exports = function(yargs, argv, convertOptions) {
 				path = resolve.sync(process.cwd(), name);
 			} catch(e) {
 				console.log('Cannot resolve plugin ' + name + '.');
-				process.exit(-1);
+				process.exitCode = -1;
 			}
 			var Plugin;
 			try {
@@ -281,7 +275,11 @@ module.exports = function(yargs, argv, convertOptions) {
 		}
 
 		ifArgPair('entry', function(name, entry) {
-			options.entry[name] = entry;
+			if(typeof options.entry[name] !== 'undefined' && options.entry[name] !== null) {
+				options.entry[name] = [].concat(options.entry[name]).concat(entry);
+			} else {
+				options.entry[name] = entry;
+			}
 		}, function() {
 			ensureObject(options, 'entry');
 		});
@@ -322,7 +320,7 @@ module.exports = function(yargs, argv, convertOptions) {
 
 		ifArg('output-path', function(value) {
 			ensureObject(options, 'output');
-			options.output.path = value;
+			options.output.path = path.resolve(value);
 		});
 
 		ifArg('output-filename', function(value) {
@@ -454,7 +452,7 @@ module.exports = function(yargs, argv, convertOptions) {
 
 		ifArg('prefetch', function(request) {
 			ensureArray(options, 'plugins');
-			var PrefetchPlugin = require('webpack/PrefetchPlugin');
+			var PrefetchPlugin = require('webpack/lib/PrefetchPlugin');
 			options.plugins.push(new PrefetchPlugin(request));
 		});
 
@@ -468,16 +466,10 @@ module.exports = function(yargs, argv, convertOptions) {
 			} else {
 				name = value;
 			}
-			var ProvidePlugin = require('webpack/ProvidePlugin');
+			var ProvidePlugin = require('webpack/lib/ProvidePlugin');
 			options.plugins.push(new ProvidePlugin(name, value));
 		});
 
-		ifBooleanArg('labeled-modules', function() {
-			ensureArray(options, 'plugins');
-			var LabeledModulesPlugin = require('webpack/lib/dependencies/LabeledModulesPlugin');
-			options.plugins.push(new LabeledModulesPlugin());
-		});
-
 		ifArg('plugin', function(value) {
 			ensureArray(options, 'plugins');
 			options.plugins.push(loadPlugin(value));
@@ -490,19 +482,20 @@ module.exports = function(yargs, argv, convertOptions) {
 		if(noOutputFilenameDefined) {
 			ensureObject(options, 'output');
 			if(convertOptions && convertOptions.outputFilename) {
-				options.output.path = path.dirname(convertOptions.outputFilename);
+				options.output.path = path.resolve(path.dirname(convertOptions.outputFilename));
 				options.output.filename = path.basename(convertOptions.outputFilename);
 			} else if(argv._.length > 0) {
 				options.output.filename = argv._.pop();
-				options.output.path = path.dirname(options.output.filename);
+				options.output.path = path.resolve(path.dirname(options.output.filename));
 				options.output.filename = path.basename(options.output.filename);
 			} else if(configFileLoaded) {
 				throw new Error('\'output.filename\' is required, either in config file or as --output-filename');
-			} else {
+			}
+			else {
 				console.error('No configuration file found and no output filename configured via CLI option.');
 				console.error('A configuration file could be named \'webpack.config.js\' in the current directory.');
 				console.error('Use --help to display the CLI options.');
-				process.exit(-1);
+				process.exitCode = -1;
 			}
 		}
 
@@ -549,7 +542,7 @@ module.exports = function(yargs, argv, convertOptions) {
 				console.error('A configuration file could be named \'webpack.config.js\' in the current directory.');
 			}
 			console.error('Use --help to display the CLI options.');
-			process.exit(-1);
+			process.exitCode = -1;
 		}
 	}
 };

bin/process-options.js

@@ -139,7 +139,7 @@ module.exports = function processOptions(yargs, argv) {
 				console.error('\u001b[1m\u001b[31m' + e.message + '\u001b[39m\u001b[22m');
 			else
 				console.error(e.message);
-			process.exit(1);
+			process.exitCode = 1;
 		}
 		throw e;
 	}
@@ -160,7 +160,7 @@ module.exports = function processOptions(yargs, argv) {
 			lastHash = null;
 			console.error(err.stack || err);
 			if(err.details) console.error(err.details);
-			process.exit(1);
+			process.exitCode = 1;
 		}
 		if(outputOptions.json) {
 			process.stdout.write(JSON.stringify(stats.toJson(outputOptions), null, 2) + '\n');
@@ -172,7 +172,7 @@ module.exports = function processOptions(yargs, argv) {
 		}
 		if(!options.watch && stats.hasErrors()) {
 			process.on('exit', function() {
-				process.exit(2);
+				process.exitCode = 2;
 			});
 		}
 	}
@@ -181,7 +181,7 @@ module.exports = function processOptions(yargs, argv) {
 		var watchOptions = primaryOptions.watchOptions || primaryOptions.watch || {};
 		if(watchOptions.stdin) {
 			process.stdin.on('end', function() {
-				process.exit(0);
+				process.exitCode = 0;
 			});
 			process.stdin.resume();
 		}