扯扯JavaScript 代码规范
2017-08-20 本文已影响43人
changchao
1 不想吵架
JS的代码标准之争,惨烈程度堪比《世界上最好的语言》,无论是行尾的引号还是行首的缩进,都是分分钟引发数小时口水仗的节奏,所以,本文其实并不讨论什么样的规范是最好的,而是,‘粗暴’的抛给你一个 :-D。小伙子,如果你还在为JS代码规范寻寻觅觅,那么请你遵守这个并且别问原因别废话,赶紧把注意力放到code本身,别在无谓的浪费时间了。
重点来了,本文要给大家推荐的就是 JavaScript Standard Style。虽说个人认为争辩标准是个无意义且浪费时间的事情,但是也不能乱推荐不是,JS Standard Style 是一套成熟的经过检验的高效的标准,举几个用户:
相比你已经被我安利成功了,让我们继续吧! O(∩_∩)O
2 安装使用
熟悉一套代码规范,最好的方法自然就是赶紧用起来并且坚持下去。
- 安装
$ npm install standard --global #全局安装
$ standard #检查当前目录中的JS文件,有问题直接爆出来
$ standard "src/util/**/*.js" "test/**/*.js" #检查某些JS文件,支持glob表达式
注: glob表达式
检查出来的错误,可以使用 standard --fix
来自动解决(一部分)。
- 再进一步
作为现(lan)代(duo)的程序员,上面那种写完代码手动挨个检查的方式想必满足不了挑剔的你。改进一下,把代码检查加到你的项目中,打开package.json,编辑如下:
{
"name": "my-cool-package",
"devDependencies": {
"standard": "*"
},
"scripts": {
"test": "standard && node my-tests.js"
}
}
接下来,直接运行 npm test
就可以执行测试了,立马风骚多了 ;-)
- 还不够
不够不够,当然不够!!我写代码的时候直接提示我,让我写不出不符合规范的代码,这多好啊!对嘛,就知道你会想到这儿。之前的jslint,eslint都有插件能帮我们,这个怎么可能缺!以我最爱的webstorm为例(jetbrain全家桶都支持):file - setting - Editor - Code Style - JavaScript
webstorm设置
设置完想必你就看到效果了,照着执行吧 :-)
对了,建议你先粗略过一遍规范细则,以免面对提示的错误一脸懵逼,不知道哪儿错了 。
3 one more thing...
如果你已经完全使用起了JS standard Style并享受其中,别忘了给你的开源代码加个性感小徽章呀!_
//1
[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
//2
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
装逼小徽章1
装逼小徽章2
原文链接:http://www.jianshu.com/p/b6964a86ed5d
作者: changchao 转载请注明出处