rst-lint for Mac 版
ReStructuredText 语法检查工具
rst-lint 是什么
rst-lint 是一个 reStructuredText 的语法检查工具,最初是为了避免在 PyPI 上传文档后才发现 reST 格式有误而开发的,同时也配合 Sublime Text 的 linter 插件使用。它能对 reST 文本进行 lint 检查,返回系统消息列表,比如提示“标题下划线太短”这类具体问题。除了作为 Python 模块调用,它还提供了命令行工具 rst-lint(也叫 restructuredtext-lint),可以检查单个文件或整个文件夹,支持文本和 JSON 两种输出格式,并能设置最低报告级别(默认 warning)。检查全部通过时返回 0,内部错误返回 1,检查失败返回 2。此外,它还支持通过 --rst-prolog 为所有文件预置 reST 内容,方便处理替换定义。这个工具适合写 reST 文档、准备发布到 PyPI 的开发者,以及希望在编辑阶段就发现格式问题的用户。它也被集成到其他工具中,相关列表维护在项目 wiki 上。需要注意的是,某些非内置 lexer(如 bibtex)在本地能通过检查,但 PyPI 上可能无法识别,建议避免使用。
如何安装 rst-lint
- 打开 终端(按 ⌘ + 空格,输入“终端”)。
- 如果还没安装 Homebrew,先运行下面这条安装命令。
- 运行下面这条命令:
最近 10 个版本记录
该项目暂未在 GitHub 发布 Release。
二进制包支持平台
Homebrew 官方提供的预编译包(bottle)覆盖:
- all
⚠️ 未提供 Intel Mac 的预编译包,Intel 机型需要通过 brew install --build-from-source 从源码编译。
与同类应用对比
只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。
| 应用 | 版本 | 许可证 | 架构 | 近 30 天安装 |
|---|---|---|---|---|
| rst-lint | 2.0.2 | Unlicense | 命令行 | 7 |
| api-linter | v2.4.1 | Apache-2.0 | 命令行 | 9 |
| go-critic | v0.15.0 | MIT | 命令行 | 10 |
| solhint | 6.2.5 | MIT | 命令行 | 10 |