1 Star 0 Fork 0

KirkLin/eslint-config

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

@kirklin/eslint-config

CI npm downloads javascript_code style

English | 简体中文

特性

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

如何使用

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

运行以下命令开始使用:

安装

pnpm add -D eslint @kirklin/eslint-config

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

{
  "extends": "@kirklin"
}

你通常不需要.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": [
    "@kirklin"
  ],
  "rules": {
    "vue/component-tags-order": ["error", {
      "order": ["template", "script", "style"]
    }]
  }
}

TypeScript Aware Rules

当在项目根目录中找到tsconfig.eslint.json时,将启用Type Aware Rules, 参阅此处.

徽章

在你的README中包括一个这样的徽章,以便让人们知道你的代码使用的是哪种ESLint样式。

kirklin-code-style-image

[![kirklin-code-style-image](https://img.shields.io/badge/code__style-%40kirklin%2Feslint--config-brightgreen)](https://github.com/kirklin/eslint-config/)

致谢

本项目基于 @antfu/eslint-config

开源协议

MIT License © 2019-PRESENT Kirk Lin

MIT License Copyright (c) 2019-PRESENT Kirk Lin<https://github.com/kirklin> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

Kirk Lin's ESLint config presets 展开 收起
JavaScript 等 2 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
JavaScript
1
https://gitee.com/kirklin/eslint-config.git
git@gitee.com:kirklin/eslint-config.git
kirklin
eslint-config
eslint-config
master

搜索帮助