# LuaFormat

> Lua Format Plugin For Sublime Text

[![GitHub version][version-image]][version-link]
[![Build Status][travis-image]][travis-link]
[![MIT License][mit-image]](LICENCE)

## Install

- Package Control

Search `LuaFormat` via `Package Control: Install Package`

- Git

git clone this repository to `Packages Path`

- Zip

download zip and unzip to `Packages Path`

## Usage

- Command Panel

  > `Ctrl + Shift + P`

      - `LuaFormat: Key Bindings`
      - `LuaFormat: Settings`

- Menu

  > Preferences -> Package Settings -> LuaFormat

      - `Settings - User`
      - `Key Bindings - User`

- Shortcuts

  - `Ctrl + Alt + F`

- Settings
  - `tab_size`: the number of spaces a tab
  - `special_symbol_split`: split special symbol with a spaces
  - `bracket_split`: split bracket with a spaces
  - `auto_format_on_save`: run `Lua Format` automatically when saved file

[version-image]: https://badge.fury.io/gh/floydagithub%2Fluaformat.svg
[version-link]: https://badge.fury.io/gh/floydagithub%2Fluaformat
[travis-image]: https://img.shields.io/travis/FloydaGithub/LuaFormat/master.png
[travis-link]: https://travis-ci.org/FloydaGithub/LuaFormat
[mit-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat