SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
yamllint is installed on your system. To install
yamllint, do the following:
Install Python and pip. Python is required by
yamllintby typing the following in a terminal:
[sudo] pip install yamllint
Note: This plugin requires
yamllint 1.9 or later.
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.
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:
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.
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.
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
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- 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!