Permalink
Browse files

Docs: Clarify browserslist configuration precedence

Also restructure documentation to emphasize using `browserslist`
in `package.json` as recommended by the `browserslist` project.

Plus fix `defaults` example to match current `browserslist` behavior.

Close #1611
  • Loading branch information...
antross authored and alrra committed Jan 8, 2019
1 parent 04718ec commit ccb6731bb2ed548360b7cba57a3b020de64b20b8
Showing with 18 additions and 8 deletions.
  1. +18 −8 packages/hint/docs/user-guide/configuring-webhint/browser-context.md
@@ -1,9 +1,8 @@
# Browser configuration

`webhint` allows you to define what browsers are relevant to your
scenario by adding the property `browserslist` to your `.hintrc`
file, or in the `package.json` file. This property follows the same
convention as [`browserslist`][browserslist]:
scenario by adding the property `browserslist` to your `package.json`
file as defined by [`browserslist`][browserslist]:

```json
{
@@ -17,21 +16,32 @@ convention as [`browserslist`][browserslist]:
By specifying this property, you are giving more context to the hints
allowing them to adapt their behavior. An example of a hint taking
advantage of this property is [`highest-available-document-mode`][doc
modes]. This hint will advice to use `edge` mode if Internet Explorer
8, 9, or 10 need to be supported, but tell you to remove that tag or
header otherwise, as document modes are not needed for other browsers.
modes]. This hint will advise you to use `edge` mode if Internet
Explorer 8, 9, or 10 need to be supported, but tell you to remove that
element or header otherwise, as document modes are not needed for other
browsers.

If no value is defined, [`browserslist`’s defaults][browserslist
defaults] will be used:

```js
browserslist.defaults = [
'> 1%',
'> 0.5%',
'last 2 versions',
'Firefox ESR'
'Firefox ESR',
'not dead'
];
```

You can also configure browsers using any other
[`browserslist` configuration option][browserslist defaults], such as
`.browserslistrc`.

If you need to configure browsers for `webhint` without affecting
other tools, you can specify a `browserslist` property in your
`.hintrc` file using the same format. This list will take precedence
over any `browserslist` specified elsewhere when using `webhint`.

<!-- Link labels: -->

[browserslist]: https://github.com/ai/browserslist#readme

0 comments on commit ccb6731

Please sign in to comment.