node.js 13 KB

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