index.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. let { execSync } = require('child_process')
  2. let escalade = require('escalade/sync')
  3. let { existsSync, readFileSync, writeFileSync } = require('fs')
  4. let { dirname, join } = require('path')
  5. let pico = require('picocolors')
  6. let { detectEOL, detectIndent } = require('./utils')
  7. function BrowserslistUpdateError(message) {
  8. this.name = 'BrowserslistUpdateError'
  9. this.message = message
  10. this.browserslist = true
  11. if (Error.captureStackTrace) {
  12. Error.captureStackTrace(this, BrowserslistUpdateError)
  13. }
  14. }
  15. BrowserslistUpdateError.prototype = Error.prototype
  16. // Check if HADOOP_HOME is set to determine if this is running in a Hadoop environment
  17. const YARN_CMD = process.env.HADOOP_HOME ? 'yarnpkg' : 'yarn'
  18. /* c8 ignore next 3 */
  19. function defaultPrint(str) {
  20. process.stdout.write(str)
  21. }
  22. function detectLockfile() {
  23. let packageDir = escalade('.', (dir, names) => {
  24. return names.indexOf('package.json') !== -1 ? dir : ''
  25. })
  26. if (!packageDir) {
  27. throw new BrowserslistUpdateError(
  28. 'Cannot find package.json. ' +
  29. 'Is this the right directory to run `npx update-browserslist-db` in?'
  30. )
  31. }
  32. let lockfileNpm = join(packageDir, 'package-lock.json')
  33. let lockfileShrinkwrap = join(packageDir, 'npm-shrinkwrap.json')
  34. let lockfileYarn = join(packageDir, 'yarn.lock')
  35. let lockfilePnpm = join(packageDir, 'pnpm-lock.yaml')
  36. let lockfileBun = join(packageDir, 'bun.lock')
  37. let lockfileBunBinary = join(packageDir, 'bun.lockb')
  38. let lockfileDeno = join(packageDir, 'deno.lock')
  39. if (existsSync(lockfilePnpm)) {
  40. return { file: lockfilePnpm, mode: 'pnpm' }
  41. } else if (existsSync(lockfileBun) || existsSync(lockfileBunBinary)) {
  42. return { file: lockfileBun, mode: 'bun' }
  43. } else if (existsSync(lockfileNpm)) {
  44. return { file: lockfileNpm, mode: 'npm' }
  45. } else if (existsSync(lockfileYarn)) {
  46. let lock = { file: lockfileYarn, mode: 'yarn' }
  47. lock.content = readFileSync(lock.file).toString()
  48. lock.version = /# yarn lockfile v1/.test(lock.content) ? 1 : 2
  49. return lock
  50. } else if (existsSync(lockfileShrinkwrap)) {
  51. return { file: lockfileShrinkwrap, mode: 'npm' }
  52. } else if (existsSync(lockfileDeno)) {
  53. return { file: lockfileDeno, mode: 'deno' }
  54. }
  55. throw new BrowserslistUpdateError(
  56. 'No lockfile found. Run "npm install", "yarn install", "pnpm install", "bun install" or "deno install"'
  57. )
  58. }
  59. function getLatestInfo(lock) {
  60. try {
  61. if (lock.mode === 'yarn') {
  62. if (lock.version === 1) {
  63. return JSON.parse(
  64. execSync(YARN_CMD + ' info caniuse-lite --json').toString()
  65. ).data
  66. } else {
  67. return JSON.parse(
  68. execSync(YARN_CMD + ' npm info caniuse-lite --json').toString()
  69. )
  70. }
  71. }
  72. if (lock.mode === 'pnpm') {
  73. return JSON.parse(execSync('pnpm info caniuse-lite --json').toString())
  74. }
  75. if (lock.mode === 'bun') {
  76. return JSON.parse(execSync('bun info caniuse-lite --json').toString())
  77. }
  78. if (lock.mode === 'deno') {
  79. let result = JSON.parse(
  80. execSync(
  81. 'deno run -A npm:npm show caniuse-lite version --json'
  82. ).toString()
  83. )
  84. return { version: Array.isArray(result) ? result[0] : result }
  85. }
  86. return JSON.parse(execSync('npm show caniuse-lite --json').toString())
  87. } catch (e) {
  88. if (e.code === 'ENOENT' || e.status === 127) {
  89. throw new BrowserslistUpdateError(
  90. 'Cannot find ' +
  91. lock.mode +
  92. ' binary in PATH. Please install ' +
  93. lock.mode +
  94. ' or run updates manually.'
  95. )
  96. }
  97. throw e
  98. }
  99. }
  100. function getBrowsers() {
  101. let browserslist = require('browserslist')
  102. return browserslist().reduce((result, entry) => {
  103. if (!result[entry[0]]) {
  104. result[entry[0]] = []
  105. }
  106. result[entry[0]].push(entry[1])
  107. return result
  108. }, {})
  109. }
  110. function diffBrowsers(old, current) {
  111. let browsers = Object.keys(old).concat(
  112. Object.keys(current).filter(browser => old[browser] === undefined)
  113. )
  114. return browsers
  115. .map(browser => {
  116. let oldVersions = old[browser] || []
  117. let currentVersions = current[browser] || []
  118. let common = oldVersions.filter(v => currentVersions.includes(v))
  119. let added = currentVersions.filter(v => !common.includes(v))
  120. let removed = oldVersions.filter(v => !common.includes(v))
  121. return removed
  122. .map(v => pico.red('- ' + browser + ' ' + v))
  123. .concat(added.map(v => pico.green('+ ' + browser + ' ' + v)))
  124. })
  125. .reduce((result, array) => result.concat(array), [])
  126. .join('\n')
  127. }
  128. function updateNpmLockfile(lock, latest) {
  129. let metadata = { latest, versions: [] }
  130. let content = deletePackage(JSON.parse(lock.content), metadata)
  131. metadata.content = JSON.stringify(content, null, detectIndent(lock.content))
  132. return metadata
  133. }
  134. function deletePackage(node, metadata) {
  135. if (node.dependencies) {
  136. if (node.dependencies['caniuse-lite']) {
  137. let version = node.dependencies['caniuse-lite'].version
  138. metadata.versions[version] = true
  139. delete node.dependencies['caniuse-lite']
  140. }
  141. for (let i in node.dependencies) {
  142. node.dependencies[i] = deletePackage(node.dependencies[i], metadata)
  143. }
  144. }
  145. if (node.packages) {
  146. for (let path in node.packages) {
  147. if (path.endsWith('/caniuse-lite')) {
  148. metadata.versions[node.packages[path].version] = true
  149. delete node.packages[path]
  150. }
  151. }
  152. }
  153. return node
  154. }
  155. let yarnVersionRe = /version "(.*?)"/
  156. function updateYarnLockfile(lock, latest) {
  157. let blocks = lock.content.split(/(\n{2,})/).map(block => {
  158. return block.split('\n')
  159. })
  160. let versions = {}
  161. blocks.forEach(lines => {
  162. if (lines[0].indexOf('caniuse-lite@') !== -1) {
  163. let match = yarnVersionRe.exec(lines[1])
  164. versions[match[1]] = true
  165. if (match[1] !== latest.version) {
  166. lines[1] = lines[1].replace(
  167. /version "[^"]+"/,
  168. 'version "' + latest.version + '"'
  169. )
  170. lines[2] = lines[2].replace(
  171. /resolved "[^"]+"/,
  172. 'resolved "' + latest.dist.tarball + '"'
  173. )
  174. if (lines.length === 4) {
  175. lines[3] = latest.dist.integrity
  176. ? lines[3].replace(
  177. /integrity .+/,
  178. 'integrity ' + latest.dist.integrity
  179. )
  180. : ''
  181. }
  182. }
  183. }
  184. })
  185. let content = blocks.map(lines => lines.join('\n')).join('')
  186. return { content, versions }
  187. }
  188. function updateLockfile(lock, latest) {
  189. if (!lock.content) lock.content = readFileSync(lock.file).toString()
  190. let updatedLockFile
  191. if (lock.mode === 'yarn') {
  192. updatedLockFile = updateYarnLockfile(lock, latest)
  193. } else {
  194. updatedLockFile = updateNpmLockfile(lock, latest)
  195. }
  196. updatedLockFile.content = updatedLockFile.content.replace(
  197. /\n/g,
  198. detectEOL(lock.content)
  199. )
  200. return updatedLockFile
  201. }
  202. function updatePackageManually(print, lock, latest) {
  203. let lockfileData = updateLockfile(lock, latest)
  204. let caniuseVersions = Object.keys(lockfileData.versions).sort()
  205. if (caniuseVersions.length === 1 && caniuseVersions[0] === latest.version) {
  206. print(
  207. 'Installed version: ' +
  208. pico.bold(pico.green(caniuseVersions[0])) +
  209. '\n' +
  210. pico.bold(pico.green('caniuse-lite is up to date')) +
  211. '\n'
  212. )
  213. return
  214. }
  215. if (caniuseVersions.length === 0) {
  216. caniuseVersions[0] = 'none'
  217. }
  218. print(
  219. 'Installed version' +
  220. (caniuseVersions.length === 1 ? ': ' : 's: ') +
  221. pico.bold(pico.red(caniuseVersions.join(', '))) +
  222. '\n' +
  223. 'Removing old caniuse-lite from lock file\n'
  224. )
  225. writeFileSync(lock.file, lockfileData.content)
  226. let install =
  227. lock.mode === 'yarn' ? YARN_CMD + ' add -W' : lock.mode + ' install'
  228. print(
  229. 'Installing new caniuse-lite version\n' +
  230. pico.yellow('$ ' + install + ' caniuse-lite baseline-browser-mapping') +
  231. '\n'
  232. )
  233. try {
  234. execSync(install + ' caniuse-lite baseline-browser-mapping')
  235. } catch (e) /* c8 ignore start */ {
  236. print(
  237. pico.red(
  238. '\n' +
  239. e.stack +
  240. '\n\n' +
  241. 'Problem with `' +
  242. install +
  243. ' caniuse-lite` call. ' +
  244. 'Run it manually.\n'
  245. )
  246. )
  247. process.exit(1)
  248. } /* c8 ignore end */
  249. let del =
  250. lock.mode === 'yarn' ? YARN_CMD + ' remove -W' : lock.mode + ' uninstall'
  251. print(
  252. 'Cleaning package.json dependencies from caniuse-lite\n' +
  253. pico.yellow('$ ' + del + ' caniuse-lite baseline-browser-mapping') +
  254. '\n'
  255. )
  256. execSync(del + ' caniuse-lite baseline-browser-mapping')
  257. }
  258. /**
  259. * Bun cannot update a transitive dependency by name: `bun update caniuse-lite`
  260. * adds caniuse-lite to package.json as a new direct dependency at the latest
  261. * version and leaves every nested copy - the ones that actually get resolved at
  262. * runtime - on the old version. A temporary `overrides` entry reaches those,
  263. * and the resolutions survive once it is taken back out.
  264. */
  265. function updateBun(print, lock, latest) {
  266. let pkgFile = join(dirname(lock.file), 'package.json')
  267. let original = readFileSync(pkgFile)
  268. let pkg = JSON.parse(original.toString())
  269. let withOverride = {
  270. ...pkg,
  271. overrides: {
  272. ...pkg.overrides,
  273. 'baseline-browser-mapping': 'latest',
  274. 'caniuse-lite': latest.version
  275. }
  276. }
  277. // The file is restored byte for byte below, so its formatting does not matter.
  278. writeFileSync(pkgFile, JSON.stringify(withOverride, null, 2) + '\n')
  279. print(
  280. 'Updating caniuse-lite version\n' +
  281. pico.yellow('$ bun install') +
  282. ' (with a temporary caniuse-lite override)\n'
  283. )
  284. try {
  285. execSync('bun install')
  286. } catch (e) /* c8 ignore start */ {
  287. writeFileSync(pkgFile, original)
  288. print(pico.red(e.stdout.toString()))
  289. print(
  290. pico.red(
  291. '\n' +
  292. e.stack +
  293. '\n\n' +
  294. 'Problem with `bun install` call. ' +
  295. 'Run it manually.\n'
  296. )
  297. )
  298. process.exit(1)
  299. } /* c8 ignore end */
  300. writeFileSync(pkgFile, original)
  301. updateWith(print, 'bun install', 'Removing the temporary override')
  302. }
  303. function updateWith(print, cmd, message = 'Updating caniuse-lite version') {
  304. print(message + '\n' + pico.yellow('$ ' + cmd) + '\n')
  305. try {
  306. execSync(cmd)
  307. } catch (e) /* c8 ignore start */ {
  308. print(pico.red(e.stdout.toString()))
  309. print(
  310. pico.red(
  311. '\n' +
  312. e.stack +
  313. '\n\n' +
  314. 'Problem with `' +
  315. cmd +
  316. '` call. ' +
  317. 'Run it manually.\n'
  318. )
  319. )
  320. process.exit(1)
  321. } /* c8 ignore end */
  322. }
  323. module.exports = function updateDB(print = defaultPrint) {
  324. let lock = detectLockfile()
  325. let latest = getLatestInfo(lock)
  326. let listError
  327. let oldList
  328. try {
  329. oldList = getBrowsers()
  330. } catch (e) {
  331. listError = e
  332. }
  333. print('Latest version: ' + pico.bold(pico.green(latest.version)) + '\n')
  334. if (lock.mode === 'yarn' && lock.version !== 1) {
  335. updateWith(print, YARN_CMD + ' up -R caniuse-lite baseline-browser-mapping')
  336. } else if (lock.mode === 'pnpm') {
  337. let lockContent = readFileSync(lock.file).toString()
  338. let packages = lockContent.includes('baseline-browser-mapping')
  339. ? 'caniuse-lite baseline-browser-mapping'
  340. : 'caniuse-lite'
  341. updateWith(print, 'pnpm up --depth=9999 --no-save ' + packages)
  342. } else if (lock.mode === 'bun') {
  343. updateBun(print, lock, latest)
  344. } else if (lock.mode === 'deno') {
  345. updateWith(print, 'deno add npm:caniuse-lite npm:baseline-browser-mapping')
  346. updateWith(
  347. print,
  348. 'deno remove caniuse-lite baseline-browser-mapping',
  349. 'Cleaning package.json dependencies from caniuse-lite'
  350. )
  351. } else {
  352. updatePackageManually(print, lock, latest)
  353. }
  354. print('caniuse-lite has been successfully updated\n')
  355. let newList
  356. if (!listError) {
  357. try {
  358. newList = getBrowsers()
  359. } catch (e) /* c8 ignore start */ {
  360. listError = e
  361. } /* c8 ignore end */
  362. }
  363. if (listError) {
  364. if (listError.message.includes("Cannot find module 'browserslist'")) {
  365. print(
  366. pico.gray(
  367. 'Install `browserslist` to your direct dependencies ' +
  368. 'to see target browser changes\n'
  369. )
  370. )
  371. } else {
  372. print(
  373. pico.gray(
  374. 'Problem with browser list retrieval.\n' +
  375. 'Target browser changes won’t be shown.\n'
  376. )
  377. )
  378. }
  379. } else {
  380. let changes = diffBrowsers(oldList, newList)
  381. if (changes) {
  382. print('\nTarget browser changes:\n')
  383. print(changes + '\n')
  384. } else {
  385. print('\n' + pico.green('No target browser changes') + '\n')
  386. }
  387. }
  388. }