Eslint 从入门到放弃

原创 2017年01月20日 21:22:35

前言

ESLint 由 JavaScript 红宝书 作者 Nicholas C. Zakas 编写, 2013 年发布第一个版本。 NCZ 的初衷不是重复造一个轮子,而是在实际需求得不到 JSHint 团队响应 的情况下做出的选择:以可扩展、每条规则独立、不内置编码风格为理念编写一个 lint 工具。

中文官方网站

英文官方网站

可以去上方网站进行相关资料查阅,长话短说,直接开始入门吧~

安装

建议采用全局安装方式

npm install -g eslint

初始化

如果你的项目还没有配置文件(.eslintrc)的话,可以通过指定–init参数来生成一个新的配置文件:

eslint --init

运行eslint –init后,会在当前目录下生成一个.eslintrc文件,你可以在这个文件中配置一些规则。

配置

ESLint被设计为完全可配置的,主要有两种方式来配置ESLint:

  1. 内嵌配置:将配置信息以注释的形式写在要检验的文件内
  2. 文件配置:利用javascript、json、yml语言的语法,生成名为.eslintrc.*的配置文件,将配置信息写到文件内

文件配置方式

env:你的脚本将要运行在什么环境中

Environment可以预设好的其他环境的全局变量,如brower、node环境变量、es6环境变量、mocha环境变量等

'env': {
    'browser': true,
    'commonjs': true,
    'es6': true
  },

globals:额外的全局变量

示例:

globals: {
    vue: true,
    wx: true
  },

rules:开启规则和发生错误时报告的等级

示例:

'rules': {
    // no-var
    'no-var': 'error',
    // 要求或禁止 var 声明中的初始化
    'init-declarations': 2,
    // 强制使用单引号
    'quotes': ['error', 'single'],
    // 要求或禁止使用分号而不是 ASI
    'semi': ['error', 'never'],
    // 禁止不必要的分号
    'no-extra-semi': 'error',
    // 强制使用一致的换行风格
    'linebreak-style': ['error', 'unix'],
    // 空格2个
    'indent': ['error', 2, {'SwitchCase': 1}],
    // 指定数组的元素之间要以空格隔开(,后面), never参数:[ 之前和 ] 之后不能带空格,always参数:[ 之前和 ] 之后必须带空格
    'array-bracket-spacing': [2, 'never'],
    // 在块级作用域外访问块内定义的变量是否报错提示
    'block-scoped-var': 0,
    // if while function 后面的{必须与if在同一行,java风格。
    'brace-style': [2, '1tbs', {'allowSingleLine': true}],
    // 双峰驼命名格式
    'camelcase': 2,
    // 数组和对象键值对最后一个逗号, never参数:不能带末尾的逗号, always参数:必须带末尾的逗号, 
    'comma-dangle': [2, 'never'],
    // 控制逗号前后的空格
    'comma-spacing': [2, {'before': false, 'after': true}],
    // 控制逗号在行尾出现还是在行首出现
    'comma-style': [2, 'last'],
    // 圈复杂度
    'complexity': [2, 9],
    // 以方括号取对象属性时,[ 后面和 ] 前面是否需要空格, 可选参数 never, always
    'computed-property-spacing': [2, 'never'],
    // TODO 关闭 强制方法必须返回值,TypeScript强类型,不配置
    // 'consistent-return': 0
  }

规则的错误等级有三种:

0或'off':关闭规则。
1或'warn':打开规则,并且作为一个警告(并不会导致检查不通过)。
2或'error':打开规则,并且作为一个错误 (退出码为1,检查不通过)。

参数说明:

参数1 : 错误等级
参数2 : 处理方式

"comma-dangle": ["error", "never"],

上述配置只是简要将最基本的一些配置罗略出来,如果有需要建议去上方官网中查看。

配置代码注释方式

有时我们可能要在代码中忽略eslint的某种检查,或者加入某种特定检查,此时我们可以用如下的方式:

示例:

  1. 忽略 no-undef 检查
/* eslint-disable no-undef */ 
  1. 忽略 no-new 检查
/* eslint-disable no-new */ 
  1. 设置检查
/*eslint eqeqeq: off*/
/*eslint eqeqeq: 0*/

eslint 检查指令

  1. 检查且修复
eslint * --fix
  1. 检查指定文件
eslint app.js --fix

开发工具上的使用

WebStorm

Preferences -> Languages & Frameworks -> JavaScript -> Code Quality Tools -> Eslint -> Enable (勾选) -> Apply -> OK

Atom

安装linter-eslint

Sublime

安装SublimeLinter

安装SublimeLinter-contrib-eslint

结语

Eslint 对于每一个开发者而言都是非常值得使用的,这样会强制你写出高质量且整洁的代码,所以建议无论大家是前端开发者、weex开发者、还是小程序开发者都建议大家讲Eslint集成进入,来提高项目的质量。

版权声明:本文为博主原创文章,未经博主允许不得转载。

JAVA 从入门到放弃?

这是博客里的第一篇文章。主要是介绍一下我从JAVA零基础到工作四个月之间这一段事情。后面会陆续写一些工作之中用到的一些东西和记录一些自己学习相关技术的文章。目的是为能够跟别人一起多交流分享学习经验,共...
  • HelloWorld_In_Java
  • HelloWorld_In_Java
  • 2016年11月12日 13:58
  • 12331

Python从入门到放弃(一):概论

Python编程基础概念
  • xierhacker
  • xierhacker
  • 2016年07月12日 11:11
  • 5488

sublime整合eslint

  • 2016年05月20日 17:00
  • 147KB
  • 下载

web学习笔记05-EsLint规则与配置

1.EsLint规则     ESLint Rules     所有的规则默认都是禁用的。在配置文件中,使用 "extends": "eslint:recommended" 来启用推荐的规则,...
  • osdfhv
  • osdfhv
  • 2018年01月06日 19:10
  • 135

如何在vscode中配置ESLint

1、首先我们需要安装ESLint,我使用的是在全局中安装,在命令行中输入:npm i eslint -g //先全局安装eslint cd yourpath //进入你的文件目录 esli...
  • NeroSolomon
  • NeroSolomon
  • 2017年12月28日 21:46
  • 30

eslint 安装配置(JS代码质量检测工具)

eslint注:这里不讲eslint的知识,仅仅讲使用一、安装(以下是全局的,同时安装到项目中–save-dev) npm install eslint -g npm install eslint-p...
  • fay462298322
  • fay462298322
  • 2017年07月12日 09:36
  • 586

Eslint 配置及规则说明

中文官方网站安装可以全局安装,也可以在项目下面安装。 如下是在项目中安装示例,只需要在 package.json 中添加如下配置,并进行安装: “eslint”: “^4.11.0” 配置配置方...
  • hsl0530hsl
  • hsl0530hsl
  • 2017年11月21日 17:33
  • 232

ESLint在Vue中的使用详解

ESLint的用途 1.审查代码是否符合编码规范和统一的代码风格; 2.审查代码是否存在语法错误; 中文网地址 http://eslint.cn/ 使用VSCode编译器在Vue项目中...
  • IT_HLM
  • IT_HLM
  • 2017年12月11日 20:53
  • 126

基于vue-cli的eslint设置

很多同学都非常不习惯eslint,这里为大家介绍一下eslint 一些语法规范还有一些配置项     很多同学都应该关注如何修改缩进标准,代码常常因为缩进标准而报错,那可以自己定义rule规...
  • MaJing_CUI
  • MaJing_CUI
  • 2017年12月20日 11:40
  • 50

eslint配置注意事项

4:1 error Parsing error: The keyword ‘import’ is reserved 确保.eslintrc文件存在,并且内容为 { "extends": "a...
  • suwu150
  • suwu150
  • 2017年11月20日 19:28
  • 575
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Eslint 从入门到放弃
举报原因:
原因补充:

(最多只允许输入30个字)