使用 AutoCorrect 规范 Markdown 文档

XOlDKING 发布于 2023/10/23

总计 1052 字｜更新于 2023/10/24｜- 次阅读｜- 条评论

本文介绍了如何安装并使用 AutoCorrect 规范中英混排 Markdown 文档。

AutoCorrect

AutoCorrect 是一个基于 Rust 编写的工具，用于「自动纠正」或「检查并建议」文案，给 CJK（中文、日语、韩语）与英文混写的场景，补充正确的空格，纠正单词，同时尝试以安全的方式自动纠正标点符号等等。

AutoCorrect 可以用于 CI 环境，它提供 Lint 功能，能便捷的检测出项目中有问题的文案，起到统一规范的作用。

AutoCorrect 的主要功能：

在英文单词与中文内容之间添加空格。
将紧贴中文的标点符号修正为全角。
将英文内容中的标点符号修正为半角。
根据自定义词典检查并修正单词拼写。

查看 AutoCorrect 在线示例了解其功能。

安装

AutoCorrect 可通过 Homebrew 安装：

1
2
3
4
5


$ brew install autocorrect

# 查看版本号，确认安装成功
$ autocorrect -V
AutoCorrect 2.8.5

配置

配置文件

AutoCorrect 的默认配置为 .autocorrect.default，可在当前项目中生成项目专属配置文件，自定义规则。

1
2


$ autocorrect init [--local]
AutoCorrect init config: .autocorrectrc

参数：

--local：无法从服务器获取配置文件时使用。

配置文件规则参数说明：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49


rules:
    # 参数值设为：0 - 禁用，1 - 报错，2 - 警告

    # 自动在英文单词与中文之间加空格
    space-word: 1

    # 在某些标点符号之间加空格
    space-punctuation: 1

    # 在括号 () [] 与中文之间加空格
    space-bracket: 1

    # 转换成全角
    fullwidth: 1

    # 去除全角标点周围的空格
    on-space-fullwidth: 1

    # 全角字母、数字转换成半角
    halfwidth-word: 1

    # 在英文内容中将全角标点转换为半角
    halfwidth-punctuation: 1

    # 检查拼写
    spellcheck: 2

textRules:
    # 为某些文本单独配置规则
    # "Hello你好": 2
    # "Hi你好": 0
fileTypes:
    # 指定文件后缀名对应的编程语言
    # "rb": ruby
    # "Rakefile": ruby
    # "*.js": javascript
    # ".mdx": markdown
spellcheck:
    # 专有名词的正确写法
    words:
        - GitHub
        - App Store
        - AppStore = App Store
        - Git
        - Node.js
        - nodejs = Node.js
        - DNS
        - HTTP
        - SSL

忽略文件

AutoCorrect 会自动忽略 .gitignore 中的文件。

也可以创建 .autocorrectignore 自定义忽略文件，语法规则与 .gitignore 相同。

临时禁用规则

可通过在文档内添加行内注释的方式，临时禁用 AutoCorrect 规则。

// autocorrect-disable space-word
该注释之后的文档禁用 spcae-word 规则。
// autocorrect-disable space-word, fullwidth
该注释之后的文档禁用 spcae-word、fullwith 规则。
// autocorrect-disable
该注释之后的文档禁用 AutoCorrect 所有规则。
// autocorrect-enable
该注释之后的文档启用 AutoCorrect。

运行

1
2
3
4
5
6
7
8


# 检查指定文档
autocorrect --lint path/to/file.md

# 纠正目录下的所有文档
autocorrect --fix 

# 根据指定配置文件，检查项目中的所有文档
autocorrect --config myautocorrect --lint myproject/

参数：

--lint：检查并输出文档的违规语法。
--fix：自动纠正文档的违规语法。
--format <FORMAT>：指定输出格式，可选格式为：diff，json，rdjson。
--config <CONFIG>：指定配置文件。

【参考】：

AutoCorrect：用于改进文案写作的语法检查和修正工具。