- 集成了 prettier,自动修复并格式化
- 多种预设的配置: JavaScript, TypeScript, Vue, React, ReactNative, Svelte and Solid
- 同样也可以格式化 html、json、yaml、markdown
- 首先安装 eslint 和 typescript 依赖
pnpm i -D eslint
pnpm i -D typescript
- 然后根据项目中使用的技术,安装下面的其中一个
pnpm i -D eslint-config-redon # 等同于 redon-ts
pnpm i -D eslint-config-redon-base # 基础的
pnpm i -D eslint-config-redon-ts # TypeScript
pnpm i -D eslint-config-redon-vue # Vue3
pnpm i -D eslint-config-redon-react # React
pnpm i -D eslint-config-redon-react-native # ReactNative
pnpm i -D eslint-config-redon-svelte # Svelte
pnpm i -D eslint-config-redon-solid # Solid
创建.eslintrc.js、.eslintrc.json、.eslintrc 任意一个文件即可
- .eslintrc.js
module.exports = {
extends: "redon", // redon-base | redon-ts | redon-vue | redon-react | redon-react-native | redon-svelte | redon-solid
};
- .eslintrc.json、.eslintrc
{
"extends": "redon" // redon-base | redon-ts | redon-vue | redon-react | redon-react-native | redon-svelte | redon-solid
}
通常不需要添加 .eslintignore 配置文件,因为已经预设了一些配置,如果项目需要,可以自行添加
下面是默认的别名配置(不需要添加),如果需要更改,请自行在 eslint 配置文件中按照下面的代码格式去变更别名
{
"settings": {
"import/resolver": {
"alias": {
"map": [
["~", "."],
["@", "./src"]
],
"extensions": [".js", ".jsx", ".mjs", ".ts", ".tsx", "mts", ".d.ts"]
}
}
}
}
{
"scripts": {
"lint": "eslint . --fix"
}
}
然后在项目中可以使用下面的命令对代码进行格式化修复
npm run lint # npm
yarn lint # yarn
pnpm lint # pnpm