ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-contrib-yamllint

by thomasmeeus ST3

SublimeLinter 3 plugin for yaml-files which detects duplicate keys, invalid indentation, etc..

Details

Installs

  • Total 1K
  • Win 230
  • OS X 584
  • Linux 274
Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10
Windows 2 3 5 2 1 2 1 2 2 2 5 5 2 0 0 0 0 0 4 1 2 1 7 4 5 3 1 3 1 0 4 1 7 5 2 2 2 8 1 2 2 0 2 1 1 3
OS X 2 7 7 5 4 6 7 2 7 5 8 5 6 3 2 6 8 5 10 2 6 2 7 8 5 4 4 1 4 3 7 8 12 4 1 4 5 9 7 13 5 5 3 13 8 5
Linux 3 3 3 2 5 3 3 0 4 3 6 1 7 2 3 3 4 3 3 3 1 1 5 4 4 9 5 0 2 1 5 2 1 4 0 0 5 7 6 5 4 3 0 2 2 7

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-yamllint

Build Status

This linter plugin for SublimeLinter provides an interface to yamllint. It will be used with files that have the “yaml” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that yamllint is installed on your system. To install yamllint, do the following:

  1. Install Python3 and pip. Python3 is required by yamllint

  2. Install yamllint by typing the following in a terminal:

[sudo] pip3 install yamllint

Note: This plugin requires yamllint 1.9 or later.

Linter configuration

In order for yamllint to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.

Once you have installed and configured yamllint, you can proceed to install the SublimeLinter-contrib-yamllint plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type yamllint. Among the entries you should see SublimeLinter-contrib-yamllint. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

Check the Yamllint docs for more information about all settings. I suggest to create the file ~/.config/yamllint/config to override specific settings.

extends: default

rules:
  line-length:
    max: 600

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!