在团队成员中,每个人都有自己的编码习惯,同时新进的同事也可能会有自己的代码风格,如果都是百花齐放、百家争鸣的话,那整个项目的代码就会难以维护。因此我们需要统一代码风格。
目前比较流行的工具是eslint和standardjs,以及更在之前的jslint。
eslint和jslint有点过于灵活,需要自己配置规范。这其实增加了团队规范成本。
而standardjs虽然没办法进行灵活配置,但是总体上也在最大限度上的采用了业内最流行通用的规范,使用简单,推广成本低。
如果项目脚手架里没有配置eslint的话,完全可以在项目中单独采用standardjs。
安装和使用
首先请确定已经安装了node.js和npm
然后在终端中运行下面的命令安装
1 | # 全局安装 |
使用1
2# 检查当前目录下的所有js文件
$ standard
更多时候我们应该在编辑器里直接继承插件进行代码规范检测。
我们团队都是用的sublime,那非常好统一,大家统一安装下列插件既可
SublimeLinter、SublimeLinter-contrib-standard
如果想编辑器能在保存文件的时候直接自动修正规范的话,再安装一个StandardFormat 就可以了。不过不建议安装这个插件,会拖累编辑器速度,而且比较明显。同时在自己手动更改不规范的代码的过程中,自己也可以对对应的代码规范有更加深入理解,哪怕脱离了插件直接手写也能达到风格统一的水准。
对于团队来说,只是最基础的使用,这样就足以,如果有想更加深入的了解其他的特性,个人可以看看下面的链接