项目如何引入eslint、配置、vscode格式化配置

本文详细介绍了如何配置eslint、引入airbnb风格指南,并在VSCode中设置自动格式化规则,以符合项目规范。同时,通过安装lint-staged和husky,实现了git提交前的eslint校验,确保代码质量。
摘要由CSDN通过智能技术生成

一、eslint安装配置

起初的安装按照官网提示操作即可:

1.安装

npm install eslint --save-dev
npx eslint --init 

按顺序安装和引入eslint即可,你会在外层发现一个.eslintrc.js文件

2.引入airbnb

npm i eslint-config-airbnb -S

这里我引用的是airbnb,当然你也可以根据需要引入其他eslint配置

3.设置相关eslint配置:

module.exports = {
  env: {
    browser: true,
    es2021: true,
  },
  extends: ['plugin:react/recommended', 'airbnb'], // 扩展这里加上airbnb
  parserOptions: {
    ecmaFeatures: {
      jsx: true,
    },
    ecmaVersion: 13,
    sourceType: 'module',
  },
  plugins: ['react'], // 我新建的项目为react
  rules: {
    quotes: ['error', 'single'], // 单双引号报错设置
    'no-unused-vars': 'warn', // 未引用变量警告设置
    'comma-dangle': ['off', 'never'], // 关闭末尾逗号的校验
  },
};

4.vscode安装eslint插件
上面三步设置完成后,你会发现在运行项目时,不规范的代码是会出现报错的,终端也会提示错误。
但vscode中却不提示报错信息,这是因为你还没有安装eslint插件
没有报错

在这里插入图片描述
安装好该插件以后,你会发现,你的代码里也就提示了eslint报错
在这里插入图片描述
到这为止,一个简单的eslint配置就结束了。如果需要其他配置,可以去官网搜索相关的配置设置,在.eslintrc.js中添加上即可~

二、vscode简单配置:

在vscode中编码过程,许多代码不规范的地方 大家都考虑格式化一下就好,但有些时候格式化的内容与项目eslint校验规则根本不对,这时候你需要在vscode设置里面进行一些配置了。

这里举个简单的例子:
项目eslint校验规则要求尽量使用「单引号」, 但格式化时,总是「双引号」优先,所以每次格式化都会将小伙伴辛苦敲打的引号自动格式化为双引号,并引起eslint报错,这里你就需要进行一些配置了:
在这里插入图片描述
这三步点击完后,这时你会进入一个json文件,你需要在最后添加你需要的格式化规则:

   "prettier.singleQuote": true, // 格式化强制单引号
    "editor.formatOnSave": true, // 保存自动格式化

(这里我例举两个规则,蛮实用的。 但是要注意** 第一次修改的小伙伴在它原来的末尾加个逗号,再添加哦)

三、git提交校验

git 提交前自动验证eslint
npm i lint-staged husky -save-dev
安装好之后,会自动在项目.git目录生成一个hock,这个hock会读取package.json中的内容
修改package.json文件,这时git commit时会自动对要提交的文件调用eslint检测并修复,如果还有报错的话会阻止代码提交,lint-staged只针对要提交的文件处理

这样,一个项目的eslint配置、格式化配置、编辑过程中保存自动格式化操作就完成了,就可以愉快的编辑代码了!~
希望对你有所帮助

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值