index.js 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
  1. /*
  2. MIT License http://www.opensource.org/licenses/mit-license.php
  3. Author Tobias Koppers @sokra
  4. */
  5. "use strict";
  6. const fs = require("graceful-fs");
  7. const CachedInputFileSystem = require("./CachedInputFileSystem");
  8. const ResolverFactory = require("./ResolverFactory");
  9. /** @typedef {import("./CachedInputFileSystem").BaseFileSystem} BaseFileSystem */
  10. /** @typedef {import("./PnpPlugin").PnpApiImpl} PnpApi */
  11. /** @typedef {import("./Resolver")} Resolver */
  12. /** @typedef {import("./Resolver").FileSystem} FileSystem */
  13. /** @typedef {import("./Resolver").ResolveCallback} ResolveCallback */
  14. /** @typedef {import("./Resolver").ResolveContext} ResolveContext */
  15. /** @typedef {import("./Resolver").ResolveRequest} ResolveRequest */
  16. /** @typedef {import("./Resolver").SyncFileSystem} SyncFileSystem */
  17. /** @typedef {import("./ResolverFactory").Plugin} Plugin */
  18. /** @typedef {import("./ResolverFactory").UserResolveOptions} ResolveOptions */
  19. /**
  20. * @typedef {{
  21. * (context: object, path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void;
  22. * (context: object, path: string, request: string, callback: ResolveCallback): void;
  23. * (path: string, request: string, resolveContext: ResolveContext, callback: ResolveCallback): void;
  24. * (path: string, request: string, callback: ResolveCallback): void;
  25. * }} ResolveFunctionAsync
  26. */
  27. /**
  28. * @typedef {{
  29. * (context: object, path: string, request: string): string | false;
  30. * (path: string, request: string): string | false;
  31. * }} ResolveFunction
  32. */
  33. const nodeFileSystem = new CachedInputFileSystem(fs, 4000);
  34. const nodeContext = {
  35. environments: ["node+es3+es5+process+native"],
  36. };
  37. const asyncResolver = ResolverFactory.createResolver({
  38. conditionNames: ["node"],
  39. extensions: [".js", ".json", ".node"],
  40. fileSystem: nodeFileSystem,
  41. });
  42. /**
  43. * @type {ResolveFunctionAsync}
  44. */
  45. const resolve =
  46. /**
  47. * @param {object | string} context context
  48. * @param {string} path path
  49. * @param {string | ResolveContext | ResolveCallback} request request
  50. * @param {ResolveContext | ResolveCallback=} resolveContext resolve context
  51. * @param {ResolveCallback=} callback callback
  52. */
  53. (context, path, request, resolveContext, callback) => {
  54. if (typeof context === "string") {
  55. callback = /** @type {ResolveCallback} */ (resolveContext);
  56. resolveContext = /** @type {ResolveContext} */ (request);
  57. request = path;
  58. path = context;
  59. context = nodeContext;
  60. }
  61. if (typeof callback !== "function") {
  62. callback = /** @type {ResolveCallback} */ (resolveContext);
  63. }
  64. asyncResolver.resolve(
  65. context,
  66. path,
  67. /** @type {string} */ (request),
  68. /** @type {ResolveContext} */ (resolveContext),
  69. /** @type {ResolveCallback} */ (callback),
  70. );
  71. };
  72. const syncResolver = ResolverFactory.createResolver({
  73. conditionNames: ["node"],
  74. extensions: [".js", ".json", ".node"],
  75. useSyncFileSystemCalls: true,
  76. fileSystem: nodeFileSystem,
  77. });
  78. /**
  79. * @type {ResolveFunction}
  80. */
  81. const resolveSync =
  82. /**
  83. * @param {object|string} context context
  84. * @param {string} path path
  85. * @param {string=} request request
  86. * @returns {string | false} result
  87. */
  88. (context, path, request) => {
  89. if (typeof context === "string") {
  90. request = path;
  91. path = context;
  92. context = nodeContext;
  93. }
  94. return syncResolver.resolveSync(
  95. context,
  96. path,
  97. /** @type {string} */ (request),
  98. );
  99. };
  100. /** @typedef {Omit<ResolveOptions, "fileSystem"> & Partial<Pick<ResolveOptions, "fileSystem">>} ResolveOptionsOptionalFS */
  101. /**
  102. * @param {ResolveOptionsOptionalFS} options Resolver options
  103. * @returns {ResolveFunctionAsync} Resolver function
  104. */
  105. function create(options) {
  106. const resolver = ResolverFactory.createResolver({
  107. fileSystem: nodeFileSystem,
  108. ...options,
  109. });
  110. /**
  111. * @param {object|string} context Custom context
  112. * @param {string} path Base path
  113. * @param {string|ResolveContext|ResolveCallback} request String to resolve
  114. * @param {ResolveContext|ResolveCallback=} resolveContext Resolve context
  115. * @param {ResolveCallback=} callback Result callback
  116. */
  117. return function create(context, path, request, resolveContext, callback) {
  118. if (typeof context === "string") {
  119. callback = /** @type {ResolveCallback} */ (resolveContext);
  120. resolveContext = /** @type {ResolveContext} */ (request);
  121. request = path;
  122. path = context;
  123. context = nodeContext;
  124. }
  125. if (typeof callback !== "function") {
  126. callback = /** @type {ResolveCallback} */ (resolveContext);
  127. }
  128. resolver.resolve(
  129. context,
  130. path,
  131. /** @type {string} */ (request),
  132. /** @type {ResolveContext} */ (resolveContext),
  133. callback,
  134. );
  135. };
  136. }
  137. /**
  138. * @param {ResolveOptionsOptionalFS} options Resolver options
  139. * @returns {ResolveFunction} Resolver function
  140. */
  141. function createSync(options) {
  142. const resolver = ResolverFactory.createResolver({
  143. useSyncFileSystemCalls: true,
  144. fileSystem: nodeFileSystem,
  145. ...options,
  146. });
  147. /**
  148. * @param {object | string} context custom context
  149. * @param {string} path base path
  150. * @param {string=} request request to resolve
  151. * @returns {string | false} Resolved path or false
  152. */
  153. return function createSync(context, path, request) {
  154. if (typeof context === "string") {
  155. request = path;
  156. path = context;
  157. context = nodeContext;
  158. }
  159. return resolver.resolveSync(context, path, /** @type {string} */ (request));
  160. };
  161. }
  162. /**
  163. * @template A
  164. * @template B
  165. * @param {A} obj input a
  166. * @param {B} exports input b
  167. * @returns {A & B} merged
  168. */
  169. const mergeExports = (obj, exports) => {
  170. const descriptors = Object.getOwnPropertyDescriptors(exports);
  171. Object.defineProperties(obj, descriptors);
  172. return /** @type {A & B} */ (Object.freeze(obj));
  173. };
  174. module.exports = mergeExports(resolve, {
  175. get sync() {
  176. return resolveSync;
  177. },
  178. create: mergeExports(create, {
  179. get sync() {
  180. return createSync;
  181. },
  182. }),
  183. ResolverFactory,
  184. CachedInputFileSystem,
  185. get CloneBasenamePlugin() {
  186. return require("./CloneBasenamePlugin");
  187. },
  188. get LogInfoPlugin() {
  189. return require("./LogInfoPlugin");
  190. },
  191. get forEachBail() {
  192. return require("./forEachBail");
  193. },
  194. });