@gogogosir/eslint-config v1.0.0-alpha.12

@gogogosir/eslint-config

🚀 实现的功能

• 集成 js 语法校验
• 集成 json、jsonc、json5 语法校验
• 集成 typescript 语法校验
• 集成 vue 语法校验
• 集成 tailwindcss 语法校验

安装

yarn add eslint @gogogosir/eslint-config -D

配置 .eslintrc.js 或 .eslintrc.cjs

module.exports = {
  'extends': [
    '@gogogosir'
  ]
}

在 package.json 中添加命令

举例 :

{
  "scripts": {
    "lint": "eslint .",
    "lint:fix": "eslint . --fix"
  }
}

配置 vscode

确保在 vscode 中有安装以下插件

• ESLint

• Prettier - Code formatter

• Format Code Action prettier-vscode issue

在根目录创建一个 .vscode/settings.json

{
  "prettier.enable": true,
  "editor.formatOnSave": false,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "vetur.format.defaultFormatter.html": "none",
  "vetur.format.defaultFormatter.ts": "none",
  "vetur.format.defaultFormatter.js": "none",
  "vetur.format.defaultFormatter.css": "prettier",
  "vetur.format.defaultFormatter.postcss": "prettier",
  "vetur.format.defaultFormatter.less": "prettier",
  "vetur.format.defaultFormatter.scss": "prettier",
  // 保存修复
  "editor.codeActionsOnSave": [
    "source.formatDocument",
    "source.fixAll.eslint"
  ],
  "eslint.validate": [
    "typescript",
    "javascript",
    "javascriptreact",
    "typescriptreact",
    "json",
    "jsonc",
    "json5"
  ]
}

Q&A

1. 配置了eslint校验不生效 ?

• 请升级 eslint 的版本必须大于 8.0.1, typescript 的版本必须大于 3.9

• 如果你项目本身安装了 @typescript-eslint/eslint-plugin 、@typescript-eslint/parser 、eslint-plugin-vue 这几个插件，请卸载它，因为该库已经依赖了这些库，以免因为版本不同而冲突