项目地址: https://github.com/huntzhan/zh-doclint
目前仅支持 Markdown 格式的文档解析,文档规则( style guide )参考的是 写作规范和格式规范, DaoCloud 文档 的规范。
1
laosb 2016-09-06 06:22:52 +08:00
|
2
huntzhan OP @laosb 对任意文本建立 AST 应该很难吧,毕竟文本不像程序语言,没有良好定义。目前我的做法是分出段落与句子,然后按段落、句子上 regex 找非法的风格。
|
3
laosb 2016-09-07 05:59:39 +08:00
@huntzhan 我的想法并不是分解句子中每一个语言成分,对于这种简单的 lint 其实也没必要。这个 AST 的大致定义我写在 https://github.com/laosb/halint/blob/master/docs/ast-based-solution.md 了,还没开始写代码。
|
5
huntzhan OP @laosb 不过有几个点建议你也考虑一下: 1 、支持 markup ,特别是 Markdown 。 2 、包含各种 markup 格式的转换关系,包括解析后文本位置与原始 markup 文本位置的信息。这个信息在在做自动更正的时候比较有用。
|
6
laosb 2016-09-08 06:10:23 +08:00
@huntzhan 对,这就是代码里 fileParser 的作用,只不过现在只写了 plain text 的解析(按行直接拆开)。感觉如果切换到 AST 方案的话,要在 parser 处就部分解析为 AST 树(按段落、标题这些基本 markup 元素先拆开并矫正 position )。
|
7
laosb 2016-09-08 06:11:41 +08:00
@huntzhan 等我过两天休息找时间先重写 plain 的 parser 和 zh_cn 的 linter ,试试这个 AST 方案。
|