Feature-Sliced ESLint 配置项目教程

Feature-Sliced ESLint 配置项目教程

eslint-config 🍰 Lint feature-sliced concepts by existing eslint plugins 项目地址: https://gitcode.com/gh_mirrors/eslint/eslint-config

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

Feature-Sliced ESLint 配置项目的目录结构如下：

.
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── FAQ.md
├── LICENSE
├── README.md
├── index.js
├── index.legacy.js
├── package.json
├── yarn.lock
├── eslintrc.json
├── gitignore
├── npmignore
├── prettierignore
├── prettierrc.js
├── rules/
│   ├── import-order/
│   ├── public-api/
│   └── layers-slices/
├── test/
│   ├── import-order/
│   ├── public-api/
│   └── layers-slices/
└── utils/

目录结构介绍

• CODE_OF_CONDUCT.md: 项目的行为准则文件。
• CONTRIBUTING.md: 项目贡献指南文件。
• FAQ.md: 常见问题解答文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文件。
• index.js: 项目的主入口文件。
• index.legacy.js: 项目的旧版本入口文件。
• package.json: 项目的依赖和脚本配置文件。
• yarn.lock: Yarn 包管理器的锁定文件。
• eslintrc.json: ESLint 配置文件。
• gitignore: Git 忽略文件配置。
• npmignore: npm 忽略文件配置。
• prettierignore: Prettier 忽略文件配置。
• prettierrc.js: Prettier 配置文件。
• rules/: 包含各种 ESLint 规则的配置文件。
• test/: 包含各种规则的测试文件。
• utils/: 包含项目使用的工具函数。

2. 项目的启动文件介绍

index.js

index.js 是项目的主入口文件，负责导出默认的 ESLint 配置。该文件的主要作用是整合和导出所有规则配置，以便在项目中使用。

index.legacy.js

index.legacy.js 是项目的旧版本入口文件，用于兼容旧版本的配置。如果你需要使用旧版本的配置，可以参考该文件。

3. 项目的配置文件介绍

eslintrc.json

eslintrc.json 是 ESLint 的主要配置文件，定义了项目的 ESLint 规则和插件。该文件通常包含以下内容：

{
  "extends": ["@feature-sliced"],
  "rules": {
    // 自定义规则
  }
}

package.json

package.json 是项目的依赖和脚本配置文件。它包含了项目的依赖包、脚本命令等信息。以下是一些关键字段：

{
  "name": "@feature-sliced/eslint-config",
  "version": "1.0.0",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {
    "eslint": "^7.0.0",
    "eslint-plugin-import": "^2.22.1",
    "eslint-plugin-boundaries": "^1.0.0"
  }
}

prettierrc.js

prettierrc.js 是 Prettier 的配置文件，用于格式化代码。以下是一个简单的配置示例：

module.exports = {
  semi: true,
  singleQuote: true,
  trailingComma: 'all',
  printWidth: 80,
};

通过以上配置文件，你可以轻松地集成和使用 Feature-Sliced ESLint 配置项目。

eslint-config 🍰 Lint feature-sliced concepts by existing eslint plugins 项目地址: https://gitcode.com/gh_mirrors/eslint/eslint-config