From 49d0f202c5c0ebb07472cd78b829e33abd9805e3 Mon Sep 17 00:00:00 2001 From: Glavin Wiechert Date: Wed, 5 Aug 2015 12:16:31 -0300 Subject: [PATCH] Update docs --- docs/options.md | 127 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) diff --git a/docs/options.md b/docs/options.md index 4c5eba6..7aff727 100644 --- a/docs/options.md +++ b/docs/options.md @@ -273,6 +273,34 @@ If lists of assignments or properties should be vertically aligned for faster an Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify) +#### [gherkin - Indent size](#gherkin---indent-size) + +**Key**: `gherkin_indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) + +**Description**: + +Indentation size/length (Supported by Gherkin formatter) + +#### [gherkin - Indent char](#gherkin---indent-char) + +**Key**: `gherkin_indent_char` + +**Default**: ` ` + +**Type**: `string` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) + +**Description**: + +Indentation character (Supported by Gherkin formatter) + #### [Fortran - Emacs path](#fortran---emacs-path) **Key**: `fortran_emacs_path` @@ -1263,6 +1291,40 @@ Default Beautifier to be used for ERB Automatically beautify ERB files on save +#### [Language Config - gherkin - Disable Beautifying Language](#language-config---gherkin---disable-beautifying-language) + +**Key**: `language_gherkin_disabled` + +**Type**: `boolean` + +**Description**: + +Disable gherkin Beautification + +#### [Language Config - gherkin - Default Beautifier](#language-config---gherkin---default-beautifier) + +**Key**: `language_gherkin_default_beautifier` + +**Default**: `Gherkin formatter` + +**Type**: `string` + +**Enum**: `Gherkin formatter` + +**Description**: + +Default Beautifier to be used for gherkin + +#### [Language Config - gherkin - Beautify On Save](#language-config---gherkin---beautify-on-save) + +**Key**: `language_gherkin_beautify_on_save` + +**Type**: `boolean` + +**Description**: + +Automatically beautify gherkin files on save + #### [Language Config - Go - Disable Beautifying Language](#language-config---go---disable-beautifying-language) **Key**: `language_go_disabled` @@ -1807,6 +1869,40 @@ Default Beautifier to be used for PHP Automatically beautify PHP files on save +#### [Language Config - Puppet - Disable Beautifying Language](#language-config---puppet---disable-beautifying-language) + +**Key**: `language_puppet_disabled` + +**Type**: `boolean` + +**Description**: + +Disable Puppet Beautification + +#### [Language Config - Puppet - Default Beautifier](#language-config---puppet---default-beautifier) + +**Key**: `language_puppet_default_beautifier` + +**Default**: `puppet-lint` + +**Type**: `string` + +**Enum**: `puppet-lint` + +**Description**: + +Default Beautifier to be used for Puppet + +#### [Language Config - Puppet - Beautify On Save](#language-config---puppet---beautify-on-save) + +**Key**: `language_puppet_beautify_on_save` + +**Type**: `boolean` + +**Description**: + +Automatically beautify Puppet files on save + #### [Language Config - Python - Disable Beautifying Language](#language-config---python---disable-beautifying-language) **Key**: `language_python_disabled` @@ -3157,6 +3253,37 @@ Add a space before an anonymous function's parens, ie. function () (Support Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff) +### Gherkin formatter + +#### [gherkin - Indent size](#gherkin---indent-size) + +**Key**: `gherkin_indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) + +**Description**: + +Indentation size/length (Supported by Gherkin formatter) + +#### [gherkin - Indent char](#gherkin---indent-char) + +**Key**: `gherkin_indent_char` + +**Default**: ` ` + +**Type**: `string` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) + +**Description**: + +Indentation character (Supported by Gherkin formatter) + + ### Fortran Beautifier #### [Fortran - Emacs path](#fortran---emacs-path)