Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Authors
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Russell Cloak <russcloak@gmail.com>
Sean Keery <skibum55@hotmail.com>
8 changes: 6 additions & 2 deletions Puppet.sublime-build
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,9 @@
"cmd": [ "puppet", "parser", "validate", "--color=false", "--confdir=/tmp", "--vardir=/tmp", "$file" ],
"working_dir": "${project_path:${folder:${file_path}}}",
"selector": "source.pp",
"path": "/opt/local/bin:$PATH"
}
"path": "/opt/local/bin:$PATH",
"windows":
{
"cmd": ["puppet.bat", "parser", "validate", "--color=false", "$file" ]
}
}
67 changes: 65 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,67 @@
SublimePuppet
=============
==================================

Puppet (puppetlabs.com) highlighting, snippets and completion for Sublime Text 2
[Puppet](puppetlabs.com) 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](https://github.com/russCloak/SublimePuppet/archive/master.zip) 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](http://ruby-lang.org).

1. Install `puppet` by typing the following in a terminal:
```
gem install puppet
```

1. If you are using `rvm` or `rbenv`, ensure that they are loaded in your shell’s correct startup file. See [here](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#shell-startup-files) for more information.

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

1. Fork the plugin repository.
1. Hack on a separate topic branch created from the latest `master`.
1. Commit and push the topic branch.
1. Make a pull request.
1. 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.

[pc]: https://sublime.wbond.net/installation
[locating-executables]: http://sublimelinter.readthedocs.org/en/latest/usage.html#how-linter-executables-are-located
[cmd]: http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html
Loading