webpack/lib/dependencies/CssIcssSelfLocalIdentifierDependency.js

Packs ECMAScript/CommonJs/AMD modules for the browser. Allows you to split your codebase into multiple bundles, which can be loaded on demand. Supports loaders to preprocess files, i.e. json, jsx, es7, css, less, ... and your custom stuff.

/*
	MIT License http://www.opensource.org/licenses/mit-license.php
	Author Ivan Kopeykin @vankop
*/

"use strict";

const Dependency = require("../Dependency");
const WebpackError = require("../WebpackError");
const makeSerializable = require("../util/makeSerializable");
const CssIcssExportDependency = require("./CssIcssExportDependency");
const CssLocalIdentifierDependency = require("./CssIcssLocalIdentifierDependency");

/** @typedef {import("../../declarations/WebpackOptions").CssGeneratorExportsConvention} CssGeneratorExportsConvention */
/** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
/** @typedef {import("../Dependency").ExportsSpec} ExportsSpec */
/** @typedef {import("../Dependency").ReferencedExports} ReferencedExports */
/** @typedef {import("../DependencyTemplate").CssDependencyTemplateContext} DependencyTemplateContext */
/** @typedef {import("../ModuleGraph")} ModuleGraph */
/** @typedef {import("../css/CssParser").Range} Range */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
/** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
/** @typedef {import("../CssModule")} CssModule */
/** @typedef {import("../css/CssGenerator")} CssGenerator */

class CssIcssSelfLocalIdentifierDependency extends CssLocalIdentifierDependency {
	/**
	 * @param {string} name name
	 * @param {string | undefined} referencedExport referenced export name
	 * @param {Range} range range
	 * @param {string=} prefix prefix
	 * @param {Set<string>=} declaredSet set of declared names (will only be active when in declared set)
	 * @param {string=} reexport reexport name
	 */
	constructor(
		name,
		referencedExport,
		range,
		prefix = "",
		declaredSet = undefined,
		reexport = undefined
	) {
		super(name, range, prefix);
		this.declaredSet = declaredSet;
		this.referencedExport = referencedExport;
		this.reexport = reexport;
		this.interpolationMode = referencedExport
			? CssIcssExportDependency.INTERPOLATION_MODE.NONE
			: CssIcssExportDependency.INTERPOLATION_MODE.VALUE;
		this.exportMode = referencedExport
			? CssIcssExportDependency.EXPORT_MODE.APPEND
			: CssIcssExportDependency.EXPORT_MODE.ONCE;
	}

	get type() {
		return "css self local identifier";
	}

	get category() {
		return "self";
	}

	/**
	 * @returns {string | null} an identifier to merge equal requests
	 */
	getResourceIdentifier() {
		return "self";
	}

	/**
	 * Returns the exported names
	 * @param {ModuleGraph} moduleGraph module graph
	 * @returns {ExportsSpec | undefined} export names
	 */
	getExports(moduleGraph) {
		if (
			(this.declaredSet && !this.declaredSet.has(this.name)) ||
			this.referencedExport
		) {
			return;
		}
		return super.getExports(moduleGraph);
	}

	/**
	 * Returns list of exports referenced by this dependency
	 * @param {ModuleGraph} moduleGraph module graph
	 * @param {RuntimeSpec} runtime the runtime for which the module is analysed
	 * @returns {ReferencedExports} referenced exports
	 */
	getReferencedExports(moduleGraph, runtime) {
		if (this.declaredSet && !this.declaredSet.has(this.name)) {
			return Dependency.NO_EXPORTS_REFERENCED;
		}
		return [
			{
				name: [this.referencedExport || this.name],
				canMangle: true
			}
		];
	}

	/**
	 * Returns warnings
	 * @param {ModuleGraph} moduleGraph module graph
	 * @returns {WebpackError[] | null | undefined} warnings
	 */
	getWarnings(moduleGraph) {
		if (this.referencedExport && !this.reexport) {
			const module = moduleGraph.getModule(this);

			if (
				module &&
				!moduleGraph
					.getExportsInfo(module)
					.isExportProvided(this.referencedExport)
			) {
				const error = new WebpackError(
					`Self-referencing name "${this.referencedExport}" not found`
				);
				error.module = module;

				return [error];
			}
		}

		return null;
	}

	/**
	 * @param {ObjectSerializerContext} context context
	 */
	serialize(context) {
		const { write } = context;
		write(this.declaredSet);
		write(this.referencedExport);
		super.serialize(context);
	}

	/**
	 * @param {ObjectDeserializerContext} context context
	 */
	deserialize(context) {
		const { read } = context;
		this.declaredSet = read();
		this.referencedExport = read();
		super.deserialize(context);
	}
}

CssIcssSelfLocalIdentifierDependency.Template = class CssSelfLocalIdentifierDependencyTemplate extends (
	CssLocalIdentifierDependency.Template
) {
	/**
	 * @param {Dependency} dependency the dependency for which the template should be applied
	 * @param {ReplaceSource} source the current replace source which can be modified
	 * @param {DependencyTemplateContext} templateContext the context object
	 * @returns {void}
	 */
	apply(dependency, source, templateContext) {
		const dep =
			/** @type {CssIcssSelfLocalIdentifierDependency} */
			(dependency);
		if (dep.declaredSet && !dep.declaredSet.has(dep.name)) return;
		if (dep.referencedExport) {
			const { module: m, moduleGraph, cssData } = templateContext;
			const module = /** @type {CssModule} */ (m);

			if (
				!dep.reexport &&
				!moduleGraph
					.getExportsInfo(module)
					.isExportProvided(dep.referencedExport)
			) {
				return;
			}

			dep.value = cssData.exports.get(dep.referencedExport) || "";
		}
		super.apply(dependency, source, templateContext);
	}
};

makeSerializable(
	CssIcssSelfLocalIdentifierDependency,
	"webpack/lib/dependencies/CssIcssSelfLocalIdentifierDependency"
);

module.exports = CssIcssSelfLocalIdentifierDependency;