Node.js如何自动审核团队的代码


Posted in Javascript onJuly 20, 2016

前言

在团队开发中,无论是写前端(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官网查看

{
  "rules": {
    "comma-dangle": ["error", "never"],
    "arrow-body-style": ["warn", "always"],
    "no-const-assign": ["error"]
    },
  "parserOptions": {
    "ecmaVersion": 6
  }
}

因测试,bash 中使用js-beautiful递归多层文件的时候总出现错误,所以由一脚本来进行代码美化:

beatufyjs.js

const fs = require( 'fs' );
const path = require( 'path' );
const child_process = require( 'child_process' );

for( let arg of process.argv.splice( 2 ) ) {
  let pathName = path.join( process.cwd(),arg );
  if( isFile( path.join( process.cwd(),arg ) ) ) {
    child_process.exec( `./node_modules/js-beautify/js/bin/js-beautify.js -P -E -j -a ${pathName} -r` , function( error, msg, stderr ) {
      console.log( msg.replace('\\\\n','') );
    } );
  } else {
    read_dir( pathName );
  }
}

function read_dir( dir ){
  let files = fs.readdirSync( dir );
  for( let file of files ) {
    let pathName = path.join( dir,file );
    if( isFile( pathName ) ) {
      child_process.exec( `./node_modules/js-beautify/js/bin/js-beautify.js -P -E -j -a ${pathName} -r` , function( error, msg, stderr ) {
        console.log( msg.replace( '\\\\n','') );
      } );
    } else {
      read_dir( pathName );
    }
  }
}

function isFile( path ){ 
  return exists( path ) && fs.statSync( path ).isFile(); 
} 

function exists( path ){ 
   return fs.existsSync( path ) || path.existsSync( path ); 
}

三:使用上述工具

在package.json文件中配置:

{
 "name": "demo",
 "version": "1.0.0",
 "description": "",
 "main": "index.js",
 "scripts": {
  "lint": "./node_modules/.bin/eslint routes runtime utils libs --quiet",
  "lint-fix": "./node_modules/.bin/eslint routes runtime utils libs --quiet --fix",
  "js-beautify": "node --harmony --use_strict ./bin/beatufyjs.js libs middlewares index.js "
 },
 "author": "kelvv",
 "license": "ISC",
 "config": {
  "pre-git": {
   "commit-msg": "",
   "pre-commit": [
    "npm run lint-fix",
    "npm run js-beautify",
    "git add ."
   ],
   "pre-push": [],
   "post-commit": [],
   "post-checkout": [],
   "post-merge": []
  }
 },
 "devDependencies": {
  "eslint": "^2.12.0",
  "js-beautify": "^1.6.3",
  "pre-git": "^3.9.1"
 }
}

此时当你修改其中一个文件,然后"git add && git commit -m 'msg' "的时候,pre-commit中的三条命令就会执行,如果中途有错就会停止提交,修改完毕后再继续提交。

有一点需要注意的是,有的格式问题不足以报错的话,改方法会自动修改优化代码,并且自动添加修改,最后一步,执行:git push即可!可以结合单元测试,更佳

总结

以上就是为大家整理的如何用Node.js自动审核团队的代码的全部内容,有需要的可以进行参考学习。

Javascript 相关文章推荐
JS 用6N±1法求素数 实例教程
Oct 20 Javascript
一款jquery特效编写的大度宽屏焦点图切换特效的实例代码
Aug 05 Javascript
IE6下javasc#ipt:void(0) 无效的解决方法
Dec 23 Javascript
JavaScript事件委托用法分析
Jan 24 Javascript
关于延迟加载JavaScript
May 05 Javascript
jquery获取下拉框中的循环值
Feb 08 Javascript
详解react-webpack2-热模块替换[HMR]
Aug 03 Javascript
JavaScript闭包原理与用法实例分析
Aug 10 Javascript
vuejs实现ready函数加载完之后执行某个函数的方法
Aug 31 Javascript
JavaScript实现横版菜单栏
Mar 17 Javascript
如何利用 JS 脚本实现网页全自动秒杀抢购功能
Oct 12 Javascript
详解JavaScript中Arguments对象用途
Aug 30 Javascript
js只执行1次的函数示例
Jul 20 #Javascript
JQuery为元素添加样式的实现方法
Jul 20 #Javascript
JCrop+ajaxUpload 图像切割上传的实例代码
Jul 20 #Javascript
javaScript给元素添加多个class的简单实现
Jul 20 #Javascript
JavaScript中数组的22种方法必学(推荐)
Jul 20 #Javascript
JavaScript DOM 对象深入了解
Jul 20 #Javascript
JavaScript中的splice方法用法详解
Jul 20 #Javascript
You might like
Linux下实现PHP多进程的方法分享
2012/08/16 PHP
Laravel框架中扩展函数、扩展自定义类的方法
2014/09/04 PHP
PHP的APC模块实现上传进度条
2015/10/27 PHP
通过Jquery遍历Json的两种数据结构的实现代码
2011/01/19 Javascript
js内置对象 学习笔记
2011/08/01 Javascript
jQuery表格插件ParamQuery简单使用方法示例
2013/12/05 Javascript
jquery实现文本框数量加减功能的例子分享
2014/05/10 Javascript
jQuery动态创建html元素的常用方法汇总
2014/09/05 Javascript
jquery实现表格隔行换色效果
2015/11/19 Javascript
jquery控制页面的展开和隐藏实现方法(推荐)
2016/10/15 Javascript
arcgis for js 修改infowindow样式的方法
2016/11/02 Javascript
JavaScript中transform实现数字翻页效果
2017/03/08 Javascript
老生常谈ES6中的类
2017/07/31 Javascript
vue 中滚动条始终定位在底部的方法
2018/09/03 Javascript
js防抖和节流的深入讲解
2018/12/06 Javascript
解决layui动态加载复选框无法选中的问题
2019/09/20 Javascript
[02:25]专访DOTA2负责人Erik 国际邀请赛暂不会离开西雅
2014/07/21 DOTA
Python程序设计入门(3)数组的使用
2014/06/16 Python
Python合并两个字典的常用方法与效率比较
2015/06/17 Python
python选择排序算法实例总结
2015/07/01 Python
Python之reload流程实例代码解析
2018/01/29 Python
python2和python3的输入和输出区别介绍
2018/11/20 Python
Python实现正则表达式匹配任意的邮箱方法
2018/12/20 Python
详解Selenium+PhantomJS+python简单实现爬虫的功能
2019/07/14 Python
将python依赖包打包成window下可执行文件bat方式
2019/12/26 Python
浅谈python 调用open()打开文件时路径出错的原因
2020/06/05 Python
OpenCV读取与写入图片的实现
2020/10/13 Python
美国著名手表网站:Timepiece
2017/11/15 全球购物
FC-Moto英国:欧洲最大的摩托车服装和头盔商店之一
2019/08/25 全球购物
资深地理教师自我评价
2013/09/21 职场文书
会计主管岗位职责
2014/01/03 职场文书
经销商订货会主持词
2014/03/27 职场文书
行政监察建议书
2014/05/19 职场文书
六五普法宣传标语
2014/10/06 职场文书
党员个人剖析材料2014
2014/10/08 职场文书
Vue+TypeScript中处理computed方式
2022/04/02 Vue.js