eslint-config

介绍

Eslint 配置。

软件架构

基于 @antfu/eslint-config 配置 eslint 。

安装教程

注意：因为 @antfu/eslint-config 中的部分依赖需要用到 typescript ，所以项目即使未使用到也必须安装，否则将引起 vscode eslint 服务报错！

# npm
npm i -D eslint eslint-define-config typescript @lei-xx/eslint-config
# yarn | pnpm
pnpm add -D eslint eslint-define-config typescript @lei-xx/eslint-config

使用说明

手动创建 eslint 配置文件。

// .eslintrc.js
const { defineConfig } = require('eslint-define-config')

module.exports = defineConfig({
  extends: ['@lei-xx']
})

命令行初始化配置文件，加上 --install 参数可自动安装 eslint 相关依赖。

# npm
npx lei-eslint init --install
# yarn
yarn lei-eslint init --install
# pnpm
pnpm lei-eslint init --install

配合 prettier 使用时，通过 -p 或 --prettier 参数生成 prettier 配置文件。

# npm
npx lei-eslint init -p
# yarn
yarn lei-eslint init -p
# pnpm
pnpm lei-eslint init -p

在 vscode 中，使用 prettier 作为默认格式化工具，配合保存时 eslint 代码自动修复可达到最佳效果。

// .vscode/settings.json
{
  "eslint.alwaysShowStatus": true,
  "eslint.format.enable": true,
  "files.autoSave": "onWindowChange",
  "editor.formatOnSave": true,
  "editor.wordWrapColumn": 100,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}