target.js 11 KB

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