1.0.4 • Published 2 years ago

@vinsea/eslint-config-rules v1.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

eslint 规则

个人常用的一套比较严格的规则,可以直接用于实际项目中

使用

安装

npm install eslint @vinsea/eslint-config-rules -D

引用

引用方式 1: 在package.json中加入eslintConfig字段

{
    "eslintConfig": {
        "root": true,
        "extends": ["plugin:vue/essential", "@vinsea/rules"]
    }
}

引入方式 2: 编辑根目录下的.eslintrc.js

  1. 新建 .eslintrc.js,或通过 ./node_modules/.bin/eslint --init 生成;
  2. extends中添加:
module.exports = {
    root: true,
    extends: ['plugin:vue/essential', '@vinsea/rules']
};

配置文件优先级

如果同一个目录下有多个配置文件,ESLint 只会使用一个。优先级顺序如下:

  • .eslintrc.js
  • .eslintrc.yaml
  • .eslintrc.yml
  • .eslintrc.json
  • .eslintrc
  • package.json

⚠️ 注意

  1. 如果是vue项目,必须使用vue/essential规则;

  2. @vinsea/rules一定要放在数组最后;

  3. @vinsea/rules不是单词漏写(全称@vinsea/eslint-config-rules),是因为eslint在解析模块的时候会默认忽略 eslint-config- 这个前缀(还有eslint-plugin-);

  4. prettier只用来做代码风格,禁止使用eslint-config-prettiereslint-plugin-prettier来禁用 eslint 规则;

  5. 此插件已经包含parser配置:

parserOptions: {
    parser: '@babel/eslint-parser',
}

如果你的项目中也有,可以删掉,统一用此插件的配置

vs code 配置

查看 vs code 统一配置

.eslintignore

增加以下忽略配置

/build/
/config/
/dist/
/*.js
1.0.4

2 years ago

1.0.2

2 years ago