React Testing Library 文档教程

1. 项目的目录结构及介绍

React Testing Library 的文档项目结构如下：

testing-library-docs/
├── docs/
│   ├── examples/
│   ├── guides/
│   ├── api/
│   ├── faq/
│   ├── best-practices/
│   └── ...
├── src/
│   ├── components/
│   ├── pages/
│   ├── styles/
│   └── ...
├── static/
│   └── images/
├── .gitignore
├── .prettierrc
├── .eslintrc
├── package.json
├── README.md
└── ...

目录介绍

• docs/: 包含所有文档的 Markdown 文件，分为多个子目录，如示例、指南、API 文档、常见问题等。
• src/: 包含文档网站的源代码，包括 React 组件、页面和样式文件。
• static/: 包含静态资源，如图片等。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 代码格式化配置。
• .eslintrc: ESLint 代码检查配置。
• package.json: 项目依赖和脚本配置。
• README.md: 项目介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 src/index.js，它负责初始化文档网站并渲染到 DOM 中。

import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

启动文件介绍

• src/index.js: 引入 React 和 ReactDOM，渲染 App 组件到 root 元素。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "testing-library-docs",
  "version": "1.0.0",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  },
  "devDependencies": {
    "eslint": "^7.23.0",
    "prettier": "^2.2.1"
  }
}

.prettierrc

prettierrc 文件配置了 Prettier 的代码格式化规则。

{
  "singleQuote": true,
  "trailingComma": "all",
  "printWidth": 80
}

.eslintrc

eslintrc 文件配置了 ESLint 的代码检查规则。

{
  "extends": ["react-app", "prettier"],
  "plugins": ["prettier"],
  "rules": {
    "prettier/prettier": "error"
  }
}

通过这些配置文件，可以确保项目的代码风格一致，并且遵循最佳实践。