1.1.6 • Published 1 year ago

eslint-config-jiang v1.1.6

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

eslint-config-jiang

本包使用是基于 eslint-config-ali,提供了多套配置文件以支持 JavaScript、TypeScript、React、Vue、Node.js 等多种项目类型。并添加部分自定义规则。

安装依赖
npm i -D eslint-config-jiang 

JavaScript

针对未使用 React 或 Vue 的原生 JavaScript 项目,使用 ESLint 原生规则和 eslint-plugin-import 规则,使用 @babel/eslint-parser 作为 parser,是本包的默认配置。

配置
{
  "extends": ["eslint-config-jiang"]
}

React

针对 JS React 项目,继承了默认配置,并启用了 eslint-plugin-reacteslint-plugin-react-hooks 的规则。

配置
{
  "extends": ["eslint-config-jiang/react"]
}

Vue

针对 JS Vue 的项目,继承了默认配置,并启用了 eslint-plugin-vue 插件的规则,使用 vue-eslint-parser 作为 parser。

配置
{
  "extends": ["eslint-config-jiang/vue"]
}

node

针对 Node.js 项目,继承了默认配置和 egg-config-egg 的 node 规则,规则由 ESLint 原生规则和 eslint-plugin-node 提供。

配置
{
  "extends": ["eslint-config-jiang/node"]
}

TypeScript

针对未使用 React 或 Vue 的 TypeScript 项目,继承了默认配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

配置
{
  "extends": ["eslint-config-jiang/typescript"]
}

需保证项目已安装 typescript 依赖,另外如果项目的 TS 配置文件不是 ./tsconfig.json,则需要设置 .eslintrc 中的 parserOptions.project 字段 ,例如:

{
  "extends": "eslint-config-jiang/typescript",
  "parserOptions": {
    "project": "./tsconfig.eslint.json"
  }
}

React ( TypeScript )

针对 TS React 项目,继承了 JS React 的配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

配置
{
  "extends": ["eslint-config-jiang/typescript-react"]
}

Vue ( TypeScript )

针对 TS Vue 项目,继承了 JS Vue 的配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

配置
{
  "extends": ["eslint-config-jiang/typescript-vue"]
}

Node ( TypeScript )

针对未使用 React 和 Vue 的 TypeScript(Node) 项目,继承了 JS Node.js 配置,并启用了 @typescript-eslint/eslint-plugin 插件的规则,使用 @typescript-eslint/parser 作为 parser。

配置
{
  "extends": ["eslint-config-jiang/typescript-node"]
}