123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- "use strict";
- Object.defineProperty(exports, "__esModule", { value: true });
- const WEBPACK_PACKAGE = process.env.WEBPACK_PACKAGE || "webpack";
- const WEBPACK_DEV_SERVER_PACKAGE = process.env.WEBPACK_DEV_SERVER_PACKAGE || "webpack-dev-server";
- class ServeCommand {
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
- async apply(cli) {
- const loadDevServerOptions = () => {
- // TODO simplify this after drop webpack v4 and webpack-dev-server v3
- // eslint-disable-next-line @typescript-eslint/no-var-requires
- const devServer = require(WEBPACK_DEV_SERVER_PACKAGE);
- const isNewDevServerCLIAPI = typeof devServer.schema !== "undefined";
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- let options = {};
- if (isNewDevServerCLIAPI) {
- if (cli.webpack.cli && typeof cli.webpack.cli.getArguments === "function") {
- options = cli.webpack.cli.getArguments(devServer.schema);
- }
- else {
- options = devServer.cli.getArguments();
- }
- }
- else {
- options = require(`${WEBPACK_DEV_SERVER_PACKAGE}/bin/cli-flags`);
- }
- // Old options format
- // { devServer: [{...}, {}...] }
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore
- if (options.devServer) {
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore
- return options.devServer;
- }
- // New options format
- // { flag1: {}, flag2: {} }
- return Object.keys(options).map((key) => {
- options[key].name = key;
- return options[key];
- });
- };
- await cli.makeCommand({
- name: "serve [entries...]",
- alias: ["server", "s"],
- description: "Run the webpack dev server.",
- usage: "[entries...] [options]",
- pkg: "@webpack-cli/serve",
- dependencies: [WEBPACK_PACKAGE, WEBPACK_DEV_SERVER_PACKAGE],
- }, async () => {
- let devServerFlags = [];
- cli.webpack = await cli.loadWebpack();
- try {
- devServerFlags = loadDevServerOptions();
- }
- catch (error) {
- cli.logger.error(`You need to install 'webpack-dev-server' for running 'webpack serve'.\n${error}`);
- process.exit(2);
- }
- const builtInOptions = cli.getBuiltInOptions().filter(
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- (option) => option.name !== "watch");
- return [...builtInOptions, ...devServerFlags];
- },
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- async (entries, options) => {
- const builtInOptions = cli.getBuiltInOptions();
- let devServerFlags = [];
- try {
- devServerFlags = loadDevServerOptions();
- }
- catch (error) {
- // Nothing, to prevent future updates
- }
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const webpackCLIOptions = {};
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const devServerCLIOptions = {};
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const processors = [];
- for (const optionName in options) {
- const kebabedOption = cli.toKebabCase(optionName);
- // `webpack-dev-server` has own logic for the `--hot` option
- const isBuiltInOption = kebabedOption !== "hot" &&
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- builtInOptions.find((builtInOption) => builtInOption.name === kebabedOption);
- if (isBuiltInOption) {
- webpackCLIOptions[optionName] = options[optionName];
- }
- else {
- const needToProcess = devServerFlags.find(
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- (devServerOption) => devServerOption.name === kebabedOption && devServerOption.processor);
- if (needToProcess) {
- processors.push(needToProcess.processor);
- }
- devServerCLIOptions[optionName] = options[optionName];
- }
- }
- for (const processor of processors) {
- processor(devServerCLIOptions);
- }
- if (entries.length > 0) {
- webpackCLIOptions.entry = [...entries, ...(webpackCLIOptions.entry || [])];
- }
- webpackCLIOptions.argv = Object.assign(Object.assign({}, options), { env: Object.assign({ WEBPACK_SERVE: true }, options.env) });
- const compiler = await cli.createCompiler(webpackCLIOptions);
- if (!compiler) {
- return;
- }
- const servers = [];
- if (cli.needWatchStdin(compiler) || devServerCLIOptions.stdin) {
- // TODO remove in the next major release
- // Compatibility with old `stdin` option for `webpack-dev-server`
- // Should be removed for the next major release on both sides
- if (devServerCLIOptions.stdin) {
- delete devServerCLIOptions.stdin;
- }
- process.stdin.on("end", () => {
- Promise.all(servers.map((server) => {
- if (typeof server.stop === "function") {
- return server.stop();
- }
- // TODO remove in the next major release
- return new Promise((resolve) => {
- server.close(() => {
- resolve();
- });
- });
- })).then(() => {
- process.exit(0);
- });
- });
- process.stdin.resume();
- }
- // eslint-disable-next-line @typescript-eslint/no-var-requires
- const DevServer = require(WEBPACK_DEV_SERVER_PACKAGE);
- const isNewDevServerCLIAPI = typeof DevServer.schema !== "undefined";
- let devServerVersion;
- try {
- // eslint-disable-next-line @typescript-eslint/no-var-requires
- devServerVersion = require(`${WEBPACK_DEV_SERVER_PACKAGE}/package.json`).version;
- }
- catch (err) {
- cli.logger.error(`You need to install 'webpack-dev-server' for running 'webpack serve'.\n${err}`);
- process.exit(2);
- }
- const compilers = typeof compiler.compilers !== "undefined" ? compiler.compilers : [compiler];
- const possibleCompilers = compilers.filter((compiler) => compiler.options.devServer);
- const compilersForDevServer = possibleCompilers.length > 0 ? possibleCompilers : [compilers[0]];
- const isDevServer4 = devServerVersion.startsWith("4");
- const usedPorts = [];
- for (const compilerForDevServer of compilersForDevServer) {
- let devServerOptions;
- if (isNewDevServerCLIAPI) {
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const args = devServerFlags.reduce((accumulator, flag) => {
- accumulator[flag.name] = flag;
- return accumulator;
- }, {});
- const values = Object.keys(devServerCLIOptions).reduce(
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- (accumulator, name) => {
- const kebabName = cli.toKebabCase(name);
- if (args[kebabName]) {
- accumulator[kebabName] = options[name];
- }
- return accumulator;
- }, {});
- const result = Object.assign({}, (compilerForDevServer.options.devServer || {}));
- const problems = (cli.webpack.cli && typeof cli.webpack.cli.processArguments === "function"
- ? cli.webpack.cli
- : DevServer.cli).processArguments(args, result, values);
- if (problems) {
- 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) => {
- cli.logger.error(`${cli.capitalizeFirstLetter(problem.type.replace(/-/g, " "))}${problem.value ? ` '${problem.value}'` : ""} for the '--${problem.argument}' option${problem.index ? ` by index '${problem.index}'` : ""}`);
- if (problem.expected) {
- cli.logger.error(`Expected: '${problem.expected}'`);
- }
- });
- }
- process.exit(2);
- }
- devServerOptions = result;
- }
- else {
- // TODO remove in the next major release
- const mergeOptions = (devServerOptions, devServerCliOptions) => {
- // CLI options should take precedence over devServer options,
- // and CLI options should have no default values included
- const options = Object.assign(Object.assign({}, devServerOptions), devServerCliOptions);
- if (devServerOptions.client && devServerCliOptions.client) {
- // the user could set some client options in their devServer config,
- // then also specify client options on the CLI
- options.client = Object.assign(Object.assign({}, devServerOptions.client), devServerCliOptions.client);
- }
- return options;
- };
- devServerOptions = mergeOptions(compilerForDevServer.options.devServer || {}, devServerCLIOptions);
- }
- // TODO remove in the next major release
- if (!isDevServer4) {
- const getPublicPathOption = () => {
- const normalizePublicPath = (publicPath) => typeof publicPath === "undefined" || publicPath === "auto" ? "/" : publicPath;
- if (options.outputPublicPath) {
- return normalizePublicPath(compilerForDevServer.options.output.publicPath);
- }
- if (devServerOptions.publicPath) {
- // eslint-disable-next-line @typescript-eslint/ban-ts-comment
- // @ts-ignore
- return normalizePublicPath(devServerOptions.publicPath);
- }
- return normalizePublicPath(compilerForDevServer.options.output.publicPath);
- };
- const getStatsOption = () => {
- if (options.stats) {
- return options.stats;
- }
- if (devServerOptions.stats) {
- return devServerOptions.stats;
- }
- return compilerForDevServer.options.stats;
- };
- devServerOptions.host = devServerOptions.host || "localhost";
- devServerOptions.port =
- typeof devServerOptions.port !== "undefined" ? devServerOptions.port : 8080;
- devServerOptions.stats = getStatsOption();
- devServerOptions.publicPath = getPublicPathOption();
- }
- if (devServerOptions.port) {
- const portNumber = Number(devServerOptions.port);
- if (usedPorts.find((port) => portNumber === port)) {
- throw new Error("Unique ports must be specified for each devServer option in your webpack configuration. Alternatively, run only 1 devServer config using the --config-name flag to specify your desired config.");
- }
- usedPorts.push(portNumber);
- }
- try {
- let server;
- // TODO: remove after dropping webpack-dev-server@v3
- if (isDevServer4) {
- server = new DevServer(devServerOptions, compiler);
- }
- else {
- server = new DevServer(compiler, devServerOptions);
- }
- if (typeof server.start === "function") {
- await server.start();
- }
- else {
- // TODO remove in the next major release
- server.listen(devServerOptions.port, devServerOptions.host, (error) => {
- if (error) {
- throw error;
- }
- });
- }
- servers.push(server);
- }
- catch (error) {
- if (cli.isValidationError(error)) {
- cli.logger.error(error.message);
- }
- else {
- cli.logger.error(error);
- }
- process.exit(2);
- }
- }
- });
- }
- }
- exports.default = ServeCommand;
|