node.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  1. var region = require('caniuse-lite/dist/unpacker/region').default
  2. var path = require('path')
  3. var fs = require('fs')
  4. var BrowserslistError = require('./error')
  5. var IS_SECTION = /^\s*\[(.+)]\s*$/
  6. var CONFIG_PATTERN = /^browserslist-config-/
  7. var SCOPED_CONFIG__PATTERN = /@[^/]+\/browserslist-config(-|$|\/)/
  8. var TIME_TO_UPDATE_CANIUSE = 6 * 30 * 24 * 60 * 60 * 1000
  9. var FORMAT = 'Browserslist config should be a string or an array ' +
  10. 'of strings with browser queries'
  11. var dataTimeChecked = false
  12. var filenessCache = { }
  13. var configCache = { }
  14. function checkExtend (name) {
  15. var use = ' Use `dangerousExtend` option to disable.'
  16. if (!CONFIG_PATTERN.test(name) && !SCOPED_CONFIG__PATTERN.test(name)) {
  17. throw new BrowserslistError(
  18. 'Browserslist config needs `browserslist-config-` prefix. ' + use)
  19. }
  20. if (name.replace(/^@[^/]+\//, '').indexOf('.') !== -1) {
  21. throw new BrowserslistError(
  22. '`.` not allowed in Browserslist config name. ' + use)
  23. }
  24. if (name.indexOf('node_modules') !== -1) {
  25. throw new BrowserslistError(
  26. '`node_modules` not allowed in Browserslist config.' + use)
  27. }
  28. }
  29. function isFile (file) {
  30. if (file in filenessCache) {
  31. return filenessCache[file]
  32. }
  33. var result = fs.existsSync(file) && fs.statSync(file).isFile()
  34. if (!process.env.BROWSERSLIST_DISABLE_CACHE) {
  35. filenessCache[file] = result
  36. }
  37. return result
  38. }
  39. function eachParent (file, callback) {
  40. var dir = isFile(file) ? path.dirname(file) : file
  41. var loc = path.resolve(dir)
  42. do {
  43. var result = callback(loc)
  44. if (typeof result !== 'undefined') return result
  45. } while (loc !== (loc = path.dirname(loc)))
  46. return undefined
  47. }
  48. function check (section) {
  49. if (Array.isArray(section)) {
  50. for (var i = 0; i < section.length; i++) {
  51. if (typeof section[i] !== 'string') {
  52. throw new BrowserslistError(FORMAT)
  53. }
  54. }
  55. } else if (typeof section !== 'string') {
  56. throw new BrowserslistError(FORMAT)
  57. }
  58. }
  59. function pickEnv (config, opts) {
  60. if (typeof config !== 'object') return config
  61. var name
  62. if (typeof opts.env === 'string') {
  63. name = opts.env
  64. } else if (process.env.BROWSERSLIST_ENV) {
  65. name = process.env.BROWSERSLIST_ENV
  66. } else if (process.env.NODE_ENV) {
  67. name = process.env.NODE_ENV
  68. } else {
  69. name = 'production'
  70. }
  71. return config[name] || config.defaults
  72. }
  73. function parsePackage (file) {
  74. var config = JSON.parse(fs.readFileSync(file))
  75. if (config.browserlist && !config.browserslist) {
  76. throw new BrowserslistError(
  77. '`browserlist` key instead of `browserslist` in ' + file
  78. )
  79. }
  80. var list = config.browserslist
  81. if (Array.isArray(list) || typeof list === 'string') {
  82. list = { defaults: list }
  83. }
  84. for (var i in list) {
  85. check(list[i])
  86. }
  87. return list
  88. }
  89. function latestReleaseTime (agents) {
  90. var latest = 0
  91. for (var name in agents) {
  92. var dates = agents[name].releaseDate || { }
  93. for (var key in dates) {
  94. if (latest < dates[key]) {
  95. latest = dates[key]
  96. }
  97. }
  98. }
  99. return latest * 1000
  100. }
  101. function normalizeStats (data, stats) {
  102. if (stats && 'dataByBrowser' in stats) {
  103. stats = stats.dataByBrowser
  104. }
  105. if (typeof stats !== 'object') return undefined
  106. var normalized = { }
  107. for (var i in stats) {
  108. var versions = Object.keys(stats[i])
  109. if (
  110. versions.length === 1 &&
  111. data[i] &&
  112. data[i].versions.length === 1
  113. ) {
  114. var normal = Object.keys(data[i].versions)[0]
  115. normalized[i] = { }
  116. normalized[i][normal] = stats[i][versions[0]]
  117. } else {
  118. normalized[i] = stats[i]
  119. }
  120. }
  121. return normalized
  122. }
  123. function normalizeUsageData (usageData, data) {
  124. for (var browser in usageData) {
  125. var browserUsage = usageData[browser]
  126. // eslint-disable-next-line max-len
  127. // https://github.com/browserslist/browserslist/issues/431#issuecomment-565230615
  128. // caniuse-db returns { 0: "percentage" } for `and_*` regional stats
  129. if ('0' in browserUsage) {
  130. var versions = data[browser].versions
  131. browserUsage[versions[versions.length - 1]] = browserUsage[0]
  132. delete browserUsage[0]
  133. }
  134. }
  135. }
  136. module.exports = {
  137. loadQueries: function loadQueries (context, name) {
  138. if (!context.dangerousExtend) checkExtend(name)
  139. // eslint-disable-next-line security/detect-non-literal-require
  140. var queries = require(require.resolve(name, { paths: ['.'] }))
  141. if (queries) {
  142. if (Array.isArray(queries)) {
  143. return queries
  144. } else if (typeof queries === 'object') {
  145. if (!queries.defaults) queries.defaults = []
  146. return pickEnv(queries, context, name)
  147. }
  148. }
  149. throw new BrowserslistError(
  150. '`' + name + '` config exports not an array of queries' +
  151. ' or an object of envs'
  152. )
  153. },
  154. loadStat: function loadStat (context, name, data) {
  155. if (!context.dangerousExtend) checkExtend(name)
  156. // eslint-disable-next-line security/detect-non-literal-require
  157. var stats = require(
  158. require.resolve(
  159. path.join(name, 'browserslist-stats.json'),
  160. { paths: ['.'] }
  161. )
  162. )
  163. return normalizeStats(data, stats)
  164. },
  165. getStat: function getStat (opts, data) {
  166. var stats
  167. if (opts.stats) {
  168. stats = opts.stats
  169. } else if (process.env.BROWSERSLIST_STATS) {
  170. stats = process.env.BROWSERSLIST_STATS
  171. } else if (opts.path && path.resolve && fs.existsSync) {
  172. stats = eachParent(opts.path, function (dir) {
  173. var file = path.join(dir, 'browserslist-stats.json')
  174. return isFile(file) ? file : undefined
  175. })
  176. }
  177. if (typeof stats === 'string') {
  178. try {
  179. stats = JSON.parse(fs.readFileSync(stats))
  180. } catch (e) {
  181. throw new BrowserslistError('Can\'t read ' + stats)
  182. }
  183. }
  184. return normalizeStats(data, stats)
  185. },
  186. loadConfig: function loadConfig (opts) {
  187. if (process.env.BROWSERSLIST) {
  188. return process.env.BROWSERSLIST
  189. } else if (opts.config || process.env.BROWSERSLIST_CONFIG) {
  190. var file = opts.config || process.env.BROWSERSLIST_CONFIG
  191. if (path.basename(file) === 'package.json') {
  192. return pickEnv(parsePackage(file), opts)
  193. } else {
  194. return pickEnv(module.exports.readConfig(file), opts)
  195. }
  196. } else if (opts.path) {
  197. return pickEnv(module.exports.findConfig(opts.path), opts)
  198. } else {
  199. return undefined
  200. }
  201. },
  202. loadCountry: function loadCountry (usage, country, data) {
  203. var code = country.replace(/[^\w-]/g, '')
  204. if (!usage[code]) {
  205. // eslint-disable-next-line security/detect-non-literal-require
  206. var compressed = require('caniuse-lite/data/regions/' + code + '.js')
  207. var usageData = region(compressed)
  208. normalizeUsageData(usageData, data)
  209. usage[country] = { }
  210. for (var i in usageData) {
  211. for (var j in usageData[i]) {
  212. usage[country][i + ' ' + j] = usageData[i][j]
  213. }
  214. }
  215. }
  216. },
  217. parseConfig: function parseConfig (string) {
  218. var result = { defaults: [] }
  219. var sections = ['defaults']
  220. string.toString()
  221. .replace(/#[^\n]*/g, '')
  222. .split(/\n|,/)
  223. .map(function (line) {
  224. return line.trim()
  225. })
  226. .filter(function (line) {
  227. return line !== ''
  228. })
  229. .forEach(function (line) {
  230. if (IS_SECTION.test(line)) {
  231. sections = line.match(IS_SECTION)[1].trim().split(' ')
  232. sections.forEach(function (section) {
  233. if (result[section]) {
  234. throw new BrowserslistError(
  235. 'Duplicate section ' + section + ' in Browserslist config'
  236. )
  237. }
  238. result[section] = []
  239. })
  240. } else {
  241. sections.forEach(function (section) {
  242. result[section].push(line)
  243. })
  244. }
  245. })
  246. return result
  247. },
  248. readConfig: function readConfig (file) {
  249. if (!isFile(file)) {
  250. throw new BrowserslistError('Can\'t read ' + file + ' config')
  251. }
  252. return module.exports.parseConfig(fs.readFileSync(file))
  253. },
  254. findConfig: function findConfig (from) {
  255. from = path.resolve(from)
  256. var passed = []
  257. var resolved = eachParent(from, function (dir) {
  258. if (dir in configCache) {
  259. return configCache[dir]
  260. }
  261. passed.push(dir)
  262. var config = path.join(dir, 'browserslist')
  263. var pkg = path.join(dir, 'package.json')
  264. var rc = path.join(dir, '.browserslistrc')
  265. var pkgBrowserslist
  266. if (isFile(pkg)) {
  267. try {
  268. pkgBrowserslist = parsePackage(pkg)
  269. } catch (e) {
  270. if (e.name === 'BrowserslistError') throw e
  271. console.warn(
  272. '[Browserslist] Could not parse ' + pkg + '. Ignoring it.'
  273. )
  274. }
  275. }
  276. if (isFile(config) && pkgBrowserslist) {
  277. throw new BrowserslistError(
  278. dir + ' contains both browserslist and package.json with browsers'
  279. )
  280. } else if (isFile(rc) && pkgBrowserslist) {
  281. throw new BrowserslistError(
  282. dir + ' contains both .browserslistrc and package.json with browsers'
  283. )
  284. } else if (isFile(config) && isFile(rc)) {
  285. throw new BrowserslistError(
  286. dir + ' contains both .browserslistrc and browserslist'
  287. )
  288. } else if (isFile(config)) {
  289. return module.exports.readConfig(config)
  290. } else if (isFile(rc)) {
  291. return module.exports.readConfig(rc)
  292. } else {
  293. return pkgBrowserslist
  294. }
  295. })
  296. if (!process.env.BROWSERSLIST_DISABLE_CACHE) {
  297. passed.forEach(function (dir) {
  298. configCache[dir] = resolved
  299. })
  300. }
  301. return resolved
  302. },
  303. clearCaches: function clearCaches () {
  304. dataTimeChecked = false
  305. filenessCache = { }
  306. configCache = { }
  307. },
  308. oldDataWarning: function oldDataWarning (agentsObj) {
  309. if (dataTimeChecked) return
  310. dataTimeChecked = true
  311. if (process.env.BROWSERSLIST_IGNORE_OLD_DATA) return
  312. var latest = latestReleaseTime(agentsObj)
  313. var halfYearAgo = Date.now() - TIME_TO_UPDATE_CANIUSE
  314. if (latest !== 0 && latest < halfYearAgo) {
  315. console.warn(
  316. 'Browserslist: caniuse-lite is outdated. Please run:\n' +
  317. 'npx browserslist@latest --update-db'
  318. )
  319. }
  320. },
  321. currentNode: function currentNode () {
  322. return 'node ' + process.versions.node
  323. }
  324. }