node.js 13 KB

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