ImportsFieldPlugin.js 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Ivan Kopeykin @vankop
  4. */
  5. "use strict";
  6. const DescriptionFileUtils = require("./DescriptionFileUtils");
  7. const forEachBail = require("./forEachBail");
  8. const { processImportsField } = require("./util/entrypoints");
  9. const { parseIdentifier } = require("./util/identifier");
  10. const { checkImportsExportsFieldTarget } = require("./util/path");
  11. /** @typedef {import("./Resolver")} Resolver */
  12. /** @typedef {import("./Resolver").JsonObject} JsonObject */
  13. /** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
  14. /** @typedef {import("./Resolver").ResolveStepHook} ResolveStepHook */
  15. /** @typedef {import("./util/entrypoints").FieldProcessor} FieldProcessor */
  16. /** @typedef {import("./util/entrypoints").ImportsField} ImportsField */
  17. const dotCode = ".".charCodeAt(0);
  18. module.exports = class ImportsFieldPlugin {
  19. /**
  20. * @param {string | ResolveStepHook} source source
  21. * @param {Set<string>} conditionNames condition names
  22. * @param {string | string[]} fieldNamePath name path
  23. * @param {string | ResolveStepHook} targetFile target file
  24. * @param {string | ResolveStepHook} targetPackage target package
  25. */
  26. constructor(
  27. source,
  28. conditionNames,
  29. fieldNamePath,
  30. targetFile,
  31. targetPackage
  32. ) {
  33. this.source = source;
  34. this.targetFile = targetFile;
  35. this.targetPackage = targetPackage;
  36. this.conditionNames = conditionNames;
  37. this.fieldName = fieldNamePath;
  38. /** @type {WeakMap<JsonObject, FieldProcessor>} */
  39. this.fieldProcessorCache = new WeakMap();
  40. }
  41. /**
  42. * @param {Resolver} resolver the resolver
  43. * @returns {void}
  44. */
  45. apply(resolver) {
  46. const targetFile = resolver.ensureHook(this.targetFile);
  47. const targetPackage = resolver.ensureHook(this.targetPackage);
  48. resolver
  49. .getHook(this.source)
  50. .tapAsync("ImportsFieldPlugin", (request, resolveContext, callback) => {
  51. // When there is no description file, abort
  52. if (!request.descriptionFilePath || request.request === undefined) {
  53. return callback();
  54. }
  55. const remainingRequest =
  56. request.request + request.query + request.fragment;
  57. const importsField =
  58. /** @type {ImportsField|null|undefined} */
  59. (
  60. DescriptionFileUtils.getField(
  61. /** @type {JsonObject} */ (request.descriptionFileData),
  62. this.fieldName
  63. )
  64. );
  65. if (!importsField) return callback();
  66. if (request.directory) {
  67. return callback(
  68. new Error(
  69. `Resolving to directories is not possible with the imports field (request was ${remainingRequest}/)`
  70. )
  71. );
  72. }
  73. /** @type {string[]} */
  74. let paths;
  75. try {
  76. // We attach the cache to the description file instead of the importsField value
  77. // because we use a WeakMap and the importsField could be a string too.
  78. // Description file is always an object when exports field can be accessed.
  79. let fieldProcessor = this.fieldProcessorCache.get(
  80. /** @type {JsonObject} */ (request.descriptionFileData)
  81. );
  82. if (fieldProcessor === undefined) {
  83. fieldProcessor = processImportsField(importsField);
  84. this.fieldProcessorCache.set(
  85. /** @type {JsonObject} */ (request.descriptionFileData),
  86. fieldProcessor
  87. );
  88. }
  89. paths = fieldProcessor(remainingRequest, this.conditionNames);
  90. } catch (/** @type {unknown} */ err) {
  91. if (resolveContext.log) {
  92. resolveContext.log(
  93. `Imports field in ${request.descriptionFilePath} can't be processed: ${err}`
  94. );
  95. }
  96. return callback(/** @type {Error} */ (err));
  97. }
  98. if (paths.length === 0) {
  99. return callback(
  100. new Error(
  101. `Package import ${remainingRequest} is not imported from package ${request.descriptionFileRoot} (see imports field in ${request.descriptionFilePath})`
  102. )
  103. );
  104. }
  105. forEachBail(
  106. paths,
  107. /**
  108. * @param {string} p path
  109. * @param {(err?: null|Error, result?: null|ResolveRequest) => void} callback callback
  110. * @returns {void}
  111. */
  112. (p, callback) => {
  113. const parsedIdentifier = parseIdentifier(p);
  114. if (!parsedIdentifier) return callback();
  115. const [path_, query, fragment] = parsedIdentifier;
  116. const error = checkImportsExportsFieldTarget(path_);
  117. if (error) {
  118. return callback(error);
  119. }
  120. switch (path_.charCodeAt(0)) {
  121. // should be relative
  122. case dotCode: {
  123. /** @type {ResolveRequest} */
  124. const obj = {
  125. ...request,
  126. request: undefined,
  127. path: resolver.join(
  128. /** @type {string} */ (request.descriptionFileRoot),
  129. path_
  130. ),
  131. relativePath: path_,
  132. query,
  133. fragment
  134. };
  135. resolver.doResolve(
  136. targetFile,
  137. obj,
  138. "using imports field: " + p,
  139. resolveContext,
  140. callback
  141. );
  142. break;
  143. }
  144. // package resolving
  145. default: {
  146. /** @type {ResolveRequest} */
  147. const obj = {
  148. ...request,
  149. request: path_,
  150. relativePath: path_,
  151. fullySpecified: true,
  152. query,
  153. fragment
  154. };
  155. resolver.doResolve(
  156. targetPackage,
  157. obj,
  158. "using imports field: " + p,
  159. resolveContext,
  160. callback
  161. );
  162. }
  163. }
  164. },
  165. /**
  166. * @param {null|Error} [err] error
  167. * @param {null|ResolveRequest} [result] result
  168. * @returns {void}
  169. */
  170. (err, result) => callback(err, result || null)
  171. );
  172. });
  173. }
  174. };