browserslist 4.14.5 → 4.16.0

package/CHANGELOG.md

@@ -1,6 +1,22 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 4.16
+* Add `browserslist config` query.
+
+## 4.15
+* Add TypeScript types (by Dmitry Semigradsky).
+
+## 4.14.7
+* Fixed Yarn Workspaces support to `--update-db` (by Fausto Núñez Alberro).
+* Added browser changes to `--update-db` (by @AleksandrSl).
+* Added color output to `--update-db`.
+* Updated `package.funding` to have link to our Open Collective.
+
+## 4.14.6
+* Fixed Yarn support in `--update-db` (by Ivan Storck).
+* Fixed npm 7 support in `--update-db`.
+
 ## 4.14.5
 * Fixed `last 2 electron versions` query (by Sergey Melyukov).
 

package/README.md

@@ -21,7 +21,6 @@ when you add the following to `package.json`:
   "browserslist": [
     "defaults",
     "not IE 11",
-    "not IE_Mob 11",
     "maintained node versions"
   ]
 ```
@@ -33,7 +32,6 @@ Or in `.browserslistrc` config:
 
 defaults
 not IE 11
-not IE_Mob 11
 maintained node versions
 ```
 
@@ -45,8 +43,6 @@ Browserslist will take queries from tool option,
 `browserslist` config, `.browserslistrc` config,
 `browserslist` section in `package.json` or environment variables.
 
-[Browserslist Example] shows how every tool uses Browserslist.
-
 [cult-img]: https://cultofmartians.com/assets/badges/badge.svg
 [cult]: https://cultofmartians.com/done.html
 
@@ -69,6 +65,7 @@ Browserslist will take queries from tool option,
 ## Table of Contents
 
 * [Tools](#tools)
+  * [Text Editors](#text-editors)
 * [Best Practices](#best-practices)
 * [Browsers Data Updating](#browsers-data-updating)
 * [Queries](#queries)
@@ -116,6 +113,13 @@ Browserslist will take queries from tool option,
 [`caniuse-api`]:                   https://github.com/Nyalab/caniuse-api
 
 
+### Text Editors
+
+These extensions will add syntax highlighting for `.browserslistrc` files.
+
+* [VS Code](https://marketplace.visualstudio.com/items?itemName=webben.browserslist)
+* [Vim](https://github.com/browserslist/vim-browserslist)
+
 ## Best Practices
 
 * There is a `defaults` query, which gives a reasonable configuration
@@ -155,7 +159,7 @@ You need to do it regularly for two reasons:
    `last 2 versions` or `>1%`. For example, if you created your project
    2 years ago and did not update your dependencies, `last 1 version`
    will return 2 year old browsers.
-2. `caiuse-lite` deduplication: to synchronize version in different tools.
+2. `caniuse-lite` deduplication: to synchronize version in different tools.
 
 > What is deduplication?
 
@@ -268,6 +272,9 @@ You can specify the browser and Node.js versions by queries (case insensitive):
   `es6-module` here is the `feat` parameter at the URL of the [Can I Use]
   page. A list of all available features can be found at
   [`caniuse-lite/data/features`].
+* `browserslist config`: the browsers defined in Browserslist config. Useful
+  in the tools to modify user’s config like
+  `browserslist config and supports es6-module`.
 * `since 2015` or `last 2 years`: all versions released since year 2015
   (also `since 2015-03` and `since 2015-03-10`).
 * `unreleased versions` or `unreleased Chrome versions`:

package/error.d.ts

@@ -0,0 +1,7 @@
+declare class BrowserslistError extends Error {
+  constructor(message: any);
+  name: 'BrowserslistError';
+  browserslist: true;
+}
+
+export = BrowserslistError;

package/index.d.ts

@@ -0,0 +1,172 @@
+/**
+ * Return array of browsers by selection queries.
+ *
+ * ```js
+ * browserslist('IE >= 10, IE 8') //=> ['ie 11', 'ie 10', 'ie 8']
+ * ```
+ *
+ * @param queries Browser queries.
+ * @returns Array with browser names in Can I Use.
+ */
+declare function browserslist (
+  queries?: string | readonly string[] | null,
+  opts?: browserslist.Options
+): string[]
+
+declare namespace browserslist {
+  interface Options {
+    /**
+     * Path to processed file. It will be used to find config files.
+     */
+    path?: string | false
+    /**
+     * Processing environment. It will be used to take right queries
+     * from config file.
+     */
+    env?: string
+    /**
+     * Custom browser usage statistics for "> 1% in my stats" query.
+     */
+    stats?: Stats | string
+    /**
+     * Path to config file with queries.
+     */
+    config?: string
+    /**
+     * Do not throw on unknown version in direct query.
+     */
+    ignoreUnknownVersions?: boolean
+    /**
+     * Disable security checks for extend query.
+     */
+    dangerousExtend?: boolean
+    /**
+     * Alias mobile browsers to the desktop version when Can I Use
+     * doesn’t have data about the specified version.
+     */
+    mobileToDesktop?: boolean
+  }
+
+  type Config = {
+    defaults: string[]
+    [section: string]: string[] | undefined
+  }
+
+  interface Stats {
+    [browser: string]: {
+      [version: string]: number
+    }
+  }
+
+  /**
+   * Browser names aliases.
+   */
+  let aliases: {
+    [alias: string]: string | undefined
+  }
+
+  /**
+   * Aliases to work with joined versions like `ios_saf 7.0-7.1`.
+   */
+  let versionAliases: {
+    [browser: string]:
+      | {
+          [version: string]: string | undefined
+        }
+      | undefined
+  }
+
+  /**
+   * Can I Use only provides a few versions for some browsers (e.g. `and_chr`).
+   *
+   * Fallback to a similar browser for unknown versions.
+   */
+  let desktopNames: {
+    [browser: string]: string | undefined
+  }
+
+  let data: {
+    [browser: string]:
+      | {
+          name: string
+          versions: string[]
+          released: string[]
+          releaseDate: {
+            [version: string]: number | undefined | null
+          }
+        }
+      | undefined
+  }
+
+  interface Usage {
+    [version: string]: number
+  }
+
+  let usage: {
+    global?: Usage
+    custom?: Usage | null
+    [country: string]: Usage | undefined | null
+  }
+
+  let cache: {
+    [feature: string]: {
+      [name: string]: 'y' | 'n'
+    }
+  }
+
+  /**
+   * Default browsers query
+   */
+  let defaults: readonly string[]
+
+  /**
+   * Which statistics should be used. Country code or custom statistics.
+   * Pass `"my stats"` to load statistics from `Browserslist` files.
+   */
+  type StatsOptions = string | 'my stats' | Stats | { dataByBrowser: Stats }
+
+  /**
+   * Return browsers market coverage.
+   *
+   * ```js
+   * browserslist.coverage(browserslist('> 1% in US'), 'US') //=> 83.1
+   * ```
+   *
+   * @param browsers Browsers names in Can I Use.
+   * @param stats Which statistics should be used.
+   * @returns Total market coverage for all selected browsers.
+   */
+  function coverage (browsers: readonly string[], stats?: StatsOptions): number
+
+  function clearCaches (): void
+
+  function parseConfig (string: string): Config
+
+  function readConfig (file: string): Config
+
+  function findConfig (...pathSegments: string[]): Config | undefined
+
+  interface LoadConfigOptions {
+    config?: string
+    path?: string
+    env?: string
+  }
+
+  function loadConfig (options: LoadConfigOptions): string[] | undefined
+}
+
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      BROWSERSLIST?: string
+      BROWSERSLIST_CONFIG?: string
+      BROWSERSLIST_DANGEROUS_EXTEND?: string
+      BROWSERSLIST_DISABLE_CACHE?: string
+      BROWSERSLIST_ENV?: string
+      BROWSERSLIST_IGNORE_OLD_DATA?: string
+      BROWSERSLIST_STATS?: string
+    }
+  }
+}
+
+export = browserslist

package/index.js

@@ -425,6 +425,7 @@ function browserslist (queries, opts) {
     ignoreUnknownVersions: opts.ignoreUnknownVersions,
     dangerousExtend: opts.dangerousExtend,
     mobileToDesktop: opts.mobileToDesktop,
+    path: opts.path,
     env: opts.env
   }
 
@@ -1105,6 +1106,12 @@ var QUERIES = [
       return [data.name + ' ' + version]
     }
   },
+  {
+    regexp: /^browserslist config$/i,
+    select: function (context) {
+      return browserslist(undefined, context)
+    }
+  },
   {
     regexp: /^extends (.+)$/i,
     select: function (context, name) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browserslist",
-  "version": "4.14.5",
+  "version": "4.16.0",
   "description": "Share target browsers between different front-end tools, like Autoprefixer, Stylelint and babel-env-preset",
   "keywords": [
     "caniuse",
@@ -8,22 +8,26 @@
     "target"
   ],
   "funding": {
-    "type": "tidelift",
-    "url": "https://tidelift.com/funding/github/npm/browserslist"
+    "type": "opencollective",
+    "url": "https://opencollective.com/browserslist"
   },
   "author": "Andrey Sitnik <andrey@sitnik.ru>",
   "license": "MIT",
   "repository": "browserslist/browserslist",
   "dependencies": {
-    "caniuse-lite": "^1.0.30001135",
-    "electron-to-chromium": "^1.3.571",
-    "escalade": "^3.1.0",
-    "node-releases": "^1.1.61"
+    "caniuse-lite": "^1.0.30001165",
+    "colorette": "^1.2.1",
+    "electron-to-chromium": "^1.3.621",
+    "escalade": "^3.1.1",
+    "node-releases": "^1.1.67"
   },
   "engines": {
     "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7"
   },
-  "bin": "./cli.js",
+  "bin": {
+    "browserslist": "cli.js"
+  },
+  "types": "./index.d.ts",
   "browser": {
     "./node.js": "./browser.js",
     "path": false

package/update-db.js

@@ -1,10 +1,16 @@
 var childProcess = require('child_process')
+var colorette = require('colorette')
 var escalade = require('escalade/sync')
 var path = require('path')
 var fs = require('fs')
 
 var BrowserslistError = require('./error')
 
+var red = colorette.red
+var bold = colorette.bold
+var green = colorette.green
+var yellow = colorette.yellow
+
 function detectLockfile () {
   var packageDir = escalade('.', function (dir, names) {
     return names.indexOf('package.json') !== -1 ? dir : ''
@@ -53,10 +59,62 @@ function getCurrentVersion (lock) {
   return null
 }
 
-function getLatestInfo () {
-  return JSON.parse(
-    childProcess.execSync('npm show caniuse-lite --json').toString()
+function getLatestInfo (lock) {
+  if (lock.mode !== 'yarn') {
+    return JSON.parse(
+      childProcess.execSync('npm show caniuse-lite --json').toString()
+    )
+  } else {
+    return JSON.parse(
+      childProcess.execSync('yarn info caniuse-lite --json').toString()
+    ).data
+  }
+}
+
+function getBrowsersList () {
+  return childProcess.execSync('npx browserslist').toString()
+    .trim()
+    .split('\n')
+    .map(function (line) {
+      return line.trim().split(' ')
+    })
+    .reduce(function (result, entry) {
+      if (!result[entry[0]]) {
+        result[entry[0]] = []
+      }
+      result[entry[0]].push(entry[1])
+      return result
+    }, {})
+}
+
+function diffBrowsersLists (old, current) {
+  var browsers = Object.keys(old).concat(
+    Object.keys(current).filter(function (browser) {
+      return old[browser] === undefined
+    })
   )
+  return browsers.map(function (browser) {
+    var oldVersions = old[browser] || []
+    var currentVersions = current[browser] || []
+    var intersection = oldVersions.filter(function (version) {
+      return currentVersions.indexOf(version) !== -1
+    })
+    var addedVersions = currentVersions.filter(function (version) {
+      return intersection.indexOf(version) === -1
+    })
+    var removedVersions = oldVersions.filter(function (version) {
+      return intersection.indexOf(version) === -1
+    })
+    return removedVersions.map(function (version) {
+      return red('- ' + browser + ' ' + version)
+    }).concat(addedVersions.map(function (version) {
+      return green('+ ' + browser + ' ' + version)
+    }))
+  })
+    .reduce(function (result, array) {
+      return result.concat(array)
+    }, [])
+    .join('\n')
 }
 
 function updateLockfile (lock, latest) {
@@ -119,29 +177,81 @@ module.exports = function updateDB (print) {
   lock.content = fs.readFileSync(lock.file).toString()
 
   var current = getCurrentVersion(lock)
-  var latest = getLatestInfo()
+  var latest = getLatestInfo(lock)
+  var browsersListRetrievalError
+  var oldBrowsersList
+  try {
+    oldBrowsersList = getBrowsersList()
+  } catch (e) {
+    browsersListRetrievalError = e
+  }
 
   if (typeof current === 'string') {
-    print('Current version: ' + current + '\n')
+    print('Current version: ' + bold(red(current)) + '\n')
   }
   print(
-    'New version: ' + latest.version + '\n' +
-    'Removing old caniuse-lite from lock file…\n'
+    'New version:     ' + bold(green(latest.version)) + '\n' +
+    'Removing old caniuse-lite from lock file\n'
   )
 
   fs.writeFileSync(lock.file, updateLockfile(lock, latest))
 
+  var install = lock.mode === 'yarn' ? 'yarn add -W' : lock.mode + ' install'
   print(
-    'Installing new caniuse-lite version…\n' +
-    '$ ' + lock.mode + ' install\n'
+    'Installing new caniuse-lite version\n' +
+    yellow('$ ' + install + ' caniuse-lite') + '\n'
   )
   try {
-    childProcess.execSync(lock.mode + ' install')
+    childProcess.execSync(install + ' caniuse-lite')
   } catch (e) /* istanbul ignore next */ {
-    print(e.stack)
-    print('\nProblem with `' + lock.mode + ' install` call. Run it manually.\n')
+    print(
+      red(
+        '\n' +
+        e.stack + '\n\n' +
+        'Problem with `' + install + '  caniuse-lite` call. ' +
+        'Run it manually.\n'
+      )
+    )
     process.exit(1)
   }
 
+  var del = lock.mode === 'yarn' ? 'yarn remove -W' : lock.mode + ' uninstall'
+  print(
+    'Cleaning package.json dependencies from caniuse-lite\n' +
+    yellow('$ ' + del + ' caniuse-lite') + '\n'
+  )
+  childProcess.execSync(del + ' caniuse-lite')
+
   print('caniuse-lite has been successfully updated\n')
+
+  var currentBrowsersList
+  if (!browsersListRetrievalError) {
+    try {
+      currentBrowsersList = getBrowsersList()
+    } catch (e) /* istanbul ignore next */ {
+      browsersListRetrievalError = e
+    }
+  }
+
+  if (browsersListRetrievalError) {
+    print(
+      red(
+        '\n' +
+        browsersListRetrievalError.stack + '\n\n' +
+        'Problem with browsers list retrieval.\n' +
+        'Target browser changes won’t be shown.\n'
+      )
+    )
+  } else {
+    var targetBrowserChanges = diffBrowsersLists(
+      oldBrowsersList,
+      currentBrowsersList
+    )
+    if (targetBrowserChanges) {
+      print('\nTarget browser changes:\n')
+      print(targetBrowserChanges + '\n')
+    } else {
+      print('\n' + green('No target browser changes') + '\n')
+    }
+  }
 }