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

wdzgege 发布于2019-08-23 13:48 / 709人阅读

摘要：用于检查中文编写格式规范的命令行工具，基于开发，且方便集成。忽略不检查该规则警告，但不阻断错误，且阻断通过来忽略文件和目录，语法。

lint-md

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

安装

npm i -g lint-md

使用

Usage:   [options]

lint your markdown files

Options:
  -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.

GPU云服务器云服务器 linux命令行格式命令行工具 php命令行工具服务器格式化命令行

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/99581.html

一个前端程序猿的Sublime Text3的自我修养

摘要：效果如下配置方法参考下的配置方法完美支持提供了比默认更好的语法高亮，而且他完美支持。语法高亮默认安装的对的支持让人抓狂，帧动画别开玩笑了你只会看到一片白色的纯文本一样的代码。事实上不光，我建议用完全替代原来的来完成语法高亮。文章转载自本人的博客《三省吾身丶丶》点击查看喜欢的话请疯狂的推荐吧！ ^_^ 本文章会在本人有插件或者设置更新时，进行不定时更新偷懒了，图片地址直接设置的博客...

KunMinX 2019-08-22 10:59 评论0 收藏0
【持续集成你的项目】为你的项目创建自动化测试和代码覆盖率测试

摘要：单元测试中，代码覆盖率经常被用来衡量测试好坏的指标。执行的结果和导出的结果都可以在的下看到接下来就是把这些文件到上，就会自动构建，然后开始单元测试，并把测试结果中的代码覆盖率发送到。本文以PHP项目作为例子所需要拥有(准备)的： Github账号一个项目看着篇幅挺大的，难免有什么遗漏，如果文中有错误的地方，还请各位斧正！谢谢。因为本来篇幅就大，所以就没配图了，如果有很多人反...

Jeff 2019-06-27 13:42 评论0 收藏0
可参照的规范化标准

摘要：编码规范译代码标准中文版译文编写高质量的代码从命名入手中文排版一个可配置的更适合阅读的中文文章样式库中文网页重设与排版一致化浏览器排版效果，构建最适合中文阅读的网页排版。尽信书，不如无书 - 《孟子》这是精辟透脱的读书法，要求读者善于独立思考问题 - 百科但你苦苦寻找一种可行的规范化文案的时候，不如集大家之广益，好则取之。编码规范 PHP Standard Recomme...

Freelander 2019-07-01 12:14 评论0 收藏0
【效率专精系列】善用API统一描述语言提升RestAPI开发效率

摘要：其标准为前身是，提供强大的在线编辑功能，包括语法高亮错误提示自动完成实时预览，并且支持用户以格式撰写导入导出转换文档。团队内部RestAPI开发采用设计驱动开发的模式，即使用API设计文档解耦前端和后端的开发过程，双方只在联调与测试时耦合。在实际开发和与前端合作的过程中，受限于众多因素的影响，开发效率还有进一步提高的空间。本文的目的是优化工具链支持，减少一部分重复和枯燥的劳动。现状...

tianyu 2019-08-16 10:42 评论0 收藏0
Sublime Text3配置使用教程整理

摘要：安装完添加如下配置可自动在保存文件的时候格式化中文输入法不能跟随光标吗试试这个插件吧目前只支持和装完之后，写作时右下角显示语法为，可以按，直接就会生成，并在浏览器中显示。 Win平台上已经打造了便携版的Sublime Text3,但是，现在折腾Ubuntu不能同步过来使用了，寒假在家休息，整理一下安装过程好了：安装sublime 在sublime text官网选择合适的版本安装。 u...

Martin91 2019-08-19 17:38 评论0 收藏0