SublimeLinter-contrib-textlint

此SublimeLinter插件提供了到SublimeLinter的接口，以及到textlint的接口。以下语法将会被自动检查：

• markdown
• text
• 纯文本
• Markdown GFM
• MarkdownEditing
• Markdown Extended
• Markdown
• MultiMarkdown syntaxes.

安装

安装SublimeLinter 3以使用此插件。如果未安装SublimeLinter 3，请参考此处的说明。

代码检查器安装

在开始使用此插件之前，您必须确保已安装textlint。

1. 在Linux上，您需要安装Node.js（以及npm）。

2. 在终端中输入以下命令来安装textlint

npm install -g textlint

或者在工作目录中局部安装textlint（您必须在该目录下有一个package.json文件）

```
npm init -f
npm install textlint
```

重新打开您的项目（或重启ST）以确保使用的是本地的textlint。

1. 如果您使用nvm和zsh，请确保将加载nvm的行添加到.zshenv而不是.zshrc。

2. 如果您使用zsh和oh-my-zsh，不要在oh-my-zsh中加载nvm插件。

注意：此插件需要textlint 5.3.0或更高版本。

代码检查器配置

对于Sublimelinter正常工作，textlint必须存在于您的$PATH中。在继续之前，请阅读并遵循文档中“Finding a linter executable”部分中的步骤，确保您的PATH设置正确。

一旦安装并配置了textlint，您就可以安装SublimeLinter-contrib-textlint插件（如果尚未安装）。

插件安装

为了确保插件在新版本可用时更新，请使用带有Package Control的安装。如果您想要从源代码安装以便更改源代码，那么您可能知道您在做什么，因此我们在此不涉及该内容。

通过Package Control安装，请执行以下操作

1. 在Sublime Text中，调出命令面板，输入install。在您应该看到的命令中，应该有Package Control: Install Package。如果该命令未高亮显示，请使用键盘或鼠标选择它。Package Control 将在几秒钟内查找可用的插件列表。

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

设置

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

您可以用与命令行相同的方法配置textlint选项，使用.textlintrc文件。更多详细信息，请参阅textlint 文档。

常见问题和故障排除

当我尝试使用本地安装的textlint时，我在ST控制台中得到了‘SublimeLinter: ERROR: textlint cannot locate 'textlint'’。

若要在本地安装textlint，您必须有package.json文件。另外，重启项目或ST本身后，以确保SublimeLinter使用正确的textlint实例。

npm init -f
npm install textlint

插件仍然不起作用，或者在ST控制台中出现错误。

更新textlint实例，可能您使用的是过时的版本，有时SublimeLinter没有正确检查。

我想使用自定义规则

您可以在SublimeLinter配置中通过args键指定textlint的任何CLI 选项。

{
    "linters": {
        "textlint": {
            "args": [
                "--rulesdir", "~/rules"
            ]
        }
    }
}

插件不会检查符号链接文件夹中的文件。

看起来像ST/SublimeLinter/Textlint问题。将SublimeLinter选项--stdin-filename设置为@。

{
    "linters": {
        "textlint": {
            "args": [
                "--stdin-filename", "@"
            ]
        }
    }
}

在Package Control包列表中没有可安装的SublimeLinter-contrib-textlint包。

请检查您是否已经安装了它。

做出贡献

如果您想对增强功能或修复进行贡献，请按照以下步骤操作

1. 叉失败的插件仓库。
2. 在最新master分支上创建一个单独的主题分支进行修改。
3. 提交并推送主题分支。
4. 制作一个拉取请求。
5. 有耐心。:-)

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

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

感谢您的贡献！

测试

为了方便，这个仓库使用textlint设置了。只需在这个仓库中运行npm i并在SublimeText中启用此插件。这个文件将会有错误。