eslint-config-sea

该配置文件基于 eslint-config-airbnb（-base），并在其基础上做出一点小改动

eslint-config-airbnb 包含 ECMAScript 6 + 以及 React 的 ESLint 代码规范。 如果项目不是 React 的话，可以选择 eslint-config-airbnb-base。

Usage

js

yarn add eslint eslint-config-sea eslint-plugin-promise eslint-plugin-node eslint-plugin-import -D

在你的.eslintrc文件中修改为：

{
  "extends": "sea"
}

注意: 这里省略了 eslint-config- 前缀，是因为它会被 eslint 自动补充。

react

yarn add eslint eslint-config-sea eslint-plugin-promise eslint-plugin-node eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react -D

在你的.eslintrc文件中修改为：

{
  "extends": "sea/react"
}

如果想要在项目中使用 hook ，那么

yarn add eslint eslint-config-sea eslint-plugin-promise eslint-plugin-node eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks -D

.eslintrc文件中修改为：

{
  "extends": ["sea/react", "sea/hooks"]
}

注：如果要使用实验性功能，例如箭头作为类方法，则需要使用 @babel/eslint-parser 作为解析器。默认解析器（Espree）不支持实验性功能。

yarn add @babel/core @babel/eslint-parser -D 后，将.eslintrc文件中修改为：

{
  "parser": "@babel/eslint-parser"
}

规则

• eslint
• import
• jsx-a11y
• react
• react-hooks
• airbnb
• standard
• standard-react

Contributing

Development

$ git clone https://github.com/MrSeaWave/lint-config.git
$ cd lint-config/packages/eslint-config-sea
# npm is not allowed.
$ yarn

Run Test

$ yarn run test

Pull Request Etiquette

• 必须严格按照 commitlint 格式提交代码
• 请尽可能提供 test 文件