@linxuwen/eslint-config

[![CI][ci-image]][ci-url] ![npm][npm-image] [![downloads][downloads-image]][downloads-url] [![javascript_code style][code-style-image]][code-style-url]

特性

• "双引号"，必须加分号;
• 格式化的自动修复（旨在独立使用，不需要Prettier）。
• TypeScript，Vue开箱即用
• 对 JSON、YAML、Markdown也支持格式化
• 导入自动排序，需要尾随逗号，更干净的提交差异
• 合理的默认值，最佳实践，只有一行的配置

如何使用

可共享的配置被设计在.eslintrc文件的extends。 你可以了解更多关于 Shareable Configs 在 官方ESLint网站上

运行以下命令开始使用:

安装

pnpm add -D eslint @linxuewen/eslint-config

在你的.eslintrc文件中加入这个。

{
  "extends": "@linxuewen"
}

你通常不需要.eslintignore，因为它已经由预设提供了。

为package.json添加脚本配置

例如:

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

在Vscode中 配置自动修复

创建 .vscode/settings.json

{
  "prettier.enable": false,
  "editor.formatOnSave": false,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

自定义规则

在你的.eslintrc文件中添加你喜欢的规则。

{
  "extends": [
    "@linxuewen"
  ],
  "rules": {
    "vue/component-tags-order": ["error", {
      "order": ["template", "script", "style"]
    }]
  }
}

TypeScript Aware Rules

当在项目根目录中找到tsconfig.eslint.json时，将启用Type Aware Rules

致谢

本项目基于 @antfu/eslint-config

开源协议

MIT License © 2019-PRESENT