So verwenden Sie ESLint mit Jest

Ich versuche, den ESLint-Linter mit dem Jest-Testframework zu verwenden.

Scherztests laufen mit einigen Globals wie jest, worüber ich dem Linter erzählen muss; Das Knifflige ist aber die Verzeichnisstruktur, bei Jest werden die Tests mit dem Quellcode eingebettet __tests__ Ordner, sodass die Verzeichnisstruktur in etwa so aussieht:

src
    foo
        foo.js
        __tests__
            fooTest.js
    bar
        bar.js
        __tests__
            barTest.js

Normalerweise hätte ich alle meine Tests unter einem einzigen Verzeichnis, und ich könnte einfach ein hinzufügen .eslintrc Datei dort, um die Globals hinzuzufügen … aber ich möchte auf keinen Fall eine hinzufügen .eslintrc Datei zu jedem einzelnen __test__ dir.

Fürs Erste habe ich nur die Test-Globals zu global hinzugefügt .eslintrc Datei, aber da könnte ich jetzt referenzieren jest in nicht testendem Code scheint das nicht die “richtige” Lösung zu sein.

Gibt es eine Möglichkeit, eslint dazu zu bringen, Regeln anzuwenden, die auf einem Muster basieren, das auf dem Verzeichnisnamen basiert, oder so ähnlich?

Die Dokumente zeigen, dass Sie jetzt Folgendes hinzufügen können:

"env": {
    "jest/globals": true
}

Zu deinem .eslintrc Dadurch werden alle scherzbezogenen Dinge zu Ihrer Umgebung hinzugefügt, wodurch die Linter-Fehler / -Warnungen beseitigt werden.

Möglicherweise müssen Sie einbeziehen plugins: ["jest"] zu Ihrer esconfig und fügen Sie die hinzu eslint-plugin-jest Plugin, wenn es immer noch nicht funktioniert.

ESLint unterstützt dies ab Version >= 4:

/*
.eslintrc.js
*/
const ERROR = 2;
const WARN = 1;

module.exports = {
  extends: "eslint:recommended",
  env: {
    es6: true
  },
  overrides: [
    {
      files: [
        "**/*.test.js"
      ],
      env: {
        jest: true // now **/*.test.js files' env has both es6 *and* jest
      },
      // Can't extend in overrides: https://github.com/eslint/eslint/issues/8813
      // "extends": ["plugin:jest/recommended"]
      plugins: ["jest"],
      rules: {
        "jest/no-disabled-tests": "warn",
        "jest/no-focused-tests": "error",
        "jest/no-identical-title": "error",
        "jest/prefer-to-have-length": "warn",
        "jest/valid-expect": "error"
      }
    }
  ],
};

Hier ist eine Problemumgehung (von einer anderen Antwort hier, stimmen Sie es ab!) Für die Einschränkung “Extend in Overrides” von eslint config :

overrides: [
  Object.assign(
    {
      files: [ '**/*.test.js' ],
      env: { jest: true },
      plugins: [ 'jest' ],
    },
    require('eslint-plugin-jest').configs.recommended
  )
]

Aus https://github.com/eslint/eslint/issues/8813#issuecomment-320448724

Sie können die Testumgebung auch wie folgt in Ihrer Testdatei festlegen:

/* eslint-env jest */

describe(() => {
  /* ... */
})

Um Zacharys Antwort zu vervollständigen, hier ist eine Problemumgehung für die Einschränkung „In Überschreibungen erweitern“ von eslint config :

overrides: [
  Object.assign(
    {
      files: [ '**/*.test.js' ],
      env: { jest: true },
      plugins: [ 'jest' ],
    },
    require('eslint-plugin-jest').configs.recommended
  )
]

Aus https://github.com/eslint/eslint/issues/8813#issuecomment-320448724

ich habe das Problem gelöst REF

Laufen

# For Yarn
yarn add eslint-plugin-jest -D

# For NPM
npm i eslint-plugin-jest -D

Und fügen Sie dann Ihre hinzu .eslintrc Datei

{
    "extends": ["airbnb","plugin:jest/recommended"],
}

Ab 2021 denke ich, dass der richtige oder zumindest der funktionierende Weg die Installation ist @types/jest und eslint-plugin-jest:

npm i -D eslint-plugin-jest @types/jest

Und das Hinzufügen des Jest-Plugins in .eslintrc.js mit der von @Loren erwähnten Overrides-Anweisung:

module.exports = {
  ...
  plugins: ["jest"],
  ...
  overrides: [
    {
      files: ["**/*.test.js"],
      env: { "jest/globals": true },
      plugins: ["jest"],
      extends: ["plugin:jest/recommended"],
    },
  ],
  ...
};

Auf diese Weise erhalten Sie sowohl in Ihren Quelldateien als auch in Testdateien Linting-Fehler, aber in Testdateien erhalten Sie keine Linting-Fehler test und andere Funktionen von Jest, aber Sie erhalten sie in Ihren Quelldateien, da sie dort als undefiniert erscheinen.

einige der Antworten davon ausgehen Sie haben eslint-plugin-jest jedoch installiert ohne Wenn Sie das tun müssen, können Sie es einfach tun Dies in deiner .eslintrc Datei, hinzufügen:

  "globals": {
    "jest": true,
  }