Home > Archives > 软件组前端代码规范及代码检查设置

软件组前端代码规范及代码检查设置

Publish:

规范详情

优秀、统一的代码风格更有利于团队开发协作,同时也更有可能使应用良构。

因此我们选择了一套spec作为软件组前端开发代码规范,并配置相应的代码风格检测工具来帮助开发者约束自己的开发流程。

本规范几乎全文参照百度EFE前端编码规范,相关学习资料移步:

EFE前端编码规范

WebStorm代码检查配置

本规范采用EFE团队的FECS作为前端代码风格检查工具

请先全局安装FECS:

npm i -g fecs

然后clone Baidu-FE-Code-Style

git clone https://github.com/leeight/Baidu-FE-Code-Style.git

设置WebStorm的JSCS Package路径

image

Configuration file新建一个空文件即可

修改分号检查

我们认为JavaScript中的分号是不必要的,使用分号会带来代码风格不统一的问题,同时也会降低开发效率

而不使用分号可能遇到的陷阱完全可以通过学习来避开,具体学习资料请参考:写javascript时要不要省略分号?

所以我们倾向于修改对分号的检查规则

首先查找npm的安装路径 $npm-path

npm -h

得到:

image

然后进入fecs的安装路径:

cd $npm-path
cd ..
cd fecs

修改eslint配置文件中semi的always属性为never:

vim lib/js/eslint.yml
image

修改相关描述:

vim lib/reporter/baidu/javascript.yml
image

至此代码风格检查工具应该配置完成。

待决定

关于是否配置为仅显示[强制]风格规范而忽略[建议]风格规范还未决定,请先酌情处理

处理方法:Baidu-FE-Code-Style-issue#41

声明: 本文采用 BY-NC-SA 授权。转载请注明转自: 软件组前端代码规范及代码检查设置 - 无火的余灰