code-style-cli
基于git hooks和fecs实现的代码风格检查工具
使用
全局安装
npm install -g code-style-cli
本地安装
npm install code-style-cli
初始化
cs -i
初始化时会:
- 在当前项目路径下生成文件:
.ignoreitr.js
- 向
.git/hooks
注入pre-commit
的钩子
运行代码风格检查
命令执行
# 检查指定文件(未指定将检查所有git diff出的文件) # options: -c :指定git diff --cached; -h: help msg; --tscheck: 是否检查ts文件; --configfile: 指定ts文件检查的eslint配置文件 cs [options] [file.js..]
git commit时执行
git commit
时将自动执行,检查所有提交的文件
配置
.ignoreitr.js
文件支持用户自定义配置:
, // 配置检查时忽略的文件规则 "ignore": [ "*.json", "fis.config.js" ] }
注释方式豁免检查
1、htmlcs豁免注释:
<!-- htmlcs-disable rule1[,rule2,...] --> 你要豁免的代码 <!-- htmlcs-enable rule1[,rule2,...] -->
2、csshint豁免注释:
/* csshint-disable rule1[,rule2,...] */ 你要豁免的代码 /* csshint-enable rule1[,rule2,...] */
3、eslint豁免注释:
/* eslint-disable rule1[,rule2,...] */ 你要豁免的代码 /* eslint-enable rule1[,rule2,...] */