这是 JavaScript standard 代码规范的全文。
掌握本规范的最好方法是安装并在自己的代码中使用它。
细则
使用两个空格进行缩进。
eslint:
indent
{console}除需要转义的情况外,字符串统一使用单引号。
eslint:
quotes
console不要定义未使用的变量。
eslint:
no-unused-vars
{var result = // ✗ avoid}关键字后面加空格。
eslint:
keyword-spacing
if condition ... // ✓ okif condition ... // ✗ avoid函数声明时括号与函数名间加空格。
eslint:
space-before-function-paren
{ ... } // ✓ ok{ ... } // ✗ avoid// ✓ ok// ✗ avoid始终使用
===
替代==
。
例外:obj == null
可以用来检查null || undefined
。eslint:
eqeqeq
if name === 'John' // ✓ okif name == 'John' // ✗ avoidif name !== 'John' // ✓ okif name != 'John' // ✗ avoid字符串拼接操作符 (Infix operators) 之间要留空格。
eslint:
space-infix-ops
// ✓ okvar x = 2var message = 'hello, ' + name + '!'// ✗ avoidvar x=2var message = 'hello, '+name+'!'逗号后面加空格。
eslint:
comma-spacing
// ✓ okvar list = 1 2 3 4{ ... }// ✗ avoidvar list = 1234{ ... }else 关键字要与花括号保持在同一行。
eslint:
brace-style
// ✓ okif condition// ...else// ...}// ✗ avoidif condition{// ...}else{// ...}多行 if 语句的的括号不能省。
eslint:
curly
// ✓ okif optionsquiet !== true console// ✓ okif optionsquiet !== trueconsole}// ✗ avoidif optionsquiet !== trueconsole不要丢掉异常处理中
err
参数。eslint:
handle-callback-err
// ✓ ok// ✗ avoid使用浏览器全局变量时加上
window.
前缀。
Exceptions are:document
,console
andnavigator
.eslint:
no-undef
window // ✓ ok不允许有连续多行空行。
eslint:
no-multiple-empty-lines
// ✓ okvar value = 'hello world'console// ✗ avoidvar value = 'hello world'console对于三元运算符
?
和:
与他们所负责的代码处于同一行eslint:
operator-linebreak
// ✓ okvar location = envdevelopment ? 'localhost' : 'www.api.com'// ✓ okvar location = envdevelopment? 'localhost': 'www.api.com'// ✗ avoidvar location = envdevelopment ?'localhost' :'www.api.com'每个 var 关键字单独声明一个变量。
eslint:
one-var
// ✓ okvar silent = truevar verbose = true// ✗ avoidvar silent = true verbose = true// ✗ avoidvar silent = trueverbose = true条件语句中赋值语句使用括号包起来。这样使得代码更加清晰可读,而不会认为是将条件判断语句的全等号(
===
)错写成了等号(=
)。eslint:
no-cond-assign
// ✓ okwhile m = text// ...}// ✗ avoidwhile m = text// ...}单行代码块两边加空格。
eslint:
block-spacing
{return true} // ✗ avoid{ return true } // ✓ ok对于变量和函数名统一使用驼峰命名法。
eslint:
camelcase
{ } // ✗ avoid{ } // ✓ okvar my_var = 'hello' // ✗ avoidvar myVar = 'hello' // ✓ ok不允许有多余的行末逗号。
eslint:
comma-dangle
var obj =message: 'hello' // ✗ avoid始终将逗号置于行末。
eslint:
comma-style
var obj =foo: 'foo': 'bar' // ✗ avoid barvar obj =foo: 'foo'bar: 'bar' // ✓ ok点号操作符须与属性需在同一行。
eslint:
dot-location
console// ✗ avoidconsole// ✓ ok文件末尾留一空行。
elint:
eol-last
函数调用时标识符与括号间不留间隔。
eslint:
func-call-spacing
console // ✗ avoidconsole // ✓ ok键值对当中冒号与值之间要留空白。
eslint:
key-spacing
var obj = 'key' : 'value' // ✗ avoidvar obj = 'key' :'value' // ✗ avoidvar obj = 'key':'value' // ✗ avoidvar obj = 'key': 'value' // ✓ ok构造函数要以大写字母开头。
eslint:
new-cap
{}var dog = // ✗ avoid{}var dog = // ✓ ok无参的构造函数调用时要带上括号。
eslint:
new-parens
{}var dog = // ✗ avoidvar dog = // ✓ ok对象中定义了存值器,一定要对应的定义取值器。
eslint:
accessor-pairs
var person ={ // ✗ avoidthisname = value}}var person ={thisname = value}{ // ✓ okreturn thisname}}子类的构造器中一定要调用
super
eslint:
constructor-super
{super // ✗ avoid}}{super // ✓ ok}}使用数组字面量而不是构造器。
eslint:
no-array-constructor
var nums = 1 2 3 // ✗ avoidvar nums = 1 2 3 // ✓ ok避免使用
arguments.callee
和arguments.caller
。eslint:
no-caller
{if n <= 0 returnargumentscallee n - 1 // ✗ avoid}{if n <= 0 return}避免对类名重新赋值。
eslint:
no-class-assign
{}Dog = 'Fido' // ✗ avoid避免修改使用
const
声明的变量。eslint:
no-const-assign
const score = 100score = 125 // ✗ avoid避免使用常量作为条件表达式的条件(循环语句除外)。
eslint:
no-constant-condition
if false // ✗ avoid// ...}if x === 0 // ✓ ok// ...}while true // ✓ ok// ...}正则中不要使用控制符。
eslint:
no-control-regex
var pattern = /\x1f/ // ✗ avoidvar pattern = /\x20/ // ✓ ok不要使用
debugger
。eslint:
no-debugger
{debugger // ✗ avoidreturn a + b}不要对变量使用
delete
操作。eslint:
no-delete-var
var namedelete name // ✗ avoid不要定义冗余的函数参数。
eslint:
no-dupe-args
{ // ✗ avoid// ...}{ // ✓ ok// ...}类中不要定义冗余的属性。
eslint:
no-dupe-class-members
{}{} // ✗ avoid}对象字面量中不要定义重复的属性。
eslint:
no-dupe-keys
var user =name: 'Jane Doe'name: 'John Doe' // ✗ avoid}switch
语句中不要定义重复的case
分支。eslint:
no-duplicate-case
}同一模块有多个导入时一次性写完。
eslint:
no-duplicate-imports
正则中不要使用空字符。
eslint:
no-empty-character-class
const myRegex = /^abc[]/ // ✗ avoidconst myRegex = /^abc[a-z]/ // ✓ ok不要解构空值。
eslint:
no-empty-pattern
const a: = foo // ✗ avoidconst a: b = foo // ✓ ok不要使用
eval()
。eslint:
no-eval
// ✗ avoidvar result = user propName // ✓ okcatch
中不要对错误重新赋值。eslint:
no-ex-assign
try// ...catch ee = 'new value' // ✗ avoid}try// ...catch econst newVal = 'new value' // ✓ ok}不要扩展原生对象。
eslint:
no-extend-native
Objectprototypeage = 21 // ✗ avoid避免多余的函数上下文绑定。
eslint:
no-extra-bind
const name = {} // ✗ avoidconst name = {this} // ✓ ok避免不必要的布尔转换。
eslint:
no-extra-boolean-cast
const result = trueif !!result // ✗ avoid// ...}const result = trueif result // ✓ ok// ...}不要使用多余的括号包裹函数。
eslint:
no-extra-parens
const myFunc = { } // ✗ avoidconst myFunc = { } // ✓ okswitch
一定要使用break
来将条件分支正常中断。eslint:
no-fallthrough
}}}不要省去小数点前面的0。
eslint:
no-floating-decimal
const discount = 5// ✗ avoidconst discount = 0 5// ✓ ok避免对声明过的函数重新赋值。
eslint:
no-func-assign
{ }myFunc = myOtherFunc // ✗ avoid不要对全局只读对象重新赋值。
eslint:
no-global-assign
window = {} // ✗ avoid注意隐式的
eval()
。eslint:
no-implied-eval
// ✗ avoid// ✓ ok嵌套的代码块中禁止再定义函数。
eslint:
no-inner-declarations
if authenticated{} // ✗ avoid}不要向
RegExp
构造器传入非法的正则表达式。eslint:
no-invalid-regexp
RegExp'[a-z' // ✗ avoidRegExp'[a-z]' // ✓ ok不要使用非法的空白符。
eslint:
no-irregular-whitespace
/*<NBSP>*/{} // ✗ avoid禁止使用
__iterator__
。eslint:
no-iterator
Fooprototype {} // ✗ avoid外部变量不要与对象属性重名。
eslint:
no-label-var
var score = 100{score: 50 // ✗ avoid}不要使用标签语句。
eslint:
no-labels
label:while truebreak label // ✗ avoid不要书写不必要的嵌套代码块。
eslint:
no-lone-blocks
{// ✗ avoid}{// ✓ ok}不要混合使用空格与制表符作为缩进。
eslint:
no-mixed-spaces-and-tabs
除了缩进,不要使用多个空格。
eslint:
no-multi-spaces
const id = 1234 // ✗ avoidconst id = 1234 // ✓ ok不要使用多行字符串。
eslint:
no-multi-str
const message = 'Hello \world' // ✗ avoidnew
创建对象实例后需要赋值给变量。eslint:
no-new
// ✗ avoidconst character = // ✓ ok禁止使用
Function
构造器。eslint:
no-new-func
var sum = 'a' 'b' 'return a + b' // ✗ avoid禁止使用
Object
构造器。eslint:
no-new-object
let config = // ✗ avoid禁止使用
new require
。eslint:
no-new-require
const myModule = 'my-module' // ✗ avoid禁止使用
Symbol
构造器。eslint:
no-new-symbol
const foo = 'foo' // ✗ avoid禁止使用原始包装器。
eslint:
no-new-wrappers
const message = 'hello' // ✗ avoid不要将全局对象的属性作为函数调用。
eslint:
no-obj-calls
const math = Math // ✗ avoid不要使用八进制字面量。
eslint:
no-octal
const num = 042 // ✗ avoidconst num = '042' // ✓ ok字符串字面量中也不要使用八进制转义字符。
eslint:
no-octal-escape
const copyright = 'Copyright \251' // ✗ avoid使用
__dirname
和__filename
时尽量避免使用字符串拼接。eslint:
no-path-concat
const pathToFile = __dirname + '/app.js' // ✗ avoidconst pathToFile = path // ✓ ok使用
getPrototypeOf
来替代__proto__
。eslint:
no-proto
const foo = obj__proto__ // ✗ avoidconst foo = Object // ✓ ok不要重复声明变量。
eslint:
no-redeclare
let name = 'John'let name = 'Jane' // ✗ avoidlet name = 'John'name = 'Jane' // ✓ ok正则中避免使用多个空格。
eslint:
no-regex-spaces
const regexp = /test value/ // ✗ avoidconst regexp = /test {3}value/ // ✓ okconst regexp = /test value/ // ✓ okreturn 语句中的赋值必需有括号包裹。
eslint:
no-return-assign
{return result = a + b // ✗ avoid}{return result = a + b // ✓ ok}避免将变量赋值给自己。
eslint:
no-self-assign
name = name // ✗ avoid避免将变量与自己进行比较操作。
esint:
no-self-compare
if score === score {} // ✗ avoid避免使用逗号操作符。
eslint:
no-sequences
if !!test {} // ✗ avoid不要随意更改关键字的值。
eslint:
no-shadow-restricted-names
let undefined = 'value' // ✗ avoid禁止使用稀疏数组(Sparse arrays)。
eslint:
no-sparse-arrays
let fruits = 'apple' 'orange' // ✗ avoid不要使用制表符。
eslint:
no-tabs
正确使用 ES6 中的字符串模板。
eslint:
no-template-curly-in-string
const message = 'Hello ${name}' // ✗ avoidconst message = `Hello ` // ✓ ok使用
this
前请确保super()
已调用。eslint:
no-this-before-super
{thislegs = 4 // ✗ avoidsuper}}用
throw
抛错时,抛出Error
对象而不是字符串。eslint:
no-throw-literal
throw 'error' // ✗ avoidthrow 'error' // ✓ ok行末不留空格。
eslint:
no-trailing-spaces
不要使用
undefined
来初始化变量。eslint:
no-undef-init
let name = undefined // ✗ avoidlet namename = 'value' // ✓ ok循环语句中注意更新循环变量。
eslint:
no-unmodified-loop-condition
for let i = 0; i < itemslength; j++ ... // ✗ avoidfor let i = 0; i < itemslength; i++ ... // ✓ ok如果有更好的实现,尽量不要使用三元表达式。
eslint:
no-unneeded-ternary
let score = val ? val : 0 // ✗ avoidlet score = val || 0 // ✓ okreturn
,throw
,continue
和break
后不要再跟代码。eslint:
no-unreachable
{return trueconsole // ✗ avoid}finally
代码块中不要再改变程序执行流程。eslint:
no-unsafe-finally
try// ...catch e// ...finallyreturn 42 // ✗ avoid}关系运算符的左值不要做取反操作。
eslint:
no-unsafe-negation
if !key in obj {} // ✗ avoid避免不必要的
.call()
和.apply()
。eslint:
no-useless-call
sum // ✗ avoid避免使用不必要的计算值作对象属性。
eslint:
no-useless-computed-key
const user = 'name': 'John Doe' // ✗ avoidconst user = name: 'John Doe' // ✓ ok禁止多余的构造器。
eslint:
no-useless-constructor
{ // ✗ avoid}}禁止不必要的转义。
eslint:
no-useless-escape
let message = 'Hell\o' // ✗ avoidimport, export 和解构操作中,禁止赋值到同名变量。
eslint:
no-useless-rename
属性前面不要加空格。
eslint:
no-whitespace-before-property
user name // ✗ avoidusername // ✓ ok禁止使用
with
。eslint:
no-with
with val ... // ✗ avoid对象属性换行时注意统一代码风格。
eslint:
object-property-newline
const user =name: 'Jane Doe' age: 30username: 'jdoe86' // ✗ avoid}const user = name: 'Jane Doe' age: 30 username: 'jdoe86' // ✓ okconst user =name: 'Jane Doe'age: 30username: 'jdoe86'// ✓ ok代码块中避免多余留白。
eslint:
padded-blocks
if user// ✗ avoidconst name =}if userconst name = // ✓ ok}展开运算符与它的表达式间不要留空白。
eslint:
rest-spread-spacing
// ✗ avoid// ✓ ok遇到分号时空格要后留前不留。
eslint:
semi-spacing
for let i = 0 ;i < itemslength ;i++ ... // ✗ avoidfor let i = 0; i < itemslength; i++ ... // ✓ ok代码块首尾留空格。
eslint:
space-before-blocks
if admin... // ✗ avoidif admin ... // ✓ ok圆括号间不留空格。
eslint:
space-in-parens
// ✗ avoid// ✓ ok一元运算符后面跟一个空格。
eslint:
space-unary-ops
typeof!admin // ✗ avoidtypeof !admin // ✓ ok注释首尾留空格。
eslint:
spaced-comment
//comment // ✗ avoid// comment // ✓ ok/*comment*/ // ✗ avoid/* comment */ // ✓ ok模板字符串中变量前后不加空格。
eslint:
template-curly-spacing
const message = `Hello, ` // ✗ avoidconst message = `Hello, ` // ✓ ok检查
NaN
的正确姿势是使用isNaN()
。eslint:
use-isnan
if price === NaN // ✗ avoidif // ✓ ok用合法的字符串跟
typeof
进行比较操作。eslint:
valid-typeof
typeof name === 'undefimed' // ✗ avoidtypeof name === 'undefined' // ✓ ok自调用匿名函数 (IIFEs) 使用括号包裹。
eslint:
wrap-iife
const getName = { } // ✗ avoidconst getName = { } // ✓ okconst getName = { } // ✓ okyield *
中的*
前后都要有空格。eslint:
yield-star-spacing
// ✗ avoid// ✓ ok请书写优雅的条件语句(avoid Yoda conditions)。
eslint:
yoda
if 42 === age // ✗ avoidif age === 42 // ✓ ok
关于分号
eslint:
semi
window // ✓ okwindow; // ✗ avoid不要使用
(
,[
, or`
等作为一行的开始。在没有分号的情况下代码压缩后会导致报错,而坚持这一规范则可避免出错。eslint:
no-unexpected-multiline
// ✓ ok; {window}// ✗ avoid{window}// ✓ ok;1 2 3// ✗ avoid1 2 3// ✓ ok;`hello`// ✗ avoid`hello`备注:上面的写法只能说聪明过头了。
相比更加可读易懂的代码,那些看似投巧的写法是不可取的。
譬如:
;1 2 3建议的写法是:
var nums = 1 2 3nums
拓展阅读
- An Open Letter to JavaScript Leaders Regarding Semicolons
- JavaScript Semicolon Insertion – Everything you need to know
一个值得观看的视频:
当前主流的代码压缩方案都是基于词法(AST-based)进行的,所以在处理无分号的代码时完全没有压力(何况 JavaScript 中分号本来就不是强制的)。
一段摘抄自 "An Open Letter to JavaScript Leaders Regarding Semicolons" 这篇文章的内容:
[自动化插入分号的做法]是安全可依赖的,而且其产出的代码能够在所有浏览器里很好地运行。 Closure compiler, yuicompressor, packer 还有 jsmin 都能正确地对这样的代码进行压缩处理。并没有任何性能相关的问题。
不得不说,Javascript 社区里的大牛们一直是错误的,并不能教给你最佳实践。真是让人忧伤啊。 我建议先弄清楚 JS 是怎样断句的(还有就是哪些地方看起来断了其实并没有),明白了这个后就可以随心写出漂亮的代码了。
一般来说,
\n
表示语句结束,除非:
- 该语句有未闭合的括号, 数组字面量, 对象字面量 或者其他不能正常结束一条语句的情况(譬如,以
.
或,
结尾)- 该语句是
--
或者++
(它会将后面的内容进行自增或减)- 该语句是
for()
,while()
,do
,if()
或者else
并且没有{
- 下一行以
[
,(
,+
,*
,/
,-
,,
,.
或者其他只会单独出现在两块内容间的二元操作符。第一条很容易理解。即使在 JSLint 中,也允许 JSON,构造器的括号中,以及使用
var
配合,
结尾来声明多个变量等这些情中包含\n
。第二条有点奇葩。 我还想不出谁会(除了这里用作讨论外)写出
i\n++\nj
这样的代码来,不过,顺便说一下,这种写法最后解析的结果是i; ++j
,而不是i++; j
。第三条也容易理解。
if (x)\ny()
等价于if (x) { y() }
。解释器会向下寻找到代码块或一条语句为止。
;
是条合法的 JavaScript 语句。所以if(x);
等价于if(x){}
,表示 “如果 x 为真,什么也不做。” 这种写法在循环里面可以看到,就是当条件判断与条件更新是同一个方法的时候。 不常见,但也不至于没听说过吧。第四条就是常见的 “看,说过要加分号!” 的情形。但这些情况可以通过在语句前面加上分号来解决,如果你确定该语句跟前面的没关系的话。举个例子,假如你想这样:
;123;那么完全可以这样来写:
;123后者的好处是分号比较瞩目,一旦习惯后便再也不会看到以
(
和[
开头又不带分号的语句了。