-
Notifications
You must be signed in to change notification settings - Fork 667
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Breaking: Update configurations to use defaults
- Loading branch information
Showing
8 changed files
with
152 additions
and
220 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,69 +1,7 @@ | ||
# webhint's all configuration (`@hint/configuration-all`) | ||
|
||
This is a `webhint` configuration package to use for enabling | ||
all hints. | ||
**You should not use this package in your environment.** | ||
|
||
This package will automatically install all the missing dependencies. | ||
|
||
To use it you will have to install it via `npm`: | ||
|
||
```bash | ||
npm install @hint/configuration-all --save-dev | ||
``` | ||
|
||
**Note:** The recommended way of running webhint is as a `devDependency` of | ||
your project. | ||
|
||
The minimum required [`.hintrc`][hintrc] file to use it is | ||
the following: | ||
|
||
```json | ||
{ | ||
"extends": ["all"] | ||
} | ||
``` | ||
|
||
and it will be as if you had this: | ||
|
||
```json | ||
{ | ||
"connector": "puppeteer", | ||
"formatters": [ | ||
"html", | ||
"summary" | ||
], | ||
"hints": { | ||
"amp-validator": "error", | ||
"apple-touch-icons": "error", | ||
"axe/aria": "error", | ||
"axe/forms": "error", | ||
"axe/color": "error", | ||
... | ||
}, | ||
"hintsTimeout": 120000 | ||
} | ||
``` | ||
|
||
If you prefer to use another formatter (or any other hint/connector, | ||
etc.) you can do something like: | ||
|
||
```json | ||
{ | ||
"extends": ["all"], | ||
"formatters": ["codeframe"] | ||
} | ||
``` | ||
|
||
Note: Not all the hints can be used for all connectors, | ||
you will be warned when a hint is going to be ignored | ||
for a connector. | ||
|
||
e.g. | ||
|
||
```text | ||
Warning: The hint "babel-config/is-valid" will be ignored for the connector "puppeteer" | ||
``` | ||
|
||
<!-- Link labels: --> | ||
|
||
[hintrc]: https://webhint.io/docs/user-guide/configuring-webhint/summary/ | ||
This package is for internal usage and have an easy way to download all | ||
the first party resources to generate the documentation in | ||
[webhint.io](https://webhint.io). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.