This commit is contained in:
2022-07-18 02:50:52 +00:00
parent befd344ab0
commit 06181b34d6
8569 changed files with 818704 additions and 352705 deletions
+2 -581
View File
@@ -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
@@ -66,580 +62,5 @@ Browserslist will take queries from tool option,
[Babel]: https://github.com/babel/babel/tree/master/packages/babel-preset-env
[obsolete-webpack-plugin]: https://github.com/ElemeFE/obsolete-webpack-plugin
## Table of Contents
* [Tools](#tools)
* [Best Practices](#best-practices)
* [Queries](#queries)
* [Query Composition](#query-composition)
* [Full List](#full-list)
* [Debug](#debug)
* [Browsers](#browsers)
* [Config File](#config-file)
* [`package.json`](#packagejson)
* [`.browserslistrc`](#browserslistrc)
* [Shareable Configs](#shareable-configs)
* [Configuring for Different Environments](#configuring-for-different-environments)
* [Custom Usage Data](#custom-usage-data)
* [JS API](#js-api)
* [Environment Variables](#environment-variables)
* [Cache](#cache)
* [Security Contact](#security-contact)
* [For Enterprise](#for-enterprise)
## Tools
* [`browserl.ist`](https://browserl.ist/) is an online tool to check
what browsers will be selected by some query.
* [`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
to test browser useragent.
* [`browserslist-useragent-ruby`] is a Ruby library to checks browser
by user agent string to match Browserslist.
* [`browserslist-browserstack`] runs BrowserStack tests for all browsers
in Browserslist config.
* [`browserslist-adobe-analytics`] use Adobe Analytics data to target browsers.
* [`caniuse-api`] returns browsers which support some specific feature.
* Run `npx browserslist` in your project directory to see projects
target browsers. This CLI tool is built-in and available in any project
with Autoprefixer.
[`browserslist-useragent-regexp`]: https://github.com/browserslist/browserslist-useragent-regexp
[`browserslist-adobe-analytics`]: https://github.com/xeroxinteractive/browserslist-adobe-analytics
[`browserslist-useragent-ruby`]: https://github.com/browserslist/browserslist-useragent-ruby
[`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-ga`]: https://github.com/browserslist/browserslist-ga
[`caniuse-api`]: https://github.com/Nyalab/caniuse-api
## Best Practices
* There is a `defaults` query, which gives a reasonable configuration
for most users:
```json
"browserslist": [
"defaults"
]
```
* If you want to change the default set of browsers, we recommend combining
`last 2 versions`, `not dead` with a usage number like `> 0.2%`. This is
because `last n versions` on its own does not add popular old versions, while
only using a percentage above `0.2%` will in the long run make popular
browsers even more popular. We might run into a monopoly and stagnation
situation, as we had with Internet Explorer 6. Please use this setting
with caution.
* Select browsers directly (`last 2 Chrome versions`) only if you are making
a web app for a kiosk with one browser. There are a lot of browsers
on the market. If you are making general web app you should respect
browsers diversity.
* Dont remove browsers just because you dont know them. Opera Mini has
100 million users in Africa and it is more popular in the global market
than Microsoft Edge. Chinese QQ Browsers has more market share than Firefox
and desktop Safari combined.
## Queries
Browserslist will use browsers and Node.js versions query
from one of these sources:
1. `browserslist` key in `package.json` file in current or parent directories.
**We recommend this way.**
2. `.browserslistrc` config file in current or parent directories.
3. `browserslist` config file in current or parent directories.
4. `BROWSERSLIST` environment variable.
5. If the above methods did not produce a valid result
Browserslist will use defaults:
`> 0.5%, last 2 versions, Firefox ESR, not dead`.
### Query Composition
An `or` combiner can use the keyword `or` as well as `,`.
`last 1 version or > 1%` is equal to `last 1 version, > 1%`.
`and` query combinations are also supported to perform an
intersection of the previous query: `last 1 version and > 1%`.
There is 3 different ways to combine queries as depicted below. First you start
with a single query and then we combine the queries to get our final list.
Obviously you can *not* start with a `not` combiner, since there is no left-hand
side query to combine it with. The left-hand is always resolved as `and`
combiner even if `or` is used (this is an API implementation specificity).
`and` combiner has precedence over `or` combiner.
| Query combiner type | Illustration | Example |
| ------------------- | :----------: | ------- |
|`or`/`,` combiner <br> (union) | ![Union of queries](img/union.svg) | `> .5% or last 2 versions` <br> `> .5%, last 2 versions` |
| `and` combiner <br> (intersection) | ![intersection of queries](img/intersection.svg) | `> .5% and last 2 versions` |
| `not` combiner <br> (relative complement) | ![Relative complement of queries](img/complement.svg) | All those three are equivalent to the first one <br> `> .5% and not last 2 versions` <br> `> .5% or not last 2 versions` <br> `> .5%, not last 2 versions` |
_A quick way to test your query is to do `npx browserslist '> 0.5%, not IE 11'`
in your terminal._
### Full List
You can specify the browser and Node.js versions by queries (case insensitive):
* `defaults`: Browserslists default browsers
(`> 0.5%, last 2 versions, Firefox ESR, not dead`).
* `> 5%`: browsers versions selected by global usage statistics.
`>=`, `<` and `<=` work too.
* `> 5% in US`: uses USA usage statistics.
It accepts [two-letter country code].
* `> 5% in alt-AS`: uses Asia region usage statistics.
List of all region codes can be found at [`caniuse-lite/data/regions`].
* `> 5% in my stats`: uses [custom usage data].
* `> 5% in browserslist-config-mycompany stats`: uses [custom usage data]
from `browserslist-config-mycompany/browserslist-stats.json`.
* `cover 99.5%`: most popular browsers that provide coverage.
* `cover 99.5% in US`: same as above, with [two-letter country code].
* `cover 99.5% in my stats`: uses [custom usage data].
* `dead`: browsers without official support or updates for 24 months.
Right now it is `IE 10`, `IE_Mob 11`, `BlackBerry 10`, `BlackBerry 7`,
`Samsung 4` and `OperaMobile 12.1`.
* `last 2 versions`: the last 2 versions for *each* browser.
* `last 2 Chrome versions`: the last 2 versions of Chrome browser.
* `last 2 major versions` or `last 2 iOS major versions`:
all minor/patch releases of last 2 major versions.
* `node 10` and `node 10.4`: selects latest Node.js `10.x.x`
or `10.4.x` release.
* `current node`: Node.js version used by Browserslist right now.
* `maintained node versions`: all Node.js versions, which are [still maintained]
by Node.js Foundation.
* `iOS 7`: the iOS browser version 7 directly.
* `Firefox > 20`: versions of Firefox newer than 20.
`>=`, `<` and `<=` work too. It also works with Node.js.
* `ie 6-8`: selects an inclusive range of versions.
* `Firefox ESR`: the latest [Firefox ESR] version.
* `PhantomJS 2.1` and `PhantomJS 1.9`: selects Safari versions similar
to PhantomJS runtime.
* `extends browserslist-config-mycompany`: take queries from
`browserslist-config-mycompany` npm package.
* `supports rtcpeerconnection`: browsers with support for specific features.
`rtcpeerconnection` 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`].
* `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`:
alpha and beta versions.
* `not ie <= 8`: exclude browsers selected by previous queries.
You can add `not ` to any query.
[`caniuse-lite/data/regions`]: https://github.com/ben-eb/caniuse-lite/tree/master/data/regions
[`caniuse-lite/data/features`]: https://github.com/ben-eb/caniuse-lite/tree/master/data/features
[two-letter country code]: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
[custom usage data]: #custom-usage-data
[still maintained]: https://github.com/nodejs/Release
[Can I Use]: https://caniuse.com/
### Debug
Run `npx browserslist` in project directory to see what browsers was selected
by your queries.
```sh
$ npx browserslist
and_chr 61
and_ff 56
and_qq 1.2
and_uc 11.4
android 56
baidu 7.12
bb 10
chrome 62
edge 16
firefox 56
ios_saf 11
opera 48
safari 11
samsung 5
```
### Browsers
Names are case insensitive:
* `Android` for Android WebView.
* `Baidu` for Baidu Browser.
* `BlackBerry` or `bb` for Blackberry browser.
* `Chrome` for Google Chrome.
* `ChromeAndroid` or `and_chr` for Chrome for Android
* `Edge` for Microsoft Edge.
* `Electron` for Electron framework. It will be converted to Chrome version.
* `Explorer` or `ie` for Internet Explorer.
* `ExplorerMobile` or `ie_mob` for Internet Explorer Mobile.
* `Firefox` or `ff` for Mozilla Firefox.
* `FirefoxAndroid` or `and_ff` for Firefox for Android.
* `iOS` or `ios_saf` for iOS Safari.
* `Node` for Node.js.
* `Opera` for Opera.
* `OperaMini` or `op_mini` for Opera Mini.
* `OperaMobile` or `op_mob` for Opera Mobile.
* `QQAndroid` or `and_qq` for QQ Browser for Android.
* `Safari` for desktop Safari.
* `Samsung` for Samsung Internet.
* `UCAndroid` or `and_uc` for UC Browser for Android.
* `kaios` for KaiOS Browser.
## Config File
### `package.json`
If you want to reduce config files in project root, you can specify
browsers in `package.json` with `browserslist` key:
```json
{
"private": true,
"dependencies": {
"autoprefixer": "^6.5.4"
},
"browserslist": [
"last 1 version",
"> 1%",
"IE 10"
]
}
```
### `.browserslistrc`
Separated Browserslist config should be named `.browserslistrc`
and have browsers queries split by a new line.
Each line is combined with the `or` combiner. Comments starts with `#` symbol:
```yaml
# Browsers that we support
last 1 version
> 1%
IE 10 # sorry
```
Browserslist will check config in every directory in `path`.
So, if tool process `app/styles/main.css`, you can put config to root,
`app/` or `app/styles`.
You can specify direct path in `BROWSERSLIST_CONFIG` environment variables.
## Shareable Configs
You can use the following query to reference an exported Browserslist config
from another package:
```json
"browserslist": [
"extends browserslist-config-mycompany"
]
```
For security reasons, external configuration only supports packages that have
the `browserslist-config-` prefix. npm scoped packages are also supported, by
naming or prefixing the module with `@scope/browserslist-config`, such as
`@scope/browserslist-config` or `@scope/browserslist-config-mycompany`.
If you dont accept Browserslist queries from users, you can disable the
validation by using the `dangerousExtend` option:
```js
browserslist(queries, { path, dangerousExtend: true })
```
Because this uses `npm`'s resolution, you can also reference specific files
in a package:
```json
"browserslist": [
"extends browserslist-config-mycompany/desktop",
"extends browserslist-config-mycompany/mobile"
]
```
When writing a shared Browserslist package, just export an array.
`browserslist-config-mycompany/index.js`:
```js
module.exports = [
'last 1 version',
'> 1%',
'ie 10'
]
```
You can also include a `browserslist-stats.json` file as part of your shareable
config at the root and query it using
`> 5% in browserslist-config-mycompany stats`. It uses the same format
as `extends` and the `dangerousExtend` property as above.
You can export configs for different environments and select environment
by `BROWSERSLIST_ENV` or `env` option in your tool:
```js
module.exports = {
development: [
'last 1 version'
],
production: [
'last 1 version',
'> 1%',
'ie 10'
]
}
```
## Configuring for Different Environments
You can also specify different browser queries for various environments.
Browserslist will choose query according to `BROWSERSLIST_ENV` or `NODE_ENV`
variables. If none of them is declared, Browserslist will firstly look
for `production` queries and then use defaults.
In `package.json`:
```js
"browserslist": {
"production": [
"> 1%",
"ie 10"
],
"modern": [
"last 1 chrome version",
"last 1 firefox version"
],
"ssr": [
"node 12"
]
}
```
In `.browserslistrc` config:
```ini
[production]
> 1%
ie 10
[modern]
last 1 chrome version
last 1 firefox version
[ssr]
node 12
```
## Custom Usage Data
If you have a website, you can query against the usage statistics of your site.
[`browserslist-ga`] will ask access to Google Analytics and then generate
`browserslist-stats.json`:
```
npx browserslist-ga
```
Or you can use [`browserslist-ga-export`] to convert Google Analytics data without giving a password for Google account.
You can generate usage statistics file by any other method. File format should
be like:
```js
{
"ie": {
"6": 0.01,
"7": 0.4,
"8": 1.5
},
"chrome": {
},
}
```
Note that you can query against your custom usage data while also querying
against global or regional data. For example, the query
`> 1% in my stats, > 5% in US, 10%` is permitted.
[`browserslist-ga-export`]: https://github.com/browserslist/browserslist-ga-export
[`browserslist-ga`]: https://github.com/browserslist/browserslist-ga
[Can I Use]: https://caniuse.com/
## JS API
```js
const browserslist = require('browserslist')
// Your CSS/JS build tool code
function process (source, opts) {
const browsers = browserslist(opts.overrideBrowserslist, {
stats: opts.stats,
path: opts.file,
env: opts.env
})
// Your code to add features for selected browsers
}
```
Queries can be a string `"> 1%, IE 10"`
or an array `['> 1%', 'IE 10']`.
If a query is missing, Browserslist will look for a config file.
You can provide a `path` option (that can be a file) to find the config file
relatively to it.
Options:
* `path`: file or a directory path to look for config file. Default is `.`.
* `env`: what environment section use from config. Default is `production`.
* `stats`: custom usage statistics data.
* `config`: path to config if you want to set it manually.
* `ignoreUnknownVersions`: do not throw on direct query (like `ie 12`).
Default is `false.`
* `dangerousExtend`: Disable security checks for `extend` query.
Default is `false.`
* `mobileToDesktop`: Use desktop browsers if Can I Use doesnt have data
about this mobile version. For instance, Browserslist will return
`chrome 20` on `and_chr 20` query (Can I Use has only data only about
latest versions of mobile browsers). Default is `false`.
For non-JS environment and debug purpose you can use CLI tool:
```sh
browserslist "> 1%, IE 10"
```
You can get total users coverage for selected browsers by JS API:
```js
browserslist.coverage(browserslist('> 1%'))
//=> 81.4
```
```js
browserslist.coverage(browserslist('> 1% in US'), 'US')
//=> 83.1
```
```js
browserslist.coverage(browserslist('> 1% in my stats'), 'my stats')
//=> 83.1
```
```js
browserslist.coverage(browserslist('> 1% in my stats', { stats }), stats)
//=> 82.2
```
Or by CLI:
```sh
$ browserslist --coverage "> 1%"
These browsers account for 81.4% of all users globally
```
```sh
$ browserslist --coverage=US "> 1% in US"
These browsers account for 83.1% of all users in the US
```
```sh
$ browserslist --coverage "> 1% in my stats"
These browsers account for 83.1% of all users in custom statistics
```
```sh
$ browserslist --coverage "> 1% in my stats" --stats=./stats.json
These browsers account for 83.1% of all users in custom statistics
```
## Environment Variables
If a tool uses Browserslist inside, you can change the Browserslist settings
with [environment variables]:
* `BROWSERSLIST` with browsers queries.
```sh
BROWSERSLIST="> 5%" gulp css
```
* `BROWSERSLIST_CONFIG` with path to config file.
```sh
BROWSERSLIST_CONFIG=./config/browserslist gulp css
```
* `BROWSERSLIST_ENV` with environments string.
```sh
BROWSERSLIST_ENV="development" gulp css
```
* `BROWSERSLIST_STATS` with path to the custom usage data
for `> 1% in my stats` query.
```sh
BROWSERSLIST_STATS=./config/usage_data.json gulp css
```
* `BROWSERSLIST_DISABLE_CACHE` if you want to disable config reading cache.
```sh
BROWSERSLIST_DISABLE_CACHE=1 gulp css
```
[environment variables]: https://en.wikipedia.org/wiki/Environment_variable
## Cache
Browserslist caches the configuration it reads from `package.json` and
`browserslist` files, as well as knowledge about the existence of files,
for the duration of the hosting process.
To clear these caches, use:
```js
browserslist.clearCaches()
```
To disable the caching altogether, set the `BROWSERSLIST_DISABLE_CACHE`
environment variable.
## Security Contact
To report a security vulnerability, please use the [Tidelift security contact].
Tidelift will coordinate the fix and disclosure.
[Tidelift security contact]: https://tidelift.com/security
## For Enterprise
Available as part of the Tidelift Subscription.
The maintainers of `browserslist` and thousands of other packages are working
with Tidelift to deliver commercial support and maintenance for the open source
dependencies you use to build your applications. Save time, reduce risk,
and improve code health, while paying the maintainers of the exact dependencies
you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-browserslist?utm_source=npm-browserslist&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
## Docs
Read **[full docs](https://github.com/browserslist/browserslist#readme)** on GitHub.
+15 -11
View File
@@ -1,36 +1,40 @@
var BrowserslistError = require('./error')
function noop () { }
function noop() {}
module.exports = {
loadQueries: function loadQueries () {
loadQueries: function loadQueries() {
throw new BrowserslistError(
'Sharable configs are not supported in client-side build of Browserslist')
'Sharable configs are not supported in client-side build of Browserslist'
)
},
getStat: function getStat (opts) {
getStat: function getStat(opts) {
return opts.stats
},
loadConfig: function loadConfig (opts) {
loadConfig: function loadConfig(opts) {
if (opts.config) {
throw new BrowserslistError(
'Browserslist config are not supported in client-side build')
'Browserslist config are not supported in client-side build'
)
}
},
loadCountry: function loadCountry () {
loadCountry: function loadCountry() {
throw new BrowserslistError(
'Country statistics are not supported ' +
'in client-side build of Browserslist')
'in client-side build of Browserslist'
)
},
loadFeature: function loadFeature () {
loadFeature: function loadFeature() {
throw new BrowserslistError(
'Supports queries are not available in client-side build of Browserslist')
'Supports queries are not available in client-side build of Browserslist'
)
},
currentNode: function currentNode (resolve, context) {
currentNode: function currentNode(resolve, context) {
return resolve(['maintained node versions'], context)[0]
},
+25 -19
View File
@@ -1,33 +1,34 @@
#!/usr/bin/env node
var updateDb = require('update-browserslist-db')
var fs = require('fs')
var browserslist = require('./')
var updateDb = require('./update-db')
var pkg = require('./package.json')
var args = process.argv.slice(2)
var USAGE = 'Usage:\n' +
' npx browserslist\n' +
' npx browserslist "QUERIES"\n' +
' npx browserslist --json "QUERIES"\n' +
' npx browserslist --config="path/to/browserlist/file"\n' +
' npx browserslist --coverage "QUERIES"\n' +
' npx browserslist --coverage=US "QUERIES"\n' +
' npx browserslist --coverage=US,RU,global "QUERIES"\n' +
' npx browserslist --env="environment name defined in config"\n' +
' npx browserslist --stats="path/to/browserlist/stats/file"\n' +
' npx browserslist --mobile-to-desktop\n' +
' npx browserslist --update-db'
var USAGE =
'Usage:\n' +
' npx browserslist\n' +
' npx browserslist "QUERIES"\n' +
' npx browserslist --json "QUERIES"\n' +
' npx browserslist --config="path/to/browserlist/file"\n' +
' npx browserslist --coverage "QUERIES"\n' +
' npx browserslist --coverage=US "QUERIES"\n' +
' npx browserslist --coverage=US,RU,global "QUERIES"\n' +
' npx browserslist --env="environment name defined in config"\n' +
' npx browserslist --stats="path/to/browserlist/stats/file"\n' +
' npx browserslist --mobile-to-desktop\n' +
' npx browserslist --ignore-unknown-versions\n'
function isArg (arg) {
function isArg(arg) {
return args.some(function (str) {
return str === arg || str.indexOf(arg + '=') === 0
})
}
function error (msg) {
function error(msg) {
process.stderr.write('browserslist: ' + msg + '\n')
process.exit(1)
}
@@ -37,12 +38,13 @@ if (isArg('--help') || isArg('-h')) {
} else if (isArg('--version') || isArg('-v')) {
process.stdout.write('browserslist ' + pkg.version + '\n')
} else if (isArg('--update-db')) {
/* c8 ignore next 3 */
updateDb(function (str) {
process.stdout.write(str)
})
} else {
var mode = 'browsers'
var opts = { }
var opts = {}
var queries
var areas
@@ -74,7 +76,11 @@ if (isArg('--help') || isArg('-h')) {
} else if (name === '--json') {
mode = 'json'
} else if (name === '--mobile-to-desktop') {
/* c8 ignore next */
opts.mobileToDesktop = true
} else if (name === '--ignore-unknown-versions') {
/* c8 ignore next */
opts.ignoreUnknownVersions = true
} else {
error('Unknown arguments ' + args[i] + '.\n\n' + USAGE)
}
@@ -86,9 +92,9 @@ if (isArg('--help') || isArg('-h')) {
} catch (e) {
if (e.name === 'BrowserslistError') {
error(e.message)
} else {
} /* c8 ignore start */ else {
throw e
}
} /* c8 ignore end */
}
var coverage
@@ -138,7 +144,7 @@ if (isArg('--help') || isArg('-h')) {
data.coverage = coverage.reduce(function (object, j) {
object[j[0]] = j[1]
return object
}, { })
}, {})
}
process.stdout.write(JSON.stringify(data, null, ' ') + '\n')
}
+7
View File
@@ -0,0 +1,7 @@
declare class BrowserslistError extends Error {
constructor(message: any)
name: 'BrowserslistError'
browserslist: true
}
export = BrowserslistError
+1 -1
View File
@@ -1,4 +1,4 @@
function BrowserslistError (message) {
function BrowserslistError(message) {
this.name = 'BrowserslistError'
this.message = message
this.browserslist = true
+198
View File
@@ -0,0 +1,198 @@
/**
* Return array of browsers by selection queries.
*
* ```js
* browserslist('IE >= 10, IE 8') //=> ['ie 11', 'ie 10', 'ie 8']
* ```
*
* @param queries Browser queries.
* @param opts Options.
* @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 Query {
compose: 'or' | 'and'
type: string
query: string
not?: true
}
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
/**
* Throw a error if env is not found.
*/
throwOnMissing?: boolean
/**
* Disable security checks for extend query.
*/
dangerousExtend?: boolean
/**
* Alias mobile browsers to the desktop version when Can I Use
* doesnt 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
}
let nodeVersions: string[]
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
/**
* Get queries AST to analyze the config content.
*
* @param queries Browser queries.
* @param opts Options.
* @returns An array of the data of each query in the config.
*/
function parse(
queries?: string | readonly string[] | null,
opts?: browserslist.Options
): Query[]
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
+469 -454
View File
File diff suppressed because it is too large Load Diff
+82 -63
View File
@@ -9,29 +9,33 @@ var IS_SECTION = /^\s*\[(.+)]\s*$/
var CONFIG_PATTERN = /^browserslist-config-/
var SCOPED_CONFIG__PATTERN = /@[^/]+\/browserslist-config(-|$|\/)/
var TIME_TO_UPDATE_CANIUSE = 6 * 30 * 24 * 60 * 60 * 1000
var FORMAT = 'Browserslist config should be a string or an array ' +
'of strings with browser queries'
var FORMAT =
'Browserslist config should be a string or an array ' +
'of strings with browser queries'
var dataTimeChecked = false
var filenessCache = { }
var configCache = { }
function checkExtend (name) {
var filenessCache = {}
var configCache = {}
function checkExtend(name) {
var use = ' Use `dangerousExtend` option to disable.'
if (!CONFIG_PATTERN.test(name) && !SCOPED_CONFIG__PATTERN.test(name)) {
throw new BrowserslistError(
'Browserslist config needs `browserslist-config-` prefix. ' + use)
'Browserslist config needs `browserslist-config-` prefix. ' + use
)
}
if (name.replace(/^@[^/]+\//, '').indexOf('.') !== -1) {
throw new BrowserslistError(
'`.` not allowed in Browserslist config name. ' + use)
'`.` not allowed in Browserslist config name. ' + use
)
}
if (name.indexOf('node_modules') !== -1) {
throw new BrowserslistError(
'`node_modules` not allowed in Browserslist config.' + use)
'`node_modules` not allowed in Browserslist config.' + use
)
}
}
function isFile (file) {
function isFile(file) {
if (file in filenessCache) {
return filenessCache[file]
}
@@ -42,7 +46,7 @@ function isFile (file) {
return result
}
function eachParent (file, callback) {
function eachParent(file, callback) {
var dir = isFile(file) ? path.dirname(file) : file
var loc = path.resolve(dir)
do {
@@ -52,7 +56,7 @@ function eachParent (file, callback) {
return undefined
}
function check (section) {
function check(section) {
if (Array.isArray(section)) {
for (var i = 0; i < section.length; i++) {
if (typeof section[i] !== 'string') {
@@ -64,7 +68,7 @@ function check (section) {
}
}
function pickEnv (config, opts) {
function pickEnv(config, opts) {
if (typeof config !== 'object') return config
var name
@@ -78,11 +82,24 @@ function pickEnv (config, opts) {
name = 'production'
}
if (opts.throwOnMissing) {
if (name && name !== 'defaults' && !config[name]) {
throw new BrowserslistError(
'Missing config for Browserslist environment `' + name + '`'
)
}
}
return config[name] || config.defaults
}
function parsePackage (file) {
var config = JSON.parse(fs.readFileSync(file))
function parsePackage(file) {
var config = JSON.parse(
fs
.readFileSync(file)
.toString()
.replace(/^\uFEFF/m, '')
)
if (config.browserlist && !config.browserslist) {
throw new BrowserslistError(
'`browserlist` key instead of `browserslist` in ' + file
@@ -99,10 +116,10 @@ function parsePackage (file) {
return list
}
function latestReleaseTime (agents) {
function latestReleaseTime(agents) {
var latest = 0
for (var name in agents) {
var dates = agents[name].releaseDate || { }
var dates = agents[name].releaseDate || {}
for (var key in dates) {
if (latest < dates[key]) {
latest = dates[key]
@@ -112,23 +129,22 @@ function latestReleaseTime (agents) {
return latest * 1000
}
function normalizeStats (data, stats) {
function normalizeStats(data, stats) {
if (!data) {
data = {}
}
if (stats && 'dataByBrowser' in stats) {
stats = stats.dataByBrowser
}
if (typeof stats !== 'object') return undefined
var normalized = { }
var normalized = {}
for (var i in stats) {
var versions = Object.keys(stats[i])
if (
versions.length === 1 &&
data[i] &&
data[i].versions.length === 1
) {
var normal = Object.keys(data[i].versions)[0]
normalized[i] = { }
if (versions.length === 1 && data[i] && data[i].versions.length === 1) {
var normal = data[i].versions[0]
normalized[i] = {}
normalized[i][normal] = stats[i][versions[0]]
} else {
normalized[i] = stats[i]
@@ -138,7 +154,7 @@ function normalizeStats (data, stats) {
return normalized
}
function normalizeUsageData (usageData, data) {
function normalizeUsageData(usageData, data) {
for (var browser in usageData) {
var browserUsage = usageData[browser]
// eslint-disable-next-line max-len
@@ -153,37 +169,39 @@ function normalizeUsageData (usageData, data) {
}
module.exports = {
loadQueries: function loadQueries (context, name) {
if (!context.dangerousExtend) checkExtend(name)
// eslint-disable-next-line security/detect-non-literal-require
var queries = require(require.resolve(name, { paths: ['.'] }))
loadQueries: function loadQueries(ctx, name) {
if (!ctx.dangerousExtend && !process.env.BROWSERSLIST_DANGEROUS_EXTEND) {
checkExtend(name)
}
var queries = require(require.resolve(name, { paths: ['.', ctx.path] }))
if (queries) {
if (Array.isArray(queries)) {
return queries
} else if (typeof queries === 'object') {
if (!queries.defaults) queries.defaults = []
return pickEnv(queries, context, name)
return pickEnv(queries, ctx, name)
}
}
throw new BrowserslistError(
'`' + name + '` config exports not an array of queries' +
' or an object of envs'
'`' +
name +
'` config exports not an array of queries' +
' or an object of envs'
)
},
loadStat: function loadStat (context, name, data) {
if (!context.dangerousExtend) checkExtend(name)
// eslint-disable-next-line security/detect-non-literal-require
var stats = require(
require.resolve(
path.join(name, 'browserslist-stats.json'),
{ paths: ['.'] }
)
)
loadStat: function loadStat(ctx, name, data) {
if (!ctx.dangerousExtend && !process.env.BROWSERSLIST_DANGEROUS_EXTEND) {
checkExtend(name)
}
var stats = require(require.resolve(
path.join(name, 'browserslist-stats.json'),
{ paths: ['.'] }
))
return normalizeStats(data, stats)
},
getStat: function getStat (opts, data) {
getStat: function getStat(opts, data) {
var stats
if (opts.stats) {
stats = opts.stats
@@ -199,13 +217,13 @@ module.exports = {
try {
stats = JSON.parse(fs.readFileSync(stats))
} catch (e) {
throw new BrowserslistError('Can\'t read ' + stats)
throw new BrowserslistError("Can't read " + stats)
}
}
return normalizeStats(data, stats)
},
loadConfig: function loadConfig (opts) {
loadConfig: function loadConfig(opts) {
if (process.env.BROWSERSLIST) {
return process.env.BROWSERSLIST
} else if (opts.config || process.env.BROWSERSLIST_CONFIG) {
@@ -222,14 +240,13 @@ module.exports = {
}
},
loadCountry: function loadCountry (usage, country, data) {
loadCountry: function loadCountry(usage, country, data) {
var code = country.replace(/[^\w-]/g, '')
if (!usage[code]) {
// eslint-disable-next-line security/detect-non-literal-require
var compressed = require('caniuse-lite/data/regions/' + code + '.js')
var usageData = region(compressed)
normalizeUsageData(usageData, data)
usage[country] = { }
usage[country] = {}
for (var i in usageData) {
for (var j in usageData[i]) {
usage[country][i + ' ' + j] = usageData[i][j]
@@ -238,14 +255,13 @@ module.exports = {
}
},
loadFeature: function loadFeature (features, name) {
loadFeature: function loadFeature(features, name) {
name = name.replace(/[^\w-]/g, '')
if (features[name]) return
// eslint-disable-next-line security/detect-non-literal-require
var compressed = require('caniuse-lite/data/features/' + name + '.js')
var stats = feature(compressed).stats
features[name] = { }
features[name] = {}
for (var i in stats) {
for (var j in stats[i]) {
features[name][i + ' ' + j] = stats[i][j]
@@ -253,11 +269,12 @@ module.exports = {
}
},
parseConfig: function parseConfig (string) {
parseConfig: function parseConfig(string) {
var result = { defaults: [] }
var sections = ['defaults']
string.toString()
string
.toString()
.replace(/#[^\n]*/g, '')
.split(/\n|,/)
.map(function (line) {
@@ -287,14 +304,14 @@ module.exports = {
return result
},
readConfig: function readConfig (file) {
readConfig: function readConfig(file) {
if (!isFile(file)) {
throw new BrowserslistError('Can\'t read ' + file + ' config')
throw new BrowserslistError("Can't read " + file + ' config')
}
return module.exports.parseConfig(fs.readFileSync(file))
},
findConfig: function findConfig (from) {
findConfig: function findConfig(from) {
from = path.resolve(from)
var passed = []
@@ -349,15 +366,15 @@ module.exports = {
return resolved
},
clearCaches: function clearCaches () {
clearCaches: function clearCaches() {
dataTimeChecked = false
filenessCache = { }
configCache = { }
filenessCache = {}
configCache = {}
this.cache = { }
this.cache = {}
},
oldDataWarning: function oldDataWarning (agentsObj) {
oldDataWarning: function oldDataWarning(agentsObj) {
if (dataTimeChecked) return
dataTimeChecked = true
if (process.env.BROWSERSLIST_IGNORE_OLD_DATA) return
@@ -368,12 +385,14 @@ module.exports = {
if (latest !== 0 && latest < halfYearAgo) {
console.warn(
'Browserslist: caniuse-lite is outdated. Please run:\n' +
'npx browserslist@latest --update-db'
' npx update-browserslist-db@latest\n' +
' Why you should do it regularly: ' +
'https://github.com/browserslist/update-db#readme'
)
}
},
currentNode: function currentNode () {
currentNode: function currentNode() {
return 'node ' + process.versions.node
}
}
+27 -22
View File
@@ -1,30 +1,28 @@
{
"_args": [
[
"browserslist@4.13.0",
"/mnt/Foxconn/Digitalent/Deverloper/liff-push_2series"
"browserslist@4.21.2",
"/home/node/nuxt"
]
],
"_from": "browserslist@4.13.0",
"_id": "browserslist@4.13.0",
"_from": "browserslist@4.21.2",
"_id": "browserslist@4.21.2",
"_inBundle": false,
"_integrity": "sha512-MINatJ5ZNrLnQ6blGvePd/QOz9Xtu+Ne+x29iQSCHfkU5BugKVJwZKn/iiL8UbpIpa3JhviKjz+XxMo0m2caFQ==",
"_integrity": "sha512-MonuOgAtUB46uP5CezYbRaYKBNt2LxP0yX+Pmj4LkcDFGkn9Cbpi83d9sCjwQDErXsIJSzY5oKGDbgOlF/LPAA==",
"_location": "/browserslist",
"_phantomChildren": {},
"_requested": {
"type": "version",
"registry": true,
"raw": "browserslist@4.13.0",
"raw": "browserslist@4.21.2",
"name": "browserslist",
"escapedName": "browserslist",
"rawSpec": "4.13.0",
"rawSpec": "4.21.2",
"saveSpec": null,
"fetchSpec": "4.13.0"
"fetchSpec": "4.21.2"
},
"_requiredBy": [
"/@babel/compat-data",
"/@babel/helper-compilation-targets",
"/@babel/preset-env",
"/autoprefixer",
"/caniuse-api",
"/core-js-compat",
@@ -36,9 +34,9 @@
"/postcss-reduce-initial",
"/stylehacks"
],
"_resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.13.0.tgz",
"_spec": "4.13.0",
"_where": "/mnt/Foxconn/Digitalent/Deverloper/liff-push_2series",
"_resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.21.2.tgz",
"_spec": "4.21.2",
"_where": "/home/node/nuxt",
"author": {
"name": "Andrey Sitnik",
"email": "andrey@sitnik.ru"
@@ -54,19 +52,25 @@
"url": "https://github.com/browserslist/browserslist/issues"
},
"dependencies": {
"caniuse-lite": "^1.0.30001093",
"electron-to-chromium": "^1.3.488",
"escalade": "^3.0.1",
"node-releases": "^1.1.58"
"caniuse-lite": "^1.0.30001366",
"electron-to-chromium": "^1.4.188",
"node-releases": "^2.0.6",
"update-browserslist-db": "^1.0.4"
},
"description": "Share target browsers between different front-end tools, like Autoprefixer, Stylelint and babel-env-preset",
"engines": {
"node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7"
},
"funding": {
"type": "tidelift",
"url": "https://tidelift.com/funding/github/npm/browserslist"
},
"funding": [
{
"type": "opencollective",
"url": "https://opencollective.com/browserslist"
},
{
"type": "tidelift",
"url": "https://tidelift.com/funding/github/npm/browserslist"
}
],
"homepage": "https://github.com/browserslist/browserslist#readme",
"keywords": [
"caniuse",
@@ -79,5 +83,6 @@
"type": "git",
"url": "git+https://github.com/browserslist/browserslist.git"
},
"version": "4.13.0"
"types": "./index.d.ts",
"version": "4.21.2"
}
+78
View File
@@ -0,0 +1,78 @@
var AND_REGEXP = /^\s+and\s+(.*)/i
var OR_REGEXP = /^(?:,\s*|\s+or\s+)(.*)/i
function flatten(array) {
if (!Array.isArray(array)) return [array]
return array.reduce(function (a, b) {
return a.concat(flatten(b))
}, [])
}
function find(string, predicate) {
for (var n = 1, max = string.length; n <= max; n++) {
var parsed = string.substr(-n, n)
if (predicate(parsed, n, max)) {
return string.slice(0, -n)
}
}
return ''
}
function matchQuery(all, query) {
var node = { query: query }
if (query.indexOf('not ') === 0) {
node.not = true
query = query.slice(4)
}
for (var name in all) {
var type = all[name]
var match = query.match(type.regexp)
if (match) {
node.type = name
for (var i = 0; i < type.matches.length; i++) {
node[type.matches[i]] = match[i + 1]
}
return node
}
}
node.type = 'unknown'
return node
}
function matchBlock(all, string, qs) {
var node
return find(string, function (parsed, n, max) {
if (AND_REGEXP.test(parsed)) {
node = matchQuery(all, parsed.match(AND_REGEXP)[1])
node.compose = 'and'
qs.unshift(node)
return true
} else if (OR_REGEXP.test(parsed)) {
node = matchQuery(all, parsed.match(OR_REGEXP)[1])
node.compose = 'or'
qs.unshift(node)
return true
} else if (n === max) {
node = matchQuery(all, parsed.trim())
node.compose = 'or'
qs.unshift(node)
return true
}
return false
})
}
module.exports = function parse(all, queries) {
if (!Array.isArray(queries)) queries = [queries]
return flatten(
queries.map(function (block) {
var qs = []
do {
block = matchBlock(all, block, qs)
} while (block)
return qs
})
)
}