ctrl+shift+p filters: :st2 :st3 :win :osx :linux
浏览

SublimeLinter-contrib-yamllint

作者: thomasmeeus ST3

SublimeLinter 3 插件,用于检测 yaml 文件中的重复键、无效缩进等。

详细信息

安装次数

  • 总数 17K
  • Win 4K
  • Mac 8K
  • Linux 4K
8 月 6 日 8 月 5 日 8 月 4 日 8 月 3 日 8 月 2 日 8 月 1 日 7 月 31 日 7 月 30 日 7 月 29 日 7 月 28 日 7 月 27 日 7 月 26 日 7 月 25 日 7 月 24 日 7 月 23 日 7 月 22 日 7 月 21 日 7 月 20 日 7 月 19 日 7 月 18 日 7 月 17 日 7 月 16 日 7 月 15 日 7 月 14 日 7 月 13 日 7 月 12 日 7 月 11 日 7 月 10 日 7 月 9 日 7 月 8 日 7 月 7 日 7 月 6 日 7 月 5 日 7 月 4 日 7 月 3 日 7 月 2 日 7 月 1 日 6 月 30 日 6 月 29 日 6 月 28 日 6 月 27 日 6 月 26 日 6 月 25 日 6 月 24 日 6 月 23 日 6 月 22 日
Windows 0 1 0 0 0 3 1 1 0 1 0 1 2 0 1 2 0 0 0 1 3 1 0 0 0 1 0 0 1 0 1 0 0 0 0 1 1 0 2 2 0 3 0 1 2 0
Mac 3 6 0 0 1 0 4 2 2 0 0 1 2 0 1 2 1 0 1 3 0 1 1 0 0 1 4 2 1 2 3 0 2 0 4 2 2 0 0 1 0 4 1 2 0 1
Linux 2 2 2 2 0 1 2 0 0 0 1 0 1 1 2 1 0 0 0 1 0 1 1 0 0 3 0 0 1 3 0 0 0 0 0 0 2 2 0 0 0 0 1 1 0 0

自述文件

源代码
raw.githubusercontent.com

SublimeLinter-contrib-yamllint

Build Status

此代码风格检查插件为 SublimeLinter 提供了与 yamllint 的接口。它将用于具有“yaml”语法的文件。

SublimeLinter-contrib-yamllint detecting a duplicate key

安装

要使用此插件,必须安装 SublimeLinter 3。如果尚未安装,请按照此处的说明进行操作。

代码风格检查程序安装

在使用此插件之前,您必须确保系统上已安装 yamllint。要安装 yamllint,请在终端中输入以下内容:

  1. 安装 Python 和 pip。Python 是 yamllint 所必需的。

  2. 使用以下命令安装 yamllint

[sudo] pip install yamllint

注意:此插件需要 yamllint 1.9 或更高版本。

代码风格检查程序配置 - 基础

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

安装并配置 yamllint 后,如果尚未安装,您可以继续安装 SublimeLinter-contrib-yamllint 插件。

代码风格检查程序配置 - 覆盖默认设置

请注意,默认情况下,yamllint 尝试从工作目录加载 .yamllint 文件(如果存在)。这就是为什么有时根据项目加载特定配置更好。

可以通过设置 .sublime-project 的 settings 部分,覆盖插件默认设置,例如以下示例将使用项目路径根目录中的 .yamllint 文件:

"settings":
    {
        "SublimeLinter.linters.yamllint.c":
        [
            "${project_path}/.yamllint"
        ]
    }

当然,如果您确实需要,您也可以在此处硬编码某些路径。

直接参数,无需 .yamllint

为了防止创建 .yamllint 文件,您可以使用 d 选项添加原始 YAML 文本(请使用 \n 和适当的缩进来正确设置 YAML)

逐项目

"settings":
    {
        "SublimeLinter.linters.yamllint.d":
            "extends: default\nrules: { line-length: { max: 120 } }"
    }

或者在全局 SublimeLinter 配置文件中

// SublimeLinter Settings - User
{
    ...

    "linters": {

        ...

        "yamllint": {
            "d": "extends: default\nrules: { line-length: { max: 120 } }",
        },
    }
}

更多信息,请参见 SublimeLinter 文档

插件安装

请使用 Package Control 来安装 linter 插件。这将确保插件在新版本可用时得到更新。如果您想从源安装以便修改源代码,您可能已知自己在做什么,因此这里不会涵盖这一点。

要使用 Package Control 安装,请执行以下操作

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

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

设置

有关所有设置的更多信息,请参阅 Yamllint 文档。我建议创建文件 ~/.config/yamllint/config 以覆盖特定设置。

extends: default

rules:
  line-length:
    max: 600

此外,如果您使用逐项目覆盖,则强烈建议在项目路径的根目录中设置 .yamllint 文件。

贡献

如果您想提供改进或修复,请按照以下步骤操作

  1. 叉 fork 插件仓库。
  2. 从最新的 master 创建一个独立的主题分支。
  3. 提交并推送主题分支。
  4. 发起 pull request。
  5. 要有耐心。;-)

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

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

感谢您的帮助!