Mirrors
/
atom-beautify
mirror of https://github.com/Glavin001/atom-beautify.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Close #1039. Add beautifier option comparison documentation

This commit is contained in:
Glavin Wiechert 2016-07-04 23:42:22 -03:00
parent 41ebc5ed93
commit 535f08e515
4 changed files with 668 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README-template.md
View File

@ -12,7 +12,7 @@
| Before | After |
| --- | ---- |
| Original HTML | Beautified HTML |
| ![image](https://cloud.githubusercontent.com/assets/1885333/16542239/dd92b766-4076-11e6-8667-0e66cd9f4515.png) | ![image](https://cloud.githubusercontent.com/assets/1885333/16542240/df9bedb6-4076-11e6-98c3-0cbac446583b.png) |
| ![image](https://cloud.githubusercontent.com/assets/1885333/16542727/db52adc6-408a-11e6-824e-04aed06bd2f7.png) | ![image](https://cloud.githubusercontent.com/assets/1885333/16542728/dcac3700-408a-11e6-8e35-9c8fc4432edc.png) |
## Table of Contents

35
docs/index.coffee
View File

@ -115,6 +115,41 @@ Handlebars.registerHelper('language-beautifiers-support', (languageOptions, opti
return new Handlebars.SafeString(results)
)
Handlebars.registerHelper('language-options-support', (languageOptions, options) ->
###
| Option | PrettyDiff | JS-Beautify |
| --- | --- | --- |
| `brace_style` | ? | ? |
| `break_chained_methods` | ? | ? |
| `end_with_comma` | ? | ? |
| `end_with_newline` | ? | ? |
| `eval_code` | ? | ? |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
###
rows = []
beautifiers = languageOptions.beautifiers.sort()
headers = ['Option'].concat(beautifiers)
rows.push(headers)
rows.push(_.map(headers, () -> '---'))
# console.log(languageOptions)
_.each(Object.keys(languageOptions.properties), (op) ->
field = languageOptions.properties[op]
support = _.map(beautifiers, (b) ->
if (_.includes(field.beautifiers, b) or _.includes(["disabled", "default_beautifier", "beautify_on_save"], op))
return ':white_check_mark:'
else
return ':x:'
)
rows.push(["`#{op}`"].concat(support))
)
results = _.map(rows, (r) -> "| #{r.join(' | ')} |").join('\n')
return new Handlebars.SafeString(results)
)
sortKeysBy = (obj, comparator) ->
keys = _.sortBy(_.keys(obj), (key) ->
return if comparator then comparator(obj[key], key) else key

2
docs/option-group-template.md
View File

@ -2,6 +2,8 @@
{{#if beautifiers}}
**Supported Beautifiers**: {{#each beautifiers}} {{#linkify this}}`{{this}}`{{/linkify}} {{/each}}
{{language-options-support this}}
{{/if}}
**Description**:

630
docs/options.md
View File

@ -135,6 +135,13 @@ Supported options for each language.
**Supported Beautifiers**: [`Uncrustify`](#uncrustify)
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
**Description**:
Options for language Apex
@ -222,6 +229,13 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`Uncrustify`](#uncrustify)
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
**Description**:
Options for language Arduino
@ -309,6 +323,13 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`Uncrustify`](#uncrustify) [`clang-format`](#clang-format)
| Option | Uncrustify | clang-format |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
**Description**:
Options for language C
@ -396,6 +417,16 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Coldfusion
@ -563,6 +594,31 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt)
| Option | Coffee Formatter | coffee-fmt |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `break_chained_methods` | :white_check_mark: | :x: |
| `end_with_comma` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `eval_code` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :x: |
| `space_after_anon_function` | :white_check_mark: | :x: |
| `space_before_conditional` | :white_check_mark: | :x: |
| `space_in_paren` | :white_check_mark: | :x: |
| `unescape_strings` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :x: |
**Description**:
Options for language CoffeeScript
@ -1096,6 +1152,13 @@ Wrap lines at next opportunity after N characters (Supported by Coffee Formatter
**Supported Beautifiers**: [`Uncrustify`](#uncrustify) [`clang-format`](#clang-format)
| Option | Uncrustify | clang-format |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
**Description**:
Options for language C++
@ -1183,6 +1246,12 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`Crystal`](#crystal)
| Option | Crystal |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Crystal
@ -1246,6 +1315,13 @@ Automatically beautify Crystal files on save
**Supported Beautifiers**: [`Uncrustify`](#uncrustify)
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
**Description**:
Options for language C#
@ -1333,6 +1409,25 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`CSScomb`](#csscomb) [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff)
| Option | CSScomb | JS Beautify | Pretty Diff |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: | :x: |
| `convert_quotes` | :x: | :x: | :white_check_mark: |
| `force_indentation` | :x: | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: | :white_check_mark: |
| `indent_comments` | :x: | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: | :white_check_mark: |
| `no_lead_zero` | :x: | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: | :white_check_mark: |
| `selector_separator_newline` | :x: | :white_check_mark: | :x: |
| `wrap_line_length` | :x: | :white_check_mark: | :white_check_mark: |
**Description**:
Options for language CSS
@ -1722,6 +1817,12 @@ Maximum amount of characters per line (0 = disable) (Supported by JS Beautify, P
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language CSV
@ -1785,6 +1886,13 @@ Automatically beautify CSV files on save
**Supported Beautifiers**: [`Uncrustify`](#uncrustify) [`dfmt`](#dfmt)
| Option | Uncrustify | dfmt |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
**Description**:
Options for language D
@ -1872,6 +1980,20 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language EJS
@ -2135,6 +2257,12 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`elm-format`](#elm-format)
| Option | elm-format |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Elm
@ -2198,6 +2326,16 @@ Automatically beautify Elm files on save
**Supported Beautifiers**: [`HTML Beautifier`](#html-beautifier) [`Pretty Diff`](#pretty-diff)
| Option | HTML Beautifier | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
**Description**:
Options for language ERB
@ -2365,6 +2503,12 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`erl_tidy`](#erl_tidy)
| Option | erl_tidy |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Erlang
@ -2428,6 +2572,14 @@ Automatically beautify Erlang files on save
**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier)
| Option | Fortran Beautifier |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `emacs_path` | :white_check_mark: |
| `emacs_script_path` | :white_check_mark: |
**Description**:
Options for language Fortran
@ -2539,6 +2691,14 @@ Path to the emacs script (Supported by Fortran Beautifier)
**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter)
| Option | Gherkin formatter |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
**Description**:
Options for language gherkin
@ -2654,6 +2814,12 @@ Indentation size/length (Supported by Gherkin formatter)
**Supported Beautifiers**: [`gofmt`](#gofmt)
| Option | gofmt |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Go
@ -2717,6 +2883,25 @@ Automatically beautify Go files on save
**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff)
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
**Description**:
Options for language Handlebars
@ -3162,6 +3347,12 @@ Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
**Supported Beautifiers**: [`stylish-haskell`](#stylish-haskell)
| Option | stylish-haskell |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Haskell
@ -3225,6 +3416,25 @@ Automatically beautify Haskell files on save
**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff)
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
**Description**:
Options for language HTML
@ -3670,6 +3880,14 @@ Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify)
| Option | Pug Beautify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
**Description**:
Options for language Jade
@ -3785,6 +4003,13 @@ Indentation size/length (Supported by Pug Beautify)
**Supported Beautifiers**: [`Uncrustify`](#uncrustify)
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
**Description**:
Options for language Java
@ -3872,6 +4097,31 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`JSCS Fixer`](#jscs-fixer) [`Pretty Diff`](#pretty-diff)
| Option | JS Beautify | JSCS Fixer | Pretty Diff |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: | :x: |
| `break_chained_methods` | :white_check_mark: | :x: | :white_check_mark: |
| `end_with_comma` | :white_check_mark: | :x: | :white_check_mark: |
| `end_with_newline` | :white_check_mark: | :x: | :x: |
| `eval_code` | :white_check_mark: | :x: | :x: |
| `indent_char` | :white_check_mark: | :x: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: | :x: |
| `indent_size` | :white_check_mark: | :x: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :x: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: | :x: |
| `preserve_newlines` | :white_check_mark: | :x: | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: | :x: | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: | :x: | :x: |
| `space_in_paren` | :white_check_mark: | :x: | :x: |
| `unescape_strings` | :white_check_mark: | :x: | :x: |
| `wrap_line_length` | :white_check_mark: | :x: | :white_check_mark: |
**Description**:
Options for language JavaScript
@ -4405,6 +4655,31 @@ Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pre
**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff)
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `break_chained_methods` | :white_check_mark: | :white_check_mark: |
| `end_with_comma` | :white_check_mark: | :white_check_mark: |
| `end_with_newline` | :white_check_mark: | :x: |
| `eval_code` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: | :x: |
| `space_in_paren` | :white_check_mark: | :x: |
| `unescape_strings` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
**Description**:
Options for language JSON
@ -4938,6 +5213,20 @@ Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pre
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language JSX
@ -5199,6 +5488,19 @@ Wrap lines at next opportunity after N characters (Supported by Pretty Diff)
**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify)
| Option | Latex Beautify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `align_columns_in_environments` | :white_check_mark: |
| `always_look_for_split_braces` | :white_check_mark: |
| `always_look_for_split_brackets` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_preamble` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `remove_trailing_whitespace` | :white_check_mark: |
**Description**:
Options for language LaTeX
@ -5443,6 +5745,24 @@ Remove trailing whitespace (Supported by Latex Beautify)
**Supported Beautifiers**: [`CSScomb`](#csscomb) [`Pretty Diff`](#pretty-diff)
| Option | CSScomb | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
| `convert_quotes` | :x: | :white_check_mark: |
| `force_indentation` | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_comments` | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: |
| `no_lead_zero` | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
**Description**:
Options for language LESS
@ -5808,6 +6128,12 @@ Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)
**Supported Beautifiers**: [`Lua beautifier`](#lua-beautifier)
| Option | Lua beautifier |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Lua
@ -5871,6 +6197,15 @@ Automatically beautify Lua files on save
**Supported Beautifiers**: [`Remark`](#remark) [`Tidy Markdown`](#tidy-markdown)
| Option | Remark | Tidy Markdown |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `commonmark` | :white_check_mark: | :x: |
| `gfm` | :white_check_mark: | :x: |
| `yaml` | :white_check_mark: | :x: |
**Description**:
Options for language Markdown
@ -6010,6 +6345,26 @@ Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax
**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier)
| Option | Marko Beautifier |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `brace_style` | :white_check_mark: |
| `end_with_newline` | :white_check_mark: |
| `extra_liners` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: |
| `indent_scripts` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `syntax` | :white_check_mark: |
| `unformatted` | :white_check_mark: |
| `wrap_attributes` | :white_check_mark: |
| `wrap_attributes_indent_size` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Marko
@ -6483,6 +6838,25 @@ Maximum characters per line (0 disables) (Supported by Marko Beautifier)
**Supported Beautifiers**: [`JS Beautify`](#js-beautify)
| Option | JS Beautify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `brace_style` | :white_check_mark: |
| `end_with_newline` | :white_check_mark: |
| `extra_liners` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: |
| `indent_scripts` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `unformatted` | :white_check_mark: |
| `wrap_attributes` | :white_check_mark: |
| `wrap_attributes_indent_size` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Mustache
@ -6928,6 +7302,13 @@ Maximum characters per line (0 disables) (Supported by JS Beautify)
**Supported Beautifiers**: [`Uncrustify`](#uncrustify) [`clang-format`](#clang-format)
| Option | Uncrustify | clang-format |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
**Description**:
Options for language Objective-C
@ -7015,6 +7396,12 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`ocp-indent`](#ocp-indent)
| Option | ocp-indent |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language OCaml
@ -7078,6 +7465,13 @@ Automatically beautify OCaml files on save
**Supported Beautifiers**: [`Uncrustify`](#uncrustify)
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
**Description**:
Options for language Pawn
@ -7165,6 +7559,13 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`Perltidy`](#perltidy)
| Option | Perltidy |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `perltidy_profile` | :white_check_mark: |
**Description**:
Options for language Perl
@ -7252,6 +7653,17 @@ Specify a configuration file which will override the default name of .perltidyrc
**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) [`PHPCBF`](#phpcbf)
| Option | PHP-CS-Fixer | PHPCBF |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `cs_fixer_path` | :white_check_mark: | :x: |
| `fixers` | :white_check_mark: | :x: |
| `level` | :white_check_mark: | :x: |
| `phpcbf_path` | :white_check_mark: | :x: |
| `standard` | :white_check_mark: | :white_check_mark: |
**Description**:
Options for language PHP
@ -7435,6 +7847,12 @@ Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS ru
**Supported Beautifiers**: [`puppet-lint`](#puppet-lint)
| Option | puppet-lint |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Puppet
@ -7498,6 +7916,16 @@ Automatically beautify Puppet files on save
**Supported Beautifiers**: [`autopep8`](#autopep8) [`yapf`](#yapf)
| Option | autopep8 | yapf |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `ignore` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :x: |
| `max_line_length` | :white_check_mark: | :x: |
| `sort_imports` | :white_check_mark: | :x: |
**Description**:
Options for language Python
@ -7665,6 +8093,16 @@ sort imports (requires isort installed) (Supported by autopep8)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Riot.js
@ -7832,6 +8270,15 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify)
| Option | Rubocop | Ruby Beautify |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `rubocop_path` | :white_check_mark: | :x: |
**Description**:
Options for language Ruby
@ -7973,6 +8420,13 @@ Path to the `rubocop` CLI executable (Supported by Rubocop)
**Supported Beautifiers**: [`rustfmt`](#rustfmt)
| Option | rustfmt |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `rustfmt_path` | :white_check_mark: |
**Description**:
Options for language Rust
@ -8060,6 +8514,24 @@ Path to rustfmt program (Supported by rustfmt)
**Supported Beautifiers**: [`CSScomb`](#csscomb) [`Pretty Diff`](#pretty-diff)
| Option | CSScomb | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
| `convert_quotes` | :x: | :white_check_mark: |
| `force_indentation` | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_comments` | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: |
| `no_lead_zero` | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
**Description**:
Options for language Sass
@ -8425,6 +8897,24 @@ Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)
**Supported Beautifiers**: [`CSScomb`](#csscomb) [`Pretty Diff`](#pretty-diff)
| Option | CSScomb | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
| `convert_quotes` | :x: | :white_check_mark: |
| `force_indentation` | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_comments` | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: |
| `no_lead_zero` | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
**Description**:
Options for language SCSS
@ -8790,6 +9280,16 @@ Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Spacebars
@ -8957,6 +9457,15 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`sqlformat`](#sqlformat)
| Option | sqlformat |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `identifiers` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `keywords` | :white_check_mark: |
**Description**:
Options for language SQL
@ -9102,6 +9611,16 @@ Change case of keywords (Supported by sqlformat)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language SVG
@ -9269,6 +9788,16 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Swig
@ -9436,6 +9965,22 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `align_assignments` | :white_check_mark: |
| `convert_quotes` | :white_check_mark: |
| `force_indentation` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_comments` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `newline_between_rules` | :white_check_mark: |
| `no_lead_zero` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language TSS
@ -9749,6 +10294,20 @@ Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Twig
@ -10012,6 +10571,31 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter)
| Option | TypeScript Formatter |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `brace_style` | :white_check_mark: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `end_with_newline` | :white_check_mark: |
| `eval_code` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_level` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `jslint_happy` | :white_check_mark: |
| `keep_array_indentation` | :white_check_mark: |
| `keep_function_indentation` | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: |
| `space_in_paren` | :white_check_mark: |
| `unescape_strings` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language TypeScript
@ -10545,6 +11129,13 @@ Wrap lines at next opportunity after N characters (Supported by TypeScript Forma
**Supported Beautifiers**: [`Uncrustify`](#uncrustify)
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
**Description**:
Options for language Vala
@ -10632,6 +11223,16 @@ Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language Visualforce
@ -10799,6 +11400,25 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff)
**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff)
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
**Description**:
Options for language XML
@ -11244,6 +11864,16 @@ Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff)
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language XTemplate