如何在 Jest 中使用 ESLint

Question

我正在尝试将 ESLint linter 与 Jest 测试框架一起使用。

Jest 测试运行一些全局变量，比如 jest，我需要告诉 linter；但棘手的是目录结构，使用 Jest 时，测试与源代码一起嵌入到 __tests__ 文件夹中，因此目录结构类似于：

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

通常，我会将所有测试都放在一个目录下，我可以在那里添加一个 .eslintrc 文件来添加全局变量...但我当然不想添加 .eslintrc 文件到每个 __test__ 目录。

现在，我刚刚将测试全局变量添加到全局 .eslintrc 文件中，但这意味着我现在可以在非测试代码中引用 jest，这似乎像 "right" 解决方案。

有没有办法让 eslint 应用基于目录名称或类似内容的某种模式的规则？

Answer 1

在您的 .eslintignore 文件中添加以下值：

**/__tests__/

这应该忽略 __tests__ 目录及其子目录的所有实例。

Answer 2

基于模式的配置计划用于 ESLint 的 2.0.0 版本。但是，现在您必须创建两个单独的任务（如评论中所述）。一个用于测试，一个用于其余代码，运行两者，同时提供不同的 .eslintrc 文件。

P.S。下一个版本的 ESLint 中有一个 jest 环境，它将注册所有必要的全局变量。

Answer 3

The docs 显示您现在可以添加：

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

到你的.eslintrc，这将把所有与笑话相关的东西添加到你的环境中，消除 linter errors/warnings。

您可能需要将 plugins: ["jest"] 添加到您的 esconfig 中，如果仍然无法正常工作，请添加 eslint-plugin-jest 插件。

Answer 4

仅为 `tests` 文件夹添加环境

您可以在 __tests__ 文件夹中添加一个 .eslintrc.yml 文件，以扩展您的基本配置：

extends: <relative_path to .eslintrc>
env:
    jest: true

如果您只有一个 __tests__ 文件夹，此解决方案是最佳解决方案，因为它只在需要的地方限定 jest 环境。

处理许多测试文件夹

如果您有更多测试文件夹（OPs 案例），我仍然建议添加这些文件。如果您有大量这些文件夹，可以使用简单的 zsh 脚本添加它们：

#!/usr/bin/env zsh

for folder in **/__tests__/ ;do
    count=$(($(tr -cd '/' <<< $folder | wc -c)))
    echo $folder : $count
    cat <<EOF > $folder.eslintrc.yml
extends: $(printf '../%.0s' {1..$count}).eslintrc
env:
    jest: true
EOF
done

此脚本将查找 __tests__ 文件夹并添加一个 .eslintrc.yml 文件到如上所示的配置中。此脚本必须在包含您的父 .eslintrc.

的文件夹中启动

Answer 5

ESLint 从版本 >= 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"
      }
    }
  ],
};

这是一个针对 eslint 配置的 "extend in overrides" 限制的解决方法（来自此处的另一个答案，投赞成票！）：

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

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

Answer 6

为了完成 Zachary 的回答，这里有一个针对 eslint 配置的 "extend in overrides" 限制的解决方法：

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

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

Answer 7

您还可以在测试文件中设置测试环境，如下所示：

/* eslint-env jest */

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

Answer 8

一些答案假设你已经安装了eslint-plugin-jest，但是不需要，你可以简单地做this 在你的 .eslintrc 文件中，add:

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

Answer 9

我解决了问题REF

运行

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

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

然后添加到您的 .eslintrc 文件中

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

Answer 10

我花了一些时间尝试不同的选项后运行明白了。希望这可以帮助其他人陷入困境。

.eslintrc.json（在根项目文件夹中）：

{
    "env": {
        "browser": true,
        "es2021": true,
        "jest/globals": true
    },
    "extends": [
        "standard",
        "plugin:jest/all"
    ],
    "parser": "@babel/eslint-parser",
    "parserOptions": {
        "ecmaVersion": 12,
        "sourceType": "module"
    },
    "rules": {
        "jest/no-hooks": [
            "error",
            {
                "allow": [
                    "afterEach",
                    "beforeEach"
                ]
            }
        ]
    },
    "plugins": [
        "jest"
    ]
}

空 .babelrc（在根项目文件夹中）：

{}

.package.json（在根项目文件夹中）：

{
  "scripts": {
    "test": "jest",
    "lint": "npx eslint --format=table .",
    "lintfix": "npx eslint --fix ."
  },
  "devDependencies": {
    "@babel/core": "^7.15.0",
    "@babel/eslint-parser": "^7.15.0",
    "aws-sdk-mock": "^5.2.1",
    "eslint": "^7.32.0",
    "eslint-config-standard": "^16.0.3",
    "eslint-plugin-import": "^2.24.0",
    "eslint-plugin-jest": "^24.4.0",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^5.1.0",
    "jest": "^27.0.6"
  }
}

VS Code settings.xml（编辑器配置：在保存时启用自动修复 + babel 解析器）：

    "eslint.alwaysShowStatus": true,
    "eslint.format.enable": true,
    "eslint.lintTask.enable": true,
    "eslint.options": {
        "parser": "@babel/eslint-parser"
    },
    "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
    },
    "eslint.validate": [
        "javascript"
    ]

Answer 11

首先安装eslint-plugin-jest

运行:

 yarn add eslint-plugin-jest or npm install eslint-plugin-jest

然后编辑.eslintrc.json

{
   "env":{
     "jest": true
   }
}

Answer 12

从 ESLint V 6（2019 年底发布）开始，您可以在基于 glob 的配置中使用扩展，如下所示：

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

Answer 13

截至 2021 年，我认为正确的方法或至少是有效的方法是安装 @types/jest 和 eslint-plugin-jest:

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

并使用 @Loren 提到的覆盖指令将 Jest 插件添加到 .eslintrc.js：

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

这样你会在源文件和测试文件中得到 linting 错误，但是在测试文件中你不会得到 test 和其他 Jest 函数的 linting 错误，但是你会得到它们您的源文件，因为它们将在那里显示为未定义。

如何在 Jest 中使用 ESLint

How to use ESLint with Jest

javascript

eslint

jestjs

仅为 `tests` 文件夹添加环境

处理许多测试文件夹

如何在 Jest 中使用 ESLint

How to use ESLint with Jest

javascript

eslint

jestjs

仅为 __tests__ 文件夹添加环境

处理许多测试文件夹

仅为 `tests` 文件夹添加环境