lint-md

用于检查中文 markdown 编写格式规范的核心模块，基于 AST 开发。Library used to lint your markdown file for Chinese.

安装

npm i --save lint-md

API 调用

import { lint, fix, getDescription } from 'lint-md';

// get the markdown 's style errors
const errors = lint(markdown, rules);

// get the error type description
const describe = getDescription(type[, lang = 'en_US']);

// fix the markdown
const fixed = fix(markdown);

• lint：通过 API 方式来校验 markdown 文本；
• fix：通过 API 方式来修复文本；
• getDescription：获取错误类型的文本描述，包含多语言；
• version：获得模块的版本号；

检查类型

检查规则来源于 chinese-document-style-guide.

配置选项

no-long-code 接受两个可配置参数：

• length: 每行代码接受的最大长度，数字，默认值为 100
• exclude: 可以配置部分代码类型不做长度检查，字符串数组，默认值为 []

Pull Request

目前仅仅检查了比较通用的类型，欢迎 pull request，在 rules 中增加自己的规则，开发约束：

• 规则主要针对于中文 markdown 的编写规范
• 使用类 babel plugin 的方式来进行规则检查，一个插件对应一个规则
• 规则名称对应和插件文件名保持一致
• 先提 issue 进行讨论
• AST 工具，使用其中的 markdown AST 辅助开发插件

Rules 配置

默认所有的规则都是 error 类型，看一个 rules 规则配置的示例：

const rules = {
  "no-empty-code": 1,
  "no-long-code": [2, {
    "length": 100,
    "exclude": ["dot"]
  }]
};

const errors = lint(markdown, rules);

通过 rules 来配置规则。key 对应规则的名称。如果 value 是一个数字，那么表示规则的等级：

• 0：ignore 忽略不检查该规则
• 1：warning 警告，但不阻断 ci
• 2：error 错误，且阻断 ci

如果 value 是一个数组，那么第一个是数字，表示该规则的等级；第二个为规则可接受的配置信息。

其他相关

• lint-md-cli：lint-md 模块的 CLI 工具，方便用于 ci 集成。
• vscode 插件：在 vscode 中使用 lint-md 工具。
• 语雀 lint 服务：利用语雀的 webhook 自动校验提交的文档格式并做提醒。

License

[email protected]hustcc.