【亲测免费】 ESLint 插件 Jest 使用教程

1. 项目目录结构及介绍

eslint-plugin-jest/
├── docs/
│   └── rules/
├── src/
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .npmignore
├── .prettierignore
├── .yarnrc
├── .yarnrc.yml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── babel.config.js
├── dangerfile.ts
├── eslint-remote-tester.config.ts
├── jest.config.ts
├── markdown_link_check_config.json
├── package.json
├── tsconfig.json
└── yarn.lock

目录结构介绍

• docs/: 包含项目的文档，特别是规则的文档。
• src/: 包含插件的源代码。
• .eslintignore: 指定 ESLint 忽略的文件和目录。
• .eslintrc.js: ESLint 配置文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmignore: 指定 npm 发布时忽略的文件和目录。
• .prettierignore: 指定 Prettier 忽略的文件和目录。
• .yarnrc: Yarn 配置文件。
• .yarnrc.yml: Yarn 配置文件（YAML 格式）。
• CHANGELOG.md: 项目变更日志。
• LICENSE: 项目许可证。
• README.md: 项目介绍和使用说明。
• babel.config.js: Babel 配置文件。
• dangerfile.ts: Danger 配置文件。
• eslint-remote-tester.config.ts: ESLint 远程测试配置文件。
• jest.config.ts: Jest 配置文件。
• markdown_link_check_config.json: Markdown 链接检查配置文件。
• package.json: 项目元数据和依赖管理。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 锁定文件，确保依赖版本一致性。

2. 项目的启动文件介绍

项目没有明确的“启动文件”，因为这是一个 ESLint 插件，而不是一个独立的应用程序。插件的入口点通常是 src/ 目录下的文件，这些文件定义了插件的规则和配置。

3. 项目的配置文件介绍

.eslintrc.js

这是 ESLint 的主要配置文件，定义了插件的规则和环境。以下是一个示例配置：

module.exports = {
  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"
  },
  env: {
    "jest/globals": true
  }
};

jest.config.ts

这是 Jest 的配置文件，定义了 Jest 测试框架的行为。以下是一个示例配置：

export default {
  preset: "ts-jest",
  testEnvironment: "node",
  testMatch: ["**/__tests__/**/*.ts?(x)", "**/?(*.)+(spec|test).ts?(x)"],
  moduleFileExtensions: ["ts", "tsx", "js", "jsx", "json", "node"]
};

tsconfig.json

这是 TypeScript 的配置文件，定义了 TypeScript 编译器的选项。以下是一个示例配置：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

通过这些配置文件，你可以定制 ESLint 插件 Jest 的行为，确保你的测试代码符合最佳实践和项目规范。