target.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  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. const getBrowserslistTargetHandler = memoize(() =>
  8. require("./browserslistTargetHandler")
  9. );
  10. /**
  11. * @param {string} context the context directory
  12. * @returns {string} default target
  13. */
  14. const getDefaultTarget = (context) => {
  15. const browsers = getBrowserslistTargetHandler().load(undefined, context);
  16. return browsers ? "browserslist" : "web";
  17. };
  18. /**
  19. * @typedef {object} PlatformTargetProperties
  20. * @property {boolean | null=} web web platform, importing of http(s) and std: is available
  21. * @property {boolean | null=} browser browser platform, running in a normal web browser
  22. * @property {boolean | null=} webworker (Web)Worker platform, running in a web/shared/service worker
  23. * @property {boolean | null=} node node platform, require of node built-in modules is available
  24. * @property {boolean | null=} nwjs nwjs platform, require of legacy nw.gui is available
  25. * @property {boolean | null=} electron electron platform, require of some electron built-in modules is available
  26. */
  27. /**
  28. * @typedef {object} ElectronContextTargetProperties
  29. * @property {boolean | null} electronMain in main context
  30. * @property {boolean | null} electronPreload in preload context
  31. * @property {boolean | null} electronRenderer in renderer context with node integration
  32. */
  33. /**
  34. * @typedef {object} ApiTargetProperties
  35. * @property {boolean | null} require has require function available
  36. * @property {boolean | null} nodeBuiltins has node.js built-in modules available
  37. * @property {boolean | null} nodePrefixForCoreModules node.js allows to use `node:` prefix for core modules
  38. * @property {boolean | null} importMetaDirnameAndFilename node.js allows to use `import.meta.dirname` and `import.meta.filename`
  39. * @property {boolean | null} document has document available (allows script tags)
  40. * @property {boolean | null} importScripts has importScripts available
  41. * @property {boolean | null} importScriptsInWorker has importScripts available when creating a worker
  42. * @property {boolean | null} fetchWasm has fetch function available for WebAssembly
  43. * @property {boolean | null} global has global variable available
  44. */
  45. /**
  46. * @typedef {object} EcmaTargetProperties
  47. * @property {boolean | null} globalThis has globalThis variable available
  48. * @property {boolean | null} bigIntLiteral big int literal syntax is available
  49. * @property {boolean | null} const const and let variable declarations are available
  50. * @property {boolean | null} methodShorthand object method shorthand is available
  51. * @property {boolean | null} arrowFunction arrow functions are available
  52. * @property {boolean | null} forOf for of iteration is available
  53. * @property {boolean | null} destructuring destructuring is available
  54. * @property {boolean | null} dynamicImport async import() is available
  55. * @property {boolean | null} dynamicImportInWorker async import() is available when creating a worker
  56. * @property {boolean | null} module ESM syntax is available (when in module)
  57. * @property {boolean | null} optionalChaining optional chaining is available
  58. * @property {boolean | null} templateLiteral template literal is available
  59. * @property {boolean | null} asyncFunction async functions and await are available
  60. */
  61. /**
  62. * @template T
  63. * @typedef {{ [P in keyof T]?: never }} Never<T>
  64. */
  65. /**
  66. * @template A
  67. * @template B
  68. * @typedef {(A & Never<B>) | (Never<A> & B) | (A & B)} Mix<A, B>
  69. */
  70. /** @typedef {Mix<Mix<PlatformTargetProperties, ElectronContextTargetProperties>, Mix<ApiTargetProperties, EcmaTargetProperties>>} TargetProperties */
  71. /**
  72. * @param {string} major major version
  73. * @param {string | undefined} minor minor version
  74. * @returns {(vMajor: number, vMinor?: number) => boolean | undefined} check if version is greater or equal
  75. */
  76. const versionDependent = (major, minor) => {
  77. if (!major) {
  78. return () => /** @type {undefined} */ (undefined);
  79. }
  80. /** @type {number} */
  81. const nMajor = Number(major);
  82. /** @type {number} */
  83. const nMinor = minor ? Number(minor) : 0;
  84. return (vMajor, vMinor = 0) =>
  85. nMajor > vMajor || (nMajor === vMajor && nMinor >= vMinor);
  86. };
  87. /** @type {[string, string, RegExp, (...args: string[]) => Partial<TargetProperties>][]} */
  88. const TARGETS = [
  89. [
  90. "browserslist / browserslist:env / browserslist:query / browserslist:path-to-config / browserslist:path-to-config:env",
  91. "Resolve features from browserslist. Will resolve browserslist config automatically. Only browser or node queries are supported (electron is not supported). Examples: 'browserslist:modern' to use 'modern' environment from browserslist config",
  92. /^browserslist(?::(.+))?$/,
  93. (rest, context) => {
  94. const browserslistTargetHandler = getBrowserslistTargetHandler();
  95. const browsers = browserslistTargetHandler.load(
  96. rest ? rest.trim() : null,
  97. context
  98. );
  99. if (!browsers) {
  100. throw new Error(`No browserslist config found to handle the 'browserslist' target.
  101. See https://github.com/browserslist/browserslist#queries for possible ways to provide a config.
  102. The recommended way is to add a 'browserslist' key to your package.json and list supported browsers (resp. node.js versions).
  103. You can also more options via the 'target' option: 'browserslist' / 'browserslist:env' / 'browserslist:query' / 'browserslist:path-to-config' / 'browserslist:path-to-config:env'`);
  104. }
  105. return browserslistTargetHandler.resolve(browsers);
  106. }
  107. ],
  108. [
  109. "web",
  110. "Web browser.",
  111. /^web$/,
  112. () => ({
  113. node: false,
  114. web: true,
  115. webworker: null,
  116. browser: true,
  117. electron: false,
  118. nwjs: false,
  119. document: true,
  120. importScriptsInWorker: true,
  121. fetchWasm: true,
  122. nodeBuiltins: false,
  123. importScripts: false,
  124. require: false,
  125. global: false
  126. })
  127. ],
  128. [
  129. "webworker",
  130. "Web Worker, SharedWorker or Service Worker.",
  131. /^webworker$/,
  132. () => ({
  133. node: false,
  134. web: true,
  135. webworker: true,
  136. browser: true,
  137. electron: false,
  138. nwjs: false,
  139. importScripts: true,
  140. importScriptsInWorker: true,
  141. fetchWasm: true,
  142. nodeBuiltins: false,
  143. require: false,
  144. document: false,
  145. global: false
  146. })
  147. ],
  148. [
  149. "[async-]node[X[.Y]]",
  150. "Node.js in version X.Y. The 'async-' prefix will load chunks asynchronously via 'fs' and 'vm' instead of 'require()'. Examples: node14.5, async-node10.",
  151. /^(async-)?node((\d+)(?:\.(\d+))?)?$/,
  152. (asyncFlag, _, major, minor) => {
  153. const v = versionDependent(major, minor);
  154. // see https://node.green/
  155. return {
  156. node: true,
  157. web: false,
  158. webworker: false,
  159. browser: false,
  160. electron: false,
  161. nwjs: false,
  162. require: !asyncFlag,
  163. nodeBuiltins: true,
  164. // v16.0.0, v14.18.0
  165. nodePrefixForCoreModules: Number(major) < 15 ? v(14, 18) : v(16),
  166. // Added in: v21.2.0, v20.11.0, but Node.js will output experimental warning, we don't want it
  167. // v24.0.0, v22.16.0 - This property is no longer experimental.
  168. importMetaDirnameAndFilename: v(22, 16),
  169. global: true,
  170. document: false,
  171. fetchWasm: false,
  172. importScripts: false,
  173. importScriptsInWorker: false,
  174. globalThis: v(12),
  175. const: v(6),
  176. templateLiteral: v(4),
  177. optionalChaining: v(14),
  178. methodShorthand: v(4),
  179. arrowFunction: v(6),
  180. asyncFunction: v(7, 6),
  181. forOf: v(5),
  182. destructuring: v(6),
  183. bigIntLiteral: v(10, 4),
  184. dynamicImport: v(12, 17),
  185. dynamicImportInWorker: v(12, 17),
  186. module: v(12, 17)
  187. };
  188. }
  189. ],
  190. [
  191. "electron[X[.Y]]-main/preload/renderer",
  192. "Electron in version X.Y. Script is running in main, preload resp. renderer context.",
  193. /^electron((\d+)(?:\.(\d+))?)?-(main|preload|renderer)$/,
  194. (_, major, minor, context) => {
  195. const v = versionDependent(major, minor);
  196. // see https://node.green/ + https://github.com/electron/releases
  197. return {
  198. node: true,
  199. web: context !== "main",
  200. webworker: false,
  201. browser: false,
  202. electron: true,
  203. nwjs: false,
  204. electronMain: context === "main",
  205. electronPreload: context === "preload",
  206. electronRenderer: context === "renderer",
  207. global: true,
  208. nodeBuiltins: true,
  209. // 15.0.0 - Node.js v16.5
  210. // 14.0.0 - Mode.js v14.17, but prefixes only since v14.18
  211. nodePrefixForCoreModules: v(15),
  212. // 37.0.0 - Node.js v22.16
  213. importMetaDirnameAndFilename: v(37),
  214. require: true,
  215. document: context === "renderer",
  216. fetchWasm: context === "renderer",
  217. importScripts: false,
  218. importScriptsInWorker: true,
  219. globalThis: v(5),
  220. const: v(1, 1),
  221. templateLiteral: v(1, 1),
  222. optionalChaining: v(8),
  223. methodShorthand: v(1, 1),
  224. arrowFunction: v(1, 1),
  225. asyncFunction: v(1, 7),
  226. forOf: v(0, 36),
  227. destructuring: v(1, 1),
  228. bigIntLiteral: v(4),
  229. dynamicImport: v(11),
  230. dynamicImportInWorker: v(11),
  231. module: v(11)
  232. };
  233. }
  234. ],
  235. [
  236. "nwjs[X[.Y]] / node-webkit[X[.Y]]",
  237. "NW.js in version X.Y.",
  238. /^(?:nwjs|node-webkit)((\d+)(?:\.(\d+))?)?$/,
  239. (_, major, minor) => {
  240. const v = versionDependent(major, minor);
  241. // see https://node.green/ + https://github.com/nwjs/nw.js/blob/nw48/CHANGELOG.md
  242. return {
  243. node: true,
  244. web: true,
  245. webworker: null,
  246. browser: false,
  247. electron: false,
  248. nwjs: true,
  249. global: true,
  250. nodeBuiltins: true,
  251. document: false,
  252. importScriptsInWorker: false,
  253. fetchWasm: false,
  254. importScripts: false,
  255. require: false,
  256. globalThis: v(0, 43),
  257. const: v(0, 15),
  258. templateLiteral: v(0, 13),
  259. optionalChaining: v(0, 44),
  260. methodShorthand: v(0, 15),
  261. arrowFunction: v(0, 15),
  262. asyncFunction: v(0, 21),
  263. forOf: v(0, 13),
  264. destructuring: v(0, 15),
  265. bigIntLiteral: v(0, 32),
  266. dynamicImport: v(0, 43),
  267. dynamicImportInWorker: v(0, 44),
  268. module: v(0, 43)
  269. };
  270. }
  271. ],
  272. [
  273. "esX",
  274. "EcmaScript in this version. Examples: es2020, es5.",
  275. /^es(\d+)$/,
  276. (version) => {
  277. let v = Number(version);
  278. if (v < 1000) v += 2009;
  279. return {
  280. const: v >= 2015,
  281. templateLiteral: v >= 2015,
  282. optionalChaining: v >= 2020,
  283. methodShorthand: v >= 2015,
  284. arrowFunction: v >= 2015,
  285. forOf: v >= 2015,
  286. destructuring: v >= 2015,
  287. module: v >= 2015,
  288. asyncFunction: v >= 2017,
  289. globalThis: v >= 2020,
  290. bigIntLiteral: v >= 2020,
  291. dynamicImport: v >= 2020,
  292. dynamicImportInWorker: v >= 2020
  293. };
  294. }
  295. ]
  296. ];
  297. /**
  298. * @param {string} target the target
  299. * @param {string} context the context directory
  300. * @returns {TargetProperties} target properties
  301. */
  302. const getTargetProperties = (target, context) => {
  303. for (const [, , regExp, handler] of TARGETS) {
  304. const match = regExp.exec(target);
  305. if (match) {
  306. const [, ...args] = match;
  307. const result = handler(...args, context);
  308. if (result) return /** @type {TargetProperties} */ (result);
  309. }
  310. }
  311. throw new Error(
  312. `Unknown target '${target}'. The following targets are supported:\n${TARGETS.map(
  313. ([name, description]) => `* ${name}: ${description}`
  314. ).join("\n")}`
  315. );
  316. };
  317. /**
  318. * @param {TargetProperties[]} targetProperties array of target properties
  319. * @returns {TargetProperties} merged target properties
  320. */
  321. const mergeTargetProperties = (targetProperties) => {
  322. /** @type {Set<keyof TargetProperties>} */
  323. const keys = new Set();
  324. for (const tp of targetProperties) {
  325. for (const key of Object.keys(tp)) {
  326. keys.add(/** @type {keyof TargetProperties} */ (key));
  327. }
  328. }
  329. /** @type {TargetProperties} */
  330. const result = {};
  331. for (const key of keys) {
  332. let hasTrue = false;
  333. let hasFalse = false;
  334. for (const tp of targetProperties) {
  335. const value = tp[key];
  336. switch (value) {
  337. case true:
  338. hasTrue = true;
  339. break;
  340. case false:
  341. hasFalse = true;
  342. break;
  343. }
  344. }
  345. if (hasTrue || hasFalse) {
  346. /** @type {TargetProperties} */
  347. (result)[key] = hasFalse && hasTrue ? null : Boolean(hasTrue);
  348. }
  349. }
  350. return result;
  351. };
  352. /**
  353. * @param {string[]} targets the targets
  354. * @param {string} context the context directory
  355. * @returns {TargetProperties} target properties
  356. */
  357. const getTargetsProperties = (targets, context) =>
  358. mergeTargetProperties(targets.map((t) => getTargetProperties(t, context)));
  359. module.exports.getDefaultTarget = getDefaultTarget;
  360. module.exports.getTargetProperties = getTargetProperties;
  361. module.exports.getTargetsProperties = getTargetsProperties;