browserslist 4.14.7 → 4.15.0

package/CHANGELOG.md

@@ -1,6 +1,9 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 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).

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
 
@@ -92,6 +88,8 @@ Browserslist will take queries from tool option,
 
 * [`browserl.ist`](https://browserl.ist/) is an online tool to check
   what browsers will be selected by some query.
+* [`browserslist-vscode`] adds `.browserslistrc` syntax highlighting
+  to Visual Studio Code.
 * [`browserslist-ga`] and [`browserslist-ga-export`] download your website
   browsers statistics to use it in `> 0.5% in my stats` query.
 * [`browserslist-useragent-regexp`] compiles Browserslist query to a RegExp
@@ -112,6 +110,7 @@ Browserslist will take queries from tool option,
 [`browserslist-browserstack`]:     https://github.com/xeroxinteractive/browserslist-browserstack
 [`browserslist-ga-export`]:        https://github.com/browserslist/browserslist-ga-export
 [`browserslist-useragent`]:        https://github.com/pastelsky/browserslist-useragent
+[`browserslist-vscode`]:           https://marketplace.visualstudio.com/items?itemName=webben.browserslist
 [`browserslist-ga`]:               https://github.com/browserslist/browserslist-ga
 [`caniuse-api`]:                   https://github.com/Nyalab/caniuse-api
 
@@ -155,7 +154,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?
 

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browserslist",
-  "version": "4.14.7",
+  "version": "4.15.0",
   "description": "Share target browsers between different front-end tools, like Autoprefixer, Stylelint and babel-env-preset",
   "keywords": [
     "caniuse",
@@ -15,11 +15,11 @@
   "license": "MIT",
   "repository": "browserslist/browserslist",
   "dependencies": {
-    "caniuse-lite": "^1.0.30001157",
+    "caniuse-lite": "^1.0.30001164",
     "colorette": "^1.2.1",
-    "electron-to-chromium": "^1.3.591",
+    "electron-to-chromium": "^1.3.612",
     "escalade": "^3.1.1",
-    "node-releases": "^1.1.66"
+    "node-releases": "^1.1.67"
   },
   "engines": {
     "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7"
@@ -27,6 +27,7 @@
   "bin": {
     "browserslist": "cli.js"
   },
+  "types": "./index.d.ts",
   "browser": {
     "./node.js": "./browser.js",
     "path": false