Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 2.63 KB

README.md

File metadata and controls

67 lines (41 loc) · 2.63 KB
Raw

SublimePuppet

Puppet highlighting, snippets and completion for Sublime Text 2 & 3. Now with windows parsing support.

Plugin installation

Package Manager

First, install the Package Control plugin, instructions here: http://wbond.net/sublime_packages/package_control.

Once you install Package Control, restart ST2 and bring up the Command Palette (Command+Shift+P on OS X, Control+Shift+P on Linux/Windows). Select "Package Control: Install Package", wait while Package Control fetches the latest package list, then select SublimeLinter when the list appears. The advantage of using this method is that Package Control will automatically keep SublimePuppet up to date with the latest version.

Manual

With Git: Clone the repository in your Sublime Text "Packages" directory:

git clone https://github.com/SublimeLinter/SublimeLinter.git

The "Packages" directory is located at:

  • OS X:

      ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/

  • Linux:

      ~/.config/sublime-text-2/Packages/

  • Windows:

      %APPDATA%/Sublime Text 2/Packages/

Without Git: Download the latest source from here and copy the SublimePuppet folder to your Sublime Text "Packages" directory.

Puppet installation

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

  1. Install Ruby.

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

    gem install puppet

  3. If you are using rvm or rbenv, ensure that they are loaded in your shell’s correct startup file. See here for more information.

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.