开源项目 `eslint-config` 使用教程

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

eslint-config 项目的目录结构相对简单，主要包含以下几个部分：

eslint-config/
├── README.md
├── package.json
├── index.js
├── dist/
└── src/

• README.md: 项目说明文档，包含项目的基本介绍、使用方法和配置说明。
• package.json: 项目的依赖管理文件，包含项目的依赖包、脚本命令等信息。
• index.js: 项目的入口文件，负责导出配置。
• dist/: 编译后的文件目录，通常包含编译后的 JavaScript 文件。
• src/: 源代码目录，包含项目的源代码文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js，它负责导出默认的 ESLint 配置。以下是 index.js 的基本内容：

import antfu from '@antfu/eslint-config';

export default antfu();

这个文件通过导入 @antfu/eslint-config 并调用其默认导出函数，生成并导出一个 ESLint 配置对象。

3. 项目的配置文件介绍

eslint-config 项目的主要配置文件是 index.js，它导出了一个 ESLint 配置对象。以下是一些常见的配置选项：

import antfu from '@antfu/eslint-config';

export default antfu({
  // 忽略的文件或目录
  ignores: [],
  // 格式化选项
  formatters: {
    css: true,
    html: true,
    markdown: 'prettier'
  },
  // React 支持
  react: true,
  // 编辑器支持
  isInEditor: false
});

• ignores: 指定需要忽略的文件或目录。
• formatters: 指定格式化选项，如 CSS、HTML 和 Markdown 文件的格式化。
• react: 启用 React 支持。
• isInEditor: 是否在编辑器中启用。

通过这些配置选项，可以灵活地定制 ESLint 配置，以满足不同项目的需求。

---

以上是 eslint-config 项目的基本使用教程，希望对你有所帮助。