Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 4.82 KB

README.md

File metadata and controls

101 lines (67 loc) · 4.82 KB
Raw

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.

SublimeLinter-contrib-yamllint detecting a duplicate key

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 Python and pip. Python is required by yamllint

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

    [sudo] pip install yamllint

Note: This plugin requires yamllint 1.9 or later.

Linter configuration - basic

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.

Linter configuration - overriding

Notice that by default yamllint tries to load .yamllint file from the working directory, if exists. That's why sometimes it is better to load specific config based on the project.

Overriding plugin defaults can be done by setting .sublime-project settings section, for example below will use .yamllint file from the root of the project path:

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

Of course you can also hard-code here some path if you really need to.

For more info see SublimeLinter docs.

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

Also if you use per-project override then it is strongly encouraged to set .yamllint file in the root of the project path.

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!