SublimeLinter-vale

这个用于 SublimeLinter 的代码检查插件，提供了一个访问 SublimeLinter 和 Vale 的接口。它将用于具有 Plain text 或 Markdown 语法的文件。

安装

为了使用此插件，必须安装 SublimeLinter 3。如果尚未安装 SublimeLinter 3，请按照以下说明进行操作 这里。

代码检查器安装

在开始使用本插件之前，请确保您的系统上已安装 vale（参见 https://vale.sh/docs/vale-cli/installation/）。

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

Windows

您可以使用 choco 安装 Vale

choco install vale

macOS

您可以使用 Homebrew 安装 Vale

brew tap ValeLint/vale
brew install vale

Linux

您可以使用 snap 安装 Vale

snap install vale

代码检查器配置

为了使 SublimeLinter 能够执行 vale，请确保其路径对于 SublimeLinter 可用。在继续之前，请阅读并按照文档中的“寻找代码检查器可执行文件”部分中的步骤进行操作，“验证您的 PATH”。

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

插件安装

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

要使用 Package Control 安装此软件包，请按照以下步骤操作

1. 在Sublime Text中，打开命令面板，输入install。你将看到Package Control: Install Package命令。如果该命令没有被高亮，请使用键盘或鼠标选择它。Package Control会暂停几秒钟来获取可用的插件列表。

2. 当插件列表出现时，输入vale。你应该会看到SublimeLinter-vale。如果这条记录没有被高亮，请使用键盘或鼠标选择它。

设置

有关SublimeLinter如何使用设置的通用信息，请参阅设置。有关通用linter设置的详细信息，请参阅Linter 设置。

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

贡献

如果您想为增强功能或修复贡献力量，请按照以下步骤操作：

1. 从本存储库派生一个分支。
2. 从最新的master创建一个单独的话题分支。
3. 提交并推动话题分支。
4. 发起一个合并请求。

请注意，修改应遵循以下编码指南：

• 缩进是4个空格。
• 代码应通过flake8和pep257 linter测试。
• 垂直空白有助于可读性，不要害怕使用它。
• 请使用描述性变量名，除非它们是众所周知的首字母缩写词。

感谢您的帮助！