eslint-plugin-compat

    3.13.0 • Public • Published

    eslint-plugin-compat

    Build Status Financial Contributors on Open Collective NPM version Dependency Status npm Backers on Open Collective Sponsors on Open Collective

    Lint the browser compatibility of your code

    demo of plugin usage

    Setup

    1. Install

    npm install --save-dev eslint-plugin-compat

    2. Update ESLint Config

    .eslintrc.json

       {
    +    "extends": ["plugin:compat/recommended"],
    +    "env": {
    +      "browser": true
    +    },
         // ...
       }

    3. Configure Target Browsers

    Browser targets are configured using browserslist. You can configure browser targets in your package.json:

    package.json

       {
         // ...
    +    "browserslist": [
    +      "defaults"
    +    ]
      }

    If no configuration is found, browserslist defaults to "> 0.5%, last 2 versions, Firefox ESR, not dead".

    See 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:

    {
      // ...
      "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"
        ]
      }
    }

    Demo

    For a minimal demo, see amilajack/eslint-plugin-compat-demo

    Advanced

    Road Map

    See the Road Map for the details.

    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

    Contributors

    Code Contributors

    This project exists thanks to all the people who contribute. [Contribute].

    Financial Contributors

    Become a financial contributor and help us sustain our community. [Contribute]

    Individuals

    Organizations

    Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

    Install

    npm i eslint-plugin-compat

    DownloadsWeekly Downloads

    296,859

    Version

    3.13.0

    License

    MIT

    Unpacked Size

    121 kB

    Total Files

    18

    Last publish

    Collaborators

    • amilajack
    • jtran