node.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  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 (queries) {
  203. if (Array.isArray(queries)) {
  204. return queries
  205. } else if (typeof queries === 'object') {
  206. if (!queries.defaults) queries.defaults = []
  207. return pickEnv(queries, ctx, name)
  208. }
  209. }
  210. throw new BrowserslistError(
  211. '`' +
  212. name +
  213. '` config exports not an array of queries' +
  214. ' or an object of envs'
  215. )
  216. },
  217. loadStat: function loadStat(ctx, name, data) {
  218. if (!ctx.dangerousExtend && !process.env.BROWSERSLIST_DANGEROUS_EXTEND) {
  219. checkExtend(name)
  220. }
  221. var stats = require(require.resolve(
  222. path.join(name, 'browserslist-stats.json'),
  223. { paths: ['.'] }
  224. ))
  225. return normalizeStats(data, stats)
  226. },
  227. getStat: function getStat(opts, data) {
  228. var stats
  229. if (opts.stats) {
  230. stats = opts.stats
  231. } else if (process.env.BROWSERSLIST_STATS) {
  232. stats = process.env.BROWSERSLIST_STATS
  233. } else if (opts.path && path.resolve && fs.existsSync) {
  234. stats = eachParent(opts.path, function (dir) {
  235. var file = path.join(dir, 'browserslist-stats.json')
  236. return isFile(file) ? file : undefined
  237. }, statCache)
  238. }
  239. if (typeof stats === 'string') {
  240. try {
  241. stats = JSON.parse(fs.readFileSync(stats))
  242. } catch (e) {
  243. throw new BrowserslistError("Can't read " + stats)
  244. }
  245. }
  246. return normalizeStats(data, stats)
  247. },
  248. loadConfig: function loadConfig(opts) {
  249. if (process.env.BROWSERSLIST) {
  250. return process.env.BROWSERSLIST
  251. } else if (opts.config || process.env.BROWSERSLIST_CONFIG) {
  252. var file = opts.config || process.env.BROWSERSLIST_CONFIG
  253. return pickEnv(parsePackageOrReadConfig(file), opts)
  254. } else if (opts.path) {
  255. return pickEnv(module.exports.findConfig(opts.path), opts)
  256. } else {
  257. return undefined
  258. }
  259. },
  260. loadCountry: function loadCountry(usage, country, data) {
  261. var code = country.replace(/[^\w-]/g, '')
  262. if (!usage[code]) {
  263. var compressed
  264. try {
  265. compressed = require('caniuse-lite/data/regions/' + code + '.js')
  266. } catch (e) {
  267. throw new BrowserslistError('Unknown region name `' + code + '`.')
  268. }
  269. var usageData = region(compressed)
  270. normalizeUsageData(usageData, data)
  271. usage[country] = {}
  272. for (var i in usageData) {
  273. for (var j in usageData[i]) {
  274. usage[country][i + ' ' + j] = usageData[i][j]
  275. }
  276. }
  277. }
  278. },
  279. loadFeature: function loadFeature(features, name) {
  280. name = name.replace(/[^\w-]/g, '')
  281. if (features[name]) return
  282. var compressed
  283. try {
  284. compressed = require('caniuse-lite/data/features/' + name + '.js')
  285. } catch (e) {
  286. throw new BrowserslistError('Unknown feature name `' + name + '`.')
  287. }
  288. var stats = feature(compressed).stats
  289. features[name] = {}
  290. for (var i in stats) {
  291. features[name][i] = {}
  292. for (var j in stats[i]) {
  293. features[name][i][j] = stats[i][j]
  294. }
  295. }
  296. },
  297. parseConfig: function parseConfig(string) {
  298. var result = { defaults: [] }
  299. var sections = ['defaults']
  300. string
  301. .toString()
  302. .replace(/#[^\n]*/g, '')
  303. .split(/\n|,/)
  304. .map(function (line) {
  305. return line.trim()
  306. })
  307. .filter(function (line) {
  308. return line !== ''
  309. })
  310. .forEach(function (line) {
  311. if (IS_SECTION.test(line)) {
  312. sections = line.match(IS_SECTION)[1].trim().split(' ')
  313. sections.forEach(function (section) {
  314. if (result[section]) {
  315. throw new BrowserslistError(
  316. 'Duplicate section ' + section + ' in Browserslist config'
  317. )
  318. }
  319. result[section] = []
  320. })
  321. } else {
  322. sections.forEach(function (section) {
  323. result[section].push(line)
  324. })
  325. }
  326. })
  327. return result
  328. },
  329. readConfig: function readConfig(file) {
  330. if (!isFile(file)) {
  331. throw new BrowserslistError("Can't read " + file + ' config')
  332. }
  333. return module.exports.parseConfig(fs.readFileSync(file))
  334. },
  335. findConfigFile: function findConfigFile(from) {
  336. return eachParent(from, function (dir) {
  337. var config = path.join(dir, 'browserslist')
  338. var pkg = path.join(dir, 'package.json')
  339. var rc = path.join(dir, '.browserslistrc')
  340. var pkgBrowserslist
  341. if (isFile(pkg)) {
  342. try {
  343. pkgBrowserslist = parsePackage(pkg)
  344. } catch (e) {
  345. if (e.name === 'BrowserslistError') throw e
  346. console.warn(
  347. '[Browserslist] Could not parse ' + pkg + '. Ignoring it.'
  348. )
  349. }
  350. }
  351. if (isFile(config) && pkgBrowserslist) {
  352. throw new BrowserslistError(
  353. dir + ' contains both browserslist and package.json with browsers'
  354. )
  355. } else if (isFile(rc) && pkgBrowserslist) {
  356. throw new BrowserslistError(
  357. dir + ' contains both .browserslistrc and package.json with browsers'
  358. )
  359. } else if (isFile(config) && isFile(rc)) {
  360. throw new BrowserslistError(
  361. dir + ' contains both .browserslistrc and browserslist'
  362. )
  363. } else if (isFile(config)) {
  364. return config
  365. } else if (isFile(rc)) {
  366. return rc
  367. } else if (pkgBrowserslist) {
  368. return pkg
  369. }
  370. }, configPathCache)
  371. },
  372. findConfig: function findConfig(from) {
  373. var configFile = this.findConfigFile(from)
  374. return configFile ? parsePackageOrReadConfig(configFile) : undefined
  375. },
  376. clearCaches: function clearCaches() {
  377. dataTimeChecked = false
  378. statCache = {}
  379. configPathCache = {}
  380. parseConfigCache = {}
  381. this.cache = {}
  382. },
  383. oldDataWarning: function oldDataWarning(agentsObj) {
  384. if (dataTimeChecked) return
  385. dataTimeChecked = true
  386. if (process.env.BROWSERSLIST_IGNORE_OLD_DATA) return
  387. var latest = latestReleaseTime(agentsObj)
  388. var monthsPassed = getMonthsPassed(latest)
  389. if (latest !== 0 && monthsPassed >= 6) {
  390. var months = monthsPassed + ' ' + (monthsPassed > 1 ? 'months' : 'month')
  391. console.warn(
  392. 'Browserslist: browsers data (caniuse-lite) is ' +
  393. months +
  394. ' old. Please run:\n' +
  395. ' npx update-browserslist-db@latest\n' +
  396. ' Why you should do it regularly: ' +
  397. 'https://github.com/browserslist/update-db#readme'
  398. )
  399. }
  400. },
  401. currentNode: function currentNode() {
  402. return 'node ' + process.versions.node
  403. },
  404. env: process.env
  405. }