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