SublimeLinter-contrib-ansible-lint

此代码检查插件为 SublimeLinter 提供与 ansible-lint 的接口。它将用于具有“Ansible”语法的文件。

安装

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

代码检查安装

在使用此插件之前，您必须确保系统中已安装 ansible-lint。要安装 ansible-lint，请在终端中执行以下操作

1. 安装 Python 和 pip。

2. 通过在终端中输入以下内容安装 ansible-lint

[sudo] pip install ansible-lint

注意： 此插件需要 ansible-lint 3.0.1 或更高版本。

语法安装

同时确保在 Sublime Text 中安装了 Ansible。要安装 Ansible，请按以下步骤操作

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

1. 在 Sublime Text 中，打开 命令面板 并输入 install。在您应该看到的命令中，应该有 Package Control: Install Package。如果不突出显示此命令，请使用键盘或鼠标选中它。Package Control 将花费几秒钟时间检索可用插件的列表。

2. 当插件列表出现时，请输入 ansible。在条目中应该看到 Ansible。如果不突出显示该条目，请使用键盘或鼠标选中它。

注意： 如果未安装 Ansible 语法，此插件将无法正常工作。

语法配置

为了能够自动使用 Ansible 语法打开 Ansible 项目的 .yml 文件，需要将 ApplySyntax 配置如下设置。如果不这样做，则 .yml 文件将以 YAML 语法打开，并且需要手动更改每个文件的语法，才能使代码检查插件正常工作。

这些设置可以在以下位置找到：

Sublime Text -> Preferences -> Package Settings -> ApplySyntax -> Settings - User

"syntaxes": [{
        "name": "Ansible/Ansible",
        "rules": [
          {"file_name": ".*/tasks/.*.yml$"},
          {"file_name": ".*/handler/.*.yml$"},
          {"file_name": ".*/*_vars/.*.yml$"},
          {"file_name": ".*/roles/.*.yml$"},
          {"file_name": ".*/playbooks/.*.yml$"},
          {"file_name": ".*/.*ansible.*/.*.yml$"}
        ]
      }]

代码检查配置

为了使 ansible-lint 能够被 SublimeLinter 执行，您必须确保其路径对于 SublimeLinter 可用。在进行下一步之前，请查阅并跟随文档中《寻找代码检查可执行文件》部分的步骤，并进行“验证您的 PATH”。

一旦您已安装和配置了 ansible-lint，如果尚未安装，您可以继续安装 SublimeLinter-contrib-ansible-lint 插件。

插件安装

请使用 Package Control 来安装代码检查插件。这将确保插件在有新版本可用时自动更新。如果您想从源代码安装以修改源代码，您可能已了解所需的操作，所以我们在这里不会涵盖。

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

1. 在 Sublime Text 中，打开 命令面板 并输入 install。在您应该看到的命令中，应该有 Package Control: Install Package。如果不突出显示此命令，请使用键盘或鼠标选中它。Package Control 将花费几秒钟时间检索可用插件的列表。

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

推荐插件

强烈建议同时安装 Sublime 插件 Trailing Spaces，方式是使用 Package Control。并将 Trim On Save 选项设置为 true。

这些设置可以在以下位置找到：

Sublime Text -> Preferences -> Settings

{ "trailing_spaces_trim_on_save": true }

设置

有关 SublimeLinter 如何配合设置工作的通用信息，请参阅 设置。有关通用代码检查设置的信息，请参阅 代码检查设置。

除了标准的 SublimeLinter 设置外，SublimeLinter-contrib-ansible-lint 还提供自己的设置。标记为“行内设置”或“行内覆盖”的设置也可以行内使用。

所有标签列表

贡献

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

1. 在插件仓库中进行分叉。
2. 在从最新的 master 创建的独立主题分支上进行开发。
3. 在主题分支中提交和推送。
4. 发起拉取请求。
5. 请耐心等待。;-)

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

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

感谢您的帮助！

感谢您的贡献！

jeffbyrnes, Boulet-