node.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469
  1. var feature = require('caniuse-lite/dist/unpacker/feature').default
  2. var region = require('caniuse-lite/dist/unpacker/region').default
  3. var fs = require('fs')
  4. var path = require('path')
  5. var BrowserslistError = require('./error')
  6. var IS_SECTION = /^\s*\[(.+)]\s*$/
  7. var CONFIG_PATTERN = /^browserslist-config-/
  8. var SCOPED_CONFIG__PATTERN = /@[^/]+(?:\/[^/]+)?\/browserslist-config(?:-|$|\/)/
  9. var FORMAT =
  10. 'Browserslist config should be a string or an array ' +
  11. 'of strings with browser queries'
  12. var dataTimeChecked = false
  13. var statCache = {}
  14. var configPathCache = {}
  15. var parseConfigCache = {}
  16. function checkExtend(name) {
  17. var use = ' Use `dangerousExtend` option to disable.'
  18. if (!CONFIG_PATTERN.test(name) && !SCOPED_CONFIG__PATTERN.test(name)) {
  19. throw new BrowserslistError(
  20. 'Browserslist config needs `browserslist-config-` prefix. ' + use
  21. )
  22. }
  23. if (name.replace(/^@[^/]+\//, '').indexOf('.') !== -1) {
  24. throw new BrowserslistError(
  25. '`.` not allowed in Browserslist config name. ' + use
  26. )
  27. }
  28. if (name.indexOf('node_modules') !== -1) {
  29. throw new BrowserslistError(
  30. '`node_modules` not allowed in Browserslist config.' + use
  31. )
  32. }
  33. }
  34. function isFile(file) {
  35. return fs.existsSync(file) && fs.statSync(file).isFile()
  36. }
  37. function isDirectory(dir) {
  38. return fs.existsSync(dir) && fs.statSync(dir).isDirectory()
  39. }
  40. function eachParent(file, callback, cache) {
  41. var loc = path.resolve(file)
  42. var pathsForCacheResult = []
  43. var result
  44. do {
  45. if (!pathInRoot(loc)) {
  46. break
  47. }
  48. if (cache && loc in cache) {
  49. result = cache[loc]
  50. break
  51. }
  52. pathsForCacheResult.push(loc)
  53. if (!isDirectory(loc)) {
  54. continue
  55. }
  56. var locResult = callback(loc)
  57. if (typeof locResult !== 'undefined') {
  58. result = locResult
  59. break
  60. }
  61. } while (loc !== (loc = path.dirname(loc)))
  62. if (cache && !process.env.BROWSERSLIST_DISABLE_CACHE) {
  63. pathsForCacheResult.forEach(function (cachePath) {
  64. cache[cachePath] = result
  65. })
  66. }
  67. return result
  68. }
  69. function pathInRoot(p) {
  70. if (!process.env.BROWSERSLIST_ROOT_PATH) return true
  71. var rootPath = path.resolve(process.env.BROWSERSLIST_ROOT_PATH)
  72. if (path.relative(rootPath, p).substring(0, 2) === '..') {
  73. return false
  74. }
  75. return true
  76. }
  77. function check(section) {
  78. if (Array.isArray(section)) {
  79. for (var i = 0; i < section.length; i++) {
  80. if (typeof section[i] !== 'string') {
  81. throw new BrowserslistError(FORMAT)
  82. }
  83. }
  84. } else if (typeof section !== 'string') {
  85. throw new BrowserslistError(FORMAT)
  86. }
  87. }
  88. function pickEnv(config, opts) {
  89. if (typeof config !== 'object') return config
  90. var name
  91. if (typeof opts.env === 'string') {
  92. name = opts.env
  93. } else if (process.env.BROWSERSLIST_ENV) {
  94. name = process.env.BROWSERSLIST_ENV
  95. } else if (process.env.NODE_ENV) {
  96. name = process.env.NODE_ENV
  97. } else {
  98. name = 'production'
  99. }
  100. if (opts.throwOnMissing) {
  101. if (name && name !== 'defaults' && !config[name]) {
  102. throw new BrowserslistError(
  103. 'Missing config for Browserslist environment `' + name + '`'
  104. )
  105. }
  106. }
  107. return config[name] || config.defaults
  108. }
  109. function parsePackage(file) {
  110. var text = fs
  111. .readFileSync(file)
  112. .toString()
  113. .replace(/^\uFEFF/m, '')
  114. var list
  115. if (text.indexOf('"browserslist"') >= 0) {
  116. list = JSON.parse(text).browserslist
  117. } else if (text.indexOf('"browserlist"') >= 0) {
  118. var config = JSON.parse(text)
  119. if (config.browserlist && !config.browserslist) {
  120. throw new BrowserslistError(
  121. '`browserlist` key instead of `browserslist` in ' + file
  122. )
  123. }
  124. }
  125. if (Array.isArray(list) || typeof list === 'string') {
  126. list = { defaults: list }
  127. }
  128. for (var i in list) {
  129. check(list[i])
  130. }
  131. return list
  132. }
  133. function parsePackageOrReadConfig(file) {
  134. if (file in parseConfigCache) {
  135. return parseConfigCache[file]
  136. }
  137. var isPackage = path.basename(file) === 'package.json'
  138. var result = isPackage ? parsePackage(file) : module.exports.readConfig(file)
  139. if (!process.env.BROWSERSLIST_DISABLE_CACHE) {
  140. parseConfigCache[file] = result
  141. }
  142. return result
  143. }
  144. function latestReleaseTime(agents) {
  145. var latest = 0
  146. for (var name in agents) {
  147. var dates = agents[name].releaseDate || {}
  148. for (var key in dates) {
  149. if (latest < dates[key]) {
  150. latest = dates[key]
  151. }
  152. }
  153. }
  154. return latest * 1000
  155. }
  156. function getMonthsPassed(date) {
  157. var now = new Date()
  158. var past = new Date(date)
  159. var years = now.getFullYear() - past.getFullYear()
  160. var months = now.getMonth() - past.getMonth()
  161. return years * 12 + months
  162. }
  163. function normalizeStats(data, stats) {
  164. if (!data) {
  165. data = {}
  166. }
  167. if (stats && 'dataByBrowser' in stats) {
  168. stats = stats.dataByBrowser
  169. }
  170. if (typeof stats !== 'object') return undefined
  171. var normalized = {}
  172. for (var i in stats) {
  173. var versions = Object.keys(stats[i])
  174. if (versions.length === 1 && data[i] && data[i].versions.length === 1) {
  175. var normal = data[i].versions[0]
  176. normalized[i] = {}
  177. normalized[i][normal] = stats[i][versions[0]]
  178. } else {
  179. normalized[i] = stats[i]
  180. }
  181. }
  182. return normalized
  183. }
  184. function normalizeUsageData(usageData, data) {
  185. for (var browser in usageData) {
  186. var browserUsage = usageData[browser]
  187. // https://github.com/browserslist/browserslist/issues/431#issuecomment-565230615
  188. // caniuse-db returns { 0: "percentage" } for `and_*` regional stats
  189. if ('0' in browserUsage) {
  190. var versions = data[browser].versions
  191. browserUsage[versions[versions.length - 1]] = browserUsage[0]
  192. delete browserUsage[0]
  193. }
  194. }
  195. }
  196. module.exports = {
  197. loadQueries: function loadQueries(ctx, name) {
  198. if (!ctx.dangerousExtend && !process.env.BROWSERSLIST_DANGEROUS_EXTEND) {
  199. checkExtend(name)
  200. }
  201. var queries = require(require.resolve(name, { paths: ['.', ctx.path] }))
  202. if (typeof queries === 'object' && queries !== null && queries.__esModule) {
  203. queries = queries.default
  204. }
  205. if (queries) {
  206. if (Array.isArray(queries)) {
  207. return queries
  208. } else if (typeof queries === 'object') {
  209. if (!queries.defaults) queries.defaults = []
  210. return pickEnv(queries, ctx, name)
  211. }
  212. }
  213. throw new BrowserslistError(
  214. '`' +
  215. name +
  216. '` config exports not an array of queries' +
  217. ' or an object of envs'
  218. )
  219. },
  220. loadStat: function loadStat(ctx, name, data) {
  221. if (!ctx.dangerousExtend && !process.env.BROWSERSLIST_DANGEROUS_EXTEND) {
  222. checkExtend(name)
  223. }
  224. var stats = require(require.resolve(
  225. path.join(name, 'browserslist-stats.json'),
  226. { paths: ['.'] }
  227. ))
  228. return normalizeStats(data, stats)
  229. },
  230. getStat: function getStat(opts, data) {
  231. var stats
  232. if (opts.stats) {
  233. stats = opts.stats
  234. } else if (process.env.BROWSERSLIST_STATS) {
  235. stats = process.env.BROWSERSLIST_STATS
  236. } else if (opts.path && path.resolve && fs.existsSync) {
  237. stats = eachParent(
  238. opts.path,
  239. function (dir) {
  240. var file = path.join(dir, 'browserslist-stats.json')
  241. return isFile(file) ? file : undefined
  242. },
  243. statCache
  244. )
  245. }
  246. if (typeof stats === 'string') {
  247. try {
  248. stats = JSON.parse(fs.readFileSync(stats))
  249. } catch (e) {
  250. throw new BrowserslistError("Can't read " + stats)
  251. }
  252. }
  253. return normalizeStats(data, stats)
  254. },
  255. loadConfig: function loadConfig(opts) {
  256. if (process.env.BROWSERSLIST) {
  257. return process.env.BROWSERSLIST
  258. } else if (opts.config || process.env.BROWSERSLIST_CONFIG) {
  259. var file = opts.config || process.env.BROWSERSLIST_CONFIG
  260. return pickEnv(parsePackageOrReadConfig(file), opts)
  261. } else if (opts.path) {
  262. return pickEnv(module.exports.findConfig(opts.path), opts)
  263. } else {
  264. return undefined
  265. }
  266. },
  267. loadCountry: function loadCountry(usage, country, data) {
  268. var code = country.replace(/[^\w-]/g, '')
  269. if (!usage[code]) {
  270. var compressed
  271. try {
  272. compressed = require('caniuse-lite/data/regions/' + code + '.js')
  273. } catch (e) {
  274. throw new BrowserslistError('Unknown region name `' + code + '`.')
  275. }
  276. var usageData = region(compressed)
  277. normalizeUsageData(usageData, data)
  278. usage[country] = {}
  279. for (var i in usageData) {
  280. for (var j in usageData[i]) {
  281. usage[country][i + ' ' + j] = usageData[i][j]
  282. }
  283. }
  284. }
  285. },
  286. loadFeature: function loadFeature(features, name) {
  287. name = name.replace(/[^\w-]/g, '')
  288. if (features[name]) return
  289. var compressed
  290. try {
  291. compressed = require('caniuse-lite/data/features/' + name + '.js')
  292. } catch (e) {
  293. throw new BrowserslistError('Unknown feature name `' + name + '`.')
  294. }
  295. var stats = feature(compressed).stats
  296. features[name] = {}
  297. for (var i in stats) {
  298. features[name][i] = {}
  299. for (var j in stats[i]) {
  300. features[name][i][j] = stats[i][j]
  301. }
  302. }
  303. },
  304. parseConfig: function parseConfig(string) {
  305. var result = { defaults: [] }
  306. var sections = ['defaults']
  307. string
  308. .toString()
  309. .replace(/#[^\n]*/g, '')
  310. .split(/\n|,/)
  311. .map(function (line) {
  312. return line.trim()
  313. })
  314. .filter(function (line) {
  315. return line !== ''
  316. })
  317. .forEach(function (line) {
  318. if (IS_SECTION.test(line)) {
  319. sections = line.match(IS_SECTION)[1].trim().split(' ')
  320. sections.forEach(function (section) {
  321. if (result[section]) {
  322. throw new BrowserslistError(
  323. 'Duplicate section ' + section + ' in Browserslist config'
  324. )
  325. }
  326. result[section] = []
  327. })
  328. } else {
  329. sections.forEach(function (section) {
  330. result[section].push(line)
  331. })
  332. }
  333. })
  334. return result
  335. },
  336. readConfig: function readConfig(file) {
  337. if (!isFile(file)) {
  338. throw new BrowserslistError("Can't read " + file + ' config')
  339. }
  340. return module.exports.parseConfig(fs.readFileSync(file))
  341. },
  342. findConfigFile: function findConfigFile(from) {
  343. return eachParent(
  344. from,
  345. function (dir) {
  346. var config = path.join(dir, 'browserslist')
  347. var pkg = path.join(dir, 'package.json')
  348. var rc = path.join(dir, '.browserslistrc')
  349. var pkgBrowserslist
  350. if (isFile(pkg)) {
  351. try {
  352. pkgBrowserslist = parsePackage(pkg)
  353. } catch (e) {
  354. if (e.name === 'BrowserslistError') throw e
  355. console.warn(
  356. '[Browserslist] Could not parse ' + pkg + '. Ignoring it.'
  357. )
  358. }
  359. }
  360. if (isFile(config) && pkgBrowserslist) {
  361. throw new BrowserslistError(
  362. dir + ' contains both browserslist and package.json with browsers'
  363. )
  364. } else if (isFile(rc) && pkgBrowserslist) {
  365. throw new BrowserslistError(
  366. dir +
  367. ' contains both .browserslistrc and package.json with browsers'
  368. )
  369. } else if (isFile(config) && isFile(rc)) {
  370. throw new BrowserslistError(
  371. dir + ' contains both .browserslistrc and browserslist'
  372. )
  373. } else if (isFile(config)) {
  374. return config
  375. } else if (isFile(rc)) {
  376. return rc
  377. } else if (pkgBrowserslist) {
  378. return pkg
  379. }
  380. },
  381. configPathCache
  382. )
  383. },
  384. findConfig: function findConfig(from) {
  385. var configFile = this.findConfigFile(from)
  386. return configFile ? parsePackageOrReadConfig(configFile) : undefined
  387. },
  388. clearCaches: function clearCaches() {
  389. dataTimeChecked = false
  390. statCache = {}
  391. configPathCache = {}
  392. parseConfigCache = {}
  393. this.cache = {}
  394. },
  395. oldDataWarning: function oldDataWarning(agentsObj) {
  396. if (dataTimeChecked) return
  397. dataTimeChecked = true
  398. if (process.env.BROWSERSLIST_IGNORE_OLD_DATA) return
  399. var latest = latestReleaseTime(agentsObj)
  400. var monthsPassed = getMonthsPassed(latest)
  401. if (latest !== 0 && monthsPassed >= 6) {
  402. var months = monthsPassed + ' ' + (monthsPassed > 1 ? 'months' : 'month')
  403. console.warn(
  404. 'Browserslist: browsers data (caniuse-lite) is ' +
  405. months +
  406. ' old. Please run:\n' +
  407. ' npx update-browserslist-db@latest\n' +
  408. ' Why you should do it regularly: ' +
  409. 'https://github.com/browserslist/update-db#readme'
  410. )
  411. }
  412. },
  413. currentNode: function currentNode() {
  414. return 'node ' + process.versions.node
  415. },
  416. env: process.env
  417. }