textlint 自动格式化工具

安装

正式使用 textlint 之前我们需要先执行安装步骤。textlint 基于 JavaScript 语言实现,其安装通过 npm 包管理工具来安装:

1
npm install textlint --global

前提是环境已安装了 Node.js和 npm 依赖,如未安装可以参考如下命令,以Ubuntu为例:

1
sudo apt -y install npm

用法

安装自动添加中英文空格的规则:

1
npm install textlint-rule-ja-space-between-half-and-full-width --global

通过终端切换到需要执行格式化目录下方,textlint 支持多层级目录和多文件批量处理,所以一般切换至项目根目录下方即可。然后执行下面命令初始化 textlint 针对该目录的配置文件,执行后会自动生成一个名为.textlintrc 的配置文件:

1
textlint --init

接下来向配置文件中添加相应的规则:

1
2
3
4
5
6
7
8
{
"filters": {},
"rules": {
"ja-space-between-half-and-full-width": {
"space": "always"
}
}
}

最后通过 textlint 实现对指定文件自动添加空格,执行:

1
textlint --fix *.md

本文链接:https://my.lmcjl.com/post/18591.html

展开阅读全文

4 评论

留下您的评论.