vue项目eslint格式化最全注释!拿走不谢

JavaScript语言因为其灵活,怎么写都不会错的特点深受开发人员喜爱,然而过于灵活也会导致一些难以排查的bug。好的代码风格能够帮我们解决这些问题(typeScript:没错,正是在下!)雾~~

代码检查是一种静态的分析,常用于寻找有问题的模式或者代码,并且不依赖于具体的编码风格。eslint附有大量开箱即用的配置规则帮助我们检查代码,但每次需要翻阅长长的文档颇为麻烦,我根据网络把大部分能用到的配置全部以注释的形式记录下来,供大家参考。

在配置文件中可以设置一些规则。

这些规则的等级有三种:

1、"off" 或者 0:关闭规则。

2、"warn" 或者 1:打开规则,并且作为一个警告(不影响exit code)。

3、"error" 或者 2:打开规则,并且作为一个错误(exit code将会是1)。

也可以临时关闭eslint检查,代码如下


/* eslint-disable */
// 关闭检查开始位置
alert('foo');
// 关闭检查结束位置
/* eslint-enable */


//下面的注释可以关闭某行的规则
alert('foo'); // eslint-disable-line
// eslint-disable-next-line
alert('foo');


//下面的注释可以关闭某行的指定规则
alert('foo'); // eslint-disable-line no-alert
// eslint-disable-next-line no-alert
alert('foo');

有关eslint怎么安装等问题不在本文考虑范围内,自行出门左转搜索查询~

下面就是规则附录

// https://eslint.org/docs/user-guide/configuring


module.exports = {
  // *
  // * 默认情况下,ESLint会在所有父级目录里寻找配置文件,一直到根目录。   
  // * 为了将ESLint限制在一个特定的项目,设置root: true;   
  // * ESLint一旦发现配置文件中有 root: true,就会停止在父级目录中寻找。   
  // *
  root: true,
  // 指定解析器  
  // babel-ESLint: 一个对Babel解析器的包装,使其能够与ESLint兼容。  
  // parser: 'babel-eslint',  
  // 设置解析器能帮助ESLint确定什么是解析错误。  
  parserOptions: {
    parser: 'babel-eslint',
    // 指定js版本。语法上的支持    
    ecmaVersion: 6
  },
  // 脚本在执行期间访问的额外的全局变量  
  // globals: {},  
  // env: 指定脚本的运行环境  
  env: {
    // 一个环境定义了一组预定义的全局变量。    
    browser: true,
    // 会自动开启es6语法支持。    
    es6: true,
    node: true
  },
  // 使用第三方插件。全局安装的 ESLint 实例只能使用全局安装的ESLint插件。本地同理,不支持混用。  
  plugins: ['html', 'vue'],
  // 配置文件从基础配置中继承已启用的规则。  
  // *   
  // * eslint:recommended  启用核心规则,在规则页面中被标记为 √ 的。   
  // *
  extends: [
    // plugin:(此处不能有空格)包名/配置名称。解析时plugin是解析成 eslint-plugin-vue。如果有空格会解析失败,eslint-plugin- vue。    
    // plugin可以省略包名的前缀 eslint-plugin-    
    'plugin:vue/essential',
    'eslint:recommended',
    'standard'
    // 也可以指定另一个基本配置文件的绝对路径或相对路径  
  ],
  // *   
  // * 每个规则有【3】个错误级别。   
  // * off或0: 关闭该规则;   
  // * warn或1: 开启规则,使用警告级别的错误,不会导致程序退出;   
  // * error或2: 开启规则,使用错误级别的错误,当被触发的时候,程序会退出。   
  // *
  rules: {
    // *     
    // * 【==== Possible Errors ====】     
  
  • 3
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值