cli(refactor): improve folder structure (#371)

* cli(refactor): improve folder structure

* chore(linting): fix linter errors

* cli(filepath): use local import instead

* cli(migrate): refactor error handling

* chore(review): fix review comments

* chore(review): fix review comments

* chore(review): fix review comments

bin/process-options.js

@@ -179,7 +179,9 @@ module.exports = function processOptions(yargs, argv) {
 			);
 		} else if (stats.hash !== lastHash) {
 			lastHash = stats.hash;
-			const delimiter = outputOptions.buildDelimiter ? `${outputOptions.buildDelimiter}\n` : "";
+			const delimiter = outputOptions.buildDelimiter
+				? `${outputOptions.buildDelimiter}\n`
+				: "";
 			process.stdout.write("\n" + new Date() + "\n" + "\n");
 			process.stdout.write(`${stats.toString(outputOptions)}\n${delimiter}`);
 			if (argv.s) lastHash = null;

bin/webpack.js

@@ -8,11 +8,9 @@
 (function() {
 	// wrap in IIFE to be able to use return
 
-	const resolveCwd = require("resolve-cwd");
-	// Local version replace global one
-	const localCLI = resolveCwd.silent("webpack-cli/bin/webpack");
-	if (localCLI && localCLI !== __filename) {
-		require(localCLI);
+	const importLocal = require("import-local");
+	// Prefer the local installation of webpack-cli
+	if (importLocal(__filename)) {
 		return;
 	}
 
@@ -48,7 +46,9 @@
 		return;
 	}
 
-	const yargs = require("yargs").usage(`webpack-cli ${require("../package.json").version}
+	const yargs = require("yargs").usage(`webpack-cli ${
+		require("../package.json").version
+	}
 
 Usage: webpack-cli [options]
        webpack-cli [options] --entry <entry> --output <output>
@@ -482,7 +482,9 @@ For more information, see https://webpack.js.org/api/cli/.`);
 				} else if (stats.hash !== lastHash) {
 					lastHash = stats.hash;
 					const statsString = stats.toString(outputOptions);
-					const delimiter = outputOptions.buildDelimiter ? `${outputOptions.buildDelimiter}\n` : "";
+					const delimiter = outputOptions.buildDelimiter
+						? `${outputOptions.buildDelimiter}\n`
+						: "";
 					if (statsString) stdout.write(`${statsString}\n${delimiter}`);
 				}
 				if (!options.watch && stats.hasErrors()) {

lib/generate-loader/index.js → lib/commands/generate-loader.js

@@ -5,6 +5,7 @@ const { LoaderGenerator } = require("../generators/loader-generator");
  * Runs a yeoman generator to create a new webpack loader project
  * @returns {void}
  */
+
 function loaderCreator() {
 	const env = yeoman.createEnv();
 	const generatorName = "webpack-loader-generator";

lib/generate-plugin/index.js → lib/commands/generate-plugin.js

@@ -1,10 +1,11 @@
 const yeoman = require("yeoman-environment");
-const PluginGenerator = require("../generators/plugin-generator").PluginGenerator;
+const { PluginGenerator } = require("../generators/plugin-generator");
 
 /**
  * Runs a yeoman generator to create a new webpack plugin project
  * @returns {void}
  */
+
 function pluginCreator() {
 	const env = yeoman.createEnv();
 	const generatorName = "webpack-plugin-generator";

lib/commands/info.js

@@ -13,7 +13,7 @@ module.exports = function info() {
 			Binaries: ["Node", "Yarn", "npm"],
 			Browsers: ["Chrome", "Firefox", "Safari"],
 			npmPackages: "*webpack*",
-			npmGlobalPackages: ["webpack", "webpack-cli"],
+			npmGlobalPackages: ["webpack", "webpack-cli"]
 		})
 	);
 };

lib/commands/init.js

@@ -9,14 +9,17 @@ const modifyHelper = require("../utils/modify-config-helper");
  * First function to be called after running the init flag. This is a check,
  * if we are running the init command with no arguments or if we got dependencies
  *
- * @param {Object} pkg - packages included when running the init command
+ * @param {Array} args - array of arguments such as
+ * packages included when running the init command
  * @returns {Function} creator/npmPackagesExists - returns an installation of the package,
  * followed up with a yeoman instance of that if there's packages. If not, it creates a defaultGenerator
  */
 
-module.exports = function initializeInquirer(pkg) {
-	if (pkg.length === 0) {
+module.exports = function initializeInquirer(...args) {
+	const packages = args.slice(3);
+
+	if (packages.length === 0) {
 		return modifyHelper("init", defaultGenerator);
 	}
-	return npmPackagesExists(pkg);
+	return npmPackagesExists(packages);
 };

lib/commands/migrate.js

@@ -1,42 +1,83 @@
 "use strict";
 
 const fs = require("fs");
+const path = require("path");
 const chalk = require("chalk");
 const diff = require("diff");
 const inquirer = require("inquirer");
 const PLazy = require("p-lazy");
 const Listr = require("listr");
 
-const validate = require("webpack").validate;
-const WebpackOptionsValidationError = require("webpack")
-	.WebpackOptionsValidationError;
+const { validate } = require("webpack");
+const { WebpackOptionsValidationError } = require("webpack");
 
 const runPrettier = require("../utils/run-prettier");
 
 /**
-*
-* Runs migration on a given configuration using AST's and promises
-* to sequentially transform a configuration file.
-*
-* @param {String} currentConfigPath - Location of the configuration to be migrated
-* @param {String} outputConfigPath - Location to where the configuration should be written
-* @param {Object} options - Any additional options regarding code style of the written configuration
+ *
+ * Runs migration on a given configuration using AST's and promises
+ * to sequentially transform a configuration file.
+ *
+ * @param {Array} args - Migrate arguments such as input and
+ * output path
+ * @returns {Function} Runs the migration using the 'runMigrate'
+ * function.
+ */
 
-* @returns {Promise} Runs the migration using a promise that will throw any errors during each transform
-* or output if the user decides to abort the migration
-*/
+module.exports = function migrate(...args) {
+	const filePaths = args.slice(3);
+	if (!filePaths.length) {
+		const errMsg = "\n ✖ Please specify a path to your webpack config \n ";
+		console.error(chalk.red(errMsg));
+		return;
+	}
+	const currentConfigPath = path.resolve(process.cwd(), filePaths[0]);
+	let outputConfigPath;
+	if (!filePaths[1]) {
+		return inquirer
+			.prompt([
+				{
+					type: "confirm",
+					name: "confirmPath",
+					message:
+						"Migration output path not specified. " +
+						"Do you want to use your existing webpack " +
+						"configuration?",
+					default: "Y"
+				}
+			])
+			.then(ans => {
+				if (!ans["confirmPath"]) {
+					console.error(chalk.red("✖ ︎Migration aborted due no output path"));
+					return;
+				}
+				outputConfigPath = path.resolve(process.cwd(), filePaths[0]);
+				return runMigration(currentConfigPath, outputConfigPath);
+			})
+			.catch(err => {
+				console.error(err);
+			});
+	}
+	outputConfigPath = path.resolve(process.cwd(), filePaths[1]);
+	return runMigration(currentConfigPath, outputConfigPath);
+};
 
-module.exports = function migrate(
-	currentConfigPath,
-	outputConfigPath,
-	options
-) {
-	const recastOptions = Object.assign(
-		{
-			quote: "single"
-		},
-		options
-	);
+/**
+ *
+ * Runs migration on a given configuration using AST's and promises
+ * to sequentially transform a configuration file.
+ *
+ * @param {String} currentConfigPath - input path for config
+ * @param {String} outputConfigPath - output path for config
+ * @returns {Promise} Runs the migration using a promise that
+ * will throw any errors during each transform or output if the
+ * user decides to abort the migration
+ */
+
+function runMigration(currentConfigPath, outputConfigPath) {
+	const recastOptions = {
+		quote: "single"
+	};
 	const tasks = new Listr([
 		{
 			title: "Reading webpack config",
@@ -145,8 +186,9 @@ module.exports = function migrate(
 				});
 		})
 		.catch(err => {
-			console.log(chalk.red("✖ ︎Migration aborted due to some errors"));
+			const errMsg = "\n ✖ ︎Migration aborted due to some errors: \n";
+			console.error(chalk.red(errMsg));
 			console.error(err);
 			process.exitCode = 1;
 		});
-};
+}

lib/generators/init-generator.js

@@ -31,11 +31,7 @@ module.exports = class InitGenerator extends Generator {
 	constructor(args, opts) {
 		super(args, opts);
 		this.isProd = false;
-		this.dependencies = [
-			"webpack",
-			"webpack-cli",
-			"uglifyjs-webpack-plugin"
-		];
+		this.dependencies = ["webpack", "webpack-cli", "uglifyjs-webpack-plugin"];
 		this.configuration = {
 			config: {
 				webpackOptions: {},
@@ -119,7 +115,9 @@ module.exports = class InitGenerator extends Generator {
 					Confirm("prodConfirm", "Are you going to use this in production?")
 				]);
 			})
-			.then(prodConfirmAnswer => this.isProd = prodConfirmAnswer["prodConfirm"])
+			.then(
+				prodConfirmAnswer => (this.isProd = prodConfirmAnswer["prodConfirm"])
+			)
 			.then(() => {
 				return this.prompt([
 					Confirm("babelConfirm", "Will you be using ES2015?")
@@ -398,8 +396,9 @@ module.exports = class InitGenerator extends Generator {
 			)
 		])
 			.then(nameTypeAnswer => {
-				this.configuration.config.configName = nameTypeAnswer["nameType"].length ?
-					nameTypeAnswer["nameType"] : defaultName;
+				this.configuration.config.configName = nameTypeAnswer["nameType"].length
+					? nameTypeAnswer["nameType"]
+					: defaultName;
 			})
 			.then(() => {
 				asyncNamePrompt();

lib/generators/loader-generator.js

@@ -25,6 +25,7 @@ function makeLoaderName(name) {
  * @class LoaderGenerator
  * @extends {Generator}
  */
+
 const LoaderGenerator = webpackGenerator(
 	[
 		{
@@ -36,7 +37,7 @@ const LoaderGenerator = webpackGenerator(
 			validate: str => str.length > 0
 		}
 	],
-	path.join(__dirname, "../generate-loader/templates"),
+	path.resolve(__dirname, "..", "generate-loader"),
 	[
 		"src/cjs.js.tpl",
 		"test/test-utils.js.tpl",

lib/generators/loader-generator.test.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const makeLoaderName = require("./loader-generator").makeLoaderName;
+const { makeLoaderName } = require("./loader-generator");
 
 describe("makeLoaderName", () => {
 	it("should kebab-case loader name and append '-loader'", () => {

lib/generators/plugin-generator.js

@@ -21,7 +21,7 @@ const PluginGenerator = webpackGenerator(
 			validate: str => str.length > 0
 		}
 	],
-	path.join(__dirname, "../generate-plugin/templates"),
+	path.resolve(__dirname, "..", "generate-plugin"),
 	[
 		"src/cjs.js.tpl",
 		"test/test-utils.js.tpl",

lib/generators/webpack-generator.js

@@ -68,7 +68,7 @@ function webpackGenerator(
 			this.npmInstall(["webpack-defaults", "bluebird"], {
 				"save-dev": true
 			}).then(() => {
-				this.spawnCommand("npm", ["run", "webpack-defaults"]);
+				this.spawnCommand("npm", ["run", "defaults"]);
 			});
 		}
 	};

lib/index.js

@@ -1,7 +1,5 @@
 "use strict";
 
-const path = require("path");
-
 /**
  *
  * First function to be called after running a flag. This is a check,
@@ -14,50 +12,10 @@ const path = require("path");
  */
 
 module.exports = function initialize(command, args) {
-	const popArgs = args ? args.slice(2).pop() : null;
-	switch (command) {
-		case "init": {
-			const initPkgs = args.slice(2).length === 1 ? [] : [popArgs];
-			//eslint-disable-next-line
-			return require("./commands/init.js")(initPkgs);
-		}
-		case "migrate": {
-			const filePaths = args.slice(2).length === 1 ? [] : [popArgs];
-			if (!filePaths.length) {
-				throw new Error("Please specify a path to your webpack config");
-			}
-			const inputConfigPath = path.resolve(process.cwd(), filePaths[0]);
-			//eslint-disable-next-line
-			return require("./commands/migrate.js")(inputConfigPath, inputConfigPath);
-		}
-		case "add": {
-			//eslint-disable-next-line
-			return require("./commands/add")();
-		}
-		case "remove": {
-			//eslint-disable-next-line
-			return require("./commands/remove")();
-		}
-		case "update": {
-			return require("./commands/update")();
-		}
-		case "serve": {
-			return require("./commands/serve").serve();
-		}
-		case "make": {
-			return require("./commands/make")();
-		}
-		case "generate-loader": {
-			return require("./generate-loader/index.js")();
-		}
-		case "generate-plugin": {
-			return require("./generate-plugin/index.js")();
-		}
-		case "info": {
-			return require("./commands/info.js")();
-		}
-		default: {
-			throw new Error(`Unknown command ${command} found`);
-		}
+	if (!command) {
+		throw new Error(`Unknown command ${command} found`);
+	} else if (command === "serve") {
+		return require(`./commands/${command}`).serve();
 	}
+	return require(`./commands/${command}`)(...args);
 };

lib/init/transformations/top-scope/top-scope.test.js

@@ -2,7 +2,13 @@
 
 const defineTest = require("../../../utils/defineTest");
 
-defineTest(__dirname, "top-scope", "top-scope-0", ["const test = 'me';"], "init");
+defineTest(
+	__dirname,
+	"top-scope",
+	"top-scope-0",
+	["const test = 'me';"],
+	"init"
+);
 defineTest(
 	__dirname,
 	"top-scope",

lib/migrate/loaderOptionsPlugin/loaderOptionsPlugin.js

@@ -20,11 +20,9 @@ module.exports = function(j, ast) {
 	// If there is debug: true, set debug: true in the plugin
 	if (ast.find(j.Identifier, { name: "debug" }).size()) {
 		loaderOptions.debug = true;
-		ast
-			.find(j.Identifier, { name: "debug" })
-			.forEach(p => {
-				p.parent.prune();
-			});
+		ast.find(j.Identifier, { name: "debug" }).forEach(p => {
+			p.parent.prune();
+		});
 	}
 
 	// If there is UglifyJsPlugin, set minimize: true