位置: 编程技术 - 正文
推荐整理分享Node.js如何自动审核团队的代码(nodejs自动生成接口文档),希望有所帮助,仅作参考,欢迎阅读内容。
文章相关热门搜索词:nodejs自动重启,node.js自动化,nodejs自启动,node.js自动化,node 自动化,nodejs自动生成接口文档,nodejs自动重启,nodejs自动重启,内容如对您有帮助,希望把文章链接给更多的朋友!
前言
在团队开发中,无论是写前端(js,css,html) ,还是后端 ,我们常常需要解决一个问题:如何统一团队代码风格。 这篇文章主要是使用pre-git , eslint , js-beautify 实现代码风格控制。
下面分别介绍这三个工具和使用方式:
pre-git
该工具能实现git hook的功能,在git的流程中插入一些自定义行为,例如commit之前执行代码检测,如果不通过则报错。
eslint
代码格式审核工具,可以随意组合配置各种风格,用于组成团队的代码统一规范。
js-beautiful
js代码整理、美化工具。
然后这三个工具互相配合就形成了以下效果:
1.项目组长定义好eslint的代码规范。
2.使用pre-git在commit之前运行eslint代码监测和js-beautiful代码美化
3.如果通过则自动"git add ." ,最后允许push。
实现
一:npm安装上述工具
$ npm install eslint js-beautify pre-git --save-dev
二:工具的配置
在根目录新建.eslintrc.json文件,并且把规范配置好,一下给一个精简版:
注意:如需更多检测,请到eslint官网查看
因测试,bash 中使用js-beautiful递归多层文件的时候总出现错误,所以由一脚本来进行代码美化:
beatufyjs.js
三:使用上述工具
在package.json文件中配置:
此时当你修改其中一个文件,然后"git add && git commit -m 'msg' "的时候,pre-commit中的三条命令就会执行,如果中途有错就会停止提交,修改完毕后再继续提交。
有一点需要注意的是,有的格式问题不足以报错的话,改方法会自动修改优化代码,并且自动添加修改,最后一步,执行:git push即可!可以结合单元测试,更佳
总结
标签: nodejs自动生成接口文档
本文链接地址:https://www.jiuchutong.com/biancheng/370760.html 转载请保留说明!友情链接: 武汉网站建设