webpack/webpack-cli

import { type Compiler } from "webpack";
import { type CLIPluginOptions } from "../types";

export class CLIPlugin {
  logger!: ReturnType<Compiler["getInfrastructureLogger"]>;
  options: CLIPluginOptions;

  constructor(options: CLIPluginOptions) {
    this.options = options;
  }

  async setupBundleAnalyzerPlugin(compiler: Compiler) {
    // eslint-disable-next-line node/no-extraneous-require,@typescript-eslint/no-var-requires
    const { BundleAnalyzerPlugin } = require("webpack-bundle-analyzer");
    const bundleAnalyzerPlugin = Boolean(
      compiler.options.plugins.find((plugin) => plugin instanceof BundleAnalyzerPlugin),
    );

    if (!bundleAnalyzerPlugin) {
      new BundleAnalyzerPlugin().apply(compiler);
    }
  }

  static #progressStates: [number, ...string[]][] = [];

  setupProgressPlugin(compiler: Compiler) {
    const { ProgressPlugin } = compiler.webpack || require("webpack");
    const progressPlugin = Boolean(
      compiler.options.plugins.find((plugin) => plugin instanceof ProgressPlugin),
    );

    if (progressPlugin) {
      return;
    }

    const isProfile = this.options.progress === "profile";

    const options: ConstructorParameters<typeof ProgressPlugin>[0] = {
      profile: isProfile,
    };

    if (this.options.isMultiCompiler && ProgressPlugin.createDefaultHandler) {
      const handler = ProgressPlugin.createDefaultHandler(
        isProfile,
        compiler.getInfrastructureLogger("webpack.Progress"),
      );
      const idx = CLIPlugin.#progressStates.length;

      CLIPlugin.#progressStates[idx] = [0];

      options.handler = (p: number, msg: string, ...args: string[]) => {
        CLIPlugin.#progressStates[idx] = [p, msg, ...args];

        let sum = 0;

        for (const [p] of CLIPlugin.#progressStates) {
          sum += p;
        }

        handler(
          sum / CLIPlugin.#progressStates.length,
          `[${compiler.name ? compiler.name : idx}] ${msg}`,
          ...args,
        );
      };
    }

    new ProgressPlugin(options).apply(compiler);
  }

  setupHelpfulOutput(compiler: Compiler) {
    const pluginName = "webpack-cli";
    const getCompilationName = () => (compiler.name ? `'${compiler.name}'` : "");
    const logCompilation = (message: string) => {
      if (process.env.WEBPACK_CLI_START_FINISH_FORCE_LOG) {
        process.stderr.write(message);
      } else {
        this.logger.log(message);
      }
    };

    const { configPath } = this.options;

    compiler.hooks.run.tap(pluginName, () => {
      const name = getCompilationName();

      logCompilation(`Compiler${name ? ` ${name}` : ""} starting... `);

      if (configPath) {
        this.logger.log(
          `Compiler${name ? ` ${name}` : ""} is using config: ${configPath
            .map((path) => `'${path}'`)
            .join(", ")}`,
        );
      }
    });

    compiler.hooks.watchRun.tap(pluginName, (compiler) => {
      const { bail, watch } = compiler.options;

      if (bail && watch) {
        this.logger.warn(
          'You are using "bail" with "watch". "bail" will still exit webpack when the first error is found.',
        );
      }

      const name = getCompilationName();

      logCompilation(`Compiler${name ? ` ${name}` : ""} starting... `);

      if (configPath) {
        this.logger.log(`Compiler${name ? ` ${name}` : ""} is using config: '${configPath}'`);
      }
    });

    compiler.hooks.invalid.tap(pluginName, (filename, changeTime) => {
      const date = new Date(changeTime);

      this.logger.log(`File '${filename}' was modified`);
      this.logger.log(`Changed time is ${date} (timestamp is ${changeTime})`);
    });

    ((compiler as Partial<Compiler>).webpack ? compiler.hooks.afterDone : compiler.hooks.done).tap(
      pluginName,
      () => {
        const name = getCompilationName();

        logCompilation(`Compiler${name ? ` ${name}` : ""} finished`);

        process.nextTick(() => {
          if (compiler.watchMode) {
            this.logger.log(`Compiler${name ? `${name}` : ""} is watching files for updates...`);
          }
        });
      },
    );
  }

  apply(compiler: Compiler) {
    this.logger = compiler.getInfrastructureLogger("webpack-cli");

    if (this.options.progress) {
      this.setupProgressPlugin(compiler);
    }

    if (this.options.analyze) {
      this.setupBundleAnalyzerPlugin(compiler);
    }

    this.setupHelpfulOutput(compiler);
  }
}

module.exports = CLIPlugin;