eslint-plugin-react-percy

eslint-plugin-react-percy

ESLint plugin for react-percy.

Installation

$ yarn add --dev eslint eslint-plugin-react-percy

Note: If you installed ESLint globally then you must also install eslint-plugin-react-percy globally.

Usage

Add react-percy to the plugins section of your .eslintrc configuration file:

{
  "plugins": [
    "react-percy"
  ]
}

You can whitelist the environment variables provided by react-percy by doing:

{
  "env": {
    "react-percy/globals": true
  }
}

If you're using ESLint v4.1.0 or later, you can instead scope the react-percy environment variables to only react-percy test files by doing:

{
  "overrides": [
    {
      "files": [
        "**/__percy__/**/.*.{js,jsx}",
        "**/*.percy.{js,jsx}"
      ],
      "env": {
        "react-percy/globals": true
      }
    }
  ]
}