RequireIncludeDependency.js 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const Dependency = require("../Dependency");
  7. const Template = require("../Template");
  8. const makeSerializable = require("../util/makeSerializable");
  9. const ModuleDependency = require("./ModuleDependency");
  10. /** @typedef {import("webpack-sources").ReplaceSource} ReplaceSource */
  11. /** @typedef {import("../Dependency").ReferencedExports} ReferencedExports */
  12. /** @typedef {import("../DependencyTemplate").DependencyTemplateContext} DependencyTemplateContext */
  13. /** @typedef {import("../ModuleGraph")} ModuleGraph */
  14. /** @typedef {import("../javascript/JavascriptParser").Range} Range */
  15. /** @typedef {import("../util/runtime").RuntimeSpec} RuntimeSpec */
  16. class RequireIncludeDependency extends ModuleDependency {
  17. /**
  18. * Creates an instance of RequireIncludeDependency.
  19. * @param {string} request the request string
  20. * @param {Range} range location in source code
  21. */
  22. constructor(request, range) {
  23. super(request);
  24. this.range = range;
  25. }
  26. /**
  27. * Returns list of exports referenced by this dependency
  28. * @param {ModuleGraph} moduleGraph module graph
  29. * @param {RuntimeSpec} runtime the runtime for which the module is analysed
  30. * @returns {ReferencedExports} referenced exports
  31. */
  32. getReferencedExports(moduleGraph, runtime) {
  33. // This doesn't use any export
  34. return Dependency.NO_EXPORTS_REFERENCED;
  35. }
  36. get type() {
  37. return "require.include";
  38. }
  39. get category() {
  40. return "commonjs";
  41. }
  42. }
  43. makeSerializable(
  44. RequireIncludeDependency,
  45. "webpack/lib/dependencies/RequireIncludeDependency"
  46. );
  47. RequireIncludeDependency.Template = class RequireIncludeDependencyTemplate extends (
  48. ModuleDependency.Template
  49. ) {
  50. /**
  51. * Applies the plugin by registering its hooks on the compiler.
  52. * @param {Dependency} dependency the dependency for which the template should be applied
  53. * @param {ReplaceSource} source the current replace source which can be modified
  54. * @param {DependencyTemplateContext} templateContext the context object
  55. * @returns {void}
  56. */
  57. apply(dependency, source, { runtimeTemplate }) {
  58. const dep = /** @type {RequireIncludeDependency} */ (dependency);
  59. const comment = runtimeTemplate.outputOptions.pathinfo
  60. ? Template.toComment(
  61. `require.include ${runtimeTemplate.requestShortener.shorten(
  62. dep.request
  63. )}`
  64. )
  65. : "";
  66. source.replace(dep.range[0], dep.range[1] - 1, `undefined${comment}`);
  67. }
  68. };
  69. module.exports = RequireIncludeDependency;