「zhlint」帮助你自动检测与修复 Markdown 文档风格

[huntzhan]

TL; DR:

• 项目地址： https://github.com/huntzhan/zhlint
• 与 flake8、cpplint 等 Lint 的功能类似，只不过是用来处理中文 Markdown 文档的。
• 支持文档风格的「检测」与「修复」。
• 检测功能基本靠谱，修复功能有一些 Cases 还没有处理好。
• 这是本项目的第一个可用版本，欢迎报 Bug ！

zhlint

Note: This project is highly related to Chinese, so the document is writtern in Chinese.

简介

一个处理文档风格的工具：

• 支持文档风格的检查（使用 check 命令）。
• 支持文档风格的自动修复（使用 fix 命令）。

注意：

• 目前仅支持 Markdown 格式文档的检测与修复。

支持的检查项目

详情见 写作规范和格式规范， DaoCloud 文档。

安装

pip install zhlint

安装成功后，可执行 zhlint 命令行程序处理文档。

命令行程序 zhlint 的使用方法

zhlint check SRC，检查文档风格

check 命令会检查路径为 SRC 的文件，打印检测到的文档风格错误。示例如下：

$ ccat doc.md 
只有中文或中英文混排中,一律使用中文全角标点. 英文 **english**与非标点的中文之间需要有一个空格。

支持简单的错误名词检测，如 APP 、 ios 这类的。
$ zhlint check doc.md 
==========================================
E101: 英文与非标点的中文之间需要有一个空格
==========================================
LINE: 1
角标点. 英文 english 与非标点的中文之间需
　　　  　　       -－
........................................

==================================================
E201: 只有中文或中英文混排中，一律使用中文全角标点
==================================================
LINE: 1
中文或中英文混排中,一律使用中文全角标
　　　　　　　　　-
.....................................
LINE: 1
律使用中文全角标点.
　　　　　　　　　-
...................

==================
E301: 常用名词错误
==================
LINE: 3
的错误名词检测，如 APP 、 ios 这类的。
　　　　　　　　　 ---
....................................
LINE: 3
名词检测，如 APP 、 ios 这类的。
　　　　　　    　---
..............................

zhlint fix SRC [DST]，修复文档风格

fix 命令会尝试修复路径为 SRC 的文件中出现的风格错误：

• 如果省略 DST，修复后的文本将打印到标准输出。
• 如果传入 DST，修复后的文本将写入到 DST。

示例如下：

$ zhlint fix doc.md 
只有中文或中英文混排中，一律使用中文全角标点。 英文 **english** 与非标点的中文之间需要有一个空格。

支持简单的错误名词检测，如 App 、 iOS 这类的。
$ zhlint fix doc.md fixed-doc.md
$ colordiff doc.md fixed-doc.md 
1c1
< 只有中文或中英文混排中,一律使用中文全角标点. 英文 **english**与非标点的中文之间需要有一个空格。
---
> 只有中文或中英文混排中，一律使用中文全角标点。 英文 **english** 与非标点的中文之间需要有一个空格。
3c3
< 支持简单的错误名词检测，如 APP 、 ios 这类的。
---
> 支持简单的错误名词检测，如 App 、 iOS 这类的。

[gouchaoer]

弄个在线的方便懒人？

[huntzhan]

@gouchaoer 可以有

[metrue]

直接作成 vim 插件就更好了。

[huntzhan]

@metrue Vim 插件好像很难写的样子，不过好像现在流行直接跑个 daemon 然后把 Vim 作为前端这种做法，估计做起来也不算太难。

[xwartz]

这个不错，感觉可以集成到 sublime 插件里面去了

[metrue]

@xwartz 挺简单的，看一下文档，很容易就搞定其实。

[xwartz]

@metrue 是的，我直接写过一个自动加空格的 https://github.com/xwartz/auto-spacing ，考虑把你这个功能集成进去

[metrue]

@xwartz 赞，做好告知一声。

[huntzhan]

@gouchaoer 有了， http://huntzhan-zhlint-web.daoapp.io/

[moell]

非常不错