init-generator.ts

import chalk from "chalk";
import * as logSymbols from "log-symbols";
import * as Generator from "yeoman-generator";
import * as path from "path";

import { getPackageManager } from "@webpack-cli/utils/package-manager";
import { Confirm, Input, List } from "@webpack-cli/webpack-scaffold";

import { getDefaultOptimization } from "./utils/webpackConfig";
import { WebpackOptions } from "./types";
import entryQuestions from "./utils/entry";
import langQuestionHandler, { LangType } from "./utils/languageSupport";
import styleQuestionHandler, { Loader, StylingType } from "./utils/styleSupport";
import tooltip from "./utils/tooltip";
import { generatePluginName } from "./utils/plugins";

/**
 *
 * Generator for initializing a webpack config
 *
 * @class 	InitGenerator
 * @extends Generator
 * @returns {Void} After execution, transforms are triggered
 *
 */
export default class InitGenerator extends Generator {
	public usingDefaults: boolean;
	private isProd: boolean;
	private dependencies: string[];
	private configuration: {
		config: {
			configName?: string;
			topScope?: string[];
			webpackOptions?: WebpackOptions;
		};
	};
	private langType: string;

	public constructor(args, opts) {
		super(args, opts);
		(this.usingDefaults = false), (this.isProd = this.usingDefaults ? true : false);

		this.dependencies = ["webpack", "webpack-cli", "babel-plugin-syntax-dynamic-import"];
		if (this.isProd) {
			this.dependencies.push("terser-webpack-plugin");
		} else {
			this.dependencies.push("webpack-dev-server");
		}

		this.configuration = {
			config: {
				configName: this.isProd ? "prod" : "config",
				topScope: [],
				webpackOptions: {
					mode: this.isProd ? "'production'" : "'development'",
					entry: undefined,
					output: undefined,
					plugins: [],
					module: {
						rules: []
					}
				}
			}
		};

		// add splitChunks options for transparency
		// defaults coming from: https://webpack.js.org/plugins/split-chunks-plugin/#optimization-splitchunks
		this.configuration.config.topScope.push(
			"const path = require('path');",
			"const webpack = require('webpack');",
			"\n",
			tooltip.splitChunks()
		);

		if (this.isProd) {
			this.configuration.config.topScope.push(
				tooltip.terser(),
				"const TerserPlugin = require('terser-webpack-plugin');",
				"\n"
			);
		}

		(this.configuration.config.webpackOptions.plugins as string[]).push("new webpack.ProgressPlugin()");

		let optimizationConfig = getDefaultOptimization(this.isProd);
		this.configuration.config.webpackOptions.optimization = optimizationConfig;

		if (!this.isProd) {
			this.configuration.config.webpackOptions.devServer = {
				open: true
			};
		}
	}

	public async prompting(): Promise<void | {}> {
		const done: () => {} = this.async();
		const self: this = this;
		let regExpForStyles: string;
		let ExtractUseProps: Loader[];

		process.stdout.write(
			`\n${logSymbols.info}${chalk.blue(" INFO ")} ` +
				`For more information and a detailed description of each question, have a look at: ` +
				`${chalk.bold.green("https://github.com/webpack/webpack-cli/blob/master/INIT.md")}\n`
		);
		process.stdout.write(
			`${logSymbols.info}${chalk.blue(" INFO ")} ` +
				`Alternatively, run "webpack(-cli) --help" for usage info\n\n`
		);

		const { multiEntries } = await this.prompt([
			Confirm("multiEntries", "Will your application have multiple bundles?", false)
		]);

		// TODO string | object
		const entryOption: void | {} = await entryQuestions(self, multiEntries);

		if (typeof entryOption === "string" && entryOption.length > 0) {
			this.configuration.config.webpackOptions.entry = `${entryOption}`;
		} else if (typeof entryOption === "object") {
			this.configuration.config.webpackOptions.entry = entryOption;
		}

		const { outputDir } = await this.prompt([
			Input("outputDir", "In which folder do you want to store your generated bundles?", "dist")
		]);

		// As entry is not required anymore and we dont set it to be an empty string or """""
		// it can be undefined so falsy check is enough (vs entry.length);
		if (!this.configuration.config.webpackOptions.entry && !this.usingDefaults) {
			this.configuration.config.webpackOptions.output = {
				chunkFilename: "'[name].[chunkhash].js'",
				filename: "'[name].[chunkhash].js'"
			};
		} else if (!this.usingDefaults) {
			this.configuration.config.webpackOptions.output = {
				filename: "'[name].[chunkhash].js'"
			};
		}
		if (!this.usingDefaults && outputDir.length) {
			this.configuration.config.webpackOptions.output.path = `path.resolve(__dirname, '${outputDir}')`;
		}

		const { langType } = await this.prompt([
			List("langType", "Will you use one of the below JS solutions?", [LangType.ES6, LangType.Typescript, "No"])
		]);

		langQuestionHandler(this, langType);
		this.langType = langType;

		const { stylingType } = await this.prompt([
			List("stylingType", "Will you use one of the below CSS solutions?", [
				"No",
				StylingType.CSS,
				StylingType.SASS,
				StylingType.LESS,
				StylingType.PostCSS
			])
		]);

		({ ExtractUseProps, regExpForStyles } = styleQuestionHandler(self, stylingType));

		if (this.isProd) {
			// Ask if the user wants to use extractPlugin
			const { useExtractPlugin } = await this.prompt([
				Input(
					"useExtractPlugin",
					"If you want to bundle your CSS files, what will you name the bundle? (press enter to skip)"
				)
			]);

			if (regExpForStyles) {
				if (this.isProd) {
					const cssBundleName: string = useExtractPlugin;
					this.dependencies.push("mini-css-extract-plugin");
					this.configuration.config.topScope.push(
						tooltip.cssPlugin(),
						"const MiniCssExtractPlugin = require('mini-css-extract-plugin');",
						"\n"
					);
					if (cssBundleName.length !== 0) {
						(this.configuration.config.webpackOptions.plugins as string[]).push(
							// TODO: use [contenthash] after it is supported
							`new MiniCssExtractPlugin({ filename:'${cssBundleName}.[chunkhash].css' })`
						);
					} else {
						(this.configuration.config.webpackOptions.plugins as string[]).push(
							"new MiniCssExtractPlugin({ filename:'style.css' })"
						);
					}

					ExtractUseProps.unshift({
						loader: "MiniCssExtractPlugin.loader"
					});
				}

				this.configuration.config.webpackOptions.module.rules.push({
					test: regExpForStyles,
					use: ExtractUseProps
				});
			}
		}
		if (!this.isProd) {
			this.dependencies.push("html-webpack-plugin");
			const htmlWebpackDependency = "html-webpack-plugin";
			const htmlwebpackPlugin = generatePluginName(htmlWebpackDependency);
			(this.configuration.config.topScope as string[]).push(
				`const ${htmlwebpackPlugin} = require('${htmlWebpackDependency}')`,
				"\n",
				tooltip.html()
			);
			(this.configuration.config.webpackOptions.plugins as string[]).push(`new ${htmlwebpackPlugin}()`);
		}
		done();
	}

	public installPlugins(): void {
		const packager = getPackageManager();
		const opts: {
			dev?: boolean;
			"save-dev"?: boolean;
		} = packager === "yarn" ? { dev: true } : { "save-dev": true };

		this.scheduleInstallTask(packager, this.dependencies, opts);
	}

	public writing(): void {
		this.config.set("configuration", this.configuration);

		const packageJsonTemplatePath = "./templates/package.json.js";
		this.fs.extendJSON(this.destinationPath("package.json"), require(packageJsonTemplatePath)(this.isProd));

		const generateEntryFile = (entryPath: string, name: string): void => {
			entryPath = entryPath.replace(/'/g, "");
			this.fs.copyTpl(path.resolve(__dirname, "./templates/index.js"), this.destinationPath(entryPath), { name });
		};

		// Generate entry file/files
		const entry = this.configuration.config.webpackOptions.entry;
		if (typeof entry === "string") {
			generateEntryFile(entry, "your main file!");
		} else if (typeof entry === "object") {
			Object.keys(entry).forEach((name: string): void => generateEntryFile(entry[name], `${name} main file!`));
		}

		// Generate README
		this.fs.copyTpl(path.resolve(__dirname, "./templates/README.md"), this.destinationPath("README.md"), {});

		// Genrate tsconfig
		if (this.langType === LangType.Typescript) {
			const tsConfigTemplatePath = "./templates/tsconfig.json.js";
			this.fs.extendJSON(this.destinationPath("tsconfig.json"), require(tsConfigTemplatePath));
		}
	}
}