12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892 |
- "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_IS_CUSTOM = !!process.env.WEBPACK_PACKAGE;
- const WEBPACK_PACKAGE = WEBPACK_PACKAGE_IS_CUSTOM
- ? process.env.WEBPACK_PACKAGE
- : "webpack";
- const WEBPACK_DEV_SERVER_PACKAGE_IS_CUSTOM = !!process.env.WEBPACK_DEV_SERVER_PACKAGE;
- const WEBPACK_DEV_SERVER_PACKAGE = WEBPACK_DEV_SERVER_PACKAGE_IS_CUSTOM
- ? 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)));
- // https://github.com/nodejs/node/blob/v18.9.1/lib/internal/modules/cjs/loader.js#L1274
- for (const internalPath of require("module").globalPaths) {
- try {
- if (fs.statSync(path.join(internalPath, packageName)).isDirectory()) {
- return true;
- }
- }
- catch (_error) {
- // Nothing
- }
- }
- 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, moduleType = "unknown") {
- let result;
- switch (moduleType) {
- case "unknown": {
- 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;
- }
- }
- break;
- }
- case "commonjs": {
- try {
- result = require(module);
- }
- catch (error) {
- if (handleError) {
- this.logger.error(error);
- process.exit(2);
- }
- else {
- throw error;
- }
- }
- break;
- }
- case "esm": {
- try {
- const dynamicImportLoader = require("./utils/dynamic-import-loader")();
- if (pathToFileURL && dynamicImportLoader) {
- const urlForConfig = pathToFileURL(module);
- result = await dynamicImportLoader(urlForConfig);
- result = result.default;
- return result;
- }
- }
- catch (error) {
- if (handleError) {
- this.logger.error(error);
- process.exit(2);
- }
- else {
- throw error;
- }
- }
- break;
- }
- }
- // For babel and other, only commonjs
- 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;
- }
- getInfoOptions() {
- return [
- {
- name: "output",
- alias: "o",
- configs: [
- {
- type: "string",
- },
- ],
- description: "To get the output in a specified format ( accept json or markdown )",
- helpLevel: "minimum",
- },
- {
- name: "additional-package",
- alias: "a",
- configs: [{ type: "string" }],
- multiple: true,
- description: "Adds additional packages to the output",
- helpLevel: "minimum",
- },
- ];
- }
- async getInfoOutput(options) {
- let { output } = options;
- const envinfoConfig = {};
- if (output) {
- // Remove quotes if exist
- output = output.replace(/['"]+/g, "");
- switch (output) {
- case "markdown":
- envinfoConfig["markdown"] = true;
- break;
- case "json":
- envinfoConfig["json"] = true;
- break;
- default:
- this.logger.error(`'${output}' is not a valid value for output`);
- process.exit(2);
- }
- }
- const defaultInformation = {
- Binaries: ["Node", "Yarn", "npm"],
- Browsers: [
- "Brave Browser",
- "Chrome",
- "Chrome Canary",
- "Edge",
- "Firefox",
- "Firefox Developer Edition",
- "Firefox Nightly",
- "Internet Explorer",
- "Safari",
- "Safari Technology Preview",
- ],
- Monorepos: ["Yarn Workspaces", "Lerna"],
- System: ["OS", "CPU", "Memory"],
- npmGlobalPackages: ["webpack", "webpack-cli", "webpack-dev-server"],
- };
- let defaultPackages = ["webpack", "loader", "@webpack-cli/"];
- if (typeof options.additionalPackage !== "undefined") {
- defaultPackages = [...defaultPackages, ...options.additionalPackage];
- }
- defaultInformation.npmPackages = `{${defaultPackages.map((item) => `*${item}*`).join(",")}}`;
- const envinfo = await this.tryRequireThenImport("envinfo", false);
- let info = await envinfo.run(defaultInformation, envinfoConfig);
- info = info.replace(/npmPackages/g, "Packages");
- info = info.replace(/npmGlobalPackages/g, "Global Packages");
- return info;
- }
- 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, {
- 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 && WEBPACK_PACKAGE_IS_CUSTOM) {
- skipInstallation = true;
- }
- // Allow to use `./path/to/webpack-dev-server.js` outside `node_modules`
- if (dependency === WEBPACK_DEV_SERVER_PACKAGE && WEBPACK_DEV_SERVER_PACKAGE_IS_CUSTOM) {
- 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();
- }
- }
- for (const option of options) {
- this.makeOption(command, option);
- }
- }
- command.action(action);
- return command;
- }
- makeOption(command, option) {
- let mainOption;
- let negativeOption;
- const flagsWithAlias = ["devtool", "output-path", "target", "watch"];
- if (flagsWithAlias.includes(option.name)) {
- option.alias = option.name[0];
- }
- if (option.configs) {
- let needNegativeOption = false;
- let negatedDescription;
- const mainOptionType = new Set();
- for (const config of option.configs) {
- 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;
- for (const value of config.values || []) {
- 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;
- }
- }
- }
- }
- mainOption = {
- flags: option.alias ? `-${option.alias}, --${option.name}` : `--${option.name}`,
- valueName: option.valueName || "value",
- 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}`,
- valueName: option.valueName || "value",
- description: option.description || "",
- 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} [${mainOption.valueName || "value"}${mainOption.multiple ? "..." : ""}]`;
- }
- else if (mainOption.type.size > 0 && !mainOption.type.has(Boolean)) {
- mainOption.flags = `${mainOption.flags} <${mainOption.valueName || "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 builtInFlags = [
- // For configs
- {
- name: "config",
- alias: "c",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: true,
- valueName: "pathToConfigFile",
- description: 'Provide path to one or more webpack configuration files to process, e.g. "./webpack.config.js".',
- helpLevel: "minimum",
- },
- {
- name: "config-name",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: true,
- valueName: "name",
- description: "Name(s) of particular configuration(s) to use if configuration file exports an array of multiple configurations.",
- helpLevel: "minimum",
- },
- {
- name: "merge",
- alias: "m",
- configs: [
- {
- type: "enum",
- values: [true],
- },
- ],
- description: "Merge two or more configurations using 'webpack-merge'.",
- helpLevel: "minimum",
- },
- {
- name: "disable-interpret",
- configs: [
- {
- type: "enum",
- values: [true],
- },
- ],
- description: "Disable interpret for loading the config file.",
- helpLevel: "minimum",
- },
- // 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 variables passed to the configuration when it is a function, e.g. "myvar" or "myvar=myval".',
- helpLevel: "minimum",
- },
- {
- name: "node-env",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: false,
- description: "Sets process.env.NODE_ENV to the specified value.",
- helpLevel: "minimum",
- },
- {
- name: "define-process-env-node-env",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: false,
- description: "Sets process.env.NODE_ENV to the specified value. (Currently an alias for `--node-env`).",
- helpLevel: "verbose",
- },
- // Adding more plugins
- {
- name: "analyze",
- configs: [
- {
- type: "enum",
- values: [true],
- },
- ],
- multiple: false,
- description: "It invokes webpack-bundle-analyzer plugin to get bundle information.",
- helpLevel: "minimum",
- },
- {
- name: "progress",
- configs: [
- {
- type: "string",
- },
- {
- type: "enum",
- values: [true],
- },
- ],
- description: "Print compilation progress during build.",
- helpLevel: "minimum",
- },
- // Output options
- {
- name: "json",
- configs: [
- {
- type: "string",
- },
- {
- type: "enum",
- values: [true],
- },
- ],
- alias: "j",
- valueName: "pathToJsonFile",
- description: "Prints result as JSON or store it in a file.",
- helpLevel: "minimum",
- },
- {
- name: "fail-on-warnings",
- configs: [
- {
- type: "enum",
- values: [true],
- },
- ],
- description: "Stop webpack-cli process with non-zero exit code on warnings from webpack.",
- helpLevel: "minimum",
- },
- // TODO remove this in the next major release, because not all webpack versions have this flag in CLI options
- {
- name: "extends",
- alias: "e",
- configs: [
- {
- type: "string",
- },
- ],
- multiple: true,
- description: "Path to the configuration to be extended (only works when using webpack-cli).",
- helpLevel: "minimum",
- },
- ];
- const minimumHelpFlags = [
- "mode",
- "watch",
- "watch-options-stdin",
- "stats",
- "devtool",
- "entry",
- "target",
- "name",
- "output-path",
- "extends",
- ];
- // 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/main/test/__snapshots__/Cli.basictest.js.snap
- const options = builtInFlags.concat(Object.entries(this.webpack.cli.getArguments()).map(([name, meta]) => {
- return Object.assign(Object.assign({}, meta), { name, group: "core", helpLevel: minimumHelpFlags.includes(name) ? "minimum" : "verbose" });
- }));
- 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",
- alias: "v",
- usage: "[options]",
- 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: "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 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
- this.makeCommand(versionCommandOptions, this.getInfoOptions(), async (options) => {
- const info = await cli.getInfoOutput(options);
- cli.logger.raw(info);
- });
- }
- 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) => {
- var _a;
- 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");
- for (const option of command.options) {
- 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);
- });
- this.program.option("-v, --version", "Output the version number of 'webpack', 'webpack-cli' and 'webpack-dev-server' and commands.");
- // webpack-cli has it's own logic for showing suggestions
- this.program.showSuggestionAfterError(false);
- 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 ? "..." : "");
- 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;
- }
- // Hide `--watch` option when developer use `webpack watch --help`
- if ((options[0] === "w" || options[0] === "watch") &&
- (option.name() === "watch" || option.name() === "no-watch")) {
- 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.name(), 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);
- // Basic command for lazy loading other commands
- 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";
- if (isVersionOption) {
- const info = await this.getInfoOutput({ output: "", additionalPackage: [] });
- this.logger.raw(info);
- process.exit(0);
- }
- 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 disableInterpret = typeof options.disableInterpret !== "undefined" && options.disableInterpret;
- const interpret = require("interpret");
- const loadConfigByPath = async (configPath, argv = {}) => {
- const ext = path.extname(configPath).toLowerCase();
- let interpreted = Object.keys(interpret.jsVariants).find((variant) => variant === ext);
- // Fallback `.cts` to `.ts`
- // TODO implement good `.mts` support after https://github.com/gulpjs/rechoir/issues/43
- // For ESM and `.mts` you need to use: 'NODE_OPTIONS="--loader ts-node/esm" webpack-cli --config ./webpack.config.mts'
- if (!interpreted && /\.cts$/.test(ext)) {
- interpreted = interpret.jsVariants[".ts"];
- }
- if (interpreted && !disableInterpret) {
- 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);
- for (const failure of error.failures) {
- 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;
- let moduleType = "unknown";
- switch (ext) {
- case ".cjs":
- case ".cts":
- moduleType = "commonjs";
- break;
- case ".mjs":
- case ".mts":
- moduleType = "esm";
- break;
- }
- try {
- options = await this.tryRequireThenImport(configPath, false, moduleType);
- // @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 (!options) {
- this.logger.error(`Failed to load '${configPath}' config. Unable to find default export.`);
- 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) {
- for (const item of loadedConfig.options) {
- config.options.push(item);
- }
- }
- else {
- config.options.push(loadedConfig.options);
- }
- }
- if (isArray) {
- for (const options of loadedConfig.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 {
- // TODO ".mts" is not supported by `interpret`, need to add it
- // Prioritize popular extensions first to avoid unnecessary fs calls
- const extensions = [
- ".js",
- ".mjs",
- ".cjs",
- ".ts",
- ".cts",
- ".mts",
- ...Object.keys(interpret.extensions),
- ];
- // Order defines the priority, in decreasing order
- const defaultConfigFiles = new Set(["webpack.config", ".webpack/webpack.config", ".webpack/webpackfile"].flatMap((filename) => extensions.map((ext) => path.resolve(filename + ext))));
- let foundDefaultConfigFile;
- for (const defaultConfigFile of defaultConfigFiles) {
- if (!fs.existsSync(defaultConfigFile)) {
- continue;
- }
- foundDefaultConfigFile = defaultConfigFile;
- break;
- }
- if (foundDefaultConfigFile) {
- const loadedConfig = await loadConfigByPath(foundDefaultConfigFile, options.argv);
- config.options = loadedConfig.options;
- if (Array.isArray(config.options)) {
- for (const item of config.options) {
- 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);
- }
- }
- const resolveExtends = async (config, configPaths, extendsPaths) => {
- delete config.extends;
- const loadedConfigs = await Promise.all(extendsPaths.map((extendsPath) => loadConfigByPath(path.resolve(extendsPath), options.argv)));
- const merge = await this.tryRequireThenImport("webpack-merge");
- const loadedOptions = loadedConfigs.flatMap((config) => config.options);
- if (loadedOptions.length > 0) {
- const prevPaths = configPaths.get(config);
- const loadedPaths = loadedConfigs.flatMap((config) => config.path);
- if (prevPaths) {
- const intersection = loadedPaths.filter((element) => prevPaths.includes(element));
- if (intersection.length > 0) {
- this.logger.error(`Recursive configuration detected, exiting.`);
- process.exit(2);
- }
- }
- config = merge(...loadedOptions, config);
- if (prevPaths) {
- configPaths.set(config, [...prevPaths, ...loadedPaths]);
- }
- }
- if (config.extends) {
- const extendsPaths = typeof config.extends === "string" ? [config.extends] : config.extends;
- config = await resolveExtends(config, configPaths, extendsPaths);
- }
- return config;
- };
- // The `extends` param in CLI gets priority over extends in config file
- if (options.extends && options.extends.length > 0) {
- const extendsPaths = options.extends;
- if (Array.isArray(config.options)) {
- config.options = await Promise.all(config.options.map((options) => resolveExtends(options, config.path, extendsPaths)));
- }
- else {
- // load the config from the extends option
- config.options = await resolveExtends(config.options, config.path, extendsPaths);
- }
- }
- // if no extends option is passed, check if the config file has extends
- else if (Array.isArray(config.options) && config.options.some((options) => options.extends)) {
- config.options = await Promise.all(config.options.map((options) => {
- if (options.extends) {
- return resolveExtends(options, config.path, typeof options.extends === "string" ? [options.extends] : options.extends);
- }
- else {
- return options;
- }
- }));
- }
- else if (!Array.isArray(config.options) && config.options.extends) {
- config.options = await resolveExtends(config.options, config.path, typeof config.options.extends === "string"
- ? [config.options.extends]
- : config.options.extends);
- }
- 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);
- if (configPath) {
- mergedConfigPaths.push(...configPath);
- }
- return mergedOptions;
- }, {});
- config.path.set(config.options, mergedConfigPaths);
- }
- return config;
- }
- async buildConfig(config, 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);
- }
- const CLIPlugin = await this.tryRequireThenImport("./plugins/cli-plugin");
- const internalBuildConfig = (item) => {
- const originalWatchValue = item.watch;
- // Apply options
- const args = this.getBuiltInOptions().reduce((accumulator, flag) => {
- if (flag.group === "core") {
- 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;
- }, {});
- if (Object.keys(values).length > 0) {
- 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];
- for (const problem of problems) {
- 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);
- }
- }
- // Output warnings
- if (options.isWatchingLikeCommand &&
- options.argv &&
- options.argv.env &&
- (typeof originalWatchValue !== "undefined" || typeof options.argv.watch !== "undefined")) {
- this.logger.warn(`No need to use the '${options.argv.env["WEBPACK_WATCH"] ? "watch" : "serve"}' command together with '{ watch: true | false }' or '--watch'/'--no-watch' configuration, it does not make sense.`);
- if (options.argv.env["WEBPACK_SERVE"]) {
- item.watch = false;
- }
- }
- 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)) {
- for (const oneOfConfigPath of configPath) {
- item.cache.buildDependencies.defaultConfig.push(oneOfConfigPath);
- }
- }
- else {
- item.cache.buildDependencies.defaultConfig.push(configPath);
- }
- }
- }
- // 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
- 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);
- }
- 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,
- progress: options.progress,
- analyze: options.analyze,
- isMultiCompiler: Array.isArray(config.options),
- }));
- };
- if (Array.isArray(config.options)) {
- for (const item of config.options) {
- internalBuildConfig(item);
- }
- }
- else {
- internalBuildConfig(config.options);
- }
- return config;
- }
- isValidationError(error) {
- return error instanceof this.webpack.ValidationError || error.name === "ValidationError";
- }
- async createCompiler(options, callback) {
- if (typeof options.defineProcessEnvNodeEnv === "string") {
- // TODO: This should only set NODE_ENV for the runtime not for the config too. Change this during next breaking change.
- process.env.NODE_ENV = options.defineProcessEnvNodeEnv;
- }
- else 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);
- }
- 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() || (options.failOnWarnings && stats.hasWarnings()))) {
- 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;
- 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;
- options.isWatchingLikeCommand = 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;
|