SublimeLinter-contrib-twiglint

这个代码检查插件为SublimeLinter提供一个接口，用于twig-lint。它将用于具有“twig”语法的文件。

安装

为了使用此插件，必须安装SublimeLinter。如果SublimeLinter未安装，请按照此处的说明进行操作。

代码检查器安装

在使用此插件之前，您必须确保您的系统已安装twig-lint。要安装twig-lint，请在终端中输入以下内容

composer global require "asm89/twig-lint" "@stable"

注意：此插件要求twiglint 1.0.1或更高版本。

代码检查器配置

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

确保twig-lint正常工作，您有两种选择

• 将~/.composer/vendor/bin添加到您的PATH中
• 将twig-lint安装文件夹的路径添加到SublimeLinter用户配置（首选项 > 软件包设置 > SublimeLinter > 设置）中的“paths”键中，例如

{
    "paths": {
        "linux": ["~/.composer/vendor/bin"],
        "osx": ["~/.composer/vendor/bin"],
        "windows": ["C:\\Users\\yourname\\.composer\\vendor\\bin"]
    }
}

在安装和配置了twig-lint后，如果尚未安装，您可以继续安装SublimeLinter-contrib-twiglint插件。

插件安装

请使用 Package Control 安装代码检查插件。这将确保插件在新版可用时自动更新。如果您想从源码安装以便修改源代码，您可能已经知道如何操作，所以我们这里不会详细介绍。

通过Package Control安装，请按照以下步骤操作

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

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

设置

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

Twig-lint没有选项。

贡献

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

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

请注意，下面的编码规范应遵循这些修改

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

感谢您的帮助！