index.js 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const memoize = require("./util/memoize");
  7. /** @typedef {import("./CachedInputFileSystem").BaseFileSystem} BaseFileSystem */
  8. /** @typedef {import("./PnpPlugin").PnpApiImpl} PnpApi */
  9. /** @typedef {import("./Resolver")} Resolver */
  10. /** @typedef {import("./Resolver").Context} Context */
  11. /** @typedef {import("./Resolver").FileSystem} FileSystem */
  12. /** @typedef {import("./Resolver").ResolveCallback} ResolveCallback */
  13. /** @typedef {import("./Resolver").ResolveContext} ResolveContext */
  14. /** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
  15. /** @typedef {import("./Resolver").SyncFileSystem} SyncFileSystem */
  16. /** @typedef {import("./ResolverFactory").Plugin} Plugin */
  17. /** @typedef {import("./ResolverFactory").UserResolveOptions} ResolveOptions */
  18. /**
  19. * @typedef {{
  20. * (context: Context, path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void,
  21. * (context: Context, path: string, request: string, callback: ResolveCallback): void,
  22. * (path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void,
  23. * (path: string, request: string, callback: ResolveCallback): void,
  24. * }} ResolveFunctionAsync
  25. */
  26. /**
  27. * @typedef {{
  28. * (context: Context, path: string, request: string, resolveContext?: ResolveContext): string | false,
  29. * (path: string, request: string, resolveContext?: ResolveContext): string | false,
  30. * }} ResolveFunction
  31. */
  32. /**
  33. * @typedef {{
  34. * (context: Context, path: string, request: string, resolveContext?: ResolveContext): Promise<string | false>,
  35. * (path: string, request: string, resolveContext?: ResolveContext): Promise<string | false>,
  36. * }} ResolveFunctionPromise
  37. */
  38. const getCachedFileSystem = memoize(() => require("./CachedInputFileSystem"));
  39. const getNodeFileSystem = memoize(() => {
  40. const fs = require("graceful-fs");
  41. const CachedInputFileSystem = getCachedFileSystem();
  42. return new CachedInputFileSystem(fs, 4000);
  43. });
  44. const getNodeContext = memoize(() => ({
  45. environments: ["node+es3+es5+process+native"],
  46. }));
  47. const getResolverFactory = memoize(() => require("./ResolverFactory"));
  48. const getAsyncResolver = memoize(() =>
  49. getResolverFactory().createResolver({
  50. conditionNames: ["node"],
  51. extensions: [".js", ".json", ".node"],
  52. fileSystem: getNodeFileSystem(),
  53. }),
  54. );
  55. /**
  56. * @type {ResolveFunctionAsync}
  57. */
  58. const resolve =
  59. /**
  60. * @param {object | string} context context
  61. * @param {string} path path
  62. * @param {string | ResolveContext | ResolveCallback} request request
  63. * @param {ResolveContext | ResolveCallback=} resolveContext resolve context
  64. * @param {ResolveCallback=} callback callback
  65. */
  66. (context, path, request, resolveContext, callback) => {
  67. if (typeof context === "string") {
  68. callback = /** @type {ResolveCallback} */ (resolveContext);
  69. resolveContext = /** @type {ResolveContext} */ (request);
  70. request = path;
  71. path = context;
  72. context = getNodeContext();
  73. }
  74. if (typeof callback !== "function") {
  75. callback = /** @type {ResolveCallback} */ (resolveContext);
  76. }
  77. getAsyncResolver().resolve(
  78. context,
  79. path,
  80. /** @type {string} */ (request),
  81. /** @type {ResolveContext} */ (resolveContext),
  82. /** @type {ResolveCallback} */ (callback),
  83. );
  84. };
  85. const getSyncResolver = memoize(() =>
  86. getResolverFactory().createResolver({
  87. conditionNames: ["node"],
  88. extensions: [".js", ".json", ".node"],
  89. useSyncFileSystemCalls: true,
  90. fileSystem: getNodeFileSystem(),
  91. }),
  92. );
  93. /**
  94. * @type {ResolveFunction}
  95. */
  96. const resolveSync =
  97. /**
  98. * @param {object | string} context context
  99. * @param {string} path path
  100. * @param {string | ResolveContext | undefined} request request
  101. * @param {ResolveContext=} resolveContext resolve context
  102. * @returns {string | false} resolved path
  103. */
  104. (context, path, request, resolveContext) => {
  105. if (typeof context === "string") {
  106. resolveContext = /** @type {ResolveContext} */ (request);
  107. request = path;
  108. path = context;
  109. context = getNodeContext();
  110. }
  111. return getSyncResolver().resolveSync(
  112. context,
  113. path,
  114. /** @type {string} */ (request),
  115. /** @type {ResolveContext} */ (resolveContext),
  116. );
  117. };
  118. /**
  119. * @type {ResolveFunctionPromise}
  120. */
  121. const resolvePromise =
  122. /**
  123. * @param {object | string} context context
  124. * @param {string} path path
  125. * @param {string | ResolveContext | undefined} request request
  126. * @param {ResolveContext=} resolveContext resolve context
  127. * @returns {Promise<string | false>} resolved path
  128. */
  129. (context, path, request, resolveContext) => {
  130. if (typeof context === "string") {
  131. resolveContext = /** @type {ResolveContext} */ (request);
  132. request = path;
  133. path = context;
  134. context = getNodeContext();
  135. }
  136. return getAsyncResolver().resolvePromise(
  137. context,
  138. path,
  139. /** @type {string} */ (request),
  140. /** @type {ResolveContext} */ (resolveContext),
  141. );
  142. };
  143. /** @typedef {Omit<ResolveOptions, "fileSystem"> & Partial<Pick<ResolveOptions, "fileSystem">>} ResolveOptionsOptionalFS */
  144. /**
  145. * @param {ResolveOptionsOptionalFS} options Resolver options
  146. * @returns {ResolveFunctionAsync} Resolver function
  147. */
  148. function create(options) {
  149. const resolver = getResolverFactory().createResolver({
  150. fileSystem: getNodeFileSystem(),
  151. ...options,
  152. });
  153. /**
  154. * @param {object | string} context Custom context
  155. * @param {string} path Base path
  156. * @param {string | ResolveContext | ResolveCallback} request String to resolve
  157. * @param {ResolveContext | ResolveCallback=} resolveContext Resolve context
  158. * @param {ResolveCallback=} callback Result callback
  159. */
  160. return function create(context, path, request, resolveContext, callback) {
  161. if (typeof context === "string") {
  162. callback = /** @type {ResolveCallback} */ (resolveContext);
  163. resolveContext = /** @type {ResolveContext} */ (request);
  164. request = path;
  165. path = context;
  166. context = getNodeContext();
  167. }
  168. if (typeof callback !== "function") {
  169. callback = /** @type {ResolveCallback} */ (resolveContext);
  170. }
  171. resolver.resolve(
  172. context,
  173. path,
  174. /** @type {string} */ (request),
  175. /** @type {ResolveContext} */ (resolveContext),
  176. callback,
  177. );
  178. };
  179. }
  180. /**
  181. * @param {ResolveOptionsOptionalFS} options Resolver options
  182. * @returns {ResolveFunction} Resolver function
  183. */
  184. function createSync(options) {
  185. const resolver = getResolverFactory().createResolver({
  186. useSyncFileSystemCalls: true,
  187. fileSystem: getNodeFileSystem(),
  188. ...options,
  189. });
  190. /**
  191. * @param {object | string} context custom context
  192. * @param {string} path base path
  193. * @param {string | ResolveContext | undefined} request request to resolve
  194. * @param {ResolveContext=} resolveContext Resolve context
  195. * @returns {string | false} Resolved path or false
  196. */
  197. return function createSync(context, path, request, resolveContext) {
  198. if (typeof context === "string") {
  199. resolveContext = /** @type {ResolveContext} */ (request);
  200. request = path;
  201. path = context;
  202. context = getNodeContext();
  203. }
  204. return resolver.resolveSync(
  205. context,
  206. path,
  207. /** @type {string} */ (request),
  208. /** @type {ResolveContext} */ (resolveContext),
  209. );
  210. };
  211. }
  212. /**
  213. * @param {ResolveOptionsOptionalFS} options Resolver options
  214. * @returns {ResolveFunctionPromise} Resolver function
  215. */
  216. function createPromise(options) {
  217. const resolver = getResolverFactory().createResolver({
  218. fileSystem: getNodeFileSystem(),
  219. ...options,
  220. });
  221. /**
  222. * @param {object | string} context Custom context
  223. * @param {string} path Base path
  224. * @param {string | ResolveContext | undefined} request String to resolve
  225. * @param {ResolveContext=} resolveContext Resolve context
  226. * @returns {Promise<string | false>} resolved path
  227. */
  228. return function createPromise(context, path, request, resolveContext) {
  229. if (typeof context === "string") {
  230. resolveContext = /** @type {ResolveContext} */ (request);
  231. request = path;
  232. path = context;
  233. context = getNodeContext();
  234. }
  235. return resolver.resolvePromise(
  236. context,
  237. path,
  238. /** @type {string} */ (request),
  239. /** @type {ResolveContext} */ (resolveContext),
  240. );
  241. };
  242. }
  243. /**
  244. * @template A
  245. * @template B
  246. * @param {A} obj input a
  247. * @param {B} exports input b
  248. * @returns {A & B} merged
  249. */
  250. const mergeExports = (obj, exports) => {
  251. const descriptors = Object.getOwnPropertyDescriptors(exports);
  252. Object.defineProperties(obj, descriptors);
  253. return /** @type {A & B} */ (Object.freeze(obj));
  254. };
  255. module.exports = mergeExports(resolve, {
  256. get sync() {
  257. return resolveSync;
  258. },
  259. get promise() {
  260. return resolvePromise;
  261. },
  262. create: mergeExports(create, {
  263. get sync() {
  264. return createSync;
  265. },
  266. get promise() {
  267. return createPromise;
  268. },
  269. }),
  270. get ResolverFactory() {
  271. return getResolverFactory();
  272. },
  273. get CachedInputFileSystem() {
  274. return getCachedFileSystem();
  275. },
  276. get CloneBasenamePlugin() {
  277. return require("./CloneBasenamePlugin");
  278. },
  279. get LogInfoPlugin() {
  280. return require("./LogInfoPlugin");
  281. },
  282. get TsconfigPathsPlugin() {
  283. return require("./TsconfigPathsPlugin");
  284. },
  285. get forEachBail() {
  286. return require("./forEachBail");
  287. },
  288. });