hit是一个简单的 markdow 静态检查的控制台 cli 工具，可以方便markdow开发者轻松集成travis自动检测。
一、安装pipistallhit
然后在系统中会得到一个 hit 的命令cli工具。
二、使用使用方法有两种：
2.1一种是命令行cli方式，简单使用方法如下：
hitmarkdow_file
或者
hitmarkdow_folder
或者使用 hit--help 查看帮助信息和具体详细的使用方法。
$ hit --helpUsage: hit-script.py [OPTIONS] FILEOptios: -i, --igore TEXT The error codes which will be igored. -f, --format [text|jso] The output format of error iformatio. -m, --max-depth INTEGER The max depth for traverse the path. --help Show this message ad exit.可以用于直接集成到各种ci系统中，例如travis-ci。
2.2另外一种是代码API调用的方式，简单使用方法如下：
import hittext='''hit 是一个简单的 **markdow** 静态检查的控制台 `cli` 工具。可以方便 markdow 开发者轻松集成 travis 自动检测。'''errors = hit.check(text, igore='E201')f = 'README.md'errors = hit.check_file(f, format='text')可以方便的进行第三方扩展开发。
三、错误码检查规则来源于 chiese-copywritig-guidelies，错误码命名方式参考于flake8。目前支持的错误码如下所示：
错误码检查类型详细描述完成E101空格中英文之间需要增加空格doeE102空格中文与数字之间需要增加空格doeE103空格全角标点与其他字符之间不加空格doeE104空格除了％、℃、°、以及倍数单位（如2x、3）之外，数字与单位之间需要增加空格doeE201标点不重复使用标点符号doeE202标点只有中文或中英文混排中，一律使用中文全角标点doeE203标点如果出现整句英文，则在这句英文中使用英文、半角标点doeE204标点省略号请使用……标准用法doeE205标点英文和后面的半角标点之间不需要空格doeE301数字数字使用半角字符doe关于各种错误码的正确、错误范例，可以参考 tests/md。目前有了大概的代码结构，欢迎PR更多的检查错误类型和检查方式。
评论