SublimeLinter-contrib-vale

此代码检查插件为SublimeLinter提供了对Vale的接口。它将用于具有Plain text或Markdown语法的文件。

安装

要使用此插件，必须安装 SublimeLinter 3。如果未安装 SublimeLinter 3，请遵循此处的说明。

代码检查器安装

在使用此插件之前，您必须确保系统上已安装vale。

注意：此插件需要版本vale 0.5.0或更高。

Windows

访问发布页面，下载并安装最新的Vale.msi安装程序。

macOS

您可以使用Homebrew安装Vale

brew tap ValeLint/vale
brew install vale

Linux

您可以使用snap安装Vale

snap install vale

代码检查器配置

为了使 SublimeLinter 能够执行 vale，您必须确保其路径可供 SublimeLinter 使用。在继续之前，请阅读并遵循文档中“找到代码检查器可执行文件”中的步骤，直到“验证您的路径”。

在安装和配置 vale 之后，如果尚未安装，您可以继续安装 SublimeLinter-contrib-vale 插件。

插件安装

请使用 Package Control 安装代码检查插件。这将确保插件在可用新版本时自动更新。

以下是如何使用Package Control安装此包的步骤：

1. 在Sublime Text中，打开 命令面板 并输入 install。在你应该看到的命令中你会发现 Package Control: Install Package。如果该命令没有高亮显示，请使用键盘或鼠标选择它。Package Control将在几秒钟内检索可用插件的列表。

2. 当插件列表出现时，输入 vale。在你应该看到的条目中会有 SublimeLinter-contrib-vale。如果该条目没有高亮显示，请使用键盘或鼠标选择它。

设置

有关SublimeLinter如何与设置一起使用的一般信息，请参阅 设置。有关通用代码检查设置的信息，请参阅 代码检查设置。

您可以使用名为 .vale 或 _vale 的配置文件为项目配置Vale。更多信息请参阅 Vale文档。

贡献

如果您想对改进或修复进行贡献，请按照以下步骤操作：

1. 此仓库。
2. 从最新的 master 创建一个独立的分支来工作。
3. 提交并推送主题分支。
4. 发起合并请求。

请注意，所有修改应遵循以下编码规范：

• 缩进为4个空格。
• 代码必须通过 flake8 和 pep257 代码检查。
• 垂直空白有助于可读性，不要害怕使用它。
• 请使用描述性变量名，除非它们广为人知，否则不要使用缩写。

感谢您的帮助！