| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204 |
- /*
- MIT License http://www.opensource.org/licenses/mit-license.php
- Author Tobias Koppers @sokra
- */
- "use strict";
- const { OriginalSource, RawSource } = require("webpack-sources");
- const Module = require("./Module");
- const {
- JAVASCRIPT_TYPE,
- JAVASCRIPT_TYPES
- } = require("./ModuleSourceTypeConstants");
- const { JAVASCRIPT_MODULE_TYPE_DYNAMIC } = require("./ModuleTypeConstants");
- const makeSerializable = require("./util/makeSerializable");
- /**
- * @import {
- * WebpackOptionsNormalizedWithDefaults as WebpackOptions
- * } from "./config/defaults"
- */
- /** @import Compilation from "./Compilation" */
- /** @import { UpdateHashContext } from "./Dependency" */
- /**
- * @import {
- * BuildCallback,
- * CodeGenerationContext,
- * CodeGenerationResult,
- * NeedBuildCallback,
- * NeedBuildContext,
- * ReadOnlyRuntimeRequirements,
- * Sources,
- * SourceTypes
- * } from "./Module"
- */
- /** @import ModuleGraph from "./ModuleGraph" */
- /** @import { ConnectionState } from "./ModuleGraphConnection" */
- /** @import RequestShortener from "./RequestShortener" */
- /** @import { ResolverWithOptions } from "./ResolverFactory" */
- /** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext<[string, string, string, ReadOnlyRuntimeRequirements | null]>} ObjectDeserializerContext */
- /** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext<[string, string, string, ReadOnlyRuntimeRequirements | null]>} ObjectSerializerContext */
- /** @import Hash from "./util/Hash" */
- /** @import { InputFileSystem } from "./util/fs" */
- class RawModule extends Module {
- /**
- * Creates an instance of RawModule.
- * @param {string} source source code
- * @param {string} identifier unique identifier
- * @param {string=} readableIdentifier readable identifier
- * @param {ReadOnlyRuntimeRequirements=} runtimeRequirements runtime requirements needed for the source code
- */
- constructor(source, identifier, readableIdentifier, runtimeRequirements) {
- super(JAVASCRIPT_MODULE_TYPE_DYNAMIC, null);
- /** @type {string} */
- this.sourceStr = source;
- /** @type {string} */
- this.identifierStr = identifier || this.sourceStr;
- /** @type {string} */
- this.readableIdentifierStr = readableIdentifier || this.identifierStr;
- /** @type {ReadOnlyRuntimeRequirements | null} */
- this.runtimeRequirements = runtimeRequirements || null;
- }
- /**
- * Returns the source types this module can generate.
- * @returns {SourceTypes} types available (do not mutate)
- */
- getSourceTypes() {
- return JAVASCRIPT_TYPES;
- }
- /**
- * Returns the unique identifier used to reference this module.
- * @returns {string} a unique identifier of the module
- */
- identifier() {
- return this.identifierStr;
- }
- /**
- * Returns the estimated size for the requested source type.
- * @param {string=} type the source type for which the size should be estimated
- * @returns {number} the estimated size of the module (must be non-zero)
- */
- size(type) {
- return Math.max(1, this.sourceStr.length);
- }
- /**
- * Returns a human-readable identifier for this module.
- * @param {RequestShortener} requestShortener the request shortener
- * @returns {string} a user readable identifier of the module
- */
- readableIdentifier(requestShortener) {
- return /** @type {string} */ (
- requestShortener.shorten(this.readableIdentifierStr)
- );
- }
- /**
- * Checks whether the module needs to be rebuilt for the current build state.
- * @param {NeedBuildContext} context context info
- * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
- * @returns {void}
- */
- needBuild(context, callback) {
- return callback(null, !this.buildMeta);
- }
- /**
- * Builds the module using the provided compilation context.
- * @param {WebpackOptions} options webpack options
- * @param {Compilation} compilation the compilation
- * @param {ResolverWithOptions} resolver the resolver
- * @param {InputFileSystem} fs the file system
- * @param {BuildCallback} callback callback function
- * @returns {void}
- */
- build(options, compilation, resolver, fs, callback) {
- this.buildMeta = {};
- this.buildInfo = {
- cacheable: true
- };
- callback();
- }
- /**
- * Gets side effects connection state.
- * @param {ModuleGraph} moduleGraph the module graph
- * @returns {ConnectionState} how this module should be connected to referencing modules when consumed for side-effects only
- */
- getSideEffectsConnectionState(moduleGraph) {
- if (this.factoryMeta !== undefined) {
- if (this.factoryMeta.sideEffectFree) return false;
- if (this.factoryMeta.sideEffectFree === false) return true;
- }
- return true;
- }
- /**
- * Generates code and runtime requirements for this module.
- * @param {CodeGenerationContext} context context for code generation
- * @returns {CodeGenerationResult} result
- */
- codeGeneration(context) {
- /** @type {Sources} */
- const sources = new Map();
- if (this.useSourceMap || this.useSimpleSourceMap) {
- sources.set(
- JAVASCRIPT_TYPE,
- new OriginalSource(this.sourceStr, this.identifier())
- );
- } else {
- sources.set(JAVASCRIPT_TYPE, new RawSource(this.sourceStr));
- }
- return { sources, runtimeRequirements: this.runtimeRequirements };
- }
- /**
- * Updates the hash with the data contributed by this instance.
- * @param {Hash} hash the hash used to track dependencies
- * @param {UpdateHashContext} context context
- * @returns {void}
- */
- updateHash(hash, context) {
- hash.update(this.sourceStr);
- super.updateHash(hash, context);
- }
- /**
- * Serializes this instance into the provided serializer context.
- * @param {ObjectSerializerContext} context context
- */
- serialize(context) {
- context
- .write(this.sourceStr)
- .write(this.identifierStr)
- .write(this.readableIdentifierStr)
- .write(this.runtimeRequirements);
- super.serialize(context);
- }
- /**
- * Restores this instance from the provided deserializer context.
- * @param {ObjectDeserializerContext} context context
- */
- deserialize(context) {
- this.sourceStr = context.read();
- const c1 = context.rest;
- this.identifierStr = c1.read();
- const c2 = c1.rest;
- this.readableIdentifierStr = c2.read();
- const c3 = c2.rest;
- this.runtimeRequirements = c3.read();
- super.deserialize(c3.rest);
- }
- }
- makeSerializable(RawModule, "webpack/lib/RawModule");
- module.exports = RawModule;
|