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

MIT
JavaScript 查看源码»
跨平台
2018-11-23
小薇

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-listList 内容不能为空List 语法中,填写内容
no-empty-code代码块内容不能为空删除空的代码块,或者填充代码内容
no-empty-blockquoteblockquote 内容不能为空删除空的 blockquote,或者填充内容
no-special-characters文本中不能有特殊字符可能是复制出来的特殊字符,删除特殊字符即可
use-standard-ellipsis使用标准规范的省略号使用标准规范的省略号‘……’ / ‘...’
no-fullwidth-number不能用全角数字注意输入法切换为半角输入

目前仅仅检查了比较通用的类型,欢迎 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.

的码云指数为
超过 的项目
加载中

评论(3)

我没有抓狂
我没有抓狂
好东西!
小薇
小薇 软件作者
哟,谁发到首页了!
OSC_YMISjY
OSC_YMISjY
好东西

中文 markdown 格式校验 lint-md v0.1.0,支持 --fix 参数

用于检查中文 markdown 编写格式规范的命令行工具,基于 AST 开发,且方便集成 ci;同时提供 API 方法调用。Cli tool to lint your markdown file for Chinese. 安装 npm i -g lint-md 使用 ...

2018/12/30 22:36

中文 markdown 格式校验 lint-md v0.0.6,支持 API 调用

lint-md 用于检查中文 markdown 编写格式规范的命令行工具,基于 AST 开发,且方便集成 ci;同时提供 API 方法调用。Cli tool to lint your markdown file for Chinese. 安装 npm i -g lint-...

2018/12/14 09:26

没有更多内容

加载失败,请刷新页面

没有更多内容

暂无问答

手把手教你构建一个web前端项目,全网最详细教程!

1. 选择现成的项目模板还是自己搭建项目骨架 搭建一个前端项目的方式有两种:选择现成的项目模板、自己搭建项目骨架。 选择一个现成项目模板是搭建一个项目最快的方式,模板已经把基本的骨架...

03/01 22:35
1
0
Lua包管理工具Luarocks详解

1. 什么是Luarocks 2. 源码安装部署Luarocks 3. 注册Luarocks为Lua社区贡献自己的代码 4. Luarocks使用初探

2015/10/20 23:38
4.9K
5
不起眼的 .editorconfig

> 还是在看别人 github 上项目的时候,看到好多项目目录下都会有个 .editorconfig 文件,起初看里面内容有个 md 的字符,还以为就 markdown 文件的配置来,后来有一次在 Webstorm 里配置一个...

2017/10/22 16:38
71
0
2.1、Android Studio通过Lint提升你的代码

为了测试你的Android应用符合功能需求。最重要的是确保你的代码没有结构性问题。结构差的代码影响你的Android应用的可靠性,让你的代码难以维护。比如,如果你的XML资源文件包含未使用的明明...

2016/07/14 15:28
6
0
PC-Lint的安装详细配置过程(以VC++6.0环境为例)

本文主要介绍了PC-Lint安装后针对VC++6.0开发环境进行配置的详细过程,总共分为三部分,下面依次对这三部分进行说明。 一、 首先下载PC-Lint,然后开始安装,一路“下一步”直到安装完成。此...

2015/08/27 13:37
423
0
Android Lint简介

android lint

2015/03/18 10:28
264
0
Android Lint使用分析

这篇文章介绍关于Android代码优化工具之Android Lint的使用总结。Android Lint是ADT版本16提供的Android代码优化工具,它能够帮助程序员快速方便的发现代码中的不足之处,并尽可能给予你提供...

2015/12/29 22:36
18
0
Android Lint

Android Lint is a new tool introduced in ADT 16 (and Tools 16) which scans Android project sources for potential bugs. It is available both as a command line tool, as well as in...

2012/06/16 09:47
917
0
在2018年如何优雅的开发一个typescript语言的npm包?

欢迎大家前往腾讯云+社区,获取更多腾讯海量技术实践干货哦~ 本文由小明plus发表 很多时候,我们可能想要用 typescript 语言来创建一些模块,并提交到 npm 供别人使用, 那么在 2018 年,如果...

2018/11/27 11:23
17
0
Android ------ 美团的Lint代码检查实践

概述 Lint是Google提供的Android静态代码检查工具,可以扫描并发现代码中潜在的问题,提醒开发人员及早修正,提高代码质量。除了Android原生提供的几百个Lint规则,还可以开发自定义Lint规则...

2018/04/16 15:29
115
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部