|
1 | | -SublimeLinter-pyyaml |
2 | | -========================= |
| 1 | +SublimeLinter-pyyaml DEPRECATED |
| 2 | +=============================== |
3 | 3 |
|
4 | 4 | [](https://travis-ci.org/SublimeLinter/SublimeLinter-pyyaml) |
5 | 5 |
|
6 | | -This linter plugin for [SublimeLinter][docs] provides an interface to [pyyaml](http://pyyaml.org/). It will be used with files that have the “YAML” syntax. |
7 | | - |
8 | | -## Installation |
9 | | -SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][installation]. |
10 | | - |
11 | | -### Linter installation |
12 | | -Before using this plugin, you must ensure that `pyyaml` is installed for **Python 3** on your system, and **available for direct import in Sublime Text 3**. |
13 | | - |
14 | | -Package Control should take care of the dependencies for you, but if not, you can do the following: |
15 | | - |
16 | | -1. Install [Python 3](http://python.org/download/) and [pip](http://www.pip-installer.org/en/latest/installing.html) for this Python 3 version. |
17 | | - |
18 | | -1. Install `pyyaml` by typing the following in a terminal: |
19 | | - ```bash |
20 | | - # X is the minor version of python 3 you installed pip with. |
21 | | - [sudo] pip-3.X install pyyaml |
22 | | - |
23 | | - # or on Windows: |
24 | | - C:\Python3X\Scripts\pip.exe install pyyaml |
25 | | - ``` |
26 | | - |
27 | | -For Windows, a PyYAML installer is also available from [PyYAML on Pypi](https://pypi.python.org/pypi/PyYAML). Make sure to use a Python 3.X version. |
28 | | - |
29 | | -For Debian(Linux), you can just use "apt-get install python3-yaml" (Since you might run into difficulties with pip3). |
30 | | - |
31 | | -Once `pyyaml` is installed, you can proceed to install the SublimeLinter-pyyaml plugin if it is not yet installed. |
32 | | - |
33 | | -### Plugin installation |
34 | | -Please use [Package Control][pc] 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. |
35 | | - |
36 | | -To install via Package Control, do the following: |
37 | | - |
38 | | -1. Within Sublime Text, bring up the [Command Palette][cmd] 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. |
39 | | - |
40 | | -1. When the plugin list appears, type `pyyaml`. Among the entries you should see `SublimeLinter-pyyaml`. If that entry is not highlighted, use the keyboard or mouse to select it. |
41 | | - |
42 | | -1. When the module is installed and you open a “YAML” file, you should see a message stating ``SublimeLinter: pyyaml activated: <builtin>`` or similar in the console. The message should be similar to ``SublimeLinter: yaml imported <module 'yaml' from '/usr/local/lib/python3.3/dist-packages/yaml/__init__.py'>`` if debug mode is on. |
43 | | - |
44 | | -1. If you see ``SublimeLinter: WARNING: import of yaml module in pyyaml failed`` instead, try running ``import yaml`` in the SublimeText console. If it fails, the module could not be located, please see [Troubleshooting](https://github.com/SublimeLinter/SublimeLinter.github.io/wiki/Troubleshooting), or use the [SublimeLinter google group](https://groups.google.com/forum/#!forum/sublimelinter) to report installation and configuration problems. |
45 | | - |
46 | | -## Settings |
47 | | -For general information on how SublimeLinter works with settings, please see [Settings][settings]. For information on generic linter settings, please see [Linter Settings][linter-settings]. |
48 | | - |
49 | | -## Contributing |
50 | | -If you would like to contribute enhancements or fixes, please do the following: |
51 | | - |
52 | | -1. Fork the plugin repository. |
53 | | -1. Hack on a separate topic branch created from the latest `master`. |
54 | | -1. Commit and push the topic branch. |
55 | | -1. Make a pull request. |
56 | | -1. Be patient. ;-) |
57 | | - |
58 | | -Please note that modications should follow these coding guidelines: |
59 | | - |
60 | | -- Indent is 4 spaces. |
61 | | -- Code should pass flake8 and pep257 linters. |
62 | | -- Vertical whitespace helps readability, don’t be afraid to use it. |
63 | | -- Please use descriptive variable names, no abbrevations unless they are very well known. |
64 | | - |
65 | | -Thank you for helping out! |
66 | | - |
67 | | -[docs]: http://sublimelinter.readthedocs.org |
68 | | -[installation]: http://sublimelinter.readthedocs.org/en/latest/installation.html |
69 | | -[locating-executables]: http://sublimelinter.readthedocs.org/en/latest/usage.html#how-linter-executables-are-located |
70 | | -[pc]: https://sublime.wbond.net/installation |
71 | | -[cmd]: http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html |
72 | | -[settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html |
73 | | -[linter-settings]: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html |
74 | | -[inline-settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-settings |
| 6 | +This package has been deprecated. [SublimeLinter-contrib-yamllint](https://packagecontrol.io/packages/SublimeLinter-contrib-yamllint) provides a smarter and more modern approach to linting yaml, please upgrade to that. SublimeLinter 4 will drop support for SL-pyyaml. |
0 commit comments