mirror of https://github.com/webpack/webpack.git
				
				
				
			
		
			
				
	
	
		
			129 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
			
		
		
	
	
			129 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
| /*
 | |
| 	MIT License http://www.opensource.org/licenses/mit-license.php
 | |
| 	Author Tobias Koppers @sokra
 | |
| */
 | |
| 
 | |
| "use strict";
 | |
| 
 | |
| const OriginalSource = require("webpack-sources").OriginalSource;
 | |
| const Module = require("./Module");
 | |
| 
 | |
| /** @typedef {import("webpack-sources").Source} Source */
 | |
| /** @typedef {import("./Chunk")} Chunk */
 | |
| /** @typedef {import("./ChunkGraph")} ChunkGraph */
 | |
| /** @typedef {import("./Compilation")} Compilation */
 | |
| /** @typedef {import("./Module").LibIdentOptions} LibIdentOptions */
 | |
| /** @typedef {import("./Module").NeedBuildContext} NeedBuildContext */
 | |
| /** @typedef {import("./Module").SourceContext} SourceContext */
 | |
| /** @typedef {import("./RequestShortener")} RequestShortener */
 | |
| /** @typedef {import("./WebpackError")} WebpackError */
 | |
| /** @typedef {import("./util/createHash").Hash} Hash */
 | |
| 
 | |
| /** @typedef {SourceContext} GenerateContext */
 | |
| 
 | |
| const TYPES = new Set(["runtime"]);
 | |
| 
 | |
| class RuntimeModule extends Module {
 | |
| 	constructor(name, stage = 0) {
 | |
| 		super("runtime");
 | |
| 		this.name = name;
 | |
| 		this.stage = stage;
 | |
| 		this.buildMeta = {};
 | |
| 		this.buildInfo = {};
 | |
| 		this._cachedGeneratedCode = undefined;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @returns {string} a unique identifier of the module
 | |
| 	 */
 | |
| 	identifier() {
 | |
| 		return `webpack/runtime/${this.name}`;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {RequestShortener} requestShortener the request shortener
 | |
| 	 * @returns {string} a user readable identifier of the module
 | |
| 	 */
 | |
| 	readableIdentifier(requestShortener) {
 | |
| 		return `webpack/runtime/${this.name}`;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {NeedBuildContext} context context info
 | |
| 	 * @param {function(WebpackError=, boolean=): void} callback callback function, returns true, if the module needs a rebuild
 | |
| 	 * @returns {void}
 | |
| 	 */
 | |
| 	needBuild(context, callback) {
 | |
| 		return callback(null, false);
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {TODO} options TODO
 | |
| 	 * @param {Compilation} compilation the compilation
 | |
| 	 * @param {TODO} resolver TODO
 | |
| 	 * @param {TODO} fs the file system
 | |
| 	 * @param {function(WebpackError=): void} callback callback function
 | |
| 	 * @returns {void}
 | |
| 	 */
 | |
| 	build(options, compilation, resolver, fs, callback) {
 | |
| 		// do nothing
 | |
| 		// should not be called as runtime modules are added later to the compilation
 | |
| 		callback();
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {Hash} hash the hash used to track dependencies
 | |
| 	 * @param {ChunkGraph} chunkGraph the chunk graph
 | |
| 	 * @returns {void}
 | |
| 	 */
 | |
| 	updateHash(hash, chunkGraph) {
 | |
| 		// Do not use getGeneratedCode here, because i. e. compilation hash is not
 | |
| 		// ready at this point. We will cache it later instead.
 | |
| 		hash.update(this.generate());
 | |
| 		super.updateHash(hash, chunkGraph);
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @returns {Set<string>} types availiable (do not mutate)
 | |
| 	 */
 | |
| 	getSourceTypes() {
 | |
| 		return TYPES;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {SourceContext} sourceContext source context
 | |
| 	 * @returns {Source} generated source
 | |
| 	 */
 | |
| 	source(sourceContext) {
 | |
| 		return new OriginalSource(this.getGeneratedCode(), this.identifier());
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @param {string=} type the source type for which the size should be estimated
 | |
| 	 * @returns {number} the estimated size of the module
 | |
| 	 */
 | |
| 	size(type) {
 | |
| 		return this.getGeneratedCode().length;
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @abstract
 | |
| 	 * @returns {string} runtime code
 | |
| 	 */
 | |
| 	generate() {
 | |
| 		throw new Error(
 | |
| 			`RuntimeModule: generate() must be overriden in subclass ${this.name}`
 | |
| 		);
 | |
| 	}
 | |
| 
 | |
| 	/**
 | |
| 	 * @returns {string} runtime code
 | |
| 	 */
 | |
| 	getGeneratedCode() {
 | |
| 		if (this._cachedGeneratedCode) return this._cachedGeneratedCode;
 | |
| 		return (this._cachedGeneratedCode = this.generate());
 | |
| 	}
 | |
| }
 | |
| 
 | |
| module.exports = RuntimeModule;
 |