123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905 |
- "use strict";
- Object.defineProperty(exports, "__esModule", { value: true });
- const fs = require("fs");
- const path = require("path");
- const { pathToFileURL } = require("url");
- const util = require("util");
- const { program, Option } = require("commander");
- const WEBPACK_PACKAGE = process.env.WEBPACK_PACKAGE || "webpack";
- const WEBPACK_DEV_SERVER_PACKAGE = process.env.WEBPACK_DEV_SERVER_PACKAGE || "webpack-dev-server";
- class WebpackCLI {
- constructor() {
- this.colors = this.createColors();
- this.logger = this.getLogger();
- // Initialize program
- this.program = program;
- this.program.name("webpack");
- this.program.configureOutput({
- writeErr: this.logger.error,
- outputError: (str, write) => write(`Error: ${this.capitalizeFirstLetter(str.replace(/^error:/, "").trim())}`),
- });
- }
- isMultipleCompiler(compiler) {
- return compiler.compilers;
- }
- isPromise(value) {
- return typeof value.then === "function";
- }
- isFunction(value) {
- return typeof value === "function";
- }
- capitalizeFirstLetter(str) {
- if (typeof str !== "string") {
- return "";
- }
- return str.charAt(0).toUpperCase() + str.slice(1);
- }
- toKebabCase(str) {
- return str.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
- }
- createColors(useColor) {
- const { createColors, isColorSupported } = require("colorette");
- let shouldUseColor;
- if (useColor) {
- shouldUseColor = useColor;
- }
- else {
- shouldUseColor = isColorSupported;
- }
- return Object.assign(Object.assign({}, createColors({ useColor: shouldUseColor })), { isColorSupported: shouldUseColor });
- }
- getLogger() {
- return {
- error: (val) => console.error(`[webpack-cli] ${this.colors.red(util.format(val))}`),
- warn: (val) => console.warn(`[webpack-cli] ${this.colors.yellow(val)}`),
- info: (val) => console.info(`[webpack-cli] ${this.colors.cyan(val)}`),
- success: (val) => console.log(`[webpack-cli] ${this.colors.green(val)}`),
- log: (val) => console.log(`[webpack-cli] ${val}`),
- raw: (val) => console.log(val),
- };
- }
- checkPackageExists(packageName) {
- if (process.versions.pnp) {
- return true;
- }
- let dir = __dirname;
- do {
- try {
- if (fs.statSync(path.join(dir, "node_modules", packageName)).isDirectory()) {
- return true;
- }
- }
- catch (_error) {
- // Nothing
- }
- } while (dir !== (dir = path.dirname(dir)));
- return false;
- }
- getAvailablePackageManagers() {
- const { sync } = require("cross-spawn");
- const installers = ["npm", "yarn", "pnpm"];
- const hasPackageManagerInstalled = (packageManager) => {
- try {
- sync(packageManager, ["--version"]);
- return packageManager;
- }
- catch (err) {
- return false;
- }
- };
- const availableInstallers = installers.filter((installer) => hasPackageManagerInstalled(installer));
- if (!availableInstallers.length) {
- this.logger.error("No package manager found.");
- process.exit(2);
- }
- return availableInstallers;
- }
- getDefaultPackageManager() {
- const { sync } = require("cross-spawn");
- const hasLocalNpm = fs.existsSync(path.resolve(process.cwd(), "package-lock.json"));
- if (hasLocalNpm) {
- return "npm";
- }
- const hasLocalYarn = fs.existsSync(path.resolve(process.cwd(), "yarn.lock"));
- if (hasLocalYarn) {
- return "yarn";
- }
- const hasLocalPnpm = fs.existsSync(path.resolve(process.cwd(), "pnpm-lock.yaml"));
- if (hasLocalPnpm) {
- return "pnpm";
- }
- try {
- // the sync function below will fail if npm is not installed,
- // an error will be thrown
- if (sync("npm", ["--version"])) {
- return "npm";
- }
- }
- catch (e) {
- // Nothing
- }
- try {
- // the sync function below will fail if yarn is not installed,
- // an error will be thrown
- if (sync("yarn", ["--version"])) {
- return "yarn";
- }
- }
- catch (e) {
- // Nothing
- }
- try {
- // the sync function below will fail if pnpm is not installed,
- // an error will be thrown
- if (sync("pnpm", ["--version"])) {
- return "pnpm";
- }
- }
- catch (e) {
- this.logger.error("No package manager found.");
- process.exit(2);
- }
- }
- async doInstall(packageName, options = {}) {
- const packageManager = this.getDefaultPackageManager();
- if (!packageManager) {
- this.logger.error("Can't find package manager");
- process.exit(2);
- }
- if (options.preMessage) {
- options.preMessage();
- }
- const prompt = ({ message, defaultResponse, stream }) => {
- const readline = require("readline");
- const rl = readline.createInterface({
- input: process.stdin,
- output: stream,
- });
- return new Promise((resolve) => {
- rl.question(`${message} `, (answer) => {
- // Close the stream
- rl.close();
- const response = (answer || defaultResponse).toLowerCase();
- // Resolve with the input response
- if (response === "y" || response === "yes") {
- resolve(true);
- }
- else {
- resolve(false);
- }
- });
- });
- };
- // yarn uses 'add' command, rest npm and pnpm both use 'install'
- const commandArguments = [packageManager === "yarn" ? "add" : "install", "-D", packageName];
- const commandToBeRun = `${packageManager} ${commandArguments.join(" ")}`;
- let needInstall;
- try {
- needInstall = await prompt({
- message: `[webpack-cli] Would you like to install '${this.colors.green(packageName)}' package? (That will run '${this.colors.green(commandToBeRun)}') (${this.colors.yellow("Y/n")})`,
- defaultResponse: "Y",
- stream: process.stderr,
- });
- }
- catch (error) {
- this.logger.error(error);
- process.exit(error);
- }
- if (needInstall) {
- const { sync } = require("cross-spawn");
- try {
- sync(packageManager, commandArguments, { stdio: "inherit" });
- }
- catch (error) {
- this.logger.error(error);
- process.exit(2);
- }
- return packageName;
- }
- process.exit(2);
- }
- async tryRequireThenImport(module, handleError = true) {
- let result;
- try {
- result = require(module);
- }
- catch (error) {
- const dynamicImportLoader = require("./utils/dynamic-import-loader")();
- if ((error.code === "ERR_REQUIRE_ESM" ||
- process.env.WEBPACK_CLI_FORCE_LOAD_ESM_CONFIG) &&
- pathToFileURL &&
- dynamicImportLoader) {
- const urlForConfig = pathToFileURL(module);
- result = await dynamicImportLoader(urlForConfig);
- result = result.default;
- return result;
- }
- if (handleError) {
- this.logger.error(error);
- process.exit(2);
- }
- else {
- throw error;
- }
- }
- // For babel/typescript
- if (result && typeof result === "object" && "default" in result) {
- result = result.default || {};
- }
- return result || {};
- }
- loadJSONFile(pathToFile, handleError = true) {
- let result;
- try {
- result = require(pathToFile);
- }
- catch (error) {
- if (handleError) {
- this.logger.error(error);
- process.exit(2);
- }
- else {
- throw error;
- }
- }
- return result;
- }
- async makeCommand(commandOptions, options, action) {
- const alreadyLoaded = this.program.commands.find((command) => command.name() === commandOptions.name.split(" ")[0] ||
- command.aliases().includes(commandOptions.alias));
- if (alreadyLoaded) {
- return;
- }
- const command = this.program.command(commandOptions.name, {
- noHelp: commandOptions.noHelp,
- hidden: commandOptions.hidden,
- isDefault: commandOptions.isDefault,
- });
- if (commandOptions.description) {
- command.description(commandOptions.description, commandOptions.argsDescription);
- }
- if (commandOptions.usage) {
- command.usage(commandOptions.usage);
- }
- if (Array.isArray(commandOptions.alias)) {
- command.aliases(commandOptions.alias);
- }
- else {
- command.alias(commandOptions.alias);
- }
- if (commandOptions.pkg) {
- command.pkg = commandOptions.pkg;
- }
- else {
- command.pkg = "webpack-cli";
- }
- const { forHelp } = this.program;
- let allDependenciesInstalled = true;
- if (commandOptions.dependencies && commandOptions.dependencies.length > 0) {
- for (const dependency of commandOptions.dependencies) {
- const isPkgExist = this.checkPackageExists(dependency);
- if (isPkgExist) {
- continue;
- }
- else if (!isPkgExist && forHelp) {
- allDependenciesInstalled = false;
- continue;
- }
- let skipInstallation = false;
- // Allow to use `./path/to/webpack.js` outside `node_modules`
- if (dependency === WEBPACK_PACKAGE && fs.existsSync(WEBPACK_PACKAGE)) {
- skipInstallation = true;
- }
- // Allow to use `./path/to/webpack-dev-server.js` outside `node_modules`
- if (dependency === WEBPACK_DEV_SERVER_PACKAGE && fs.existsSync(WEBPACK_PACKAGE)) {
- skipInstallation = true;
- }
- if (skipInstallation) {
- continue;
- }
- await this.doInstall(dependency, {
- preMessage: () => {
- this.logger.error(`For using '${this.colors.green(commandOptions.name.split(" ")[0])}' command you need to install: '${this.colors.green(dependency)}' package.`);
- },
- });
- }
- }
- if (options) {
- if (typeof options === "function") {
- if (forHelp && !allDependenciesInstalled && commandOptions.dependencies) {
- command.description(`${commandOptions.description} To see all available options you need to install ${commandOptions.dependencies
- .map((dependency) => `'${dependency}'`)
- .join(", ")}.`);
- options = [];
- }
- else {
- options = await options();
- }
- }
- options.forEach((optionForCommand) => {
- this.makeOption(command, optionForCommand);
- });
- }
- command.action(action);
- return command;
- }
- makeOption(command, option) {
- let mainOption;
- let negativeOption;
- if (option.configs) {
- let needNegativeOption = false;
- let negatedDescription;
- const mainOptionType = new Set();
- option.configs.forEach((config) => {
- switch (config.type) {
- case "reset":
- mainOptionType.add(Boolean);
- break;
- case "boolean":
- if (!needNegativeOption) {
- needNegativeOption = true;
- negatedDescription = config.negatedDescription;
- }
- mainOptionType.add(Boolean);
- break;
- case "number":
- mainOptionType.add(Number);
- break;
- case "string":
- case "path":
- case "RegExp":
- mainOptionType.add(String);
- break;
- case "enum": {
- let hasFalseEnum = false;
- const enumTypes = (config.values || []).map((value) => {
- switch (typeof value) {
- case "string":
- mainOptionType.add(String);
- break;
- case "number":
- mainOptionType.add(Number);
- break;
- case "boolean":
- if (!hasFalseEnum && value === false) {
- hasFalseEnum = true;
- break;
- }
- mainOptionType.add(Boolean);
- break;
- }
- });
- if (!needNegativeOption) {
- needNegativeOption = hasFalseEnum;
- negatedDescription = config.negatedDescription;
- }
- return enumTypes;
- }
- }
- });
- mainOption = {
- flags: option.alias ? `-${option.alias}, --${option.name}` : `--${option.name}`,
- description: option.description || "",
- type: mainOptionType,
- multiple: option.multiple,
- defaultValue: option.defaultValue,
- };
- if (needNegativeOption) {
- negativeOption = {
- flags: `--no-${option.name}`,
- description: negatedDescription || option.negatedDescription || `Negative '${option.name}' option.`,
- };
- }
- }
- else {
- mainOption = {
- flags: option.alias ? `-${option.alias}, --${option.name}` : `--${option.name}`,
- // TODO `describe` used by `webpack-dev-server@3`
- description: option.description || option.describe || "",
- type: option.type
- ? new Set(Array.isArray(option.type) ? option.type : [option.type])
- : new Set([Boolean]),
- multiple: option.multiple,
- defaultValue: option.defaultValue,
- };
- if (option.negative) {
- negativeOption = {
- flags: `--no-${option.name}`,
- description: option.negatedDescription
- ? option.negatedDescription
- : `Negative '${option.name}' option.`,
- };
- }
- }
- if (mainOption.type.size > 1 && mainOption.type.has(Boolean)) {
- mainOption.flags = `${mainOption.flags} [value${mainOption.multiple ? "..." : ""}]`;
- }
- else if (mainOption.type.size > 0 && !mainOption.type.has(Boolean)) {
- mainOption.flags = `${mainOption.flags} <value${mainOption.multiple ? "..." : ""}>`;
- }
- if (mainOption.type.size === 1) {
- if (mainOption.type.has(Number)) {
- let skipDefault = true;
- const optionForCommand = new Option(mainOption.flags, mainOption.description)
- .argParser((value, prev = []) => {
- if (mainOption.defaultValue && mainOption.multiple && skipDefault) {
- prev = [];
- skipDefault = false;
- }
- return mainOption.multiple
- ? [].concat(prev).concat(Number(value))
- : Number(value);
- })
- .default(mainOption.defaultValue);
- optionForCommand.helpLevel = option.helpLevel;
- command.addOption(optionForCommand);
- }
- else if (mainOption.type.has(String)) {
- let skipDefault = true;
- const optionForCommand = new Option(mainOption.flags, mainOption.description)
- .argParser((value, prev = []) => {
- if (mainOption.defaultValue && mainOption.multiple && skipDefault) {
- prev = [];
- skipDefault = false;
- }
- return mainOption.multiple ? [].concat(prev).concat(value) : value;
- })
- .default(mainOption.defaultValue);
- optionForCommand.helpLevel = option.helpLevel;
- command.addOption(optionForCommand);
- }
- else if (mainOption.type.has(Boolean)) {
- const optionForCommand = new Option(mainOption.flags, mainOption.description).default(mainOption.defaultValue);
- optionForCommand.helpLevel = option.helpLevel;
- command.addOption(optionForCommand);
- }
- else {
- const optionForCommand = new Option(mainOption.flags, mainOption.description)
- .argParser(Array.from(mainOption.type)[0])
- .default(mainOption.defaultValue);
- optionForCommand.helpLevel = option.helpLevel;
- command.addOption(optionForCommand);
- }
- }
- else if (mainOption.type.size > 1) {
- let skipDefault = true;
- const optionForCommand = new Option(mainOption.flags, mainOption.description, mainOption.defaultValue)
- .argParser((value, prev = []) => {
- if (mainOption.defaultValue && mainOption.multiple && skipDefault) {
- prev = [];
- skipDefault = false;
- }
- if (mainOption.type.has(Number)) {
- const numberValue = Number(value);
- if (!isNaN(numberValue)) {
- return mainOption.multiple
- ? [].concat(prev).concat(numberValue)
- : numberValue;
- }
- }
- if (mainOption.type.has(String)) {
- return mainOption.multiple ? [].concat(prev).concat(value) : value;
- }
- return value;
- })
- .default(mainOption.defaultValue);
- optionForCommand.helpLevel = option.helpLevel;
- command.addOption(optionForCommand);
- }
- else if (mainOption.type.size === 0 && negativeOption) {
- const optionForCommand = new Option(mainOption.flags, mainOption.description);
- // Hide stub option
- optionForCommand.hideHelp();
- optionForCommand.helpLevel = option.helpLevel;
- command.addOption(optionForCommand);
- }
- if (negativeOption) {
- const optionForCommand = new Option(negativeOption.flags, negativeOption.description);
- optionForCommand.helpLevel = option.helpLevel;
- command.addOption(optionForCommand);
- }
- }
- getBuiltInOptions() {
- if (this.builtInOptionsCache) {
- return this.builtInOptionsCache;
- }
- const minimumHelpFlags = [
- "config",
- "config-name",
- "merge",
- "env",
- "mode",
- "watch",
- "watch-options-stdin",
- "stats",
- "devtool",
- "entry",
- "target",
- "progress",
- "json",
- "name",
- "output-path",
- "node-env",
- ];
- const builtInFlags = [
- // For configs
- {
- name: "config",
- alias: "c",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: true,
- description: "Provide path to a webpack configuration file e.g. ./webpack.config.js.",
- },
- {
- name: "config-name",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: true,
- description: "Name of the configuration to use.",
- },
- {
- name: "merge",
- alias: "m",
- configs: [
- {
- type: "enum",
- values: [true],
- },
- ],
- description: "Merge two or more configurations using 'webpack-merge'.",
- },
- // Complex configs
- {
- name: "env",
- type: (value, previous = {}) => {
- // This ensures we're only splitting by the first `=`
- const [allKeys, val] = value.split(/=(.+)/, 2);
- const splitKeys = allKeys.split(/\.(?!$)/);
- let prevRef = previous;
- splitKeys.forEach((someKey, index) => {
- // https://github.com/webpack/webpack-cli/issues/3284
- if (someKey.endsWith("=")) {
- // remove '=' from key
- someKey = someKey.slice(0, -1);
- // @ts-expect-error we explicitly want to set it to undefined
- prevRef[someKey] = undefined;
- return;
- }
- if (!prevRef[someKey]) {
- prevRef[someKey] = {};
- }
- if (typeof prevRef[someKey] === "string") {
- prevRef[someKey] = {};
- }
- if (index === splitKeys.length - 1) {
- if (typeof val === "string") {
- prevRef[someKey] = val;
- }
- else {
- prevRef[someKey] = true;
- }
- }
- prevRef = prevRef[someKey];
- });
- return previous;
- },
- multiple: true,
- description: "Environment passed to the configuration when it is a function.",
- },
- {
- name: "node-env",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: false,
- description: "Sets process.env.NODE_ENV to the specified value.",
- },
- // Adding more plugins
- {
- name: "hot",
- alias: "h",
- configs: [
- {
- type: "string",
- },
- {
- type: "boolean",
- },
- ],
- negative: true,
- description: "Enables Hot Module Replacement",
- negatedDescription: "Disables Hot Module Replacement.",
- },
- {
- name: "analyze",
- configs: [
- {
- type: "enum",
- values: [true],
- },
- ],
- multiple: false,
- description: "It invokes webpack-bundle-analyzer plugin to get bundle information.",
- },
- {
- name: "progress",
- configs: [
- {
- type: "string",
- },
- {
- type: "enum",
- values: [true],
- },
- ],
- description: "Print compilation progress during build.",
- },
- {
- name: "prefetch",
- configs: [
- {
- type: "string",
- },
- ],
- description: "Prefetch this request.",
- },
- // Output options
- {
- name: "json",
- configs: [
- {
- type: "string",
- },
- {
- type: "enum",
- values: [true],
- },
- ],
- alias: "j",
- description: "Prints result as JSON or store it in a file.",
- },
- // For webpack@4
- {
- name: "entry",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: true,
- description: "The entry point(s) of your application e.g. ./src/main.js.",
- },
- {
- name: "output-path",
- alias: "o",
- configs: [
- {
- type: "string",
- },
- ],
- description: "Output location of the file generated by webpack e.g. ./dist/.",
- },
- {
- name: "target",
- alias: "t",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: this.webpack.cli !== undefined,
- description: "Sets the build target e.g. node.",
- },
- {
- name: "devtool",
- configs: [
- {
- type: "string",
- },
- {
- type: "enum",
- values: [false],
- },
- ],
- negative: true,
- alias: "d",
- description: "Determine source maps to use.",
- negatedDescription: "Do not generate source maps.",
- },
- {
- name: "mode",
- configs: [
- {
- type: "string",
- },
- ],
- description: "Defines the mode to pass to webpack.",
- },
- {
- name: "name",
- configs: [
- {
- type: "string",
- },
- ],
- description: "Name of the configuration. Used when loading multiple configurations.",
- },
- {
- name: "stats",
- configs: [
- {
- type: "string",
- },
- {
- type: "boolean",
- },
- ],
- negative: true,
- description: "It instructs webpack on how to treat the stats e.g. verbose.",
- negatedDescription: "Disable stats output.",
- },
- {
- name: "watch",
- configs: [
- {
- type: "boolean",
- },
- ],
- negative: true,
- alias: "w",
- description: "Watch for files changes.",
- negatedDescription: "Do not watch for file changes.",
- },
- {
- name: "watch-options-stdin",
- configs: [
- {
- type: "boolean",
- },
- ],
- negative: true,
- description: "Stop watching when stdin stream has ended.",
- negatedDescription: "Do not stop watching when stdin stream has ended.",
- },
- ];
- // Extract all the flags being exported from core.
- // A list of cli flags generated by core can be found here https://github.com/webpack/webpack/blob/master/test/__snapshots__/Cli.test.js.snap
- const coreFlags = this.webpack.cli
- ? Object.entries(this.webpack.cli.getArguments()).map(([flag, meta]) => {
- const inBuiltIn = builtInFlags.find((builtInFlag) => builtInFlag.name === flag);
- if (inBuiltIn) {
- return Object.assign(Object.assign(Object.assign(Object.assign({}, meta), {
- // @ts-expect-error this might be overwritten
- name: flag, group: "core" }), inBuiltIn), { configs: meta.configs || [] });
- }
- return Object.assign(Object.assign({}, meta), { name: flag, group: "core" });
- })
- : [];
- const options = []
- .concat(builtInFlags.filter((builtInFlag) => !coreFlags.find((coreFlag) => builtInFlag.name === coreFlag.name)))
- .concat(coreFlags)
- .map((option) => {
- option.helpLevel = minimumHelpFlags.includes(option.name)
- ? "minimum"
- : "verbose";
- return option;
- });
- this.builtInOptionsCache = options;
- return options;
- }
- async loadWebpack(handleError = true) {
- return this.tryRequireThenImport(WEBPACK_PACKAGE, handleError);
- }
- async run(args, parseOptions) {
- // Built-in internal commands
- const buildCommandOptions = {
- name: "build [entries...]",
- alias: ["bundle", "b"],
- description: "Run webpack (default command, can be omitted).",
- usage: "[entries...] [options]",
- dependencies: [WEBPACK_PACKAGE],
- };
- const watchCommandOptions = {
- name: "watch [entries...]",
- alias: "w",
- description: "Run webpack and watch for files changes.",
- usage: "[entries...] [options]",
- dependencies: [WEBPACK_PACKAGE],
- };
- const versionCommandOptions = {
- name: "version [commands...]",
- alias: "v",
- description: "Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.",
- };
- const helpCommandOptions = {
- name: "help [command] [option]",
- alias: "h",
- description: "Display help for commands and options.",
- };
- // Built-in external commands
- const externalBuiltInCommandsInfo = [
- {
- name: "serve [entries...]",
- alias: ["server", "s"],
- pkg: "@webpack-cli/serve",
- },
- {
- name: "info",
- alias: "i",
- pkg: "@webpack-cli/info",
- },
- {
- name: "init",
- alias: ["create", "new", "c", "n"],
- pkg: "@webpack-cli/generators",
- },
- {
- name: "loader",
- alias: "l",
- pkg: "@webpack-cli/generators",
- },
- {
- name: "plugin",
- alias: "p",
- pkg: "@webpack-cli/generators",
- },
- {
- name: "migrate",
- alias: "m",
- pkg: "@webpack-cli/migrate",
- },
- {
- name: "configtest [config-path]",
- alias: "t",
- pkg: "@webpack-cli/configtest",
- },
- ];
- const knownCommands = [
- buildCommandOptions,
- watchCommandOptions,
- versionCommandOptions,
- helpCommandOptions,
- ...externalBuiltInCommandsInfo,
- ];
- const getCommandName = (name) => name.split(" ")[0];
- const isKnownCommand = (name) => knownCommands.find((command) => getCommandName(command.name) === name ||
- (Array.isArray(command.alias) ? command.alias.includes(name) : command.alias === name));
- const isCommand = (input, commandOptions) => {
- const longName = getCommandName(commandOptions.name);
- if (input === longName) {
- return true;
- }
- if (commandOptions.alias) {
- if (Array.isArray(commandOptions.alias)) {
- return commandOptions.alias.includes(input);
- }
- else {
- return commandOptions.alias === input;
- }
- }
- return false;
- };
- const findCommandByName = (name) => this.program.commands.find((command) => name === command.name() || command.aliases().includes(name));
- const isOption = (value) => value.startsWith("-");
- const isGlobalOption = (value) => value === "--color" ||
- value === "--no-color" ||
- value === "-v" ||
- value === "--version" ||
- value === "-h" ||
- value === "--help";
- const loadCommandByName = async (commandName, allowToInstall = false) => {
- const isBuildCommandUsed = isCommand(commandName, buildCommandOptions);
- const isWatchCommandUsed = isCommand(commandName, watchCommandOptions);
- if (isBuildCommandUsed || isWatchCommandUsed) {
- await this.makeCommand(isBuildCommandUsed ? buildCommandOptions : watchCommandOptions, async () => {
- this.webpack = await this.loadWebpack();
- return isWatchCommandUsed
- ? this.getBuiltInOptions().filter((option) => option.name !== "watch")
- : this.getBuiltInOptions();
- }, async (entries, options) => {
- if (entries.length > 0) {
- options.entry = [...entries, ...(options.entry || [])];
- }
- await this.runWebpack(options, isWatchCommandUsed);
- });
- }
- else if (isCommand(commandName, helpCommandOptions)) {
- // Stub for the `help` command
- // eslint-disable-next-line @typescript-eslint/no-empty-function
- this.makeCommand(helpCommandOptions, [], () => { });
- }
- else if (isCommand(commandName, versionCommandOptions)) {
- // Stub for the `version` command
- // eslint-disable-next-line @typescript-eslint/no-empty-function
- this.makeCommand(versionCommandOptions, [], () => { });
- }
- else {
- const builtInExternalCommandInfo = externalBuiltInCommandsInfo.find((externalBuiltInCommandInfo) => getCommandName(externalBuiltInCommandInfo.name) === commandName ||
- (Array.isArray(externalBuiltInCommandInfo.alias)
- ? externalBuiltInCommandInfo.alias.includes(commandName)
- : externalBuiltInCommandInfo.alias === commandName));
- let pkg;
- if (builtInExternalCommandInfo) {
- ({ pkg } = builtInExternalCommandInfo);
- }
- else {
- pkg = commandName;
- }
- if (pkg !== "webpack-cli" && !this.checkPackageExists(pkg)) {
- if (!allowToInstall) {
- return;
- }
- pkg = await this.doInstall(pkg, {
- preMessage: () => {
- this.logger.error(`For using this command you need to install: '${this.colors.green(pkg)}' package.`);
- },
- });
- }
- let loadedCommand;
- try {
- loadedCommand = await this.tryRequireThenImport(pkg, false);
- }
- catch (error) {
- // Ignore, command is not installed
- return;
- }
- let command;
- try {
- command = new loadedCommand();
- await command.apply(this);
- }
- catch (error) {
- this.logger.error(`Unable to load '${pkg}' command`);
- this.logger.error(error);
- process.exit(2);
- }
- }
- };
- // Register own exit
- this.program.exitOverride(async (error) => {
- if (error.exitCode === 0) {
- process.exit(0);
- }
- if (error.code === "executeSubCommandAsync") {
- process.exit(2);
- }
- if (error.code === "commander.help") {
- process.exit(0);
- }
- if (error.code === "commander.unknownOption") {
- let name = error.message.match(/'(.+)'/);
- if (name) {
- name = name[1].slice(2);
- if (name.includes("=")) {
- name = name.split("=")[0];
- }
- const { operands } = this.program.parseOptions(this.program.args);
- const operand = typeof operands[0] !== "undefined"
- ? operands[0]
- : getCommandName(buildCommandOptions.name);
- if (operand) {
- const command = findCommandByName(operand);
- if (!command) {
- this.logger.error(`Can't find and load command '${operand}'`);
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- }
- const levenshtein = require("fastest-levenshtein");
- command.options.forEach((option) => {
- var _a;
- if (!option.hidden && levenshtein.distance(name, (_a = option.long) === null || _a === void 0 ? void 0 : _a.slice(2)) < 3) {
- this.logger.error(`Did you mean '--${option.name()}'?`);
- }
- });
- }
- }
- }
- // Codes:
- // - commander.unknownCommand
- // - commander.missingArgument
- // - commander.missingMandatoryOptionValue
- // - commander.optionMissingArgument
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- });
- // Default `--color` and `--no-color` options
- // eslint-disable-next-line @typescript-eslint/no-this-alias
- const cli = this;
- this.program.option("--color", "Enable colors on console.");
- this.program.on("option:color", function () {
- // @ts-expect-error shadowing 'this' is intended
- const { color } = this.opts();
- cli.isColorSupportChanged = color;
- cli.colors = cli.createColors(color);
- });
- this.program.option("--no-color", "Disable colors on console.");
- this.program.on("option:no-color", function () {
- // @ts-expect-error shadowing 'this' is intended
- const { color } = this.opts();
- cli.isColorSupportChanged = color;
- cli.colors = cli.createColors(color);
- });
- // Make `-v, --version` options
- // Make `version|v [commands...]` command
- const outputVersion = async (options) => {
- // Filter `bundle`, `watch`, `version` and `help` commands
- const possibleCommandNames = options.filter((option) => !isCommand(option, buildCommandOptions) &&
- !isCommand(option, watchCommandOptions) &&
- !isCommand(option, versionCommandOptions) &&
- !isCommand(option, helpCommandOptions));
- possibleCommandNames.forEach((possibleCommandName) => {
- if (!isOption(possibleCommandName)) {
- return;
- }
- this.logger.error(`Unknown option '${possibleCommandName}'`);
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- });
- if (possibleCommandNames.length > 0) {
- await Promise.all(possibleCommandNames.map((possibleCommand) => loadCommandByName(possibleCommand)));
- for (const possibleCommandName of possibleCommandNames) {
- const foundCommand = findCommandByName(possibleCommandName);
- if (!foundCommand) {
- this.logger.error(`Unknown command '${possibleCommandName}'`);
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- }
- try {
- const { name, version } = this.loadJSONFile(`${foundCommand.pkg}/package.json`);
- this.logger.raw(`${name} ${version}`);
- }
- catch (e) {
- this.logger.error(`Error: External package '${foundCommand.pkg}' not found`);
- process.exit(2);
- }
- }
- }
- let webpack;
- try {
- webpack = await this.loadWebpack(false);
- }
- catch (_error) {
- // Nothing
- }
- this.logger.raw(`webpack: ${webpack ? webpack.version : "not installed"}`);
- const pkgJSON = this.loadJSONFile("../package.json");
- this.logger.raw(`webpack-cli: ${pkgJSON.version}`);
- let devServer;
- try {
- devServer = await this.loadJSONFile("webpack-dev-server/package.json", false);
- }
- catch (_error) {
- // Nothing
- }
- this.logger.raw(`webpack-dev-server ${devServer ? devServer.version : "not installed"}`);
- process.exit(0);
- };
- this.program.option("-v, --version", "Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.");
- const outputHelp = async (options, isVerbose, isHelpCommandSyntax, program) => {
- const { bold } = this.colors;
- const outputIncorrectUsageOfHelp = () => {
- this.logger.error("Incorrect use of help");
- this.logger.error("Please use: 'webpack help [command] [option]' | 'webpack [command] --help'");
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- };
- const isGlobalHelp = options.length === 0;
- const isCommandHelp = options.length === 1 && !isOption(options[0]);
- if (isGlobalHelp || isCommandHelp) {
- program.configureHelp({
- sortSubcommands: true,
- // Support multiple aliases
- commandUsage: (command) => {
- let parentCmdNames = "";
- for (let parentCmd = command.parent; parentCmd; parentCmd = parentCmd.parent) {
- parentCmdNames = `${parentCmd.name()} ${parentCmdNames}`;
- }
- if (isGlobalHelp) {
- return `${parentCmdNames}${command.usage()}\n${bold("Alternative usage to run commands:")} ${parentCmdNames}[command] [options]`;
- }
- return `${parentCmdNames}${command.name()}|${command
- .aliases()
- .join("|")} ${command.usage()}`;
- },
- // Support multiple aliases
- subcommandTerm: (command) => {
- const humanReadableArgumentName = (argument) => {
- const nameOutput = argument.name + (argument.variadic === true ? "..." : "");
- return argument.required ? "<" + nameOutput + ">" : "[" + nameOutput + "]";
- };
- const args = command._args
- .map((arg) => humanReadableArgumentName(arg))
- .join(" ");
- return `${command.name()}|${command.aliases().join("|")}${args ? ` ${args}` : ""}${command.options.length > 0 ? " [options]" : ""}`;
- },
- visibleOptions: function visibleOptions(command) {
- return command.options.filter((option) => {
- if (option.hidden) {
- return false;
- }
- switch (option.helpLevel) {
- case "verbose":
- return isVerbose;
- case "minimum":
- default:
- return true;
- }
- });
- },
- padWidth(command, helper) {
- return Math.max(helper.longestArgumentTermLength(command, helper), helper.longestOptionTermLength(command, helper),
- // For global options
- helper.longestOptionTermLength(program, helper), helper.longestSubcommandTermLength(isGlobalHelp ? program : command, helper));
- },
- formatHelp: (command, helper) => {
- const termWidth = helper.padWidth(command, helper);
- const helpWidth = helper.helpWidth || process.env.WEBPACK_CLI_HELP_WIDTH || 80;
- const itemIndentWidth = 2;
- const itemSeparatorWidth = 2; // between term and description
- const formatItem = (term, description) => {
- if (description) {
- const fullText = `${term.padEnd(termWidth + itemSeparatorWidth)}${description}`;
- return helper.wrap(fullText, helpWidth - itemIndentWidth, termWidth + itemSeparatorWidth);
- }
- return term;
- };
- const formatList = (textArray) => textArray.join("\n").replace(/^/gm, " ".repeat(itemIndentWidth));
- // Usage
- let output = [`${bold("Usage:")} ${helper.commandUsage(command)}`, ""];
- // Description
- const commandDescription = isGlobalHelp
- ? "The build tool for modern web applications."
- : helper.commandDescription(command);
- if (commandDescription.length > 0) {
- output = output.concat([commandDescription, ""]);
- }
- // Arguments
- const argumentList = helper
- .visibleArguments(command)
- .map((argument) => formatItem(argument.term, argument.description));
- if (argumentList.length > 0) {
- output = output.concat([bold("Arguments:"), formatList(argumentList), ""]);
- }
- // Options
- const optionList = helper
- .visibleOptions(command)
- .map((option) => formatItem(helper.optionTerm(option), helper.optionDescription(option)));
- if (optionList.length > 0) {
- output = output.concat([bold("Options:"), formatList(optionList), ""]);
- }
- // Global options
- const globalOptionList = program.options.map((option) => formatItem(helper.optionTerm(option), helper.optionDescription(option)));
- if (globalOptionList.length > 0) {
- output = output.concat([bold("Global options:"), formatList(globalOptionList), ""]);
- }
- // Commands
- const commandList = helper
- .visibleCommands(isGlobalHelp ? program : command)
- .map((command) => formatItem(helper.subcommandTerm(command), helper.subcommandDescription(command)));
- if (commandList.length > 0) {
- output = output.concat([bold("Commands:"), formatList(commandList), ""]);
- }
- return output.join("\n");
- },
- });
- if (isGlobalHelp) {
- await Promise.all(knownCommands.map((knownCommand) => {
- return loadCommandByName(getCommandName(knownCommand.name));
- }));
- const buildCommand = findCommandByName(getCommandName(buildCommandOptions.name));
- buildCommand && this.logger.raw(buildCommand.helpInformation());
- }
- else {
- const name = options[0];
- await loadCommandByName(name);
- const command = findCommandByName(name);
- if (!command) {
- const builtInCommandUsed = externalBuiltInCommandsInfo.find((command) => command.name.includes(name) || name === command.alias);
- if (typeof builtInCommandUsed !== "undefined") {
- this.logger.error(`For using '${name}' command you need to install '${builtInCommandUsed.pkg}' package.`);
- }
- else {
- this.logger.error(`Can't find and load command '${name}'`);
- this.logger.error("Run 'webpack --help' to see available commands and options.");
- }
- process.exit(2);
- }
- this.logger.raw(command.helpInformation());
- }
- }
- else if (isHelpCommandSyntax) {
- let isCommandSpecified = false;
- let commandName = getCommandName(buildCommandOptions.name);
- let optionName = "";
- if (options.length === 1) {
- optionName = options[0];
- }
- else if (options.length === 2) {
- isCommandSpecified = true;
- commandName = options[0];
- optionName = options[1];
- if (isOption(commandName)) {
- outputIncorrectUsageOfHelp();
- }
- }
- else {
- outputIncorrectUsageOfHelp();
- }
- await loadCommandByName(commandName);
- const command = isGlobalOption(optionName) ? program : findCommandByName(commandName);
- if (!command) {
- this.logger.error(`Can't find and load command '${commandName}'`);
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- }
- const option = command.options.find((option) => option.short === optionName || option.long === optionName);
- if (!option) {
- this.logger.error(`Unknown option '${optionName}'`);
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- }
- const nameOutput = option.flags.replace(/^.+[[<]/, "").replace(/(\.\.\.)?[\]>].*$/, "") +
- (option.variadic === true ? "..." : "");
- const value = option.required
- ? "<" + nameOutput + ">"
- : option.optional
- ? "[" + nameOutput + "]"
- : "";
- this.logger.raw(`${bold("Usage")}: webpack${isCommandSpecified ? ` ${commandName}` : ""} ${option.long}${value ? ` ${value}` : ""}`);
- if (option.short) {
- this.logger.raw(`${bold("Short:")} webpack${isCommandSpecified ? ` ${commandName}` : ""} ${option.short}${value ? ` ${value}` : ""}`);
- }
- if (option.description) {
- this.logger.raw(`${bold("Description:")} ${option.description}`);
- }
- if (!option.negate && option.defaultValue) {
- this.logger.raw(`${bold("Default value:")} ${JSON.stringify(option.defaultValue)}`);
- }
- const flag = this.getBuiltInOptions().find((flag) => option.long === `--${flag.name}`);
- if (flag && flag.configs) {
- const possibleValues = flag.configs.reduce((accumulator, currentValue) => {
- if (currentValue.values) {
- return accumulator.concat(currentValue.values);
- }
- else {
- return accumulator;
- }
- }, []);
- if (possibleValues.length > 0) {
- this.logger.raw(`${bold("Possible values:")} ${JSON.stringify(possibleValues.join(" | "))}`);
- }
- }
- this.logger.raw("");
- // TODO implement this after refactor cli arguments
- // logger.raw('Documentation: https://webpack.js.org/option/name/');
- }
- else {
- outputIncorrectUsageOfHelp();
- }
- this.logger.raw("To see list of all supported commands and options run 'webpack --help=verbose'.\n");
- this.logger.raw(`${bold("Webpack documentation:")} https://webpack.js.org/.`);
- this.logger.raw(`${bold("CLI documentation:")} https://webpack.js.org/api/cli/.`);
- this.logger.raw(`${bold("Made with ♥ by the webpack team")}.`);
- process.exit(0);
- };
- this.program.helpOption(false);
- this.program.addHelpCommand(false);
- this.program.option("-h, --help [verbose]", "Display help for commands and options.");
- let isInternalActionCalled = false;
- // Default action
- this.program.usage("[options]");
- this.program.allowUnknownOption(true);
- this.program.action(async (options, program) => {
- if (!isInternalActionCalled) {
- isInternalActionCalled = true;
- }
- else {
- this.logger.error("No commands found to run");
- process.exit(2);
- }
- // Command and options
- const { operands, unknown } = this.program.parseOptions(program.args);
- const defaultCommandToRun = getCommandName(buildCommandOptions.name);
- const hasOperand = typeof operands[0] !== "undefined";
- const operand = hasOperand ? operands[0] : defaultCommandToRun;
- const isHelpOption = typeof options.help !== "undefined";
- const isHelpCommandSyntax = isCommand(operand, helpCommandOptions);
- if (isHelpOption || isHelpCommandSyntax) {
- let isVerbose = false;
- if (isHelpOption) {
- if (typeof options.help === "string") {
- if (options.help !== "verbose") {
- this.logger.error("Unknown value for '--help' option, please use '--help=verbose'");
- process.exit(2);
- }
- isVerbose = true;
- }
- }
- this.program.forHelp = true;
- const optionsForHelp = []
- .concat(isHelpOption && hasOperand ? [operand] : [])
- // Syntax `webpack help [command]`
- .concat(operands.slice(1))
- // Syntax `webpack help [option]`
- .concat(unknown)
- .concat(isHelpCommandSyntax && typeof options.color !== "undefined"
- ? [options.color ? "--color" : "--no-color"]
- : [])
- .concat(isHelpCommandSyntax && typeof options.version !== "undefined" ? ["--version"] : []);
- await outputHelp(optionsForHelp, isVerbose, isHelpCommandSyntax, program);
- }
- const isVersionOption = typeof options.version !== "undefined";
- const isVersionCommandSyntax = isCommand(operand, versionCommandOptions);
- if (isVersionOption || isVersionCommandSyntax) {
- const optionsForVersion = []
- .concat(isVersionOption ? [operand] : [])
- .concat(operands.slice(1))
- .concat(unknown);
- await outputVersion(optionsForVersion);
- }
- let commandToRun = operand;
- let commandOperands = operands.slice(1);
- if (isKnownCommand(commandToRun)) {
- await loadCommandByName(commandToRun, true);
- }
- else {
- const isEntrySyntax = fs.existsSync(operand);
- if (isEntrySyntax) {
- commandToRun = defaultCommandToRun;
- commandOperands = operands;
- await loadCommandByName(commandToRun);
- }
- else {
- this.logger.error(`Unknown command or entry '${operand}'`);
- const levenshtein = require("fastest-levenshtein");
- const found = knownCommands.find((commandOptions) => levenshtein.distance(operand, getCommandName(commandOptions.name)) < 3);
- if (found) {
- this.logger.error(`Did you mean '${getCommandName(found.name)}' (alias '${Array.isArray(found.alias) ? found.alias.join(", ") : found.alias}')?`);
- }
- this.logger.error("Run 'webpack --help' to see available commands and options");
- process.exit(2);
- }
- }
- await this.program.parseAsync([commandToRun, ...commandOperands, ...unknown], {
- from: "user",
- });
- });
- await this.program.parseAsync(args, parseOptions);
- }
- async loadConfig(options) {
- const interpret = require("interpret");
- const loadConfigByPath = async (configPath, argv = {}) => {
- const ext = path.extname(configPath);
- const interpreted = Object.keys(interpret.jsVariants).find((variant) => variant === ext);
- if (interpreted) {
- const rechoir = require("rechoir");
- try {
- rechoir.prepare(interpret.extensions, configPath);
- }
- catch (error) {
- if (error === null || error === void 0 ? void 0 : error.failures) {
- this.logger.error(`Unable load '${configPath}'`);
- this.logger.error(error.message);
- error.failures.forEach((failure) => {
- this.logger.error(failure.error.message);
- });
- this.logger.error("Please install one of them");
- process.exit(2);
- }
- this.logger.error(error);
- process.exit(2);
- }
- }
- let options;
- try {
- options = await this.tryRequireThenImport(configPath, false);
- // @ts-expect-error error type assertion
- }
- catch (error) {
- this.logger.error(`Failed to load '${configPath}' config`);
- if (this.isValidationError(error)) {
- this.logger.error(error.message);
- }
- else {
- this.logger.error(error);
- }
- process.exit(2);
- }
- if (Array.isArray(options)) {
- // reassign the value to assert type
- const optionsArray = options;
- await Promise.all(optionsArray.map(async (_, i) => {
- if (this.isPromise(optionsArray[i])) {
- optionsArray[i] = await optionsArray[i];
- }
- // `Promise` may return `Function`
- if (this.isFunction(optionsArray[i])) {
- // when config is a function, pass the env from args to the config function
- optionsArray[i] = await optionsArray[i](argv.env, argv);
- }
- }));
- options = optionsArray;
- }
- else {
- if (this.isPromise(options)) {
- options = await options;
- }
- // `Promise` may return `Function`
- if (this.isFunction(options)) {
- // when config is a function, pass the env from args to the config function
- options = await options(argv.env, argv);
- }
- }
- const isObject = (value) => typeof value === "object" && value !== null;
- if (!isObject(options) && !Array.isArray(options)) {
- this.logger.error(`Invalid configuration in '${configPath}'`);
- process.exit(2);
- }
- return { options, path: configPath };
- };
- const config = {
- options: {},
- path: new WeakMap(),
- };
- if (options.config && options.config.length > 0) {
- const loadedConfigs = await Promise.all(options.config.map((configPath) => loadConfigByPath(path.resolve(configPath), options.argv)));
- config.options = [];
- loadedConfigs.forEach((loadedConfig) => {
- const isArray = Array.isArray(loadedConfig.options);
- // TODO we should run webpack multiple times when the `--config` options have multiple values with `--merge`, need to solve for the next major release
- if (config.options.length === 0) {
- config.options = loadedConfig.options;
- }
- else {
- if (!Array.isArray(config.options)) {
- config.options = [config.options];
- }
- if (isArray) {
- loadedConfig.options.forEach((item) => {
- config.options.push(item);
- });
- }
- else {
- config.options.push(loadedConfig.options);
- }
- }
- if (isArray) {
- loadedConfig.options.forEach((options) => {
- config.path.set(options, loadedConfig.path);
- });
- }
- else {
- config.path.set(loadedConfig.options, loadedConfig.path);
- }
- });
- config.options = config.options.length === 1 ? config.options[0] : config.options;
- }
- else {
- // Order defines the priority, in decreasing order
- const defaultConfigFiles = [
- "webpack.config",
- ".webpack/webpack.config",
- ".webpack/webpackfile",
- ]
- .map((filename) =>
- // Since .cjs is not available on interpret side add it manually to default config extension list
- [...Object.keys(interpret.extensions), ".cjs"].map((ext) => ({
- path: path.resolve(filename + ext),
- ext: ext,
- module: interpret.extensions[ext],
- })))
- .reduce((accumulator, currentValue) => accumulator.concat(currentValue), []);
- let foundDefaultConfigFile;
- for (const defaultConfigFile of defaultConfigFiles) {
- if (!fs.existsSync(defaultConfigFile.path)) {
- continue;
- }
- foundDefaultConfigFile = defaultConfigFile;
- break;
- }
- if (foundDefaultConfigFile) {
- const loadedConfig = await loadConfigByPath(foundDefaultConfigFile.path, options.argv);
- config.options = loadedConfig.options;
- if (Array.isArray(config.options)) {
- config.options.forEach((item) => {
- config.path.set(item, loadedConfig.path);
- });
- }
- else {
- config.path.set(loadedConfig.options, loadedConfig.path);
- }
- }
- }
- if (options.configName) {
- const notFoundConfigNames = [];
- config.options = options.configName.map((configName) => {
- let found;
- if (Array.isArray(config.options)) {
- found = config.options.find((options) => options.name === configName);
- }
- else {
- found = config.options.name === configName ? config.options : undefined;
- }
- if (!found) {
- notFoundConfigNames.push(configName);
- }
- return found;
- });
- if (notFoundConfigNames.length > 0) {
- this.logger.error(notFoundConfigNames
- .map((configName) => `Configuration with the name "${configName}" was not found.`)
- .join(" "));
- process.exit(2);
- }
- }
- if (options.merge) {
- const merge = await this.tryRequireThenImport("webpack-merge");
- // we can only merge when there are multiple configurations
- // either by passing multiple configs by flags or passing a
- // single config exporting an array
- if (!Array.isArray(config.options) || config.options.length <= 1) {
- this.logger.error("At least two configurations are required for merge.");
- process.exit(2);
- }
- const mergedConfigPaths = [];
- config.options = config.options.reduce((accumulator, options) => {
- const configPath = config.path.get(options);
- const mergedOptions = merge(accumulator, options);
- mergedConfigPaths.push(configPath);
- return mergedOptions;
- }, {});
- config.path.set(config.options, mergedConfigPaths);
- }
- return config;
- }
- async buildConfig(config, options) {
- const runFunctionOnEachConfig = (options, fn) => {
- if (Array.isArray(options)) {
- for (let item of options) {
- item = fn(item);
- }
- }
- else {
- options = fn(options);
- }
- return options;
- };
- if (options.analyze) {
- if (!this.checkPackageExists("webpack-bundle-analyzer")) {
- await this.doInstall("webpack-bundle-analyzer", {
- preMessage: () => {
- this.logger.error(`It looks like ${this.colors.yellow("webpack-bundle-analyzer")} is not installed.`);
- },
- });
- this.logger.success(`${this.colors.yellow("webpack-bundle-analyzer")} was installed successfully.`);
- }
- }
- if (typeof options.progress === "string" && options.progress !== "profile") {
- this.logger.error(`'${options.progress}' is an invalid value for the --progress option. Only 'profile' is allowed.`);
- process.exit(2);
- }
- if (typeof options.hot === "string" && options.hot !== "only") {
- this.logger.error(`'${options.hot}' is an invalid value for the --hot option. Use 'only' instead.`);
- process.exit(2);
- }
- const CLIPlugin = await this.tryRequireThenImport("./plugins/CLIPlugin");
- const internalBuildConfig = (item) => {
- // Output warnings
- if (item.watch &&
- options.argv &&
- options.argv.env &&
- (options.argv.env["WEBPACK_WATCH"] || options.argv.env["WEBPACK_SERVE"])) {
- this.logger.warn(`No need to use the '${options.argv.env["WEBPACK_WATCH"] ? "watch" : "serve"}' command together with '{ watch: true }' configuration, it does not make sense.`);
- if (options.argv.env["WEBPACK_SERVE"]) {
- item.watch = false;
- }
- }
- // Apply options
- if (this.webpack.cli) {
- const args = this.getBuiltInOptions()
- .filter((flag) => flag.group === "core")
- .reduce((accumulator, flag) => {
- accumulator[flag.name] = flag;
- return accumulator;
- }, {});
- const values = Object.keys(options).reduce((accumulator, name) => {
- if (name === "argv") {
- return accumulator;
- }
- const kebabName = this.toKebabCase(name);
- if (args[kebabName]) {
- accumulator[kebabName] = options[name];
- }
- return accumulator;
- }, {});
- const problems = this.webpack.cli.processArguments(args, item, values);
- if (problems) {
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const groupBy = (xs, key) => {
- return xs.reduce((rv, x) => {
- (rv[x[key]] = rv[x[key]] || []).push(x);
- return rv;
- }, {});
- };
- const problemsByPath = groupBy(problems, "path");
- for (const path in problemsByPath) {
- const problems = problemsByPath[path];
- problems.forEach((problem) => {
- this.logger.error(`${this.capitalizeFirstLetter(problem.type.replace(/-/g, " "))}${problem.value ? ` '${problem.value}'` : ""} for the '--${problem.argument}' option${problem.index ? ` by index '${problem.index}'` : ""}`);
- if (problem.expected) {
- this.logger.error(`Expected: '${problem.expected}'`);
- }
- });
- }
- process.exit(2);
- }
- const isFileSystemCacheOptions = (config) => {
- return (Boolean(config.cache) && config.cache.type === "filesystem");
- };
- // Setup default cache options
- if (isFileSystemCacheOptions(item)) {
- const configPath = config.path.get(item);
- if (configPath) {
- if (!item.cache.buildDependencies) {
- item.cache.buildDependencies = {};
- }
- if (!item.cache.buildDependencies.defaultConfig) {
- item.cache.buildDependencies.defaultConfig = [];
- }
- if (Array.isArray(configPath)) {
- configPath.forEach((oneOfConfigPath) => {
- item.cache.buildDependencies.defaultConfig.push(oneOfConfigPath);
- });
- }
- else {
- item.cache.buildDependencies.defaultConfig.push(configPath);
- }
- }
- }
- }
- // Setup legacy logic for webpack@4
- // TODO respect `--entry-reset` in th next major release
- // TODO drop in the next major release
- if (options.entry) {
- item.entry = options.entry;
- }
- if (options.outputPath) {
- item.output = Object.assign(Object.assign({}, item.output), { path: path.resolve(options.outputPath) });
- }
- if (options.target) {
- item.target = options.target;
- }
- if (typeof options.devtool !== "undefined") {
- item.devtool = options.devtool;
- }
- if (options.name) {
- item.name = options.name;
- }
- if (typeof options.stats !== "undefined") {
- item.stats = options.stats;
- }
- if (typeof options.watch !== "undefined") {
- item.watch = options.watch;
- }
- if (typeof options.watchOptionsStdin !== "undefined") {
- item.watchOptions = Object.assign(Object.assign({}, item.watchOptions), { stdin: options.watchOptionsStdin });
- }
- if (options.mode) {
- item.mode = options.mode;
- }
- // Respect `process.env.NODE_ENV`
- if (!item.mode &&
- process.env &&
- process.env.NODE_ENV &&
- (process.env.NODE_ENV === "development" ||
- process.env.NODE_ENV === "production" ||
- process.env.NODE_ENV === "none")) {
- item.mode = process.env.NODE_ENV;
- }
- // Setup stats
- // TODO remove after drop webpack@4
- const statsForWebpack4 = this.webpack.Stats &&
- this.webpack.Stats.presetToOptions;
- if (statsForWebpack4) {
- if (typeof item.stats === "undefined") {
- item.stats = {};
- }
- else if (typeof item.stats === "boolean") {
- item.stats = this.webpack.Stats.presetToOptions(item.stats);
- }
- else if (typeof item.stats === "string" &&
- (item.stats === "none" ||
- item.stats === "verbose" ||
- item.stats === "detailed" ||
- item.stats === "normal" ||
- item.stats === "minimal" ||
- item.stats === "errors-only" ||
- item.stats === "errors-warnings")) {
- item.stats = this.webpack.Stats.presetToOptions(item.stats);
- }
- }
- else {
- if (typeof item.stats === "undefined") {
- item.stats = { preset: "normal" };
- }
- else if (typeof item.stats === "boolean") {
- item.stats = item.stats ? { preset: "normal" } : { preset: "none" };
- }
- else if (typeof item.stats === "string") {
- item.stats = { preset: item.stats };
- }
- }
- let colors;
- // From arguments
- if (typeof this.isColorSupportChanged !== "undefined") {
- colors = Boolean(this.isColorSupportChanged);
- }
- // From stats
- else if (typeof item.stats.colors !== "undefined") {
- colors = item.stats.colors;
- }
- // Default
- else {
- colors = Boolean(this.colors.isColorSupported);
- }
- // TODO remove after drop webpack v4
- if (typeof item.stats === "object" && item.stats !== null) {
- item.stats.colors = colors;
- }
- // Apply CLI plugin
- if (!item.plugins) {
- item.plugins = [];
- }
- item.plugins.unshift(new CLIPlugin({
- configPath: config.path.get(item),
- helpfulOutput: !options.json,
- hot: options.hot,
- progress: options.progress,
- prefetch: options.prefetch,
- analyze: options.analyze,
- }));
- return options;
- };
- runFunctionOnEachConfig(config.options, internalBuildConfig);
- return config;
- }
- isValidationError(error) {
- // https://github.com/webpack/webpack/blob/master/lib/index.js#L267
- // https://github.com/webpack/webpack/blob/v4.44.2/lib/webpack.js#L90
- const ValidationError = this.webpack.ValidationError || this.webpack.WebpackOptionsValidationError;
- return error instanceof ValidationError || error.name === "ValidationError";
- }
- async createCompiler(options, callback) {
- if (typeof options.nodeEnv === "string") {
- process.env.NODE_ENV = options.nodeEnv;
- }
- let config = await this.loadConfig(options);
- config = await this.buildConfig(config, options);
- let compiler;
- try {
- compiler = this.webpack(config.options, callback
- ? (error, stats) => {
- if (error && this.isValidationError(error)) {
- this.logger.error(error.message);
- process.exit(2);
- }
- callback(error, stats);
- }
- : callback);
- // @ts-expect-error error type assertion
- }
- catch (error) {
- if (this.isValidationError(error)) {
- this.logger.error(error.message);
- }
- else {
- this.logger.error(error);
- }
- process.exit(2);
- }
- // TODO webpack@4 return Watching and MultiWatching instead Compiler and MultiCompiler, remove this after drop webpack@4
- if (compiler && compiler.compiler) {
- compiler = compiler.compiler;
- }
- return compiler;
- }
- needWatchStdin(compiler) {
- if (this.isMultipleCompiler(compiler)) {
- return Boolean(compiler.compilers.some((compiler) => compiler.options.watchOptions && compiler.options.watchOptions.stdin));
- }
- return Boolean(compiler.options.watchOptions && compiler.options.watchOptions.stdin);
- }
- async runWebpack(options, isWatchCommand) {
- // eslint-disable-next-line prefer-const
- let compiler;
- let createJsonStringifyStream;
- if (options.json) {
- const jsonExt = await this.tryRequireThenImport("@discoveryjs/json-ext");
- createJsonStringifyStream = jsonExt.stringifyStream;
- }
- const callback = (error, stats) => {
- if (error) {
- this.logger.error(error);
- process.exit(2);
- }
- if (stats && stats.hasErrors()) {
- process.exitCode = 1;
- }
- if (!compiler || !stats) {
- return;
- }
- const statsOptions = this.isMultipleCompiler(compiler)
- ? {
- children: compiler.compilers.map((compiler) => compiler.options ? compiler.options.stats : undefined),
- }
- : compiler.options
- ? compiler.options.stats
- : undefined;
- // TODO webpack@4 doesn't support `{ children: [{ colors: true }, { colors: true }] }` for stats
- const statsForWebpack4 = this.webpack.Stats &&
- this.webpack.Stats.presetToOptions;
- if (this.isMultipleCompiler(compiler) && statsForWebpack4) {
- statsOptions.colors = statsOptions.children.some((child) => child.colors);
- }
- if (options.json && createJsonStringifyStream) {
- const handleWriteError = (error) => {
- this.logger.error(error);
- process.exit(2);
- };
- if (options.json === true) {
- createJsonStringifyStream(stats.toJson(statsOptions))
- .on("error", handleWriteError)
- .pipe(process.stdout)
- .on("error", handleWriteError)
- .on("close", () => process.stdout.write("\n"));
- }
- else {
- createJsonStringifyStream(stats.toJson(statsOptions))
- .on("error", handleWriteError)
- .pipe(fs.createWriteStream(options.json))
- .on("error", handleWriteError)
- // Use stderr to logging
- .on("close", () => {
- process.stderr.write(`[webpack-cli] ${this.colors.green(`stats are successfully stored as json to ${options.json}`)}\n`);
- });
- }
- }
- else {
- const printedStats = stats.toString(statsOptions);
- // Avoid extra empty line when `stats: 'none'`
- if (printedStats) {
- this.logger.raw(printedStats);
- }
- }
- };
- const env = isWatchCommand || options.watch
- ? Object.assign({ WEBPACK_WATCH: true }, options.env) : Object.assign({ WEBPACK_BUNDLE: true, WEBPACK_BUILD: true }, options.env);
- options.argv = Object.assign(Object.assign({}, options), { env });
- if (isWatchCommand) {
- options.watch = true;
- }
- compiler = await this.createCompiler(options, callback);
- if (!compiler) {
- return;
- }
- const isWatch = (compiler) => Boolean(this.isMultipleCompiler(compiler)
- ? compiler.compilers.some((compiler) => compiler.options.watch)
- : compiler.options.watch);
- if (isWatch(compiler) && this.needWatchStdin(compiler)) {
- process.stdin.on("end", () => {
- process.exit(0);
- });
- process.stdin.resume();
- }
- }
- }
- module.exports = WebpackCLI;
|