About ESLint

MATRIX使用ESLint作为代码检查工具,关于ESLint的详细介绍可以到 官网 查看.

在MATRIX目录中添加了eslint.json文件作为ESLint的配置文件,关于rules的配置,如果有觉得哪些rules不合理,可以讨论删除.

关于rules可以到 http://eslint.cn/docs/rules/进行查看.

修改了.git/hooks/pre-commit文件, 该文件不受git仓库管理,使用者需要手动修改,可以复制仓库根目录下的pre-commit文件到./git/hooks/pre-commit.

下面是对pre-commit文件的一些介绍:

pre-commit是git常见的钩子中的一种,他会在commit之前触发.

该文件的第一行可以指定运行环境,这里我指定代码的执行环境为node.

代码中使用node的child_process.execSync方法执行npm run lint, 并将结果输出.

在package.json中配置了相关的lint命令, 他执行node lint.js命令. 随后lint.js中的代码开始运行.

在lint.js中调用了eslint的相关API, 想要了解可以查看这里 http://eslint.cn/docs/developer-guide/nodejs-api.

由于MATRIX1.1.0版本pre-commit的缺失, 很多代码仍处于风格不统一, 代码不规范的状态中, 只能是后期边做开发, 边做代码规范.

希望在后期的代码开发中能遵守规范, 形成统一的代码风格.