SublimeLinter-contrib-write-good

本插件为SublimeLinter提供访问write-good的接口。它将被用于包含英语散文的文件。

安装

使用此插件前，您必须安装SublimeLinter 3。如果未安装SublimeLinter 3，请按照此处的说明进行安装。

代码检查器安装

在使用此插件之前，您必须确保系统已安装write-good。以下是安装write-good的步骤

1. 安装Node.js（以及在Linux上安装npm）。

2. 在终端中键入以下命令以安装write-good

npm install -g write-good

1. 如果您使用nvm和zsh，请确保nvm加载行在.zshenv中（而不是.zshrc中）。

2. 在尝试查找系统版本之前，如果本地有write-good版本，将优先使用它。

代码检查器配置

为了让write-good可以通过SublimeLinter执行，您必须确保其路径对SublimeLinter可用。在继续之前，请阅读并按照文档中“Finding a linter executable”中“Validating your PATH”部分的步骤操作。

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

插件安装

请使用Package Control安装代码检查器插件。这将确保插件在新版本发布时自动更新。如果您想从源代码安装以便修改源代码，那么您可能已经知道在做什么了，因此我们在此不做介绍。

通过包控制安装，请按照以下步骤操作

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

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

设置

有关SublimeLinter如何与设置协同工作的一般信息，请参阅设置。有关通用linters设置的更多信息，请参阅linters设置。

贡献

如果您想对插件进行改进或修复，请按照以下操作

1. 对插件仓库进行分支。
2. 从最新的master创建一个单独的主题分支进行开发。
3. 提交并推送主题分支。
4. 发起一个pull request。
5. 请耐心等待。;-)

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

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

感谢您帮忙！

维护者

• @ChrisCummins
• @ckaznocha (已失效)