lint-md

用于检查中文 markdown 编写格式规范的命令行工具，基于 AST 开发，且方便集成 ci。Cli tool to lint your markdown file for Chinese.

安装

npm i -g lint-md

使用

Usage: <lint-md> <files...> [options]lint your markdown filesOptions:-v, --version                  output the version number-c, --config [configure-file]  use the configure file, default .lintmdrc-h, --help                     output usage information

Example:

lint-md README.md Document.md

检查类型

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

规则	详细描述	解决办法
space-round-alphabet	中文与英文之间需要增加空格	对应提示的位置增加空格
space-round-number	中文与数字之间需要增加空格	对应提示的位置增加空格
no-empty-code-lang	代码语言不能为空	在代码块语法上增加语言
no-empty-url	链接和图片地址不能为空	填写完整的 url，或者不使用链接和图片语法
no-empty-list	List 内容不能为空	List 语法中，填写内容
no-empty-code	代码块内容不能为空	删除空的代码块，或者填充代码内容
no-empty-blockquote	blockquote 内容不能为空	删除空的 blockquote，或者填充内容
no-special-characters	文本中不能有特殊字符	可能是复制出来的特殊字符，删除特殊字符即可
use-standard-ellipsis	使用标准规范的省略号	使用标准规范的省略号‘……’ / ‘...’
no-fullwidth-number	不能用全角数字	注意输入法切换为半角输入
no-space-in-emphasis	emphasis 内容前后不能有空格	删除 emphasis 内容中的前后空格即可
no-space-in-link	link 内容前后不能有空格	删除 link 内容中的前后空格即可
no-multiple-space-blockquote	blockquote 语法不能包含有多个空格	删除 blockquote 内容中多余的空格
no-trailing-punctuation	标题不能以标点符号结尾	删除标题最后的标点符号

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

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

配置

默认所有的规则都是 error 类型，但是可以通过配置来指定规则类型。示例 .lintmdrc ：

{"excludeFiles": [],"rules": {"no-empty-code": 1}
}

通过 rules 来配置规则的等级。

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

通过 excludeFiles 来忽略文件和目录，glob 语法。

ci 集成

Travis

在 .travis.yml 文件中配置以下内容。

language: node_js
node_js:- "10"
before_install:- npm i -g lint-md
script: lint-md README.md

lint-stage

在 package.json 中增加以下配置。

"lint-staged": {"src/**/*.{md,markdown}": ["lind-md"]
}

License

MIT@hustcc.

中文 Markdown 编写格式规范的命令行工具 lint-md相关推荐

oracle命令格式,OraCmD(Oracle命令行工具) V3.1 官方版
OraCmD是一款专业强大的Oracle导入导出工具,它可以快速的帮助用户这没有进行安装Oracle客户端的情况下,进行数据的导出.导入,并且使用非常的简单,这您的命令工具里面即可快速的进行执行SQL ...
第三方模块——nodemon是一个命令行工具，用以辅助项目开发、nrm ( npm registry manager )：npm下载地址切换工具
什么是第三方模块别人写好的.具有特定功能的.我们能直接使用的模块即第三方模块,由于第三方模块通常都是由多个文件组成并且被放置在一个文件夹中,所以又名包. 第三方模块 nodemon nodemon是 ...
go编写命令行工具_编写者的命令行文档转换工具
go编写命令行工具今天,我们有足够的工具可用于在我们的计算机上编辑备忘录,信件,论文,书籍,演示幻灯片和其他文档. 这既有好处也有缺点:一方面,如果您不喜欢某个软件,则可以随时随地转到另一个软件上: ...
golang 命令行_如何使用Golang编写快速有趣的命令行应用程序
golang 命令行 by Peter Benjamin 彼得·本杰明(Peter Benjamin) 如何使用Golang编写快速有趣的命令行应用程序 (How to write fast, fun ...
GitBook是一个命令行工具（Node.js库），我们可以借用该工具使用Github/Git和Markdown来制作精美的图书，但它并不是一本关于Git的教程哟。...
GitBook是一个命令行工具(Node.js库),我们可以借用该工具使用Github/Git和Markdown来制作精美的图书,但它并不是一本关于Git的教程哟. 支持输出多种格式 GitBook支 ...
Linux下音频格式转换命令行工具
这里写自定义目录标题 Sox音频转换使用Mplayer将多种格式的而文件编码至WAV 使用FFmpeg将各种类型文件转换成各种类型文件使用Lame编码或者已不同的比特率重新编码MP3 以Ogg V ...
【Python知识点梳理】10.Python的垃圾回收机制、代码规范及命令行参数
Python的垃圾回收机制.代码规范及命令行参数文章目录 1.Python的垃圾回收机制 2.Python的引用计数机制 3.Python中的循环数据结构及引用计数 4.Python中的GC模块 5 ...
java 编写命令行工具_编写命令行工具
1.使用common-cli编写命令行工具 commons-cli是Apache开源组织提供的用于解析命令行参数的包. 先引用common-cli依赖包: commons-cli commons-cl ...
python工具是什么-使用Python编写命令行工具有什么好的库？
使用Python编写命令行工具的库很多,我最推荐的还是Google Fire Hello World 要介绍Fire是什么,看一个简单的例子就明白了 # calc.py import fire cla ...

中文 Markdown 编写格式规范的命令行工具 lint-md

lint-md

安装

使用

检查类型

配置

ci 集成

License

中文 Markdown 编写格式规范的命令行工具 lint-md相关推荐

最新文章

热门文章