Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amilajack/eslint-plugin-compat
Check the browser compatibility of your code
https://github.com/amilajack/eslint-plugin-compat
api browserslist caniuse compat eslint plugin polyfill
Last synced: about 1 month ago
JSON representation
Check the browser compatibility of your code
- Host: GitHub
- URL: https://github.com/amilajack/eslint-plugin-compat
- Owner: amilajack
- License: mit
- Created: 2016-09-30T15:47:58.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-04-04T14:09:39.000Z (5 months ago)
- Last Synced: 2024-05-01T12:20:13.212Z (4 months ago)
- Topics: api, browserslist, caniuse, compat, eslint, plugin, polyfill
- Language: TypeScript
- Homepage:
- Size: 7.65 MB
- Stars: 3,037
- Watchers: 30
- Forks: 100
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-eslint - Compat - Lint browser compatibility of APIs used ([caniuse](http://caniuse.com/#search=fetch) as an ESLint plugin). (Plugins / Compatibility)
README
# eslint-plugin-compat
[](https://github.com/amilajack/eslint-plugin-compat/actions/workflows/test.yml)
[](https://opencollective.com/eslint-plugin-compat)
[](http://badge.fury.io/js/eslint-plugin-compat)
[](https://npm-stat.com/charts.html?package=eslint-plugin-compat)
[](#backers)
[](#sponsors)
Lint the browser compatibility of your code
## Setup
### 1. Install
```bash
npm install eslint-plugin-compat
```
### 2. Update ESLint Config
#### New Config (`eslint.config.mjs`)
```js
import compat from "eslint-plugin-compat";
export default [compat.configs["flat/recommended"]];
```
#### Legacy Config (`.eslintrc.json`)
```jsonc
{
"plugins": ["compat"],
"extends": ["plugin:compat/recommended"],
"env": {
"browser": true,
},
// ...
}
```
### 3. Configure Target Browsers
Browser targets are configured using [browserslist](https://github.com/browserslist/browserslist). You can configure browser targets in your `package.json`:
#### `package.json`
```jsonc
{
// ...
"browserslist": ["defaults"],
}
```
If no configuration is found, browserslist [defaults to](https://github.com/browserslist/browserslist#queries) `"> 0.5%, last 2 versions, Firefox ESR, not dead"`.
See [browserslist/browserslist](https://github.com/browserslist/browserslist) for more details.
## Adding Polyfills
Add polyfills to the settings section of your eslint config. Append the name of the object and the property if one exists. Here are some examples:
```jsonc
{
// ...
"settings": {
"polyfills": [
// Example of marking entire API and all methods and properties as polyfilled
"Promise",
// Example of marking specific method of an API as polyfilled
"WebAssembly.compile",
// Example of API with no property (i.e. a function)
"fetch",
// Example of instance method, must add `.prototype.`
"Array.prototype.push",
],
},
}
```
## Linting ES APIs (Experimental)
This plugin also supports linting the compatibility of ES APIs in addition to Web APIs. This is an experimental feature and is disabled by default. To enable this feature, add the following to your eslint config:
```jsonc
{
// ...
"settings": {
"lintAllEsApis": true,
},
}
```
## Configuring for Different Environments
Browserslist allows specifying [different browser queries for multiple environments](https://github.com/browserslist/browserslist#configuring-for-different-environments). By default, this plugin targets the `production` browserslist environment. To change this default, set the `settings.browserslistOpts.env` property in your eslint config:
**Example**:
A browserslist with multiple environments:
```jsonc
"browserslist": {
"production": [
"> 1%",
"not dead"
],
"modern": [
"last 1 chrome version",
"last 1 firefox version"
]
}
```
Target `modern` browserslist environment:
```jsonc
{
"settings": {
"browserslistOpts": {
"env": "modern",
},
},
}
```
## Demo
For a minimal demo, see [amilajack/eslint-plugin-compat-demo](https://github.com/amilajack/eslint-plugin-compat-demo)
## Inspiration
Toolchains for native platforms, like iOS and Android, have had API linting from the start. It's about time that the web had similar tooling.
This project was inspired by a two hour conversation I had with someone on the experience of web development and if it is terrible or not. The premise they argued was that `x` browser doesn't support `y` feature while `z` browser does. Eventually, I agreed with him on this and made this plugin to save web developers from having to memorize the browser compatibility of WebAPIs.
## Related
- [ast-metadata-inferer](https://github.com/amilajack/ast-metadata-inferer)
- [compat-db](https://github.com/amilajack/compat-db)
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/eslint-plugin-compat/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/eslint-plugin-compat/contribute)]
