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