前端代码规范-eslint

前端代码规范-eslint

前言

使用

安装

本地安装(用到当前项目)

1
npm install eslint --save-dev

全局安装(用到所有项目。我们强制要求使用,推荐全局安装

1
npm install -g eslint

使用vscode编辑器是可以安装eslint插件,它在你写代码的时候就提示你代码是否符合eslint配置的规范
注意:使用vue-cli生成项目时,选择使用eslint就可以了

配置

  1. 使用.eslintrc 文件
    1
    eslint --init

init会生成.eslintrc 文件。使用vue-cli脚手架生成的项目会带有这个文件。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// https://eslint.org/docs/user-guide/configuring
module.exports = {
root: true,
parser: 'babel-eslint',
parserOptions: {
sourceType: 'module'
},
env: {
browser: true,
},
// https://github.com/standard/standard/blob/master/docs/RULES-en.md
// 主要使用标准的eslint规范
extends: 'standard',
// required to lint *.vue files
plugins: [
'html'
],
// add your custom rules here
'rules': {
// allow paren-less arrow functions
'arrow-parens': 0,
// allow async-await
'generator-star-spacing': 0,
// allow debugger during development
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0
}
}

  1. 直接在代码文件中定义
    2.1 禁用eslint
    1
    2
    3
    4
    /* eslint-disable */
    var a = 100;
    console.log(a);
    /* eslint-enable */

2.2 禁用一条规则

1
2
3
4
/*eslint-disable no-console */
var a = 100;
console.log(a);
/*eslint-enable no-console */

2.3 调整规则

1
2
3
/* eslint no-console:0 */
var a = 100;
console.log(a);

常用规则说明

1
2
3
4
“off” or 0 - 关闭(禁用)规则 
“warn” or 1 - 将规则视为一个警告(并不会导致检查不通过)
“error” or 2 - 将规则视为一个错误 (退出码为1,检查不通过)
有些规则还带有可选的参数。

Possible Errors 可能的错误或逻辑错误
no-cond-assign 禁止条件表达式中出现模棱两可的赋值操作符
no-console 禁用console
no-constant-condition 禁止在条件中使用常量表达式
no-debugger 禁用 debugger
no-dupe-args 禁止 function 定义中出现重名参数
no-dupe-keys 禁止对象字面量中出现重复的 key
no-duplicate-case 禁止出现重复的 case 标签
no-empty 禁止出现空语句块
no-ex-assign 禁止对 catch 子句的参数重新赋值
no-extra-boolean-cast 禁止不必要的布尔转换
no-extra-parens 禁止不必要的括号
no-extra-semi 禁止不必要的分号
no-func-assign 禁止对 function 声明重新赋值
no-inner-declarations 禁止在嵌套的块中出现变量声明或 function 声明
no-irregular-whitespace 禁止在字符串和注释之外不规则的空白
no-obj-calls 禁止把全局对象作为函数调用
no-sparse-arrays 禁用稀疏数组
no-prototype-builtins 禁止直接使用Object.prototypes 的内置属性
no-unexpected-multiline 禁止出现令人困惑的多行表达式
no-unreachable 禁止在return、throw、continue 和 break语句之后出现不可达代码
use-isnan 要求使用 isNaN() 检查 NaN
valid-typeof 强制 typeof 表达式与有效的字符串进行比较
—– —–
Best Practices 最佳实践
array-callback-return 强制数组方法的回调函数中有 return 语句
block-scoped-var 强制把变量的使用限制在其定义的作用域范围内
complexity 指定程序中允许的最大环路复杂度
consistent-return 要求 return 语句要么总是指定返回的值,要么不指定
curly 强制所有控制语句使用一致的括号风格
default-case 要求 switch 语句中有 default 分支
dot-location 强制在点号之前和之后一致的换行
dot-notation 强制在任何允许的时候使用点号
eqeqeq 要求使用 === 和 !==
guard-for-in 要求 for-in 循环中有一个 if 语句
no-alert 禁用 alert、confirm 和 prompt
no-case-declarations 不允许在 case 子句中使用词法声明
no-else-return 禁止 if 语句中有 return 之后有 else
no-empty-function 禁止出现空函数
no-eq-null 禁止在没有类型检查操作符的情况下与 null 进行比较
no-eval 禁用 eval()
no-extra-bind 禁止不必要的 .bind() 调用
no-fallthrough 禁止 case 语句落空
no-floating-decimal 禁止数字字面量中使用前导和末尾小数点
no-implicit-coercion 禁止使用短符号进行类型转换
no-implicit-globals 禁止在全局范围内使用 var 和命名的 function 声明
no-invalid-this: 禁止 this 关键字出现在类和类对象之外
no-lone-blocks 禁用不必要的嵌套块
no-loop-func 禁止在循环中出现 function 声明和表达式
no-magic-numbers 禁用魔术数字
no-multi-spaces 禁止使用多个空格
no-multi-str 禁止使用多行字符串
no-new 禁止在非赋值或条件语句中使用 new 操作符
no-new-func 禁止对 Function 对象使用 new 操作符
no-new-wrappers 禁止对 String,Number 和 Boolean 使用 new 操作符
no-param-reassign 不允许对 function 的参数进行重新赋值
no-redeclare 禁止使用 var 多次声明同一变量
no-return-assign 禁止在 return 语句中使用赋值语句
no-script-url 禁止使用 javascript: url
no-self-assign 禁止自我赋值
no-self-compare 禁止自身比较
no-sequences 禁用逗号操作符
no-unmodified-loop-condition 禁用一成不变的循环条件
no-unused-expressions 禁止出现未使用过的表达式
no-useless-call 禁止不必要的 .call() 和 .apply()
no-useless-concat 禁止不必要的字符串字面量或模板字面量的连接
vars-on-top 要求所有的 var 声明出现在它们所在的作用域顶部
—– —–
Strict Mode 使用严格模式和严格模式指
strict 要求或禁止使用严格模式指令
—– —–
Variables 变量声明
init-declarations 要求或禁止 var 声明中的初始化
no-catch-shadow 不允许 catch 子句的参数与外层作用域中的变量同名
no-restricted-globals 禁用特定的全局变量
no-shadow 禁止 var 声明 与外层作用域的变量同名
no-undef 禁用未声明的变量,除非它们在 /global / 注释中被提到
no-undef-init 禁止将变量初始化为 undefined
no-unused-vars 禁止出现未使用过的变量
no-use-before-define 不允许在变量定义之前使用它们
—– —–
Nodejs and CommonJS Node.js,CommonJS
global-require 要求 require() 出现在顶层模块作用域中
handle-callback-err 要求回调函数中有容错处理
no-mixed-requires 禁止混合常规 var 声明和 require 调用
no-new-require 禁止调用 require 时使用 new 操作符
no-path-concat 禁止对 dirname 和 filename进行字符串连接
no-restricted-modules 禁用指定的通过 require 加载的模块
—– —–
Stylistic Issues 风格指南
array-bracket-spacing 强制数组方括号中使用一致的空格
block-spacing 强制在单行代码块中使用一致的空格
brace-style 强制在代码块中使用一致的大括号风格
camelcase 强制使用骆驼拼写法命名约定
comma-spacing 强制在逗号前后使用一致的空格
comma-style 强制使用一致的逗号风格
computed-property-spacing 强制在计算的属性的方括号中使用一致的空格
eol-last 强制文件末尾至少保留一行空行
func-names 强制使用命名的 function 表达式
func-style 强制一致地使用函数声明或函数表达式
indent 强制使用一致的缩进
jsx-quotes 强制在 JSX 属性中一致地使用双引号或单引号
key-spacing 强制在对象字面量的属性中键和值之间使用一致的间距
keyword-spacing 强制在关键字前后使用一致的空格
linebreak-style 强制使用一致的换行风格
lines-around-comment 要求在注释周围有空行
max-depth 强制可嵌套的块的最大深度
max-len 强制一行的最大长度
max-lines 强制最大行数
max-nested-callbacks 强制回调函数最大嵌套深度
max-params 强制 function 定义中最多允许的参数数量
max-statements 强制 function 块最多允许的的语句数量
max-statements-per-line 强制每一行中所允许的最大语句数量
new-cap 要求构造函数首字母大写
new-parens 要求调用无参构造函数时有圆括号
newline-after-var 要求或禁止 var 声明语句后有一行空行
newline-before-return 要求 return 语句之前有一空行
newline-per-chained-call 要求方法链中每个调用都有一个换行符
no-array-constructor 禁止使用 Array 构造函数
no-continue 禁用 continue 语句
no-inline-comments 禁止在代码行后使用内联注释
no-lonely-if 禁止 if 作为唯一的语句出现在 else 语句中
no-mixed-spaces-and-tabs 不允许空格和 tab 混合缩进
no-multiple-empty-lines 不允许多个空行
no-negated-condition 不允许否定的表达式
no-plusplus 禁止使用一元操作符 ++ 和 –
no-spaced-func 禁止 function 标识符和括号之间出现空格
no-ternary 不允许使用三元操作符
no-trailing-spaces 禁用行尾空格
no-whitespace-before-property 禁止属性前有空白
object-curly-newline 强制花括号内换行符的一致性
object-curly-spacing 强制在花括号中使用一致的空格
object-property-newline 强制将对象的属性放在不同的行上
one-var 强制函数中的变量要么一起声明要么分开声明
one-var-declaration-per-line 要求或禁止在 var 声明周围换行
operator-assignment 要求或禁止在可能的情况下要求使用简化的赋值操作符
operator-linebreak 强制操作符使用一致的换行符
quote-props 要求对象字面量属性名称用引号括起来
quotes 强制使用一致的反勾号、双引号或单引号
require-jsdoc 要求使用 JSDoc 注释
semi 要求或禁止使用分号而不是 ASI
semi-spacing 强制分号之前和之后使用一致的空格
sort-vars 要求同一个声明块中的变量按顺序排列
space-before-blocks 强制在块之前使用一致的空格
space-before-function-paren 强制在 function的左括号之前使用一致的空格
space-in-parens 强制在圆括号内使用一致的空格
space-infix-ops 要求操作符周围有空格
space-unary-ops 强制在一元操作符前后使用一致的空格
spaced-comment 强制在注释中 // 或 /* 使用一致的空格

标准规范

  • 使用两个空格进行缩进。

    eslint: indent

    1
    2
    3
    function hello (name) {
    console.log('hi', name)
    }
  • 除需要转义的情况外,字符串统一使用单引号

    eslint: quotes

    1
    2
    console.log('hello there')
    $("<div class='box'>")
  • 不要定义未使用的变量

    eslint: no-unused-vars

    1
    2
    3
    function myFunction () {
    var result = something() // ✗ avoid
    }
  • 关键字后面加空格

    eslint: keyword-spacing

    1
    2
    if (condition) { ... }   // ✓ ok
    if(condition) { ... } // ✗ avoid
  • 函数声明时括号与函数名间加空格

    eslint: space-before-function-paren

    1
    2
    3
    4
    5
    function name (arg) { ... }   // ✓ ok
    function name(arg) { ... } // ✗ avoid

    run(function () { ... }) // ✓ ok
    run(function() { ... }) // ✗ avoid
  • 始终使用 === 替代 ==

    例外: obj == null 可以用来检查 null || undefined

    eslint: eqeqeq

    1
    2
    if (name === 'John')   // ✓ ok
    if (name == 'John') // ✗ avoid
    1
    2
    if (name !== 'John')   // ✓ ok
    if (name != 'John') // ✗ avoid
  • 字符串拼接操作符 (Infix operators) 之间要留空格。

    eslint: space-infix-ops

    1
    2
    3
    // ✓ ok
    var x = 2
    var message = 'hello, ' + name + '!'
    1
    2
    3
    // ✗ avoid
    var x=2
    var message = 'hello, '+name+'!'
  • 逗号后面加空格

    eslint: comma-spacing

    1
    2
    3
    // ✓ ok
    var list = [1, 2, 3, 4]
    function greet (name, options) { ... }
    1
    2
    3
    // ✗ avoid
    var list = [1,2,3,4]
    function greet (name,options) { ... }
  • else 关键字要与花括号保持在同一行。

    eslint: brace-style

    1
    2
    3
    4
    5
    6
    // ✓ ok
    if (condition) {
    // ...
    } else {
    // ...
    }
    1
    2
    3
    4
    5
    6
    7
    8
    9
    // ✗ avoid
    if (condition)
    {
    // ...
    }
    else
    {
    // ...
    }
  • 多行 if 语句的的括号不能省。

    eslint: curly

    1
    2
    // ✓ ok
    if (options.quiet !== true) console.log('done')
    1
    2
    3
    4
    // ✓ ok
    if (options.quiet !== true) {
    console.log('done')
    }
    1
    2
    3
    // ✗ avoid
    if (options.quiet !== true)
    console.log('done')
  • 不要丢掉异常处理中err参数。

    eslint: handle-callback-err

    1
    2
    3
    4
    5
    // ✓ ok
    run(function (err) {
    if (err) throw err
    window.alert('done')
    })
    1
    2
    3
    4
    // ✗ avoid
    run(function (err) {
    window.alert('done')
    })
  • 使用浏览器全局变量时加上 window. 前缀。

    Exceptions are: document, console and navigator.

    eslint: no-undef

    1
    window.alert('hi')   // ✓ ok
  • 不允许有连续多行空行

    eslint: no-multiple-empty-lines

    1
    2
    3
    // ✓ ok
    var value = 'hello world'
    console.log(value)
    1
    2
    3
    4
    5
    // ✗ avoid
    var value = 'hello world'


    console.log(value)
  • 对于三元运算符 ?: 与他们所负责的代码处于同一行

    eslint: operator-linebreak

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    // ✓ ok
    var location = env.development ? 'localhost' : 'www.api.com'

    // ✓ ok
    var location = env.development
    ? 'localhost'
    : 'www.api.com'

    // ✗ avoid
    var location = env.development ?
    'localhost' :
    'www.api.com'
  • 每个 var 关键字单独声明一个变量。

    eslint: one-var

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    // ✓ ok
    var silent = true
    var verbose = true

    // ✗ avoid
    var silent = true, verbose = true

    // ✗ avoid
    var silent = true,
    verbose = true
  • 条件语句中赋值语句使用括号包起来。这样使得代码更加清晰可读,而不会认为是将条件判断语句的全等号(===)错写成了等号(=)。

    eslint: no-cond-assign

    1
    2
    3
    4
    5
    6
    7
    8
    9
    // ✓ ok
    while ((m = text.match(expr))) {
    // ...
    }

    // ✗ avoid
    while (m = text.match(expr)) {
    // ...
    }
  • 单行代码块两边加空格

    eslint: block-spacing

    1
    2
    function foo () {return true}    // ✗ avoid
    function foo () { return true } // ✓ ok
  • 对于变量和函数名统一使用驼峰命名法

    eslint: camelcase

    1
    2
    3
    4
    5
    function my_function () { }    // ✗ avoid
    function myFunction () { } // ✓ ok

    var my_var = 'hello' // ✗ avoid
    var myVar = 'hello' // ✓ ok
  • 不允许有多余的行末逗号

    eslint: comma-dangle

    1
    2
    3
    var obj = {
    message: 'hello', // ✗ avoid
    }
  • 始终将逗号置于行末

    eslint: comma-style

    1
    2
    3
    4
    5
    6
    7
    8
    9
    var obj = {
    foo: 'foo'
    ,bar: 'bar' // ✗ avoid
    }

    var obj = {
    foo: 'foo',
    bar: 'bar' // ✓ ok
    }
  • 点号操作符须与属性需在同一行

    eslint: dot-location

    1
    2
    3
    4
    5
    console.
    log('hello') // ✗ avoid

    console
    .log('hello') // ✓ ok
  • 文件末尾留一空行

    elint: eol-last

  • 函数调用时标识符与括号间不留间隔

    eslint: func-call-spacing

    1
    2
    console.log ('hello') // ✗ avoid
    console.log('hello') // ✓ ok
  • 键值对当中冒号与值之间要留空白

    eslint: key-spacing

    1
    2
    3
    4
    var obj = { 'key' : 'value' }    // ✗ avoid
    var obj = { 'key' :'value' } // ✗ avoid
    var obj = { 'key':'value' } // ✗ avoid
    var obj = { 'key': 'value' } // ✓ ok
  • 构造函数要以大写字母开头

    eslint: new-cap

    1
    2
    3
    4
    5
    function animal () {}
    var dog = new animal() // ✗ avoid

    function Animal () {}
    var dog = new Animal() // ✓ ok
  • 无参的构造函数调用时要带上括号

    eslint: new-parens

    1
    2
    3
    function Animal () {}
    var dog = new Animal // ✗ avoid
    var dog = new Animal() // ✓ ok
  • 对象中定义了存值器,一定要对应的定义取值器

    eslint: accessor-pairs

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    var person = {
    set name (value) { // ✗ avoid
    this.name = value
    }
    }

    var person = {
    set name (value) {
    this.name = value
    },
    get name () { // ✓ ok
    return this.name
    }
    }
  • 子类的构造器中一定要调用 super

    eslint: constructor-super

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    class Dog {
    constructor () {
    super() // ✗ avoid
    }
    }

    class Dog extends Mammal {
    constructor () {
    super() // ✓ ok
    }
    }
  • 使用数组字面量而不是构造器

    eslint: no-array-constructor

    1
    2
    var nums = new Array(1, 2, 3)   // ✗ avoid
    var nums = [1, 2, 3] // ✓ ok
  • 避免使用 arguments.calleearguments.caller

    eslint: no-caller

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    function foo (n) {
    if (n <= 0) return

    arguments.callee(n - 1) // ✗ avoid
    }

    function foo (n) {
    if (n <= 0) return

    foo(n - 1)
    }
  • 避免对类名重新赋值

    eslint: no-class-assign

    1
    2
    class Dog {}
    Dog = 'Fido' // ✗ avoid
  • 避免修改使用 const 声明的变量

    eslint: no-const-assign

    1
    2
    const score = 100
    score = 125 // ✗ avoid
  • 避免使用常量作为条件表达式的条件(循环语句除外)

    eslint: no-constant-condition

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    if (false) {    // ✗ avoid
    // ...
    }

    if (x === 0) { // ✓ ok
    // ...
    }

    while (true) { // ✓ ok
    // ...
    }
  • 正则中不要使用控制符

    eslint: no-control-regex

    1
    2
    var pattern = /\x1f/    // ✗ avoid
    var pattern = /\x20/ // ✓ ok
  • 不要使用 debugger

    eslint: no-debugger

    1
    2
    3
    4
    function sum (a, b) {
    debugger // ✗ avoid
    return a + b
    }
  • 不要对变量使用 delete 操作

    eslint: no-delete-var

    1
    2
    var name
    delete name // ✗ avoid
  • 不要定义冗余的函数参数

    eslint: no-dupe-args

    1
    2
    3
    4
    5
    6
    7
    function sum (a, b, a) {  // ✗ avoid
    // ...
    }

    function sum (a, b, c) { // ✓ ok
    // ...
    }
  • 类中不要定义冗余的属性

    eslint: no-dupe-class-members

    1
    2
    3
    4
    class Dog {
    bark () {}
    bark () {} // ✗ avoid
    }
  • 对象字面量中不要定义重复的属性

    eslint: no-dupe-keys

    1
    2
    3
    4
    var user = {
    name: 'Jane Doe',
    name: 'John Doe' // ✗ avoid
    }
  • switch 语句中不要定义重复的 case 分支

    eslint: no-duplicate-case

    1
    2
    3
    4
    5
    switch (id) {
    case 1:
    // ...
    case 1: // ✗ avoid
    }
  • 同一模块有多个导入时一次性写完

    eslint: no-duplicate-imports

    1
    2
    3
    4
    import { myFunc1 } from 'module'
    import { myFunc2 } from 'module' // ✗ avoid

    import { myFunc1, myFunc2 } from 'module' // ✓ ok
  • 正则中不要使用空字符

    eslint: no-empty-character-class

    1
    2
    const myRegex = /^abc[]/      // ✗ avoid
    const myRegex = /^abc[a-z]/ // ✓ ok
  • 不要解构空值

    eslint: no-empty-pattern

    1
    2
    const { a: {} } = foo         // ✗ avoid
    const { a: { b } } = foo // ✓ ok
  • 不要使用 eval()

    eslint: no-eval

    1
    2
    eval( "var result = user." + propName ) // ✗ avoid
    var result = user[propName] // ✓ ok
  • catch 中不要对错误重新赋值

    eslint: no-ex-assign

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    try {
    // ...
    } catch (e) {
    e = 'new value' // ✗ avoid
    }

    try {
    // ...
    } catch (e) {
    const newVal = 'new value' // ✓ ok
    }
  • 不要扩展原生对象

    eslint: no-extend-native

    1
    Object.prototype.age = 21     // ✗ avoid
  • 避免多余的函数上下文绑定

    eslint: no-extra-bind

    1
    2
    3
    4
    5
    6
    7
    const name = function () {
    getName()
    }.bind(user) // ✗ avoid

    const name = function () {
    this.getName()
    }.bind(user) // ✓ ok
  • 避免不必要的布尔转换

    eslint: no-extra-boolean-cast

    1
    2
    3
    4
    5
    6
    7
    8
    9
    const result = true
    if (!!result) { // ✗ avoid
    // ...
    }

    const result = true
    if (result) { // ✓ ok
    // ...
    }
  • 不要使用多余的括号包裹函数

    eslint: no-extra-parens

    1
    2
    const myFunc = (function () { })   // ✗ avoid
    const myFunc = function () { } // ✓ ok
  • switch 一定要使用 break 来将条件分支正常中断

    eslint: no-fallthrough

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    switch (filter) {
    case 1:
    doSomething() // ✗ avoid
    case 2:
    doSomethingElse()
    }

    switch (filter) {
    case 1:
    doSomething()
    break // ✓ ok
    case 2:
    doSomethingElse()
    }

    switch (filter) {
    case 1:
    doSomething()
    // fallthrough // ✓ ok
    case 2:
    doSomethingElse()
    }
  • 不要省去小数点前面的0

    eslint: no-floating-decimal

    1
    2
    const discount = .5      // ✗ avoid
    const discount = 0.5 // ✓ ok
  • 避免对声明过的函数重新赋值

    eslint: no-func-assign

    1
    2
    function myFunc () { }
    myFunc = myOtherFunc // ✗ avoid
  • 不要对全局只读对象重新赋值

    eslint: no-global-assign

    1
    window = {}     // ✗ avoid
  • 注意隐式的 eval()

    eslint: no-implied-eval

    1
    2
    setTimeout("alert('Hello world')")                   // ✗ avoid
    setTimeout(function () { alert('Hello world') }) // ✓ ok
  • 嵌套的代码块中禁止再定义函数

    eslint: no-inner-declarations

    1
    2
    3
    if (authenticated) {
    function setAuthUser () {} // ✗ avoid
    }
  • 不要向 RegExp 构造器传入非法的正则表达式

    eslint: no-invalid-regexp

    1
    2
    RegExp('[a-z')    // ✗ avoid
    RegExp('[a-z]') // ✓ ok
  • 不要使用非法的空白符

    eslint: no-irregular-whitespace

    1
    function myFunc () /*<NBSP>*/{}   // ✗ avoid
  • 禁止使用 __iterator__

    eslint: no-iterator

    1
    Foo.prototype.__iterator__ = function () {}   // ✗ avoid
  • 外部变量不要与对象属性重名

    eslint: no-label-var

    1
    2
    3
    4
    var score = 100
    function game () {
    score: 50 // ✗ avoid
    }
  • 不要使用标签语句

    eslint: no-labels

    1
    2
    3
    4
    label:
    while (true) {
    break label // ✗ avoid
    }
  • 不要书写不必要的嵌套代码块

    eslint: no-lone-blocks

    1
    2
    3
    4
    5
    6
    7
    8
    9
    function myFunc () {
    { // ✗ avoid
    myOtherFunc()
    }
    }

    function myFunc () {
    myOtherFunc() // ✓ ok
    }
  • 不要混合使用空格与制表符作为缩进

    eslint: no-mixed-spaces-and-tabs

  • 除了缩进,不要使用多个空格

    eslint: no-multi-spaces

    1
    2
    const id =    1234    // ✗ avoid
    const id = 1234 // ✓ ok
  • 不要使用多行字符串

    eslint: no-multi-str

    1
    2
    const message = 'Hello \
    world' // ✗ avoid
  • new 创建对象实例后需要赋值给变量

    eslint: no-new

    1
    2
    new Character()                     // ✗ avoid
    const character = new Character() // ✓ ok
  • 禁止使用 Function 构造器

    eslint: no-new-func

    1
    var sum = new Function('a', 'b', 'return a + b')    // ✗ avoid
  • 禁止使用 Object 构造器

    eslint: no-new-object

    1
    let config = new Object()   // ✗ avoid
  • 禁止使用 new require

    eslint: no-new-require

    1
    const myModule = new require('my-module')    // ✗ avoid
  • 禁止使用 Symbol 构造器

    eslint: no-new-symbol

    1
    const foo = new Symbol('foo')   // ✗ avoid
  • 禁止使用原始包装器

    eslint: no-new-wrappers

    1
    const message = new String('hello')   // ✗ avoid
  • 不要将全局对象的属性作为函数调用

    eslint: no-obj-calls

    1
    const math = Math()   // ✗ avoid
  • 不要使用八进制字面量

    eslint: no-octal

    1
    2
    const num = 042     // ✗ avoid
    const num = '042' // ✓ ok
  • 字符串字面量中也不要使用八进制转义字符

    eslint: no-octal-escape

    1
    const copyright = 'Copyright \251'  // ✗ avoid
  • 使用 __dirname__filename 时尽量避免使用字符串拼接

    eslint: no-path-concat

    1
    2
    const pathToFile = __dirname + '/app.js'            // ✗ avoid
    const pathToFile = path.join(__dirname, 'app.js') // ✓ ok
  • 使用 getPrototypeOf 来替代 __proto__

    eslint: no-proto

    1
    2
    const foo = obj.__proto__               // ✗ avoid
    const foo = Object.getPrototypeOf(obj) // ✓ ok
  • 不要重复声明变量

    eslint: no-redeclare

    1
    2
    3
    4
    5
    let name = 'John'
    let name = 'Jane' // ✗ avoid

    let name = 'John'
    name = 'Jane' // ✓ ok
  • 正则中避免使用多个空格

    eslint: no-regex-spaces

    1
    2
    3
    4
    const regexp = /test   value/   // ✗ avoid

    const regexp = /test {3}value/ // ✓ ok
    const regexp = /test value/ // ✓ ok
  • return 语句中的赋值必需有括号包裹

    eslint: no-return-assign

    1
    2
    3
    4
    5
    6
    7
    function sum (a, b) {
    return result = a + b // ✗ avoid
    }

    function sum (a, b) {
    return (result = a + b) // ✓ ok
    }
  • 避免将变量赋值给自己

    eslint: no-self-assign

    1
    name = name   // ✗ avoid
  • 避免将变量与自己进行比较操作

    esint: no-self-compare

    1
    if (score === score) {}   // ✗ avoid
  • 避免使用逗号操作符

    eslint: no-sequences

    1
    if (doSomething(), !!test) {}   // ✗ avoid
  • 不要随意更改关键字的值

    eslint: no-shadow-restricted-names

    1
    let undefined = 'value'     // ✗ avoid
  • 禁止使用稀疏数组(Sparse arrays)

    eslint: no-sparse-arrays

    1
    let fruits = ['apple',, 'orange']       // ✗ avoid
  • 不要使用制表符

    eslint: no-tabs

  • 正确使用 ES6 中的字符串模板

    eslint: no-template-curly-in-string

    1
    2
    const message = 'Hello ${name}'   // ✗ avoid
    const message = `Hello ${name}` // ✓ ok
  • 使用 this 前请确保 super() 已调用

    eslint: no-this-before-super

    1
    2
    3
    4
    5
    6
    class Dog extends Animal {
    constructor () {
    this.legs = 4 // ✗ avoid
    super()
    }
    }
  • throw 抛错时,抛出 Error 对象而不是字符串

    eslint: no-throw-literal

    1
    2
    throw 'error'               // ✗ avoid
    throw new Error('error') // ✓ ok
  • 行末不留空格

    eslint: no-trailing-spaces

  • 不要使用 undefined 来初始化变量

    eslint: no-undef-init

    1
    2
    3
    4
    let name = undefined    // ✗ avoid

    let name
    name = 'value' // ✓ ok
  • 循环语句中注意更新循环变量

    eslint: no-unmodified-loop-condition

    1
    2
    for (let i = 0; i < items.length; j++) {...}    // ✗ avoid
    for (let i = 0; i < items.length; i++) {...} // ✓ ok
  • 如果有更好的实现,尽量不要使用三元表达式

    eslint: no-unneeded-ternary

    1
    2
    let score = val ? val : 0     // ✗ avoid
    let score = val || 0 // ✓ ok
  • returnthrowcontinuebreak 后不要再跟代码

    eslint: no-unreachable

    1
    2
    3
    4
    function doSomething () {
    return true
    console.log('never called') // ✗ avoid
    }
  • finally 代码块中不要再改变程序执行流程

    eslint: no-unsafe-finally

    1
    2
    3
    4
    5
    6
    7
    try {
    // ...
    } catch (e) {
    // ...
    } finally {
    return 42 // ✗ avoid
    }
  • 关系运算符的左值不要做取反操作

    eslint: no-unsafe-negation

    1
    if (!key in obj) {}       // ✗ avoid
  • 避免不必要的 .call().apply()

    eslint: no-useless-call

    1
    sum.call(null, 1, 2, 3)   // ✗ avoid
  • 避免使用不必要的计算值作对象属性

    eslint: no-useless-computed-key

    1
    2
    const user = { ['name']: 'John Doe' }   // ✗ avoid
    const user = { name: 'John Doe' } // ✓ ok
  • 禁止多余的构造器

    eslint: no-useless-constructor

    1
    2
    3
    4
    class Car {
    constructor () { // ✗ avoid
    }
    }
  • 禁止不必要的转义

    eslint: no-useless-escape

    1
    let message = 'Hell\o'  // ✗ avoid
  • import, export 和解构操作中,禁止赋值到同名变量

    eslint: no-useless-rename

    1
    2
    import { config as config } from './config'     // ✗ avoid
    import { config } from './config' // ✓ ok
  • 属性前面不要加空格

    eslint: no-whitespace-before-property

    1
    2
    user .name      // ✗ avoid
    user.name // ✓ ok
  • 禁止使用 with

    eslint: no-with

    1
    with (val) {...}    // ✗ avoid
  • 对象属性换行时注意统一代码风格

    eslint: object-property-newline

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    const user = {
    name: 'Jane Doe', age: 30,
    username: 'jdoe86' // ✗ avoid
    }

    const user = { name: 'Jane Doe', age: 30, username: 'jdoe86' } // ✓ ok

    const user = {
    name: 'Jane Doe',
    age: 30,
    username: 'jdoe86'
    } // ✓ ok
  • 代码块中避免多余留白

    eslint: padded-blocks

    1
    2
    3
    4
    5
    6
    7
    8
    9
    if (user) {
    // ✗ avoid
    const name = getName()

    }

    if (user) {
    const name = getName() // ✓ ok
    }
  • 展开运算符与它的表达式间不要留空白

    eslint: rest-spread-spacing

    1
    2
    fn(... args)    // ✗ avoid
    fn(...args) // ✓ ok
  • 遇到分号时空格要后留前不留

    eslint: semi-spacing

    1
    2
    for (let i = 0 ;i < items.length ;i++) {...}    // ✗ avoid
    for (let i = 0; i < items.length; i++) {...} // ✓ ok
  • 代码块首尾留空格

    eslint: space-before-blocks

    1
    2
    if (admin){...}     // ✗ avoid
    if (admin) {...} // ✓ ok
  • 圆括号间不留空格

    eslint: space-in-parens

    1
    2
    getName( name )     // ✗ avoid
    getName(name) // ✓ ok
  • 一元运算符后面跟一个空格

    eslint: space-unary-ops

    1
    2
    typeof!admin        // ✗ avoid
    typeof !admin // ✓ ok
  • 注释首尾留空格

    eslint: spaced-comment

    1
    2
    3
    4
    5
    //comment           // ✗ avoid
    // comment // ✓ ok

    /*comment*/ // ✗ avoid
    /* comment */ // ✓ ok
  • 模板字符串中变量前后不加空格

    eslint: template-curly-spacing

    1
    2
    const message = `Hello, ${ name }`    // ✗ avoid
    const message = `Hello, ${name}` // ✓ ok
  • 检查 NaN 的正确姿势是使用 isNaN()

    eslint: use-isnan

    1
    2
    if (price === NaN) { }      // ✗ avoid
    if (isNaN(price)) { } // ✓ ok
  • 用合法的字符串跟 typeof 进行比较操作

    eslint: valid-typeof

    1
    2
    typeof name === 'undefimed'     // ✗ avoid
    typeof name === 'undefined' // ✓ ok
  • 自调用匿名函数 (IIFEs) 使用括号包裹

    eslint: wrap-iife

    1
    2
    3
    4
    const getName = function () { }()     // ✗ avoid

    const getName = (function () { }()) // ✓ ok
    const getName = (function () { })() // ✓ ok
  • yield * 中的 * 前后都要有空格

    eslint: yield-star-spacing

    1
    2
    yield* increment()    // ✗ avoid
    yield * increment() // ✓ ok
  • 请书写优雅的条件语句(avoid Yoda conditions)

    eslint: yoda

    1
    2
    if (42 === age) { }    // ✗ avoid
    if (age === 42) { } // ✓ ok

关于分号

  • 不要使用分号。 (参见:123)

    eslint: semi

    1
    2
    window.alert('hi')   // ✓ ok
    window.alert('hi'); // ✗ avoid
  • 不要使用 (, [, or ` 等作为一行的开始。在没有分号的情况下代码压缩后会导致报错,而坚持这一规范则可避免出错。

    eslint: no-unexpected-multiline

    1
    2
    3
    4
    5
    6
    7
    8
    9
    // ✓ ok
    ;(function () {
    window.alert('ok')
    }())

    // ✗ avoid
    (function () {
    window.alert('ok')
    }())
    1
    2
    3
    4
    5
    // ✓ ok
    ;[1, 2, 3].forEach(bar)

    // ✗ avoid
    [1, 2, 3].forEach(bar)
    1
    2
    3
    4
    5
    // ✓ ok
    ;`hello`.indexOf('o')

    // ✗ avoid
    `hello`.indexOf('o')
坚持原创技术分享,您的支持将鼓励我继续创作!