# Craft Sublime Snippets
Some snippets for when you are developing plugins on [Craft](http://www.buildwithcraft.com), created for Sublime Text 3.

These snippets have been made from looking at the [plugin docs](http://buildwithcraft.com/docs/plugins/introduction) and also [Pixel & Tonic's coding standards](https://github.com/pixelandtonic/CodingStandards).

## Installation
These snippets are not yet on Package Control, but they will be added soon hopefully.
For now to install simply follow these steps:

### OSX
`cd "~/Library/Application Support/Sublime Text 3/Packages"`

### Windows
`cd "C:\Users\YOUR_USERNAME\AppData\Roaming\Sublime Text 3\Packages"`

### Inside Packages
`git clone https://github.com/alecritson/Craft-Sublime-Snippets.git "craft-snippets"`

## Available snippets

Snippet  | Output | Reference
------------- | ------------- | -------------
`craft-class-comm`  | Class and interface DocBlock comment | [link](https://github.com/pixelandtonic/CodingStandards/blob/master/standards/PHP.md#29-comments)
`craft-method-comm`  | Method DocBlock comment | [link](https://github.com/pixelandtonic/CodingStandards/blob/master/standards/PHP.md#29-comments)
`craft-property-comm`  | Property DocBlock comment | [link](https://github.com/pixelandtonic/CodingStandards/blob/master/standards/PHP.md#29-comments)
`craft-h1-comm`  | Heading one comment | [link](https://github.com/pixelandtonic/CodingStandards/blob/master/standards/PHP.md#29-comments)
`craft-h2-comm`  | Heading two comment | [link](https://github.com/pixelandtonic/CodingStandards/blob/master/standards/PHP.md#29-comments)
`craft-controller-class` | Controller class scaffold | [link](http://buildwithcraft.com/docs/plugins/controllers)
`craft-fieldtype-class` | FieldType class scaffold | [link](http://buildwithcraft.com/docs/plugins/field-types)
`craft-model-class` | Model class scaffold | [link](http://buildwithcraft.com/docs/plugins/models)
`craft-record-class` | Record class scaffold | [link](http://buildwithcraft.com/docs/plugins/records)
`craft-service-class` | Service class scaffold | [link](http://buildwithcraft.com/docs/plugins/services)
`craft-variables-class` | Template Variables class scaffold | [link](http://buildwithcraft.com/docs/plugins/variables)
`craft-widget-class` | Widget class scaffold | [link](http://buildwithcraft.com/docs/plugins/widgets)