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

 更新时间:2016年07月20日 16:11:13   投稿:daisy  
在项目开发中,统一团队的代码风格很重要,本文介绍如何用Node.js来自动审核,来提高您的开发速度。

前言

在团队开发中,无论是写前端(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自动审核团队的代码的全部内容,有需要的可以进行参考学习。

相关文章

  • 详解node服务器中打开html文件的两种方法

    详解node服务器中打开html文件的两种方法

    本篇文章主要介绍了详解node服务器中打开html文件的两种方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-09-09
  • nodejs多版本管理总结

    nodejs多版本管理总结

    这篇文章主要介绍了nodejs多版本管理的相关知识点,以及实际操作方法和代码,有需要的朋友参考下。
    2018-04-04
  • node.js 动态执行脚本

    node.js 动态执行脚本

    其中的Script对象,就与require('vm')返回的对象很相似,而实质上,vm模块就是对Script对象的封装。
    2016-06-06
  • 总结Node.js中的一些错误类型

    总结Node.js中的一些错误类型

    NodeJS 的错误处理让人痛苦,在很长的一段时间里,大量的错误被放任不管。但是要想建立一个健壮的 Node.js 程序就必须正确的处理这些错误,而且这并不难学。下面跟着小编一起来学习学习。
    2016-08-08
  • 使用node.JS中的url模块解析URL信息

    使用node.JS中的url模块解析URL信息

    本文将详细介绍nodeJS中的URL模块的使用方法,利用URL模块解析出URL相关信息
    2020-02-02
  • NodeJS中的命令行程序、工程目录、NPM

    NodeJS中的命令行程序、工程目录、NPM

    使用NodeJS编写的东西,要么是一个包,要么是一个命令行程序,而前者最终也会用于开发后者,一般我们会同时提供命令行模式和API模式两种使用方式,并且我们会借助三方包来编写代码,NPM是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题
    2023-11-11
  • Node.js的npm包管理器基础使用教程

    Node.js的npm包管理器基础使用教程

    特别是JavaScript领域中,基于NPM的网络传输方式真的是越来越流行,包括React与Vue等许多JavaScript库与框架都选择使用npm进行管理,这里就为大家送上Node.js的npm包管理器基础使用教程,需要的朋友可以参考下
    2016-05-05
  • Node.js+jade+mongodb+mongoose实现爬虫分离入库与生成静态文件的方法

    Node.js+jade+mongodb+mongoose实现爬虫分离入库与生成静态文件的方法

    下面小编就为大家带来一篇Node.js+jade+mongodb+mongoose实现爬虫分离入库与生成静态文件的方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • 浅谈Koa2框架利用CORS完成跨域ajax请求

    浅谈Koa2框架利用CORS完成跨域ajax请求

    这篇文章主要介绍了浅谈Koa2框架利用CORS完成跨域ajax请求,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-03-03
  • NodeJS去除BOM和转换UTF8编码

    NodeJS去除BOM和转换UTF8编码

    使用NodeJS编写前端工具时,操作得最多的是文本文件,但遗憾的是,GBK编码不在NodeJS自身支持范围内,UTF8文件还可能带有BOM,在读取不同编码的文本文件时,需要将文件内容转换为JS使用的UTF8编码字符串后才能正常处理
    2023-11-11

最新评论