eslint-plugin-no-react-component-snapshots

    1.0.5 • Public • Published

    eslint-plugin-no-react-component-snapshots

    Version Downloads Node.js CI

    Disallows the use of React component snapshots—inline and external. 🚫⚛️📷

    Installation

    You'll first need to install ESLint:

    npm i eslint --save-dev
    # or
    yarn add --dev eslint

    Next, install eslint-plugin-no-react-component-snapshots:

    npm install eslint-plugin-no-react-component-snapshots --save-dev
    # or
    yarn add --dev eslint-plugin-no-react-component-snapshots

    Usage

    Add no-react-component-snapshots to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

    {
      "plugins": ["no-react-component-snapshots"]
    }

    Then configure the rules you want to use under the rules section:

    {
      "rules": {
        "no-react-component-snapshots/no-react-component-snapshots": 2
      }
    }

    By default, no-react-component-snapshots will check all .test.jsx, .test.tsx, .spec.jsx, .spec.tsx and .snap files. You can configure which files are checked by providing options:

    {
      "rules": {
        "no-react-component-snapshots/no-react-component-snapshots": [
          2,
          { "extensions": [".snap"] }
        ]
      }
    }

    Once configured, inline and external snapshots will be flagged with the following messages:

    Do not test React components with toMatchInlineSnapshot()
    # and
    Do not test React components with toMatchSnapshot()

    Install

    npm i eslint-plugin-no-react-component-snapshots

    DownloadsWeekly Downloads

    9

    Version

    1.0.5

    License

    MIT

    Unpacked Size

    8.86 kB

    Total Files

    9

    Last publish

    Collaborators

    • rileygowan