@mjolnir/eslint-config

适用于 web 开发的 eslint 配置集合:

• 内置了对 node, markdown, pretier 的 lint。
• 通过 overrides, 支持 babel/typescript/react/jest/mdx 的 lint.

说明

requirement

• eslint
• prettier

dependencies

@typescript-eslint/eslint-plugin
@typescript-eslint/parser
babel-eslint
eslint-plugin-babel
eslint-plugin-import
eslint-plugin-jest
eslint-plugin-node
eslint-plugin-react
eslint-plugin-react-hooks
eslint-config-prettier
eslint-plugin-prettier
eslint-plugin-mdx

安装

yarn add eslint @mjolnir/eslint-config -D

or

npm i eslint @mjolnir/eslint-config -D

配置

es6/node (默认)

适用于 web 开发, 基于 ES6 Module 模块化方式。

{
  "extends": ["@mjolnir"] // same as @mjolnir/eslint-config
}

Node.js with commonJS

纯 node 项目, 使用 commonJS 模块化方式。

{
  "extends": ["@mjolnir/eslint-config/node"]
}

overrides 配置

通过提供 overrides 的方式，增强对 babel, typescript, react,jest项目的支持。 配置文件需要使用.eslintrc.js` 格式。

recommended

推荐的 override 配置项，包含：

• babel
• typescript
• react
• jest
• mdx

适用于 Jest 项目，处理的文件类型: **/*.{spec,test}.{js,jsx,ts,tsx}.

const { recommended } = require('@mjolnir/eslint-config/overrides');
{
  ...,
  "overrides": recommended
}

Babel (ES)

适用 babel 的项目, 处理的文件为: **/*.{js, jsx}.

const { babel } = require('@mjolnir/eslint-config/overrides');
{
  ...,
  "overrides": [
    babel
  ]
}

TypeScript

适用 typescript 的项目, 处理的文件为: **/*.ts?(x).

const { typescript } = require('@mjolnir/eslint-config/overrides');
{
  ...,
  "overrides": [
    typescript
  ]
}

React

适用于 react 项目, 处理的文件为: **/*.{js,jsx,ts,tsx}.

const { react } = require('@mjolnir/eslint-config/overrides');
{
  ...,
  "overrides": [
    react
  ]
}

Jest

适用于 Jest 项目，处理的文件类型: **/*.{spec,test}.{js,jsx,ts,tsx}.

const { jest } = require('@mjolnir/eslint-config/overrides');
{
  ...,
  "overrides": [
    jest
  ]
}

mdx

适用于 mdx 文件，处理的文件类型: *.mdx.

const { mdx } = require('@mjolnir/eslint-config/overrides');
{
  ...,
  "overrides": [
    mdx
  ]
}