From 608846408d58eba2f62cde0b28f8bcf7f28fb409 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Mon, 9 Oct 2017 21:39:54 +0200 Subject: [PATCH 01/16] add terraform --- src/beautifiers/index.coffee | 1 + src/beautifiers/terraformfmt.coffee | 24 +++++++++++++++ src/languages/index.coffee | 1 + src/languages/terraform.coffee | 20 +++++++++++++ src/options.json | 46 +++++++++++++++++++++++++++-- 5 files changed, 89 insertions(+), 3 deletions(-) create mode 100644 src/beautifiers/terraformfmt.coffee create mode 100644 src/languages/terraform.coffee diff --git a/src/beautifiers/index.coffee b/src/beautifiers/index.coffee index b3e630cee..6d1441043 100644 --- a/src/beautifiers/index.coffee +++ b/src/beautifiers/index.coffee @@ -80,6 +80,7 @@ module.exports = class Beautifiers extends EventEmitter 'marko-beautifier' 'formatR' 'beautysh' + 'terraform' ] ### diff --git a/src/beautifiers/terraformfmt.coffee b/src/beautifiers/terraformfmt.coffee new file mode 100644 index 000000000..fd08d02b6 --- /dev/null +++ b/src/beautifiers/terraformfmt.coffee @@ -0,0 +1,24 @@ +### +Requires terraform installed +### + +"use strict" +Beautifier = require('./beautifier') + +module.exports = class Terraformfmt extends Beautifier + name: "terraformfmt" + link: "https://www.terraform.io/docs/commands/fmt.html" + isPreInstalled: false + + options: { + Terraform: true + } + + beautify: (text, language, options) -> + @run("terraform", [ + "fmt" + tempFile = @tempFile("input", text) + ]) + .then(=> + @readFile(tempFile) + ) diff --git a/src/languages/index.coffee b/src/languages/index.coffee index 9ea2e36a4..7cc1e5c8e 100644 --- a/src/languages/index.coffee +++ b/src/languages/index.coffee @@ -77,6 +77,7 @@ module.exports = class Languages "xml" "xtemplate" "yaml" + "terraform" ] ### diff --git a/src/languages/terraform.coffee b/src/languages/terraform.coffee new file mode 100644 index 000000000..16ad848ba --- /dev/null +++ b/src/languages/terraform.coffee @@ -0,0 +1,20 @@ +module.exports = { + + name: "Terraform" + namespace: "terraform" + fallback: ['js'] + + ### + Supported Grammars + ### + grammars: [ + "Terraform" + ] + + ### + Supported extensions + ### + extensions: [ + "tf" + ] +} diff --git a/src/options.json b/src/options.json index 8767e0d39..de2872e02 100644 --- a/src/options.json +++ b/src/options.json @@ -4578,8 +4578,7 @@ "Lua" ], "extensions": [ - "lua", - "ttslua" + "lua" ], "properties": { "end_of_line": { @@ -6517,6 +6516,47 @@ "description": "Automatically beautify Rust files on save" } } + }, + "terraform": { + "title": "Terraform", + "type": "object", + "description": "Options for language Terraform", + "collapsed": true, + "beautifiers": [ + "terraformfmt" + ], + "grammars": [ + "Terraform" + ], + "extensions": [ + "tf" + ], + "properties": { + "disabled": { + "title": "Disable Beautifying Language", + "order": -3, + "type": "boolean", + "default": false, + "description": "Disable Rust Beautification" + }, + "default_beautifier": { + "title": "Default Beautifier", + "order": -2, + "type": "string", + "default": "terraformfmt", + "description": "Default Beautifier to be used for Terraform", + "enum": [ + "terraformfmt" + ] + }, + "beautify_on_save": { + "title": "Beautify On Save", + "order": -1, + "type": "boolean", + "default": false, + "description": "Automatically beautify Terraform files on save" + } + } }, "sass": { "title": "Sass", @@ -9377,4 +9417,4 @@ } } } -} \ No newline at end of file +} From 70ae361b7a4604f8a0dd7d86c164d1c2317ecb20 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Mon, 9 Oct 2017 21:45:21 +0200 Subject: [PATCH 02/16] remove uneeded diffs --- src/options.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/options.json b/src/options.json index de2872e02..3d379dd35 100644 --- a/src/options.json +++ b/src/options.json @@ -7229,7 +7229,8 @@ "TSS" ], "extensions": [ - "tss" + "lua", + "ttslua" ], "properties": { "indent_size": { @@ -9417,4 +9418,4 @@ } } } -} +} \ No newline at end of file From e5a38e388a260f8a5efce8ce1cb56b156209a8b4 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Mon, 9 Oct 2017 21:48:05 +0200 Subject: [PATCH 03/16] remove uneeded diffs --- src/options.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/options.json b/src/options.json index 3d379dd35..6f0e95aa5 100644 --- a/src/options.json +++ b/src/options.json @@ -4578,7 +4578,8 @@ "Lua" ], "extensions": [ - "lua" + "lua", + "ttslua" ], "properties": { "end_of_line": { @@ -7229,8 +7230,7 @@ "TSS" ], "extensions": [ - "lua", - "ttslua" + "tss" ], "properties": { "indent_size": { From b95ad76d97e0866aa110253d24a0b6cc99b032e3 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Mon, 9 Oct 2017 21:51:07 +0200 Subject: [PATCH 04/16] add changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index afa599980..d6c6177d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # Next +- See [](). Add support for Terraform fmt. - See [#881](https://github.com/Glavin001/atom-beautify/issues/881). Update to Prettydiff version 2! - ... From cc08dbd6c6b907a1a739793c37a94f896ca11b9b Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Mon, 9 Oct 2017 22:09:06 +0200 Subject: [PATCH 05/16] run docs --- README.md | 2 + docs/options.md | 5908 ++++++++++++++++++++-------------- package.json | 9 +- src/beautifiers/index.coffee | 2 +- src/options.json | 375 ++- 5 files changed, 3841 insertions(+), 2455 deletions(-) diff --git a/README.md b/README.md index c33233e50..e0e249be7 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,7 @@ Some of the supported beautifiers are developed for Node.js and are automaticall | SassConvert | :warning: 1 executable | :white_check_mark: :100:% of executables | :whale: With [Docker](https://www.docker.com/):
1. Install [SassConvert (`sass-convert`)](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#syntax) with `docker pull unibeautify/sass-convert`

:bookmark_tabs: Manually:
1. Install [SassConvert (`sass-convert`)](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#syntax) by following http://sass-lang.com/documentation/file.SASS_REFERENCE.html#syntax
| | sqlformat | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to https://github.com/andialbrecht/sqlparse and follow the instructions. | | stylish-haskell | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to https://github.com/jaspervdj/stylish-haskell and follow the instructions. | +| terraformfmt | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to https://www.terraform.io/docs/commands/fmt.html and follow the instructions. | | Tidy Markdown | :white_check_mark: | :ok_hand: Not necessary | :smiley: Nothing! | | TypeScript Formatter | :white_check_mark: | :ok_hand: Not necessary | :smiley: Nothing! | | Uncrustify | :warning: 1 executable | :white_check_mark: :100:% of executables | :whale: With [Docker](https://www.docker.com/):
1. Install [Uncrustify (`uncrustify`)](http://uncrustify.sourceforge.net/) with `docker pull unibeautify/uncrustify`

:bookmark_tabs: Manually:
1. Install [Uncrustify (`uncrustify`)](http://uncrustify.sourceforge.net/) by following https://github.com/uncrustify/uncrustify
| @@ -178,6 +179,7 @@ See [all supported options in the documentation at `docs/options.md`](docs/opti | SQL | `SQL (Rails)`, `SQL` |`.sql` | **[`sqlformat`](https://github.com/andialbrecht/sqlparse)** | | SVG | `SVG` |`.svg` | **[`Pretty Diff`](https://github.com/prettydiff/prettydiff)** | | Swig | `HTML (Swig)`, `SWIG` |`.swig` | **[`Pretty Diff`](https://github.com/prettydiff/prettydiff)** | +| Terraform | `Terraform` |`.tf` | **[`terraformfmt`](https://www.terraform.io/docs/commands/fmt.html)** | | TSS | `TSS` |`.tss` | **[`Pretty Diff`](https://github.com/prettydiff/prettydiff)** | | Twig | `HTML (Twig)` |`.twig` | **[`Pretty Diff`](https://github.com/prettydiff/prettydiff)** | | TypeScript | `TypeScript` |`.ts` | **[`TypeScript Formatter`](https://github.com/vvakame/typescript-formatter)** | diff --git a/docs/options.md b/docs/options.md index 19e54ff9e..cd2a64e07 100644 --- a/docs/options.md +++ b/docs/options.md @@ -12171,29 +12171,39 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff) } ``` -#### [TSS](#tss) +#### [Terraform](#terraform) -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) -| Option | Pretty Diff | +| Option | terraformfmt | | --- | --- | | `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: | +| `brace_style` | :white_check_mark: | +| `break_chained_methods` | :white_check_mark: | +| `end_of_line` | :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_comments` | :white_check_mark: | +| `indent_level` | :white_check_mark: | | `indent_size` | :white_check_mark: | -| `newline_between_rules` | :white_check_mark: | -| `no_lead_zero` | :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 TSS +Options for language Terraform ##### [Disable Beautifying Language](#disable-beautifying-language) @@ -12203,7 +12213,7 @@ Options for language TSS **Description**: -Disable TSS Beautification +Disable Terraform Beautification **How to Configure** @@ -12216,15 +12226,15 @@ Disable TSS Beautification **Important**: This option is only configurable from within Atom Beautify's setting panel. -**Default**: `Pretty Diff` +**Default**: `terraformfmt` **Type**: `string` -**Enum**: `Pretty Diff` +**Enum**: `terraformfmt` **Description**: -Default Beautifier to be used for TSS +Default Beautifier to be used for Terraform **How to Configure** @@ -12241,7 +12251,7 @@ Default Beautifier to be used for TSS **Description**: -Automatically beautify TSS files on save +Automatically beautify Terraform files on save **How to Configure** @@ -12250,85 +12260,161 @@ Automatically beautify TSS files on save 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [Align assignments](#align-assignments) +##### [Brace style](#brace-style) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `align_assignments` +**Key**: `brace_style` + +**Default**: `collapse` + +**Type**: `string` + +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) + +**Description**: + +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by terraformfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "brace_style": "collapse" + } +} +``` + +##### [Break chained methods](#break-chained-methods) + +**Namespace**: `js` + +**Key**: `break_chained_methods` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) +Break chained method calls across subsequent lines (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "align_assignments": false + "js": { + "break_chained_methods": false } } ``` -##### [Convert quotes](#convert-quotes) +##### [End of line](#end-of-line) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `convert_quotes` +**Key**: `end_of_line` -**Default**: `none` +**Default**: `System Default` **Type**: `string` -**Enum**: `none` `double` `single` +**Enum**: `CRLF` `LF` `System Default` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) +Override EOL from line-ending-selector (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "convert_quotes": "none" + "js": { + "end_of_line": "System Default" } } ``` -##### [Force indentation](#force-indentation) +##### [End with comma](#end-with-comma) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `force_indentation` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "force_indentation": false + "js": { + "end_with_comma": false + } +} +``` + +##### [End with newline](#end-with-newline) + +**Namespace**: `js` + +**Key**: `end_with_newline` + +**Type**: `boolean` + +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) + +**Description**: + +End output with newline (Supported by terraformfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "end_with_newline": false + } +} +``` + +##### [Eval code](#eval-code) + +**Namespace**: `js` + +**Key**: `eval_code` + +**Type**: `boolean` + +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) + +**Description**: + + (Supported by terraformfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "eval_code": false } } ``` ##### [Indent char](#indent-char) -**Namespace**: `css` +**Namespace**: `js` **Key**: `indent_char` @@ -12336,51 +12422,49 @@ if indentation should be forcefully applied to markup even if it disruptively ad **Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation character (Supported by Pretty Diff) +Indentation character (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { + "js": { "indent_char": " " } } ``` -##### [Indent comments](#indent-comments) - -**Namespace**: `css` +##### [Indent level](#indent-level) -**Key**: `indent_comments` +**Namespace**: `js` -**Default**: `true` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Determines whether comments should be indented. (Supported by Pretty Diff) +Initial indentation level (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "indent_comments": true + "js": { + "indent_level": 0 } } ``` ##### [Indent size](#indent-size) -**Namespace**: `css` +**Namespace**: `js` **Key**: `indent_size` @@ -12388,455 +12472,315 @@ Determines whether comments should be indented. (Supported by Pretty Diff) **Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation size/length (Supported by Pretty Diff) +Indentation size/length (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { + "js": { "indent_size": 4 } } ``` -##### [Newline between rules](#newline-between-rules) - -**Namespace**: `css` +##### [Indent with tabs](#indent-with-tabs) -**Key**: `newline_between_rules` +**Namespace**: `js` -**Default**: `true` +**Key**: `indent_with_tabs` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Add a newline between CSS rules (Supported by Pretty Diff) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "newline_between_rules": true + "js": { + "indent_with_tabs": false } } ``` -##### [No lead zero](#no-lead-zero) +##### [Jslint happy](#jslint-happy) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `no_lead_zero` +**Key**: `jslint_happy` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) +Enable jslint-stricter mode (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "no_lead_zero": false + "js": { + "jslint_happy": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Keep array indentation](#keep-array-indentation) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `preserve_newlines` +**Key**: `keep_array_indentation` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff) +Preserve array indentation (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "preserve_newlines": false + "js": { + "keep_array_indentation": false } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Keep function indentation](#keep-function-indentation) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `wrap_line_length` +**Key**: `keep_function_indentation` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff) + (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "wrap_line_length": 0 + "js": { + "keep_function_indentation": false } } ``` -#### [Twig](#twig) - -**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: | -| `space_in_paren` | :white_check_mark: | -| `wrap_line_length` | :white_check_mark: | +##### [Max preserve newlines](#max-preserve-newlines) -**Description**: +**Namespace**: `js` -Options for language Twig +**Key**: `max_preserve_newlines` -##### [Disable Beautifying Language](#disable-beautifying-language) +**Default**: `10` -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Type**: `integer` -**Type**: `boolean` +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Disable Twig Beautification +Number of line-breaks to be preserved in one chunk (Supported by terraformfmt) -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. - -##### [Default Beautifier](#default-beautifier) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Default**: `Pretty Diff` - -**Type**: `string` - -**Enum**: `Pretty Diff` - -**Description**: - -Default Beautifier to be used for Twig - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Default Beautifier*" and change it to your desired configuration. - -##### [Beautify On Save](#beautify-on-save) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Type**: `boolean` - -**Description**: - -Automatically beautify Twig files on save - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Beautify On Save*" and change it to your desired configuration. - -##### [Break chained methods](#break-chained-methods) - -**Namespace**: `js` - -**Key**: `break_chained_methods` - -**Type**: `boolean` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Break chained method calls across subsequent lines (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** +**Example `.jsbeautifyrc` Configuration** ```json { "js": { - "break_chained_methods": false + "max_preserve_newlines": 10 } } ``` -##### [End with comma](#end-with-comma) +##### [Preserve newlines](#preserve-newlines) **Namespace**: `js` -**Key**: `end_with_comma` +**Key**: `preserve_newlines` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) +Preserve line-breaks (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_comma": false - } -} -``` - -##### [Indent char](#indent-char) - -**Namespace**: `html` - -**Key**: `indent_char` - -**Default**: ` ` - -**Type**: `string` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Indentation character (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "indent_char": " " - } -} -``` - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` - -**Default**: `4` - -**Type**: `integer` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Indentation size/length (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "indent_size": 4 + "preserve_newlines": true } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Space after anon function](#space-after-anon-function) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `space_after_anon_function` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) +Add a space before an anonymous function's parens, ie. function () (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "space_after_anon_function": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Space before conditional](#space-before-conditional) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `preserve_newlines` +**Key**: `space_before_conditional` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Preserve line-breaks (Supported by Pretty Diff) + (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "js": { + "space_before_conditional": true } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `space_after_anon_function` +**Key**: `space_in_paren` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) +Add padding spaces within paren, ie. f( a, b ) (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_after_anon_function": false + "space_in_paren": false } } ``` -##### [Space in paren](#space-in-paren) +##### [Unescape strings](#unescape-strings) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `unescape_strings` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) +Decode printable characters encoded in xNN notation (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "unescape_strings": false } } ``` ##### [Wrap line length](#wrap-line-length) -**Namespace**: `html` +**Namespace**: `js` **Key**: `wrap_line_length` -**Default**: `250` - **Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Maximum characters per line (0 disables) (Supported by Pretty Diff) +Wrap lines at next opportunity after N characters (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "js": { + "wrap_line_length": 0 } } ``` -#### [TypeScript](#typescript) +#### [TSS](#tss) -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) -| Option | TypeScript Formatter | +| Option | Pretty Diff | | --- | --- | | `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_of_line` | :white_check_mark: | -| `end_with_comma` | :white_check_mark: | -| `end_with_newline` | :white_check_mark: | -| `eval_code` | :white_check_mark: | +| `align_assignments` | :white_check_mark: | +| `convert_quotes` | :white_check_mark: | +| `force_indentation` | :white_check_mark: | | `indent_char` | :white_check_mark: | -| `indent_level` | :white_check_mark: | +| `indent_comments` | :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: | +| `newline_between_rules` | :white_check_mark: | +| `no_lead_zero` | :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 +Options for language TSS ##### [Disable Beautifying Language](#disable-beautifying-language) @@ -12846,7 +12790,7 @@ Options for language TypeScript **Description**: -Disable TypeScript Beautification +Disable TSS Beautification **How to Configure** @@ -12859,15 +12803,15 @@ Disable TypeScript Beautification **Important**: This option is only configurable from within Atom Beautify's setting panel. -**Default**: `TypeScript Formatter` +**Default**: `Pretty Diff` **Type**: `string` -**Enum**: `TypeScript Formatter` +**Enum**: `Pretty Diff` **Description**: -Default Beautifier to be used for TypeScript +Default Beautifier to be used for TSS **How to Configure** @@ -12884,7 +12828,7 @@ Default Beautifier to be used for TypeScript **Description**: -Automatically beautify TypeScript files on save +Automatically beautify TSS files on save **How to Configure** @@ -12893,521 +12837,593 @@ Automatically beautify TypeScript files on save 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [Brace style](#brace-style) - -**Namespace**: `js` - -**Key**: `brace_style` +##### [Align assignments](#align-assignments) -**Default**: `collapse` +**Namespace**: `css` -**Type**: `string` +**Key**: `align_assignments` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) +If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "brace_style": "collapse" + "css": { + "align_assignments": false } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Convert quotes](#convert-quotes) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `break_chained_methods` +**Key**: `convert_quotes` -**Type**: `boolean` +**Default**: `none` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `string` + +**Enum**: `none` `double` `single` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Break chained method calls across subsequent lines (Supported by TypeScript Formatter) +Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "css": { + "convert_quotes": "none" } } ``` -##### [End of line](#end-of-line) +##### [Force indentation](#force-indentation) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `end_of_line` +**Key**: `force_indentation` -**Default**: `System Default` +**Type**: `boolean` -**Type**: `string` - -**Enum**: `CRLF` `LF` `System Default` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Override EOL from line-ending-selector (Supported by TypeScript Formatter) +if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_of_line": "System Default" + "css": { + "force_indentation": false } } ``` -##### [End with comma](#end-with-comma) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `end_with_comma` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `string` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "css": { + "indent_char": " " } } ``` -##### [End with newline](#end-with-newline) +##### [Indent comments](#indent-comments) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `end_with_newline` +**Key**: `indent_comments` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -End output with newline (Supported by TypeScript Formatter) +Determines whether comments should be indented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_newline": false + "css": { + "indent_comments": true } } ``` -##### [Eval code](#eval-code) +##### [Indent size](#indent-size) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `eval_code` +**Key**: `indent_size` -**Type**: `boolean` +**Default**: `4` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `integer` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by TypeScript Formatter) +Indentation size/length (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "css": { + "indent_size": 4 } } ``` -##### [Indent char](#indent-char) +##### [Newline between rules](#newline-between-rules) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `indent_char` +**Key**: `newline_between_rules` -**Default**: ` ` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by TypeScript Formatter) +Add a newline between CSS rules (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_char": " " + "css": { + "newline_between_rules": true } } ``` -##### [Indent level](#indent-level) +##### [No lead zero](#no-lead-zero) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `indent_level` +**Key**: `no_lead_zero` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Initial indentation level (Supported by TypeScript Formatter) +If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_level": 0 + "css": { + "no_lead_zero": false } } ``` -##### [Indent size](#indent-size) - -**Namespace**: `js` +##### [Preserve newlines](#preserve-newlines) -**Key**: `indent_size` +**Namespace**: `css` -**Default**: `4` +**Key**: `preserve_newlines` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by TypeScript Formatter) +Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_size": 4 + "css": { + "preserve_newlines": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `indent_with_tabs` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) +Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_with_tabs": false + "css": { + "wrap_line_length": 0 } } ``` -##### [Jslint happy](#jslint-happy) +#### [Twig](#twig) -**Namespace**: `js` +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) -**Key**: `jslint_happy` +| 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: | +| `space_in_paren` | :white_check_mark: | +| `wrap_line_length` | :white_check_mark: | -**Type**: `boolean` +**Description**: -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +Options for language Twig + +##### [Disable Beautifying Language](#disable-beautifying-language) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` **Description**: -Enable jslint-stricter mode (Supported by TypeScript Formatter) +Disable Twig Beautification -**Example `.jsbeautifyrc` Configuration** +**How to Configure** -```json -{ - "js": { - "jslint_happy": false - } -} -``` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. -##### [Keep array indentation](#keep-array-indentation) +##### [Default Beautifier](#default-beautifier) -**Namespace**: `js` +**Important**: This option is only configurable from within Atom Beautify's setting panel. -**Key**: `keep_array_indentation` +**Default**: `Pretty Diff` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Enum**: `Pretty Diff` **Description**: -Preserve array indentation (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** +Default Beautifier to be used for Twig -```json -{ - "js": { - "keep_array_indentation": false - } -} -``` +**How to Configure** -##### [Keep function indentation](#keep-function-indentation) +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Default Beautifier*" and change it to your desired configuration. -**Namespace**: `js` +##### [Beautify On Save](#beautify-on-save) -**Key**: `keep_function_indentation` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - **Description**: - (Supported by TypeScript Formatter) +Automatically beautify Twig files on save -**Example `.jsbeautifyrc` Configuration** +**How to Configure** -```json -{ - "js": { - "keep_function_indentation": false - } -} -``` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [Max preserve newlines](#max-preserve-newlines) +##### [Break chained methods](#break-chained-methods) **Namespace**: `js` -**Key**: `max_preserve_newlines` - -**Default**: `10` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) +Break chained method calls across subsequent lines (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "max_preserve_newlines": 10 + "break_chained_methods": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `preserve_newlines` - -**Default**: `true` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Preserve line-breaks (Supported by TypeScript Formatter) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "preserve_newlines": true + "end_with_comma": false } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_after_anon_function` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `string` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "html": { + "indent_char": " " } } ``` -##### [Space before conditional](#space-before-conditional) +##### [Indent size](#indent-size) + +**Namespace**: `html` + +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Indentation size/length (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "indent_size": 4 + } +} +``` + +##### [Indent with tabs](#indent-with-tabs) **Namespace**: `js` -**Key**: `space_before_conditional` +**Key**: `indent_with_tabs` + +**Type**: `boolean` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_with_tabs": false + } +} +``` + +##### [Preserve newlines](#preserve-newlines) + +**Namespace**: `html` + +**Key**: `preserve_newlines` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by TypeScript Formatter) +Preserve line-breaks (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "html": { + "preserve_newlines": true } } ``` -##### [Space in paren](#space-in-paren) +##### [Space after anon function](#space-after-anon-function) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `space_after_anon_function` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) +Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "space_after_anon_function": false } } ``` -##### [Unescape strings](#unescape-strings) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `unescape_strings` +**Key**: `space_in_paren` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) +Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "unescape_strings": false + "space_in_paren": false } } ``` ##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +**Namespace**: `html` **Key**: `wrap_line_length` +**Default**: `250` + **Type**: `integer` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) +Maximum characters per line (0 disables) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "wrap_line_length": 0 + "html": { + "wrap_line_length": 250 } } ``` -#### [UX Markup](#ux-markup) +#### [TypeScript](#typescript) -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) -| Option | Pretty Diff | +| 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_of_line` | :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 UX Markup +Options for language TypeScript ##### [Disable Beautifying Language](#disable-beautifying-language) @@ -13417,7 +13433,7 @@ Options for language UX Markup **Description**: -Disable UX Markup Beautification +Disable TypeScript Beautification **How to Configure** @@ -13430,15 +13446,15 @@ Disable UX Markup Beautification **Important**: This option is only configurable from within Atom Beautify's setting panel. -**Default**: `Pretty Diff` +**Default**: `TypeScript Formatter` **Type**: `string` -**Enum**: `Pretty Diff` +**Enum**: `TypeScript Formatter` **Description**: -Default Beautifier to be used for UX Markup +Default Beautifier to be used for TypeScript **How to Configure** @@ -13455,7 +13471,7 @@ Default Beautifier to be used for UX Markup **Description**: -Automatically beautify UX Markup files on save +Automatically beautify TypeScript files on save **How to Configure** @@ -13464,149 +13480,720 @@ Automatically beautify UX Markup files on save 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [Indent char](#indent-char) +##### [Brace style](#brace-style) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `indent_char` +**Key**: `brace_style` -**Default**: ` ` +**Default**: `collapse` **Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation character (Supported by Pretty Diff) +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "brace_style": "collapse" } } ``` -##### [Indent size](#indent-size) - -**Namespace**: `html` +##### [Break chained methods](#break-chained-methods) -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by Pretty Diff) +Break chained method calls across subsequent lines (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "break_chained_methods": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [End of line](#end-of-line) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `preserve_newlines` +**Key**: `end_of_line` -**Default**: `true` +**Default**: `System Default` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Enum**: `CRLF` `LF` `System Default` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Preserve line-breaks (Supported by Pretty Diff) +Override EOL from line-ending-selector (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "js": { + "end_of_line": "System Default" } } ``` -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `html` +##### [End with comma](#end-with-comma) -**Key**: `wrap_line_length` +**Namespace**: `js` -**Default**: `250` +**Key**: `end_with_comma` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Maximum characters per line (0 disables) (Supported by Pretty Diff) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "js": { + "end_with_comma": false } } ``` -#### [Vala](#vala) +##### [End with newline](#end-with-newline) -**Supported Beautifiers**: [`Uncrustify`](#uncrustify) +**Namespace**: `js` -| Option | Uncrustify | -| --- | --- | -| `disabled` | :white_check_mark: | -| `default_beautifier` | :white_check_mark: | -| `beautify_on_save` | :white_check_mark: | -| `configPath` | :white_check_mark: | +**Key**: `end_with_newline` -**Description**: +**Type**: `boolean` -Options for language Vala +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) -##### [Disable Beautifying Language](#disable-beautifying-language) +**Description**: -**Important**: This option is only configurable from within Atom Beautify's setting panel. +End output with newline (Supported by TypeScript Formatter) -**Type**: `boolean` +**Example `.jsbeautifyrc` Configuration** -**Description**: +```json +{ + "js": { + "end_with_newline": false + } +} +``` -Disable Vala Beautification +##### [Eval code](#eval-code) -**How to Configure** +**Namespace**: `js` -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. +**Key**: `eval_code` -##### [Default Beautifier](#default-beautifier) +**Type**: `boolean` -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) -**Default**: `Uncrustify` +**Description**: -**Type**: `string` + (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "eval_code": false + } +} +``` + +##### [Indent char](#indent-char) + +**Namespace**: `js` + +**Key**: `indent_char` + +**Default**: ` ` + +**Type**: `string` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Indentation character (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_char": " " + } +} +``` + +##### [Indent level](#indent-level) + +**Namespace**: `js` + +**Key**: `indent_level` + +**Type**: `integer` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Initial indentation level (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_level": 0 + } +} +``` + +##### [Indent size](#indent-size) + +**Namespace**: `js` + +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Indentation size/length (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_size": 4 + } +} +``` + +##### [Indent with tabs](#indent-with-tabs) + +**Namespace**: `js` + +**Key**: `indent_with_tabs` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_with_tabs": false + } +} +``` + +##### [Jslint happy](#jslint-happy) + +**Namespace**: `js` + +**Key**: `jslint_happy` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Enable jslint-stricter mode (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "jslint_happy": false + } +} +``` + +##### [Keep array indentation](#keep-array-indentation) + +**Namespace**: `js` + +**Key**: `keep_array_indentation` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Preserve array indentation (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "keep_array_indentation": false + } +} +``` + +##### [Keep function indentation](#keep-function-indentation) + +**Namespace**: `js` + +**Key**: `keep_function_indentation` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + + (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "keep_function_indentation": false + } +} +``` + +##### [Max preserve newlines](#max-preserve-newlines) + +**Namespace**: `js` + +**Key**: `max_preserve_newlines` + +**Default**: `10` + +**Type**: `integer` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "max_preserve_newlines": 10 + } +} +``` + +##### [Preserve newlines](#preserve-newlines) + +**Namespace**: `js` + +**Key**: `preserve_newlines` + +**Default**: `true` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Preserve line-breaks (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "preserve_newlines": true + } +} +``` + +##### [Space after anon function](#space-after-anon-function) + +**Namespace**: `js` + +**Key**: `space_after_anon_function` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "space_after_anon_function": false + } +} +``` + +##### [Space before conditional](#space-before-conditional) + +**Namespace**: `js` + +**Key**: `space_before_conditional` + +**Default**: `true` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + + (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "space_before_conditional": true + } +} +``` + +##### [Space in paren](#space-in-paren) + +**Namespace**: `js` + +**Key**: `space_in_paren` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "space_in_paren": false + } +} +``` + +##### [Unescape strings](#unescape-strings) + +**Namespace**: `js` + +**Key**: `unescape_strings` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "unescape_strings": false + } +} +``` + +##### [Wrap line length](#wrap-line-length) + +**Namespace**: `js` + +**Key**: `wrap_line_length` + +**Type**: `integer` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "wrap_line_length": 0 + } +} +``` + +#### [UX Markup](#ux-markup) + +**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 UX Markup + +##### [Disable Beautifying Language](#disable-beautifying-language) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Disable UX Markup Beautification + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. + +##### [Default Beautifier](#default-beautifier) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Default**: `Pretty Diff` + +**Type**: `string` + +**Enum**: `Pretty Diff` + +**Description**: + +Default Beautifier to be used for UX Markup + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Default Beautifier*" and change it to your desired configuration. + +##### [Beautify On Save](#beautify-on-save) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Automatically beautify UX Markup files on save + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Beautify On Save*" and change it to your desired configuration. + +##### [Indent char](#indent-char) + +**Namespace**: `html` + +**Key**: `indent_char` + +**Default**: ` ` + +**Type**: `string` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Indentation character (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "indent_char": " " + } +} +``` + +##### [Indent size](#indent-size) + +**Namespace**: `html` + +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Indentation size/length (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "indent_size": 4 + } +} +``` + +##### [Preserve newlines](#preserve-newlines) + +**Namespace**: `html` + +**Key**: `preserve_newlines` + +**Default**: `true` + +**Type**: `boolean` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Preserve line-breaks (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "preserve_newlines": true + } +} +``` + +##### [Wrap line length](#wrap-line-length) + +**Namespace**: `html` + +**Key**: `wrap_line_length` + +**Default**: `250` + +**Type**: `integer` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Maximum characters per line (0 disables) (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "wrap_line_length": 250 + } +} +``` + +#### [Vala](#vala) + +**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 + +##### [Disable Beautifying Language](#disable-beautifying-language) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Disable Vala Beautification + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. + +##### [Default Beautifier](#default-beautifier) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Default**: `Uncrustify` + +**Type**: `string` **Enum**: `Uncrustify` @@ -15080,56 +15667,233 @@ List of tags (defaults to inline) that should not be reformatted (Supported by J } ``` -##### [Wrap attributes](#wrap-attributes) +##### [Wrap attributes](#wrap-attributes) + +**Namespace**: `html` + +**Key**: `wrap_attributes` + +**Default**: `auto` + +**Type**: `string` + +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) + +**Description**: + +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "wrap_attributes": "auto" + } +} +``` + +##### [Wrap attributes indent size](#wrap-attributes-indent-size) + +**Namespace**: `html` + +**Key**: `wrap_attributes_indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) + +**Description**: + +Indent wrapped attributes to after N characters (Supported by JS Beautify) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "wrap_attributes_indent_size": 4 + } +} +``` + +##### [Wrap line length](#wrap-line-length) + +**Namespace**: `html` + +**Key**: `wrap_line_length` + +**Default**: `250` + +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) + +**Description**: + +Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "wrap_line_length": 250 + } +} +``` + +#### [XTemplate](#xtemplate) + +**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 + +##### [Disable Beautifying Language](#disable-beautifying-language) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Disable XTemplate Beautification + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. + +##### [Default Beautifier](#default-beautifier) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Default**: `Pretty Diff` + +**Type**: `string` + +**Enum**: `Pretty Diff` + +**Description**: + +Default Beautifier to be used for XTemplate + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Default Beautifier*" and change it to your desired configuration. + +##### [Beautify On Save](#beautify-on-save) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Automatically beautify XTemplate files on save + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Beautify On Save*" and change it to your desired configuration. + +##### [Indent char](#indent-char) **Namespace**: `html` -**Key**: `wrap_attributes` +**Key**: `indent_char` -**Default**: `auto` +**Default**: ` ` **Type**: `string` -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` - -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "wrap_attributes": "auto" + "indent_char": " " } } ``` -##### [Wrap attributes indent size](#wrap-attributes-indent-size) +##### [Indent size](#indent-size) **Namespace**: `html` -**Key**: `wrap_attributes_indent_size` +**Key**: `indent_size` **Default**: `4` **Type**: `integer` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indent wrapped attributes to after N characters (Supported by JS Beautify) +Indentation size/length (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "wrap_attributes_indent_size": 4 + "indent_size": 4 + } +} +``` + +##### [Preserve newlines](#preserve-newlines) + +**Namespace**: `html` + +**Key**: `preserve_newlines` + +**Default**: `true` + +**Type**: `boolean` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Preserve line-breaks (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "preserve_newlines": true } } ``` @@ -15144,11 +15908,11 @@ Indent wrapped attributes to after N characters (Supported by JS Beautify) **Type**: `integer` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) +Maximum characters per line (0 disables) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** @@ -15160,23 +15924,20 @@ Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) } ``` -#### [XTemplate](#xtemplate) +#### [YAML](#yaml) -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`align-yaml`](#align-yaml) -| Option | Pretty Diff | +| Option | align-yaml | | --- | --- | | `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: | +| `padding` | :white_check_mark: | **Description**: -Options for language XTemplate +Options for language YAML ##### [Disable Beautifying Language](#disable-beautifying-language) @@ -15186,7 +15947,7 @@ Options for language XTemplate **Description**: -Disable XTemplate Beautification +Disable YAML Beautification **How to Configure** @@ -15199,15 +15960,15 @@ Disable XTemplate Beautification **Important**: This option is only configurable from within Atom Beautify's setting panel. -**Default**: `Pretty Diff` +**Default**: `align-yaml` **Type**: `string` -**Enum**: `Pretty Diff` +**Enum**: `align-yaml` **Description**: -Default Beautifier to be used for XTemplate +Default Beautifier to be used for YAML **How to Configure** @@ -15224,7 +15985,7 @@ Default Beautifier to be used for XTemplate **Description**: -Automatically beautify XTemplate files on save +Automatically beautify YAML files on save **How to Configure** @@ -15233,9 +15994,123 @@ Automatically beautify XTemplate files on save 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Beautify On Save*" and change it to your desired configuration. +##### [Padding](#padding) + +**Namespace**: `yaml` + +**Key**: `padding` + +**Type**: `integer` + +**Supported Beautifiers**: [`align-yaml`](#align-yaml) + +**Description**: + +The amount of padding to add next to each line. (Supported by align-yaml) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "yaml": { + "padding": 0 + } +} +``` + + +## Beautifier Options + +Supported options for each beautifier. + +--- + +### CSScomb + +##### [comb custom config file](#comb-custom-config-file) + +**Namespace**: `css` + +**Key**: `configPath` + +**Type**: `string` + +**Supported Beautifiers**: [`CSScomb`](#csscomb) + +**Description**: + +Path to custom CSScomb config file, used in absence of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "css": { + "configPath": "" + } +} +``` + +##### [comb predefined config](#comb-predefined-config) + +**Namespace**: `css` + +**Key**: `predefinedConfig` + +**Default**: `csscomb` + +**Type**: `string` + +**Enum**: `csscomb` `yandex` `zen` + +**Supported Beautifiers**: [`CSScomb`](#csscomb) + +**Description**: + +Used if neither a project or custom config file exists. (Supported by CSScomb) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "css": { + "predefinedConfig": "csscomb" + } +} +``` + + +### Coffee Formatter + +##### [Indent size](#indent-size) + +**Namespace**: `js` + +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) + +**Description**: + +Indentation size/length (Supported by Coffee Formatter, coffee-fmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_size": 4 + } +} +``` + ##### [Indent char](#indent-char) -**Namespace**: `html` +**Namespace**: `js` **Key**: `indent_char` @@ -15243,51 +16118,73 @@ Automatically beautify XTemplate files on save **Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -Indentation character (Supported by Pretty Diff) +Indentation character (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { + "js": { "indent_char": " " } } ``` -##### [Indent size](#indent-size) +##### [Indent level](#indent-level) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `indent_size` +**Key**: `indent_level` + +**Type**: `integer` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) + +**Description**: + +Initial indentation level (Supported by Coffee Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_level": 0 + } +} +``` + +##### [Indent with tabs](#indent-with-tabs) + +**Namespace**: `js` -**Default**: `4` +**Key**: `indent_with_tabs` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -Indentation size/length (Supported by Pretty Diff) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "indent_with_tabs": false } } ``` ##### [Preserve newlines](#preserve-newlines) -**Namespace**: `html` +**Namespace**: `js` **Key**: `preserve_newlines` @@ -15295,313 +16192,323 @@ Indentation size/length (Supported by Pretty Diff) **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Preserve line-breaks (Supported by Pretty Diff) +Preserve line-breaks (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { + "js": { "preserve_newlines": true } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Max preserve newlines](#max-preserve-newlines) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `wrap_line_length` +**Key**: `max_preserve_newlines` -**Default**: `250` +**Default**: `10` **Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Maximum characters per line (0 disables) (Supported by Pretty Diff) +Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "js": { + "max_preserve_newlines": 10 } } ``` -#### [YAML](#yaml) - -**Supported Beautifiers**: [`align-yaml`](#align-yaml) - -| Option | align-yaml | -| --- | --- | -| `disabled` | :white_check_mark: | -| `default_beautifier` | :white_check_mark: | -| `beautify_on_save` | :white_check_mark: | -| `padding` | :white_check_mark: | - -**Description**: - -Options for language YAML +##### [Space in paren](#space-in-paren) -##### [Disable Beautifying Language](#disable-beautifying-language) +**Namespace**: `js` -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Key**: `space_in_paren` **Type**: `boolean` +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) + **Description**: -Disable YAML Beautification +Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter) -**How to Configure** +**Example `.jsbeautifyrc` Configuration** -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. +```json +{ + "js": { + "space_in_paren": false + } +} +``` -##### [Default Beautifier](#default-beautifier) +##### [Jslint happy](#jslint-happy) -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Namespace**: `js` -**Default**: `align-yaml` +**Key**: `jslint_happy` -**Type**: `string` +**Type**: `boolean` -**Enum**: `align-yaml` +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Default Beautifier to be used for YAML +Enable jslint-stricter mode (Supported by Coffee Formatter) -**How to Configure** +**Example `.jsbeautifyrc` Configuration** -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Default Beautifier*" and change it to your desired configuration. +```json +{ + "js": { + "jslint_happy": false + } +} +``` -##### [Beautify On Save](#beautify-on-save) +##### [Space after anon function](#space-after-anon-function) -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Namespace**: `js` + +**Key**: `space_after_anon_function` **Type**: `boolean` +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) + **Description**: -Automatically beautify YAML files on save +Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter) -**How to Configure** +**Example `.jsbeautifyrc` Configuration** -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Beautify On Save*" and change it to your desired configuration. +```json +{ + "js": { + "space_after_anon_function": false + } +} +``` -##### [Padding](#padding) +##### [Brace style](#brace-style) -**Namespace**: `yaml` +**Namespace**: `js` -**Key**: `padding` +**Key**: `brace_style` -**Type**: `integer` +**Default**: `collapse` -**Supported Beautifiers**: [`align-yaml`](#align-yaml) +**Type**: `string` + +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -The amount of padding to add next to each line. (Supported by align-yaml) +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "yaml": { - "padding": 0 + "js": { + "brace_style": "collapse" } } ``` +##### [Break chained methods](#break-chained-methods) -## Beautifier Options +**Namespace**: `js` -Supported options for each beautifier. +**Key**: `break_chained_methods` ---- +**Type**: `boolean` -### CSScomb +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) -##### [comb custom config file](#comb-custom-config-file) +**Description**: -**Namespace**: `css` +Break chained method calls across subsequent lines (Supported by Coffee Formatter) -**Key**: `configPath` +**Example `.jsbeautifyrc` Configuration** -**Type**: `string` +```json +{ + "js": { + "break_chained_methods": false + } +} +``` -**Supported Beautifiers**: [`CSScomb`](#csscomb) +##### [Keep array indentation](#keep-array-indentation) + +**Namespace**: `js` + +**Key**: `keep_array_indentation` + +**Type**: `boolean` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Path to custom CSScomb config file, used in absence of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb) +Preserve array indentation (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "configPath": "" + "js": { + "keep_array_indentation": false } } ``` -##### [comb predefined config](#comb-predefined-config) - -**Namespace**: `css` - -**Key**: `predefinedConfig` +##### [Keep function indentation](#keep-function-indentation) -**Default**: `csscomb` +**Namespace**: `js` -**Type**: `string` +**Key**: `keep_function_indentation` -**Enum**: `csscomb` `yandex` `zen` +**Type**: `boolean` -**Supported Beautifiers**: [`CSScomb`](#csscomb) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Used if neither a project or custom config file exists. (Supported by CSScomb) + (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "predefinedConfig": "csscomb" + "js": { + "keep_function_indentation": false } } ``` - -### Coffee Formatter - -##### [Indent size](#indent-size) +##### [Space before conditional](#space-before-conditional) **Namespace**: `js` -**Key**: `indent_size` +**Key**: `space_before_conditional` -**Default**: `4` +**Default**: `true` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation size/length (Supported by Coffee Formatter, coffee-fmt) + (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_size": 4 + "space_before_conditional": true } } ``` -##### [Indent char](#indent-char) +##### [Eval code](#eval-code) **Namespace**: `js` -**Key**: `indent_char` - -**Default**: ` ` +**Key**: `eval_code` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation character (Supported by Coffee Formatter, coffee-fmt) + (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_char": " " + "eval_code": false } } ``` -##### [Indent level](#indent-level) +##### [Unescape strings](#unescape-strings) **Namespace**: `js` -**Key**: `indent_level` +**Key**: `unescape_strings` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Initial indentation level (Supported by Coffee Formatter) +Decode printable characters encoded in xNN notation (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_level": 0 + "unescape_strings": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Wrap line length](#wrap-line-length) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) +Wrap lines at next opportunity after N characters (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "wrap_line_length": 0 } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [End with newline](#end-with-newline) **Namespace**: `js` -**Key**: `preserve_newlines` - -**Default**: `true` +**Key**: `end_with_newline` **Type**: `boolean` @@ -15609,585 +16516,589 @@ Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by C **Description**: -Preserve line-breaks (Supported by Coffee Formatter) +End output with newline (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "preserve_newlines": true + "end_with_newline": false } } ``` -##### [Max preserve newlines](#max-preserve-newlines) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `max_preserve_newlines` - -**Default**: `10` +**Key**: `end_with_comma` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "max_preserve_newlines": 10 + "end_with_comma": false } } ``` -##### [Space in paren](#space-in-paren) +##### [End of line](#end-of-line) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `end_of_line` -**Type**: `boolean` +**Default**: `System Default` + +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` **Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter) +Override EOL from line-ending-selector (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "end_of_line": "System Default" } } ``` -##### [Jslint happy](#jslint-happy) -**Namespace**: `js` +### Fortran Beautifier -**Key**: `jslint_happy` +##### [Emacs path](#emacs-path) -**Type**: `boolean` +**Namespace**: `fortran` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Key**: `emacs_path` + +**Type**: `string` + +**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) **Description**: -Enable jslint-stricter mode (Supported by Coffee Formatter) +Path to the `emacs` executable (Supported by Fortran Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "jslint_happy": false + "fortran": { + "emacs_path": "" } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Emacs script path](#emacs-script-path) -**Namespace**: `js` +**Namespace**: `fortran` -**Key**: `space_after_anon_function` +**Key**: `emacs_script_path` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter) +Path to the emacs script (Supported by Fortran Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "fortran": { + "emacs_script_path": "" } } ``` -##### [Brace style](#brace-style) -**Namespace**: `js` +### Gherkin formatter -**Key**: `brace_style` +##### [Indent size](#indent-size) -**Default**: `collapse` +**Namespace**: `gherkin` -**Type**: `string` +**Key**: `indent_size` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Default**: `4` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Type**: `integer` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) **Description**: -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter) +Indentation size/length (Supported by Gherkin formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "brace_style": "collapse" + "gherkin": { + "indent_size": 4 } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `gherkin` -**Key**: `break_chained_methods` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Type**: `string` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) **Description**: -Break chained method calls across subsequent lines (Supported by Coffee Formatter) +Indentation character (Supported by Gherkin formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "gherkin": { + "indent_char": " " } } ``` -##### [Keep array indentation](#keep-array-indentation) -**Namespace**: `js` +### HTML Beautifier -**Key**: `keep_array_indentation` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `html` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`HTML Beautifier`](#html-beautifier) [`Pretty Diff`](#pretty-diff) **Description**: -Preserve array indentation (Supported by Coffee Formatter) +Indentation size/length (Supported by HTML Beautifier, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "html": { + "indent_size": 4 } } ``` -##### [Keep function indentation](#keep-function-indentation) -**Namespace**: `js` +### JS Beautify -**Key**: `keep_function_indentation` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `html` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by Coffee Formatter) +Indentation size/length (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "html": { + "indent_size": 4 } } ``` -##### [Space before conditional](#space-before-conditional) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_before_conditional` +**Key**: `indent_char` -**Default**: `true` +**Default**: ` ` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by Coffee Formatter) +Indentation character (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "html": { + "indent_char": " " } } ``` -##### [Eval code](#eval-code) +##### [Selector separator newline](#selector-separator-newline) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `eval_code` +**Key**: `selector_separator_newline` **Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: - (Supported by Coffee Formatter) +Add a newline between multiple selectors (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "css": { + "selector_separator_newline": false } } ``` -##### [Unescape strings](#unescape-strings) +##### [Newline between rules](#newline-between-rules) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `unescape_strings` +**Key**: `newline_between_rules` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Decode printable characters encoded in xNN notation (Supported by Coffee Formatter) +Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "unescape_strings": false + "css": { + "newline_between_rules": true } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `wrap_line_length` +**Key**: `preserve_newlines` -**Type**: `integer` +**Default**: `true` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Type**: `boolean` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Wrap lines at next opportunity after N characters (Supported by Coffee Formatter) +Preserve line-breaks (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "wrap_line_length": 0 + "html": { + "preserve_newlines": true } } ``` -##### [End with newline](#end-with-newline) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `end_with_newline` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Default**: `250` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -End output with newline (Supported by Coffee Formatter) +Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_newline": false + "html": { + "wrap_line_length": 250 } } ``` -##### [End with comma](#end-with-comma) +##### [End with newline](#end-with-newline) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `end_with_comma` +**Key**: `end_with_newline` **Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter) +End output with newline (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "html": { + "end_with_newline": false } } ``` -##### [End of line](#end-of-line) +##### [Indent level](#indent-level) **Namespace**: `js` -**Key**: `end_of_line` - -**Default**: `System Default` - -**Type**: `string` +**Key**: `indent_level` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Override EOL from line-ending-selector (Supported by Coffee Formatter) +Initial indentation level (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_of_line": "System Default" + "indent_level": 0 } } ``` +##### [Indent with tabs](#indent-with-tabs) -### Fortran Beautifier - -##### [Emacs path](#emacs-path) - -**Namespace**: `fortran` +**Namespace**: `js` -**Key**: `emacs_path` +**Key**: `indent_with_tabs` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Path to the `emacs` executable (Supported by Fortran Beautifier) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "fortran": { - "emacs_path": "" + "js": { + "indent_with_tabs": false } } ``` -##### [Emacs script path](#emacs-script-path) +##### [Max preserve newlines](#max-preserve-newlines) -**Namespace**: `fortran` +**Namespace**: `html` -**Key**: `emacs_script_path` +**Key**: `max_preserve_newlines` -**Type**: `string` +**Default**: `10` -**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Path to the emacs script (Supported by Fortran Beautifier) +Number of line-breaks to be preserved in one chunk (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "fortran": { - "emacs_script_path": "" + "html": { + "max_preserve_newlines": 10 } } ``` +##### [Space in paren](#space-in-paren) -### Gherkin formatter - -##### [Indent size](#indent-size) - -**Namespace**: `gherkin` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `space_in_paren` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by Gherkin formatter) +Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "gherkin": { - "indent_size": 4 + "js": { + "space_in_paren": false } } ``` -##### [Indent char](#indent-char) - -**Namespace**: `gherkin` +##### [Jslint happy](#jslint-happy) -**Key**: `indent_char` +**Namespace**: `js` -**Default**: ` ` +**Key**: `jslint_happy` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation character (Supported by Gherkin formatter) +Enable jslint-stricter mode (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "gherkin": { - "indent_char": " " + "js": { + "jslint_happy": false } } ``` +##### [Space after anon function](#space-after-anon-function) -### HTML Beautifier - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `space_after_anon_function` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`HTML Beautifier`](#html-beautifier) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by HTML Beautifier, Pretty Diff) +Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "space_after_anon_function": false } } ``` - -### JS Beautify - -##### [Indent size](#indent-size) +##### [Brace style](#brace-style) **Namespace**: `html` -**Key**: `indent_size` +**Key**: `brace_style` -**Default**: `4` +**Default**: `collapse` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Enum**: `collapse` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation size/length (Supported by JS Beautify, Pretty Diff) +[collapse|expand|end-expand|none] (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_size": 4 + "brace_style": "collapse" } } ``` -##### [Indent char](#indent-char) - -**Namespace**: `html` +##### [Break chained methods](#break-chained-methods) -**Key**: `indent_char` +**Namespace**: `js` -**Default**: ` ` +**Key**: `break_chained_methods` -**Type**: `string` +**Type**: `boolean` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by JS Beautify, Pretty Diff) +Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "break_chained_methods": false } } ``` -##### [Selector separator newline](#selector-separator-newline) +##### [Keep array indentation](#keep-array-indentation) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `selector_separator_newline` +**Key**: `keep_array_indentation` **Type**: `boolean` @@ -16195,101 +17106,97 @@ Indentation character (Supported by JS Beautify, Pretty Diff) **Description**: -Add a newline between multiple selectors (Supported by JS Beautify) +Preserve array indentation (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "selector_separator_newline": false + "js": { + "keep_array_indentation": false } } ``` -##### [Newline between rules](#newline-between-rules) - -**Namespace**: `css` +##### [Keep function indentation](#keep-function-indentation) -**Key**: `newline_between_rules` +**Namespace**: `js` -**Default**: `true` +**Key**: `keep_function_indentation` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff) + (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "newline_between_rules": true + "js": { + "keep_function_indentation": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Space before conditional](#space-before-conditional) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `preserve_newlines` +**Key**: `space_before_conditional` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Preserve line-breaks (Supported by JS Beautify, Pretty Diff) + (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "js": { + "space_before_conditional": true } } ``` -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `html` +##### [Eval code](#eval-code) -**Key**: `wrap_line_length` +**Namespace**: `js` -**Default**: `250` +**Key**: `eval_code` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) + (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "js": { + "eval_code": false } } ``` -##### [End with newline](#end-with-newline) +##### [Unescape strings](#unescape-strings) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `end_with_newline` +**Key**: `unescape_strings` **Type**: `boolean` @@ -16297,221 +17204,308 @@ Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) **Description**: -End output with newline (Supported by JS Beautify) +Decode printable characters encoded in xNN notation (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "end_with_newline": false + "js": { + "unescape_strings": false } } ``` -##### [Indent level](#indent-level) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `indent_level` +**Key**: `end_with_comma` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Initial indentation level (Supported by JS Beautify) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_level": 0 + "end_with_comma": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [End of line](#end-of-line) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `end_of_line` -**Type**: `boolean` +**Default**: `System Default` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff) +Override EOL from line-ending-selector (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "end_of_line": "System Default" } } ``` -##### [Max preserve newlines](#max-preserve-newlines) +##### [Indent inner html](#indent-inner-html) **Namespace**: `html` -**Key**: `max_preserve_newlines` - -**Default**: `10` +**Key**: `indent_inner_html` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by JS Beautify) +Indent and sections. (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "max_preserve_newlines": 10 + "indent_inner_html": false } } ``` -##### [Space in paren](#space-in-paren) +##### [Indent scripts](#indent-scripts) + +**Namespace**: `html` + +**Key**: `indent_scripts` -**Namespace**: `js` +**Default**: `normal` -**Key**: `space_in_paren` +**Type**: `string` -**Type**: `boolean` +**Enum**: `keep` `separate` `normal` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff) +[keep|separate|normal] (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_in_paren": false + "html": { + "indent_scripts": "normal" } } ``` -##### [Jslint happy](#jslint-happy) +##### [Wrap attributes](#wrap-attributes) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `jslint_happy` +**Key**: `wrap_attributes` -**Type**: `boolean` +**Default**: `auto` + +**Type**: `string` + +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Enable jslint-stricter mode (Supported by JS Beautify) +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "jslint_happy": false + "html": { + "wrap_attributes": "auto" } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Wrap attributes indent size](#wrap-attributes-indent-size) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_after_anon_function` +**Key**: `wrap_attributes_indent_size` -**Type**: `boolean` +**Default**: `4` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff) +Indent wrapped attributes to after N characters (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "html": { + "wrap_attributes_indent_size": 4 } } ``` -##### [Brace style](#brace-style) +##### [Unformatted](#unformatted) **Namespace**: `html` -**Key**: `brace_style` - -**Default**: `collapse` +**Key**: `unformatted` -**Type**: `string` +**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` -**Enum**: `collapse` `expand` `end-expand` `none` +**Type**: `array` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -[collapse|expand|end-expand|none] (Supported by JS Beautify) +List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "brace_style": "collapse" + "unformatted": [ + "a", + "abbr", + "area", + "audio", + "b", + "bdi", + "bdo", + "br", + "button", + "canvas", + "cite", + "code", + "data", + "datalist", + "del", + "dfn", + "em", + "embed", + "i", + "iframe", + "img", + "input", + "ins", + "kbd", + "keygen", + "label", + "map", + "mark", + "math", + "meter", + "noscript", + "object", + "output", + "progress", + "q", + "ruby", + "s", + "samp", + "select", + "small", + "span", + "strong", + "sub", + "sup", + "svg", + "template", + "textarea", + "time", + "u", + "var", + "video", + "wbr", + "text", + "acronym", + "address", + "big", + "dt", + "ins", + "small", + "strike", + "tt", + "pre", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ] } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Extra liners](#extra-liners) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `break_chained_methods` +**Key**: `extra_liners` -**Type**: `boolean` +**Default**: `head,body,/html` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Type**: `array` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff) +List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "html": { + "extra_liners": [ + "head", + "body", + "/html" + ] } } ``` -##### [Keep array indentation](#keep-array-indentation) +##### [E4x](#e4x) -**Namespace**: `js` +**Namespace**: `jsx` -**Key**: `keep_array_indentation` +**Key**: `e4x` + +**Default**: `true` **Type**: `boolean` @@ -16519,2181 +17513,2072 @@ Break chained method calls across subsequent lines (Supported by JS Beautify, Pr **Description**: -Preserve array indentation (Supported by JS Beautify) +Support e4x/jsx syntax (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "jsx": { + "e4x": true } } ``` -##### [Keep function indentation](#keep-function-indentation) -**Namespace**: `js` +### Latex Beautify -**Key**: `keep_function_indentation` +##### [Indent char](#indent-char) -**Type**: `boolean` +**Namespace**: `latex` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Key**: `indent_char` + +**Default**: ` ` + +**Type**: `string` + +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: - (Supported by JS Beautify) +Indentation character (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "latex": { + "indent_char": " " } } ``` -##### [Space before conditional](#space-before-conditional) - -**Namespace**: `js` +##### [Indent with tabs](#indent-with-tabs) -**Key**: `space_before_conditional` +**Namespace**: `latex` -**Default**: `true` +**Key**: `indent_with_tabs` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: - (Supported by JS Beautify) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "latex": { + "indent_with_tabs": false } } ``` -##### [Eval code](#eval-code) +##### [Indent preamble](#indent-preamble) -**Namespace**: `js` +**Namespace**: `latex` -**Key**: `eval_code` +**Key**: `indent_preamble` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: - (Supported by JS Beautify) +Indent the preamble (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "latex": { + "indent_preamble": false } } ``` -##### [Unescape strings](#unescape-strings) +##### [Always look for split braces](#always-look-for-split-braces) -**Namespace**: `js` +**Namespace**: `latex` -**Key**: `unescape_strings` +**Key**: `always_look_for_split_braces` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Decode printable characters encoded in xNN notation (Supported by JS Beautify) +If `latexindent` should look for commands that split braces across lines (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "unescape_strings": false + "latex": { + "always_look_for_split_braces": true } } ``` -##### [End with comma](#end-with-comma) +##### [Always look for split brackets](#always-look-for-split-brackets) -**Namespace**: `js` +**Namespace**: `latex` -**Key**: `end_with_comma` +**Key**: `always_look_for_split_brackets` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff) +If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "latex": { + "always_look_for_split_brackets": false } -} -``` - -##### [End of line](#end-of-line) - -**Namespace**: `js` +} +``` -**Key**: `end_of_line` +##### [Remove trailing whitespace](#remove-trailing-whitespace) -**Default**: `System Default` +**Namespace**: `latex` -**Type**: `string` +**Key**: `remove_trailing_whitespace` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Override EOL from line-ending-selector (Supported by JS Beautify) +Remove trailing whitespace (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_of_line": "System Default" + "latex": { + "remove_trailing_whitespace": false } } ``` -##### [Indent inner html](#indent-inner-html) +##### [Align columns in environments](#align-columns-in-environments) -**Namespace**: `html` +**Namespace**: `latex` -**Key**: `indent_inner_html` +**Key**: `align_columns_in_environments` -**Type**: `boolean` +**Default**: `tabular,matrix,bmatrix,pmatrix` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Type**: `array` + +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Indent and sections. (Supported by JS Beautify) +Aligns columns by the alignment tabs for environments specified (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_inner_html": false + "latex": { + "align_columns_in_environments": [ + "tabular", + "matrix", + "bmatrix", + "pmatrix" + ] } } ``` -##### [Indent scripts](#indent-scripts) -**Namespace**: `html` +### Lua beautifier -**Key**: `indent_scripts` +##### [End of line](#end-of-line) -**Default**: `normal` +**Namespace**: `lua` + +**Key**: `end_of_line` + +**Default**: `System Default` **Type**: `string` -**Enum**: `keep` `separate` `normal` +**Enum**: `CRLF` `LF` `System Default` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Lua beautifier`](#lua-beautifier) **Description**: -[keep|separate|normal] (Supported by JS Beautify) +Override EOL from line-ending-selector (Supported by Lua beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_scripts": "normal" + "lua": { + "end_of_line": "System Default" } } ``` -##### [Wrap attributes](#wrap-attributes) -**Namespace**: `html` +### Marko Beautifier -**Key**: `wrap_attributes` +##### [Indent size](#indent-size) -**Default**: `auto` +**Namespace**: `html` -**Type**: `string` +**Key**: `indent_size` -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` +**Default**: `4` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Type**: `integer` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) +Indentation size/length (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "wrap_attributes": "auto" + "indent_size": 4 } } ``` -##### [Wrap attributes indent size](#wrap-attributes-indent-size) +##### [Indent char](#indent-char) **Namespace**: `html` -**Key**: `wrap_attributes_indent_size` +**Key**: `indent_char` -**Default**: `4` +**Default**: ` ` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indent wrapped attributes to after N characters (Supported by JS Beautify) +Indentation character (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "wrap_attributes_indent_size": 4 + "indent_char": " " } } ``` -##### [Unformatted](#unformatted) +##### [Syntax](#syntax) -**Namespace**: `html` +**Namespace**: `marko` -**Key**: `unformatted` +**Key**: `syntax` -**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` +**Default**: `html` -**Type**: `array` +**Type**: `string` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Enum**: `html` `concise` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify) +[html|concise] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "unformatted": [ - "a", - "abbr", - "area", - "audio", - "b", - "bdi", - "bdo", - "br", - "button", - "canvas", - "cite", - "code", - "data", - "datalist", - "del", - "dfn", - "em", - "embed", - "i", - "iframe", - "img", - "input", - "ins", - "kbd", - "keygen", - "label", - "map", - "mark", - "math", - "meter", - "noscript", - "object", - "output", - "progress", - "q", - "ruby", - "s", - "samp", - "select", - "small", - "span", - "strong", - "sub", - "sup", - "svg", - "template", - "textarea", - "time", - "u", - "var", - "video", - "wbr", - "text", - "acronym", - "address", - "big", - "dt", - "ins", - "small", - "strike", - "tt", - "pre", - "h1", - "h2", - "h3", - "h4", - "h5", - "h6" - ] + "marko": { + "syntax": "html" } } ``` -##### [Extra liners](#extra-liners) +##### [Indent inner html](#indent-inner-html) **Namespace**: `html` -**Key**: `extra_liners` - -**Default**: `head,body,/html` +**Key**: `indent_inner_html` -**Type**: `array` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify) +Indent and sections. (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "extra_liners": [ - "head", - "body", - "/html" - ] + "indent_inner_html": false } } ``` -##### [E4x](#e4x) +##### [Brace style](#brace-style) -**Namespace**: `jsx` +**Namespace**: `html` -**Key**: `e4x` +**Key**: `brace_style` -**Default**: `true` +**Default**: `collapse` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Enum**: `collapse` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Support e4x/jsx syntax (Supported by JS Beautify) +[collapse|expand|end-expand|none] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "jsx": { - "e4x": true + "html": { + "brace_style": "collapse" } } ``` +##### [Indent scripts](#indent-scripts) -### Latex Beautify - -##### [Indent char](#indent-char) - -**Namespace**: `latex` +**Namespace**: `html` -**Key**: `indent_char` +**Key**: `indent_scripts` -**Default**: ` ` +**Default**: `normal` **Type**: `string` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Enum**: `keep` `separate` `normal` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indentation character (Supported by Latex Beautify) +[keep|separate|normal] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "indent_char": " " + "html": { + "indent_scripts": "normal" } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `latex` +**Namespace**: `html` -**Key**: `indent_with_tabs` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Default**: `250` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Type**: `integer` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify) +Maximum characters per line (0 disables) (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "indent_with_tabs": false + "html": { + "wrap_line_length": 250 } } ``` -##### [Indent preamble](#indent-preamble) +##### [Wrap attributes](#wrap-attributes) -**Namespace**: `latex` +**Namespace**: `html` -**Key**: `indent_preamble` +**Key**: `wrap_attributes` -**Type**: `boolean` +**Default**: `auto` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Type**: `string` + +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indent the preamble (Supported by Latex Beautify) +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "indent_preamble": false + "html": { + "wrap_attributes": "auto" } } ``` -##### [Always look for split braces](#always-look-for-split-braces) +##### [Wrap attributes indent size](#wrap-attributes-indent-size) -**Namespace**: `latex` +**Namespace**: `html` -**Key**: `always_look_for_split_braces` +**Key**: `wrap_attributes_indent_size` -**Default**: `true` +**Default**: `4` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -If `latexindent` should look for commands that split braces across lines (Supported by Latex Beautify) +Indent wrapped attributes to after N characters (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "always_look_for_split_braces": true + "html": { + "wrap_attributes_indent_size": 4 } } ``` -##### [Always look for split brackets](#always-look-for-split-brackets) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `latex` +**Namespace**: `html` -**Key**: `always_look_for_split_brackets` +**Key**: `preserve_newlines` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify) +Preserve line-breaks (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "always_look_for_split_brackets": false + "html": { + "preserve_newlines": true } } ``` -##### [Remove trailing whitespace](#remove-trailing-whitespace) +##### [Max preserve newlines](#max-preserve-newlines) -**Namespace**: `latex` +**Namespace**: `html` -**Key**: `remove_trailing_whitespace` +**Key**: `max_preserve_newlines` -**Type**: `boolean` +**Default**: `10` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Type**: `integer` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Remove trailing whitespace (Supported by Latex Beautify) +Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "remove_trailing_whitespace": false + "html": { + "max_preserve_newlines": 10 } } ``` -##### [Align columns in environments](#align-columns-in-environments) +##### [Unformatted](#unformatted) -**Namespace**: `latex` +**Namespace**: `html` -**Key**: `align_columns_in_environments` +**Key**: `unformatted` -**Default**: `tabular,matrix,bmatrix,pmatrix` +**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` **Type**: `array` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Aligns columns by the alignment tabs for environments specified (Supported by Latex Beautify) +List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "align_columns_in_environments": [ - "tabular", - "matrix", - "bmatrix", - "pmatrix" + "html": { + "unformatted": [ + "a", + "abbr", + "area", + "audio", + "b", + "bdi", + "bdo", + "br", + "button", + "canvas", + "cite", + "code", + "data", + "datalist", + "del", + "dfn", + "em", + "embed", + "i", + "iframe", + "img", + "input", + "ins", + "kbd", + "keygen", + "label", + "map", + "mark", + "math", + "meter", + "noscript", + "object", + "output", + "progress", + "q", + "ruby", + "s", + "samp", + "select", + "small", + "span", + "strong", + "sub", + "sup", + "svg", + "template", + "textarea", + "time", + "u", + "var", + "video", + "wbr", + "text", + "acronym", + "address", + "big", + "dt", + "ins", + "small", + "strike", + "tt", + "pre", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" ] } } ``` +##### [End with newline](#end-with-newline) -### Lua beautifier - -##### [End of line](#end-of-line) - -**Namespace**: `lua` - -**Key**: `end_of_line` - -**Default**: `System Default` +**Namespace**: `html` -**Type**: `string` +**Key**: `end_with_newline` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `boolean` -**Supported Beautifiers**: [`Lua beautifier`](#lua-beautifier) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Override EOL from line-ending-selector (Supported by Lua beautifier) +End output with newline (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "lua": { - "end_of_line": "System Default" + "html": { + "end_with_newline": false } } ``` - -### Marko Beautifier - -##### [Indent size](#indent-size) +##### [Extra liners](#extra-liners) **Namespace**: `html` -**Key**: `indent_size` +**Key**: `extra_liners` -**Default**: `4` +**Default**: `head,body,/html` -**Type**: `integer` +**Type**: `array` **Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indentation size/length (Supported by Marko Beautifier) +List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_size": 4 + "extra_liners": [ + "head", + "body", + "/html" + ] } } ``` -##### [Indent char](#indent-char) -**Namespace**: `html` +### Nginx Beautify -**Key**: `indent_char` +##### [Indent size](#indent-size) -**Default**: ` ` +**Namespace**: `nginx` -**Type**: `string` +**Key**: `indent_size` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -Indentation character (Supported by Marko Beautifier) +Indentation size/length (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "nginx": { + "indent_size": 4 } } ``` -##### [Syntax](#syntax) +##### [Indent char](#indent-char) -**Namespace**: `marko` +**Namespace**: `nginx` -**Key**: `syntax` +**Key**: `indent_char` -**Default**: `html` +**Default**: ` ` **Type**: `string` -**Enum**: `html` `concise` - -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -[html|concise] (Supported by Marko Beautifier) +Indentation character (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "marko": { - "syntax": "html" + "nginx": { + "indent_char": " " } } ``` -##### [Indent inner html](#indent-inner-html) +##### [Indent with tabs](#indent-with-tabs) -**Namespace**: `html` +**Namespace**: `nginx` -**Key**: `indent_inner_html` +**Key**: `indent_with_tabs` **Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -Indent and sections. (Supported by Marko Beautifier) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_inner_html": false + "nginx": { + "indent_with_tabs": false } } ``` -##### [Brace style](#brace-style) - -**Namespace**: `html` +##### [Don't join curly brackets](#don't-join-curly-brackets) -**Key**: `brace_style` +**Namespace**: `nginx` -**Default**: `collapse` +**Key**: `dontJoinCurlyBracet` -**Type**: `string` +**Default**: `true` -**Enum**: `collapse` `expand` `end-expand` `none` +**Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -[collapse|expand|end-expand|none] (Supported by Marko Beautifier) + (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "brace_style": "collapse" + "nginx": { + "dontJoinCurlyBracet": true } } ``` -##### [Indent scripts](#indent-scripts) -**Namespace**: `html` +### PHP-CS-Fixer -**Key**: `indent_scripts` +##### [PHP-CS-Fixer Path](#php-cs-fixer-path) -**Default**: `normal` +**Namespace**: `php` -**Type**: `string` +**Key**: `cs_fixer_path` -**Enum**: `keep` `separate` `normal` +**Type**: `string` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -[keep|separate|normal] (Supported by Marko Beautifier) +Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_scripts": "normal" + "php": { + "cs_fixer_path": "" } } ``` -##### [Wrap line length](#wrap-line-length) +##### [PHP-CS-Fixer Version](#php-cs-fixer-version) -**Namespace**: `html` +**Namespace**: `php` -**Key**: `wrap_line_length` +**Key**: `cs_fixer_version` -**Default**: `250` +**Default**: `2` **Type**: `integer` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Enum**: `1` `2` + +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Maximum characters per line (0 disables) (Supported by Marko Beautifier) + (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "php": { + "cs_fixer_version": 2 } } ``` -##### [Wrap attributes](#wrap-attributes) - -**Namespace**: `html` +##### [PHP-CS-Fixer Config File](#php-cs-fixer-config-file) -**Key**: `wrap_attributes` +**Namespace**: `php` -**Default**: `auto` +**Key**: `cs_fixer_config_file` **Type**: `string` -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` - -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier) +Path to php-cs-fixer config file. Will use local `.php_cs` or `.php_cs.dist` if found in the working directory or project root. (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes": "auto" + "php": { + "cs_fixer_config_file": "" } } ``` -##### [Wrap attributes indent size](#wrap-attributes-indent-size) - -**Namespace**: `html` +##### [Fixers](#fixers) -**Key**: `wrap_attributes_indent_size` +**Namespace**: `php` -**Default**: `4` +**Key**: `fixers` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Indent wrapped attributes to after N characters (Supported by Marko Beautifier) +Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes_indent_size": 4 + "php": { + "fixers": "" } } ``` -##### [Preserve newlines](#preserve-newlines) - -**Namespace**: `html` +##### [Level](#level) -**Key**: `preserve_newlines` +**Namespace**: `php` -**Default**: `true` +**Key**: `level` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Preserve line-breaks (Supported by Marko Beautifier) +By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "php": { + "level": "" } } ``` -##### [Max preserve newlines](#max-preserve-newlines) - -**Namespace**: `html` +##### [Rules](#rules) -**Key**: `max_preserve_newlines` +**Namespace**: `php` -**Default**: `10` +**Key**: `rules` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier) +Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "max_preserve_newlines": 10 + "php": { + "rules": "" } } ``` -##### [Unformatted](#unformatted) +##### [Allow risky rules](#allow-risky-rules) -**Namespace**: `html` +**Namespace**: `php` -**Key**: `unformatted` +**Key**: `allow_risky` -**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` +**Default**: `no` -**Type**: `array` +**Type**: `string` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Enum**: `no` `yes` + +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier) +Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "unformatted": [ - "a", - "abbr", - "area", - "audio", - "b", - "bdi", - "bdo", - "br", - "button", - "canvas", - "cite", - "code", - "data", - "datalist", - "del", - "dfn", - "em", - "embed", - "i", - "iframe", - "img", - "input", - "ins", - "kbd", - "keygen", - "label", - "map", - "mark", - "math", - "meter", - "noscript", - "object", - "output", - "progress", - "q", - "ruby", - "s", - "samp", - "select", - "small", - "span", - "strong", - "sub", - "sup", - "svg", - "template", - "textarea", - "time", - "u", - "var", - "video", - "wbr", - "text", - "acronym", - "address", - "big", - "dt", - "ins", - "small", - "strike", - "tt", - "pre", - "h1", - "h2", - "h3", - "h4", - "h5", - "h6" - ] + "php": { + "allow_risky": "no" } } ``` -##### [End with newline](#end-with-newline) -**Namespace**: `html` +### PHPCBF -**Key**: `end_with_newline` +##### [PHPCBF Path](#phpcbf-path) -**Type**: `boolean` +**Namespace**: `php` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Key**: `phpcbf_path` + +**Type**: `string` + +**Supported Beautifiers**: [`PHPCBF`](#phpcbf) **Description**: -End output with newline (Supported by Marko Beautifier) +Path to the `phpcbf` CLI executable (Supported by PHPCBF) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "end_with_newline": false + "php": { + "phpcbf_path": "" } } ``` -##### [Extra liners](#extra-liners) +##### [PHPCBF Version](#phpcbf-version) -**Namespace**: `html` +**Namespace**: `php` -**Key**: `extra_liners` +**Key**: `phpcbf_version` -**Default**: `head,body,/html` +**Default**: `2` -**Type**: `array` +**Type**: `integer` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Enum**: `1` `2` `3` + +**Supported Beautifiers**: [`PHPCBF`](#phpcbf) **Description**: -List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Marko Beautifier) + (Supported by PHPCBF) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "extra_liners": [ - "head", - "body", - "/html" - ] + "php": { + "phpcbf_version": 2 } } ``` +##### [PHPCBF Standard](#phpcbf-standard) -### Nginx Beautify - -##### [Indent size](#indent-size) - -**Namespace**: `nginx` +**Namespace**: `php` -**Key**: `indent_size` +**Key**: `standard` -**Default**: `4` +**Default**: `PEAR` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Supported Beautifiers**: [`PHPCBF`](#phpcbf) **Description**: -Indentation size/length (Supported by Nginx Beautify) +Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHPCBF) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "indent_size": 4 + "php": { + "standard": "PEAR" } } ``` -##### [Indent char](#indent-char) -**Namespace**: `nginx` +### Perltidy -**Key**: `indent_char` +##### [Perltidy profile](#perltidy-profile) -**Default**: ` ` +**Namespace**: `perl` + +**Key**: `perltidy_profile` **Type**: `string` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Supported Beautifiers**: [`Perltidy`](#perltidy) **Description**: -Indentation character (Supported by Nginx Beautify) +Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "indent_char": " " + "perl": { + "perltidy_profile": "" } } ``` -##### [Indent with tabs](#indent-with-tabs) -**Namespace**: `nginx` +### Pretty Diff -**Key**: `indent_with_tabs` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `html` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify) +Indentation size/length (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "indent_with_tabs": false + "html": { + "indent_size": 4 } } ``` -##### [Don't join curly brackets](#don't-join-curly-brackets) +##### [Indent char](#indent-char) -**Namespace**: `nginx` +**Namespace**: `html` -**Key**: `dontJoinCurlyBracet` +**Key**: `indent_char` -**Default**: `true` +**Default**: ` ` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by Nginx Beautify) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "dontJoinCurlyBracet": true + "html": { + "indent_char": " " } } ``` +##### [Wrap line length](#wrap-line-length) -### PHP-CS-Fixer - -##### [PHP-CS-Fixer Path](#php-cs-fixer-path) +**Namespace**: `html` -**Namespace**: `php` +**Key**: `wrap_line_length` -**Key**: `cs_fixer_path` +**Default**: `250` -**Type**: `string` +**Type**: `integer` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer) +Maximum characters per line (0 disables) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "cs_fixer_path": "" + "html": { + "wrap_line_length": 250 } } ``` -##### [PHP-CS-Fixer Version](#php-cs-fixer-version) - -**Namespace**: `php` +##### [Preserve newlines](#preserve-newlines) -**Key**: `cs_fixer_version` +**Namespace**: `html` -**Default**: `2` +**Key**: `preserve_newlines` -**Type**: `integer` +**Default**: `true` -**Enum**: `1` `2` +**Type**: `boolean` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by PHP-CS-Fixer) +Preserve line-breaks (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "cs_fixer_version": 2 + "html": { + "preserve_newlines": true } } ``` -##### [PHP-CS-Fixer Config File](#php-cs-fixer-config-file) +##### [Newline between rules](#newline-between-rules) -**Namespace**: `php` +**Namespace**: `css` -**Key**: `cs_fixer_config_file` +**Key**: `newline_between_rules` -**Type**: `string` +**Default**: `true` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Type**: `boolean` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Path to php-cs-fixer config file. Will use local `.php_cs` or `.php_cs.dist` if found in the working directory or project root. (Supported by PHP-CS-Fixer) +Add a newline between CSS rules (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "cs_fixer_config_file": "" + "css": { + "newline_between_rules": true } } ``` -##### [Fixers](#fixers) +##### [Indent comments](#indent-comments) -**Namespace**: `php` +**Namespace**: `css` -**Key**: `fixers` +**Key**: `indent_comments` -**Type**: `string` +**Default**: `true` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Type**: `boolean` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) +Determines whether comments should be indented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "fixers": "" + "css": { + "indent_comments": true } } ``` -##### [Level](#level) +##### [Force indentation](#force-indentation) -**Namespace**: `php` +**Namespace**: `css` -**Key**: `level` +**Key**: `force_indentation` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) +if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "level": "" + "css": { + "force_indentation": false } } ``` -##### [Rules](#rules) +##### [Convert quotes](#convert-quotes) -**Namespace**: `php` +**Namespace**: `css` -**Key**: `rules` +**Key**: `convert_quotes` + +**Default**: `none` **Type**: `string` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Enum**: `none` `double` `single` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) +Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "rules": "" + "css": { + "convert_quotes": "none" } } ``` -##### [Allow risky rules](#allow-risky-rules) - -**Namespace**: `php` - -**Key**: `allow_risky` +##### [Align assignments](#align-assignments) -**Default**: `no` +**Namespace**: `css` -**Type**: `string` +**Key**: `align_assignments` -**Enum**: `no` `yes` +**Type**: `boolean` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) +If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "allow_risky": "no" + "css": { + "align_assignments": false } } ``` +##### [No lead zero](#no-lead-zero) -### PHPCBF - -##### [PHPCBF Path](#phpcbf-path) - -**Namespace**: `php` +**Namespace**: `css` -**Key**: `phpcbf_path` +**Key**: `no_lead_zero` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Path to the `phpcbf` CLI executable (Supported by PHPCBF) +If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "phpcbf_path": "" + "css": { + "no_lead_zero": false } } ``` -##### [PHPCBF Version](#phpcbf-version) - -**Namespace**: `php` - -**Key**: `phpcbf_version` +##### [Indent with tabs](#indent-with-tabs) -**Default**: `2` +**Namespace**: `js` -**Type**: `integer` +**Key**: `indent_with_tabs` -**Enum**: `1` `2` `3` +**Type**: `boolean` -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by PHPCBF) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "phpcbf_version": 2 + "js": { + "indent_with_tabs": false } } ``` -##### [PHPCBF Standard](#phpcbf-standard) - -**Namespace**: `php` +##### [Space in paren](#space-in-paren) -**Key**: `standard` +**Namespace**: `js` -**Default**: `PEAR` +**Key**: `space_in_paren` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHPCBF) +Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "standard": "PEAR" + "js": { + "space_in_paren": false } } ``` +##### [Space after anon function](#space-after-anon-function) -### Perltidy - -##### [Perltidy profile](#perltidy-profile) - -**Namespace**: `perl` +**Namespace**: `js` -**Key**: `perltidy_profile` +**Key**: `space_after_anon_function` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Perltidy`](#perltidy) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy) +Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "perl": { - "perltidy_profile": "" + "js": { + "space_after_anon_function": false } } ``` +##### [Break chained methods](#break-chained-methods) -### Pretty Diff - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by Pretty Diff) +Break chained method calls across subsequent lines (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "break_chained_methods": false } } ``` -##### [Indent char](#indent-char) - -**Namespace**: `html` +##### [End with comma](#end-with-comma) -**Key**: `indent_char` +**Namespace**: `js` -**Default**: ` ` +**Key**: `end_with_comma` -**Type**: `string` +**Type**: `boolean` **Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by Pretty Diff) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "end_with_comma": false } } ``` -##### [Wrap line length](#wrap-line-length) + +### Pug Beautify + +##### [Indent size](#indent-size) **Namespace**: `html` -**Key**: `wrap_line_length` +**Key**: `indent_size` -**Default**: `250` +**Default**: `4` **Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) **Description**: -Maximum characters per line (0 disables) (Supported by Pretty Diff) +Indentation size/length (Supported by Pug Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "wrap_line_length": 250 + "indent_size": 4 } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Indent char](#indent-char) **Namespace**: `html` -**Key**: `preserve_newlines` +**Key**: `indent_char` -**Default**: `true` +**Default**: ` ` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) **Description**: -Preserve line-breaks (Supported by Pretty Diff) +Indentation character (Supported by Pug Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "preserve_newlines": true + "indent_char": " " } } ``` -##### [Newline between rules](#newline-between-rules) -**Namespace**: `css` +### Remark -**Key**: `newline_between_rules` +##### [Gfm](#gfm) + +**Namespace**: `markdown` + +**Key**: `gfm` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Remark`](#remark) **Description**: -Add a newline between CSS rules (Supported by Pretty Diff) +GitHub Flavoured Markdown (Supported by Remark) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "newline_between_rules": true + "markdown": { + "gfm": true } } ``` -##### [Indent comments](#indent-comments) +##### [Yaml](#yaml) -**Namespace**: `css` +**Namespace**: `markdown` -**Key**: `indent_comments` +**Key**: `yaml` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Remark`](#remark) **Description**: -Determines whether comments should be indented. (Supported by Pretty Diff) +Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "indent_comments": true + "markdown": { + "yaml": true } } ``` -##### [Force indentation](#force-indentation) +##### [Commonmark](#commonmark) -**Namespace**: `css` +**Namespace**: `markdown` -**Key**: `force_indentation` +**Key**: `commonmark` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Remark`](#remark) **Description**: -if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) +Allows and disallows several constructs. (Supported by Remark) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "force_indentation": false + "markdown": { + "commonmark": false } } ``` -##### [Convert quotes](#convert-quotes) -**Namespace**: `css` +### Rubocop -**Key**: `convert_quotes` +##### [Indent size](#indent-size) -**Default**: `none` +**Namespace**: `ruby` -**Type**: `string` +**Key**: `indent_size` -**Enum**: `none` `double` `single` +**Default**: `4` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `integer` + +**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) **Description**: -Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) +Indentation size/length (Supported by Rubocop, Ruby Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "convert_quotes": "none" + "ruby": { + "indent_size": 4 } } ``` -##### [Align assignments](#align-assignments) +##### [Rubocop Path](#rubocop-path) -**Namespace**: `css` +**Namespace**: `ruby` -**Key**: `align_assignments` +**Key**: `rubocop_path` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Rubocop`](#rubocop) **Description**: -If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) +Path to the `rubocop` CLI executable (Supported by Rubocop) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "align_assignments": false + "ruby": { + "rubocop_path": "" } } ``` -##### [No lead zero](#no-lead-zero) - -**Namespace**: `css` - -**Key**: `no_lead_zero` - -**Type**: `boolean` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) -**Example `.jsbeautifyrc` Configuration** +### Ruby Beautify -```json -{ - "css": { - "no_lead_zero": false - } -} -``` +##### [Indent size](#indent-size) -##### [Indent with tabs](#indent-with-tabs) +**Namespace**: `ruby` -**Namespace**: `js` +**Key**: `indent_size` -**Key**: `indent_with_tabs` +**Default**: `4` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) +Indentation size/length (Supported by Rubocop, Ruby Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_with_tabs": false + "ruby": { + "indent_size": 4 } } ``` -##### [Space in paren](#space-in-paren) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `ruby` -**Key**: `space_in_paren` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `string` + +**Enum**: ` ` ` ` + +**Supported Beautifiers**: [`Ruby Beautify`](#ruby-beautify) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) +Indentation character (Supported by Ruby Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_in_paren": false + "ruby": { + "indent_char": " " } } ``` -##### [Space after anon function](#space-after-anon-function) + +### TypeScript Formatter + +##### [Indent size](#indent-size) **Namespace**: `js` -**Key**: `space_after_anon_function` +**Key**: `indent_size` -**Type**: `boolean` +**Default**: `4` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `integer` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) +Indentation size/length (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_after_anon_function": false + "indent_size": 4 } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Indent char](#indent-char) **Namespace**: `js` -**Key**: `break_chained_methods` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `string` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Break chained method calls across subsequent lines (Supported by Pretty Diff) +Indentation character (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "break_chained_methods": false + "indent_char": " " } } ``` -##### [End with comma](#end-with-comma) +##### [Indent level](#indent-level) **Namespace**: `js` -**Key**: `end_with_comma` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) +Initial indentation level (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_comma": false + "indent_level": 0 } } ``` +##### [Indent with tabs](#indent-with-tabs) -### Pug Beautify - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `indent_with_tabs` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by Pug Beautify) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "indent_with_tabs": false } } ``` -##### [Indent char](#indent-char) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `indent_char` +**Key**: `preserve_newlines` -**Default**: ` ` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation character (Supported by Pug Beautify) +Preserve line-breaks (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "preserve_newlines": true } } ``` +##### [Max preserve newlines](#max-preserve-newlines) -### Remark - -##### [Gfm](#gfm) - -**Namespace**: `markdown` +**Namespace**: `js` -**Key**: `gfm` +**Key**: `max_preserve_newlines` -**Default**: `true` +**Default**: `10` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Remark`](#remark) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -GitHub Flavoured Markdown (Supported by Remark) +Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "markdown": { - "gfm": true + "js": { + "max_preserve_newlines": 10 } } ``` -##### [Yaml](#yaml) - -**Namespace**: `markdown` +##### [Space in paren](#space-in-paren) -**Key**: `yaml` +**Namespace**: `js` -**Default**: `true` +**Key**: `space_in_paren` **Type**: `boolean` -**Supported Beautifiers**: [`Remark`](#remark) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark) +Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "markdown": { - "yaml": true + "js": { + "space_in_paren": false } } ``` -##### [Commonmark](#commonmark) +##### [Jslint happy](#jslint-happy) -**Namespace**: `markdown` +**Namespace**: `js` -**Key**: `commonmark` +**Key**: `jslint_happy` **Type**: `boolean` -**Supported Beautifiers**: [`Remark`](#remark) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Allows and disallows several constructs. (Supported by Remark) +Enable jslint-stricter mode (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "markdown": { - "commonmark": false + "js": { + "jslint_happy": false } } ``` +##### [Space after anon function](#space-after-anon-function) -### Rubocop - -##### [Indent size](#indent-size) - -**Namespace**: `ruby` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `space_after_anon_function` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by Rubocop, Ruby Beautify) +Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "indent_size": 4 + "js": { + "space_after_anon_function": false } } ``` -##### [Rubocop Path](#rubocop-path) +##### [Brace style](#brace-style) -**Namespace**: `ruby` +**Namespace**: `js` -**Key**: `rubocop_path` +**Key**: `brace_style` + +**Default**: `collapse` **Type**: `string` -**Supported Beautifiers**: [`Rubocop`](#rubocop) +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Path to the `rubocop` CLI executable (Supported by Rubocop) +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "rubocop_path": "" + "js": { + "brace_style": "collapse" } } ``` +##### [Break chained methods](#break-chained-methods) -### Ruby Beautify - -##### [Indent size](#indent-size) - -**Namespace**: `ruby` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by Rubocop, Ruby Beautify) +Break chained method calls across subsequent lines (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "indent_size": 4 + "js": { + "break_chained_methods": false } } ``` -##### [Indent char](#indent-char) - -**Namespace**: `ruby` - -**Key**: `indent_char` +##### [Keep array indentation](#keep-array-indentation) -**Default**: ` ` +**Namespace**: `js` -**Type**: `string` +**Key**: `keep_array_indentation` -**Enum**: ` ` ` ` +**Type**: `boolean` -**Supported Beautifiers**: [`Ruby Beautify`](#ruby-beautify) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation character (Supported by Ruby Beautify) +Preserve array indentation (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "indent_char": " " + "js": { + "keep_array_indentation": false } } ``` - -### TypeScript Formatter - -##### [Indent size](#indent-size) +##### [Keep function indentation](#keep-function-indentation) **Namespace**: `js` -**Key**: `indent_size` - -**Default**: `4` +**Key**: `keep_function_indentation` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by TypeScript Formatter) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_size": 4 + "keep_function_indentation": false } } ``` -##### [Indent char](#indent-char) +##### [Space before conditional](#space-before-conditional) **Namespace**: `js` -**Key**: `indent_char` +**Key**: `space_before_conditional` -**Default**: ` ` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation character (Supported by TypeScript Formatter) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_char": " " + "space_before_conditional": true } } ``` -##### [Indent level](#indent-level) +##### [Eval code](#eval-code) **Namespace**: `js` -**Key**: `indent_level` +**Key**: `eval_code` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Initial indentation level (Supported by TypeScript Formatter) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_level": 0 + "eval_code": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Unescape strings](#unescape-strings) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `unescape_strings` **Type**: `boolean` @@ -18701,75 +19586,71 @@ Initial indentation level (Supported by TypeScript Formatter) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) +Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "unescape_strings": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Wrap line length](#wrap-line-length) **Namespace**: `js` -**Key**: `preserve_newlines` - -**Default**: `true` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Type**: `integer` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Preserve line-breaks (Supported by TypeScript Formatter) +Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "preserve_newlines": true + "wrap_line_length": 0 } } ``` -##### [Max preserve newlines](#max-preserve-newlines) +##### [End with newline](#end-with-newline) **Namespace**: `js` -**Key**: `max_preserve_newlines` - -**Default**: `10` +**Key**: `end_with_newline` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) +End output with newline (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "max_preserve_newlines": 10 + "end_with_newline": false } } ``` -##### [Space in paren](#space-in-paren) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `end_with_comma` **Type**: `boolean` @@ -18777,451 +19658,455 @@ Number of line-breaks to be preserved in one chunk (Supported by TypeScript Form **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "end_with_comma": false } } ``` -##### [Jslint happy](#jslint-happy) +##### [End of line](#end-of-line) **Namespace**: `js` -**Key**: `jslint_happy` +**Key**: `end_of_line` -**Type**: `boolean` +**Default**: `System Default` + +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Enable jslint-stricter mode (Supported by TypeScript Formatter) +Override EOL from line-ending-selector (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "jslint_happy": false + "end_of_line": "System Default" } } ``` -##### [Space after anon function](#space-after-anon-function) -**Namespace**: `js` +### Uncrustify -**Key**: `space_after_anon_function` +##### [Config Path](#config-path) -**Type**: `boolean` +**Namespace**: `vala` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Key**: `configPath` + +**Type**: `string` + +**Supported Beautifiers**: [`Uncrustify`](#uncrustify) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) +Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "vala": { + "configPath": "" } } ``` -##### [Brace style](#brace-style) -**Namespace**: `js` +### Vue Beautifier -**Key**: `brace_style` +##### [Indent size](#indent-size) -**Default**: `collapse` +**Namespace**: `html` -**Type**: `string` +**Key**: `indent_size` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Default**: `4` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `integer` + +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) +Indentation size/length (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "brace_style": "collapse" + "html": { + "indent_size": 4 } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `break_chained_methods` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `string` + +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Break chained method calls across subsequent lines (Supported by TypeScript Formatter) +Indentation character (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "html": { + "indent_char": " " } } ``` -##### [Keep array indentation](#keep-array-indentation) +##### [Indent level](#indent-level) **Namespace**: `js` -**Key**: `keep_array_indentation` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Preserve array indentation (Supported by TypeScript Formatter) +Initial indentation level (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "keep_array_indentation": false + "indent_level": 0 } } ``` -##### [Keep function indentation](#keep-function-indentation) +##### [Indent with tabs](#indent-with-tabs) **Namespace**: `js` -**Key**: `keep_function_indentation` +**Key**: `indent_with_tabs` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: - (Supported by TypeScript Formatter) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "keep_function_indentation": false + "indent_with_tabs": false } } ``` -##### [Space before conditional](#space-before-conditional) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_before_conditional` +**Key**: `preserve_newlines` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: - (Supported by TypeScript Formatter) +Preserve line-breaks (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "html": { + "preserve_newlines": true } } ``` -##### [Eval code](#eval-code) +##### [Max preserve newlines](#max-preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `eval_code` +**Key**: `max_preserve_newlines` -**Type**: `boolean` +**Default**: `10` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `integer` + +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: - (Supported by TypeScript Formatter) +Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "html": { + "max_preserve_newlines": 10 } } ``` -##### [Unescape strings](#unescape-strings) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `unescape_strings` +**Key**: `space_in_paren` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) +Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "unescape_strings": false + "space_in_paren": false } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Jslint happy](#jslint-happy) **Namespace**: `js` -**Key**: `wrap_line_length` +**Key**: `jslint_happy` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) +Enable jslint-stricter mode (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "wrap_line_length": 0 + "jslint_happy": false } } ``` -##### [End with newline](#end-with-newline) +##### [Space after anon function](#space-after-anon-function) **Namespace**: `js` -**Key**: `end_with_newline` +**Key**: `space_after_anon_function` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -End output with newline (Supported by TypeScript Formatter) +Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_newline": false + "space_after_anon_function": false } } ``` -##### [End with comma](#end-with-comma) +##### [Brace style](#brace-style) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `end_with_comma` +**Key**: `brace_style` -**Type**: `boolean` +**Default**: `collapse` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `string` + +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) +[collapse|expand|end-expand|none] (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "html": { + "brace_style": "collapse" } } ``` -##### [End of line](#end-of-line) +##### [Break chained methods](#break-chained-methods) **Namespace**: `js` -**Key**: `end_of_line` - -**Default**: `System Default` - -**Type**: `string` +**Key**: `break_chained_methods` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Override EOL from line-ending-selector (Supported by TypeScript Formatter) +Break chained method calls across subsequent lines (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_of_line": "System Default" + "break_chained_methods": false } } ``` +##### [Keep array indentation](#keep-array-indentation) -### Uncrustify - -##### [Config Path](#config-path) - -**Namespace**: `vala` +**Namespace**: `js` -**Key**: `configPath` +**Key**: `keep_array_indentation` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Uncrustify`](#uncrustify) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify) +Preserve array indentation (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "vala": { - "configPath": "" + "js": { + "keep_array_indentation": false } } ``` +##### [Keep function indentation](#keep-function-indentation) -### Vue Beautifier - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `keep_function_indentation` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indentation size/length (Supported by Vue Beautifier) + (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "keep_function_indentation": false } } ``` -##### [Indent char](#indent-char) +##### [Space before conditional](#space-before-conditional) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `indent_char` +**Key**: `space_before_conditional` -**Default**: ` ` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indentation character (Supported by Vue Beautifier) + (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "space_before_conditional": true } } ``` -##### [Indent level](#indent-level) +##### [Eval code](#eval-code) **Namespace**: `js` -**Key**: `indent_level` +**Key**: `eval_code` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Initial indentation level (Supported by Vue Beautifier) + (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_level": 0 + "eval_code": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Unescape strings](#unescape-strings) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `unescape_strings` **Type**: `boolean` @@ -19229,75 +20114,73 @@ Initial indentation level (Supported by Vue Beautifier) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Vue Beautifier) +Decode printable characters encoded in xNN notation (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "unescape_strings": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Wrap line length](#wrap-line-length) **Namespace**: `html` -**Key**: `preserve_newlines` +**Key**: `wrap_line_length` -**Default**: `true` +**Default**: `250` -**Type**: `boolean` +**Type**: `integer` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Preserve line-breaks (Supported by Vue Beautifier) +Maximum characters per line (0 disables) (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "preserve_newlines": true + "wrap_line_length": 250 } } ``` -##### [Max preserve newlines](#max-preserve-newlines) +##### [End with newline](#end-with-newline) **Namespace**: `html` -**Key**: `max_preserve_newlines` - -**Default**: `10` +**Key**: `end_with_newline` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier) +End output with newline (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "max_preserve_newlines": 10 + "end_with_newline": false } } ``` -##### [Space in paren](#space-in-paren) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `end_with_comma` **Type**: `boolean` @@ -19305,47 +20188,51 @@ Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "end_with_comma": false } } ``` -##### [Jslint happy](#jslint-happy) +##### [End of line](#end-of-line) **Namespace**: `js` -**Key**: `jslint_happy` +**Key**: `end_of_line` -**Type**: `boolean` +**Default**: `System Default` + +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Enable jslint-stricter mode (Supported by Vue Beautifier) +Override EOL from line-ending-selector (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "jslint_happy": false + "end_of_line": "System Default" } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Indent inner html](#indent-inner-html) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_after_anon_function` +**Key**: `indent_inner_html` **Type**: `boolean` @@ -19353,554 +20240,607 @@ Enable jslint-stricter mode (Supported by Vue Beautifier) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier) +Indent and sections. (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "html": { + "indent_inner_html": false } } ``` -##### [Brace style](#brace-style) +##### [Indent scripts](#indent-scripts) **Namespace**: `html` -**Key**: `brace_style` +**Key**: `indent_scripts` -**Default**: `collapse` +**Default**: `normal` **Type**: `string` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Enum**: `keep` `separate` `normal` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -[collapse|expand|end-expand|none] (Supported by Vue Beautifier) +[keep|separate|normal] (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "brace_style": "collapse" + "indent_scripts": "normal" } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Wrap attributes](#wrap-attributes) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `break_chained_methods` +**Key**: `wrap_attributes` -**Type**: `boolean` +**Default**: `auto` + +**Type**: `string` + +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Break chained method calls across subsequent lines (Supported by Vue Beautifier) +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "html": { + "wrap_attributes": "auto" } } ``` -##### [Keep array indentation](#keep-array-indentation) +##### [Wrap attributes indent size](#wrap-attributes-indent-size) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `keep_array_indentation` +**Key**: `wrap_attributes_indent_size` -**Type**: `boolean` +**Default**: `4` + +**Type**: `integer` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Preserve array indentation (Supported by Vue Beautifier) +Indent wrapped attributes to after N characters (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "html": { + "wrap_attributes_indent_size": 4 } } ``` -##### [Keep function indentation](#keep-function-indentation) +##### [Unformatted](#unformatted) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `keep_function_indentation` +**Key**: `unformatted` -**Type**: `boolean` +**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` + +**Type**: `array` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: - (Supported by Vue Beautifier) +List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "html": { + "unformatted": [ + "a", + "abbr", + "area", + "audio", + "b", + "bdi", + "bdo", + "br", + "button", + "canvas", + "cite", + "code", + "data", + "datalist", + "del", + "dfn", + "em", + "embed", + "i", + "iframe", + "img", + "input", + "ins", + "kbd", + "keygen", + "label", + "map", + "mark", + "math", + "meter", + "noscript", + "object", + "output", + "progress", + "q", + "ruby", + "s", + "samp", + "select", + "small", + "span", + "strong", + "sub", + "sup", + "svg", + "template", + "textarea", + "time", + "u", + "var", + "video", + "wbr", + "text", + "acronym", + "address", + "big", + "dt", + "ins", + "small", + "strike", + "tt", + "pre", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ] } } ``` -##### [Space before conditional](#space-before-conditional) +##### [Extra liners](#extra-liners) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_before_conditional` +**Key**: `extra_liners` -**Default**: `true` +**Default**: `head,body,/html` -**Type**: `boolean` +**Type**: `array` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: - (Supported by Vue Beautifier) +List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "html": { + "extra_liners": [ + "head", + "body", + "/html" + ] } } ``` -##### [Eval code](#eval-code) -**Namespace**: `js` +### align-yaml -**Key**: `eval_code` +##### [Padding](#padding) -**Type**: `boolean` +**Namespace**: `yaml` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Key**: `padding` + +**Type**: `integer` + +**Supported Beautifiers**: [`align-yaml`](#align-yaml) **Description**: - (Supported by Vue Beautifier) +The amount of padding to add next to each line. (Supported by align-yaml) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "yaml": { + "padding": 0 } } ``` -##### [Unescape strings](#unescape-strings) -**Namespace**: `js` +### autopep8 -**Key**: `unescape_strings` +##### [Max line length](#max-line-length) -**Type**: `boolean` +**Namespace**: `python` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Key**: `max_line_length` + +**Default**: `79` + +**Type**: `integer` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -Decode printable characters encoded in xNN notation (Supported by Vue Beautifier) +set maximum allowed line length (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "unescape_strings": false + "python": { + "max_line_length": 79 } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Indent size](#indent-size) -**Namespace**: `html` +**Namespace**: `python` -**Key**: `wrap_line_length` +**Key**: `indent_size` -**Default**: `250` +**Default**: `4` **Type**: `integer` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -Maximum characters per line (0 disables) (Supported by Vue Beautifier) +Indentation size/length (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "python": { + "indent_size": 4 } } ``` -##### [End with newline](#end-with-newline) +##### [Ignore](#ignore) -**Namespace**: `html` +**Namespace**: `python` -**Key**: `end_with_newline` +**Key**: `ignore` -**Type**: `boolean` +**Default**: `E24` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Type**: `array` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -End output with newline (Supported by Vue Beautifier) +do not fix these errors/warnings (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "end_with_newline": false + "python": { + "ignore": [ + "E24" + ] } } ``` -##### [End with comma](#end-with-comma) +##### [Formater](#formater) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `end_with_comma` +**Key**: `formater` -**Type**: `boolean` +**Default**: `autopep8` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Type**: `string` + +**Enum**: `autopep8` `yapf` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier) +formatter used by pybeautifier (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "python": { + "formater": "autopep8" } } ``` -##### [End of line](#end-of-line) +##### [Style config](#style-config) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `end_of_line` +**Key**: `style_config` -**Default**: `System Default` +**Default**: `pep8` **Type**: `string` -**Enum**: `CRLF` `LF` `System Default` - -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -Override EOL from line-ending-selector (Supported by Vue Beautifier) +formatting style used by yapf (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_of_line": "System Default" + "python": { + "style_config": "pep8" } } ``` -##### [Indent inner html](#indent-inner-html) +##### [Sort imports](#sort-imports) -**Namespace**: `html` +**Namespace**: `python` -**Key**: `indent_inner_html` +**Key**: `sort_imports` **Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -Indent and sections. (Supported by Vue Beautifier) +sort imports (requires isort installed) (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_inner_html": false + "python": { + "sort_imports": false } } ``` -##### [Indent scripts](#indent-scripts) +##### [Multi line output](#multi-line-output) -**Namespace**: `html` +**Namespace**: `python` -**Key**: `indent_scripts` +**Key**: `multi_line_output` -**Default**: `normal` +**Default**: `Hanging Grid Grouped` **Type**: `string` -**Enum**: `keep` `separate` `normal` +**Enum**: `Grid` `Vertical` `Hanging Indent` `Vertical Hanging Indent` `Hanging Grid` `Hanging Grid Grouped` `NOQA` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -[keep|separate|normal] (Supported by Vue Beautifier) +defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_scripts": "normal" + "python": { + "multi_line_output": "Hanging Grid Grouped" } } ``` -##### [Wrap attributes](#wrap-attributes) -**Namespace**: `html` +### beautysh -**Key**: `wrap_attributes` +##### [Indent size](#indent-size) -**Default**: `auto` +**Namespace**: `bash` -**Type**: `string` +**Key**: `indent_size` -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` +**Default**: `4` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Type**: `integer` + +**Supported Beautifiers**: [`beautysh`](#beautysh) **Description**: -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier) +Indentation size/length (Supported by beautysh) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes": "auto" + "bash": { + "indent_size": 4 } } ``` -##### [Wrap attributes indent size](#wrap-attributes-indent-size) -**Namespace**: `html` +### clang-format -**Key**: `wrap_attributes_indent_size` +##### [Config Path](#config-path) -**Default**: `4` +**Namespace**: `glsl` -**Type**: `integer` +**Key**: `configPath` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Type**: `string` + +**Supported Beautifiers**: [`clang-format`](#clang-format) **Description**: -Indent wrapped attributes to after N characters (Supported by Vue Beautifier) +Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes_indent_size": 4 + "glsl": { + "configPath": "" } } ``` -##### [Unformatted](#unformatted) -**Namespace**: `html` +### coffee-fmt -**Key**: `unformatted` +##### [Indent size](#indent-size) -**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` +**Namespace**: `js` -**Type**: `array` +**Key**: `indent_size` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier) +Indentation size/length (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json -{ - "html": { - "unformatted": [ - "a", - "abbr", - "area", - "audio", - "b", - "bdi", - "bdo", - "br", - "button", - "canvas", - "cite", - "code", - "data", - "datalist", - "del", - "dfn", - "em", - "embed", - "i", - "iframe", - "img", - "input", - "ins", - "kbd", - "keygen", - "label", - "map", - "mark", - "math", - "meter", - "noscript", - "object", - "output", - "progress", - "q", - "ruby", - "s", - "samp", - "select", - "small", - "span", - "strong", - "sub", - "sup", - "svg", - "template", - "textarea", - "time", - "u", - "var", - "video", - "wbr", - "text", - "acronym", - "address", - "big", - "dt", - "ins", - "small", - "strike", - "tt", - "pre", - "h1", - "h2", - "h3", - "h4", - "h5", - "h6" - ] +{ + "js": { + "indent_size": 4 } } ``` -##### [Extra liners](#extra-liners) +##### [Indent char](#indent-char) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `extra_liners` +**Key**: `indent_char` -**Default**: `head,body,/html` +**Default**: ` ` -**Type**: `array` +**Type**: `string` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier) +Indentation character (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "extra_liners": [ - "head", - "body", - "/html" - ] + "js": { + "indent_char": " " } } ``` +##### [Indent with tabs](#indent-with-tabs) -### align-yaml +**Namespace**: `js` -##### [Padding](#padding) +**Key**: `indent_with_tabs` -**Namespace**: `yaml` +**Type**: `boolean` -**Key**: `padding` +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) + +**Description**: + +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_with_tabs": false + } +} +``` + + +### formatR + +##### [Indent size](#indent-size) + +**Namespace**: `r` + +**Key**: `indent_size` + +**Default**: `4` **Type**: `integer` -**Supported Beautifiers**: [`align-yaml`](#align-yaml) +**Supported Beautifiers**: [`formatR`](#formatr) **Description**: -The amount of padding to add next to each line. (Supported by align-yaml) +Indentation size/length (Supported by formatR) **Example `.jsbeautifyrc` Configuration** ```json { - "yaml": { - "padding": 0 + "r": { + "indent_size": 4 } } ``` -### autopep8 +### pybeautifier ##### [Max line length](#max-line-length) @@ -20089,11 +21029,38 @@ defines how from imports wrap (requires isort installed) (Supported by autopep8, ``` -### beautysh +### rustfmt + +##### [Rustfmt path](#rustfmt-path) + +**Namespace**: `rust` + +**Key**: `rustfmt_path` + +**Type**: `string` + +**Supported Beautifiers**: [`rustfmt`](#rustfmt) + +**Description**: + +Path to rustfmt program (Supported by rustfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "rust": { + "rustfmt_path": "" + } +} +``` + + +### sqlformat ##### [Indent size](#indent-size) -**Namespace**: `bash` +**Namespace**: `sql` **Key**: `indent_size` @@ -20101,454 +21068,575 @@ defines how from imports wrap (requires isort installed) (Supported by autopep8, **Type**: `integer` -**Supported Beautifiers**: [`beautysh`](#beautysh) +**Supported Beautifiers**: [`sqlformat`](#sqlformat) **Description**: -Indentation size/length (Supported by beautysh) +Indentation size/length (Supported by sqlformat) **Example `.jsbeautifyrc` Configuration** ```json { - "bash": { + "sql": { + "indent_size": 4 + } +} +``` + +##### [Keywords](#keywords) + +**Namespace**: `sql` + +**Key**: `keywords` + +**Default**: `upper` + +**Type**: `string` + +**Enum**: `unchanged` `lower` `upper` `capitalize` + +**Supported Beautifiers**: [`sqlformat`](#sqlformat) + +**Description**: + +Change case of keywords (Supported by sqlformat) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "sql": { + "keywords": "upper" + } +} +``` + +##### [Identifiers](#identifiers) + +**Namespace**: `sql` + +**Key**: `identifiers` + +**Default**: `unchanged` + +**Type**: `string` + +**Enum**: `unchanged` `lower` `upper` `capitalize` + +**Supported Beautifiers**: [`sqlformat`](#sqlformat) + +**Description**: + +Change case of identifiers (Supported by sqlformat) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "sql": { + "identifiers": "unchanged" + } +} +``` + + +### terraformfmt + +##### [Indent size](#indent-size) + +**Namespace**: `js` + +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) + +**Description**: + +Indentation size/length (Supported by terraformfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { "indent_size": 4 } } ``` +##### [Indent char](#indent-char) + +**Namespace**: `js` + +**Key**: `indent_char` + +**Default**: ` ` + +**Type**: `string` + +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) + +**Description**: + +Indentation character (Supported by terraformfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_char": " " + } +} +``` + +##### [Indent level](#indent-level) + +**Namespace**: `js` + +**Key**: `indent_level` + +**Type**: `integer` + +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) + +**Description**: + +Initial indentation level (Supported by terraformfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_level": 0 + } +} +``` + +##### [Indent with tabs](#indent-with-tabs) + +**Namespace**: `js` + +**Key**: `indent_with_tabs` + +**Type**: `boolean` + +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) + +**Description**: + +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by terraformfmt) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "indent_with_tabs": false + } +} +``` + +##### [Preserve newlines](#preserve-newlines) -### clang-format - -##### [Config Path](#config-path) +**Namespace**: `js` -**Namespace**: `glsl` +**Key**: `preserve_newlines` -**Key**: `configPath` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`clang-format`](#clang-format) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format) +Preserve line-breaks (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "glsl": { - "configPath": "" + "js": { + "preserve_newlines": true } } ``` - -### coffee-fmt - -##### [Indent size](#indent-size) +##### [Max preserve newlines](#max-preserve-newlines) **Namespace**: `js` -**Key**: `indent_size` +**Key**: `max_preserve_newlines` -**Default**: `4` +**Default**: `10` **Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation size/length (Supported by Coffee Formatter, coffee-fmt) +Number of line-breaks to be preserved in one chunk (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_size": 4 + "max_preserve_newlines": 10 } } ``` -##### [Indent char](#indent-char) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `indent_char` - -**Default**: ` ` +**Key**: `space_in_paren` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation character (Supported by Coffee Formatter, coffee-fmt) +Add padding spaces within paren, ie. f( a, b ) (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_char": " " + "space_in_paren": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Jslint happy](#jslint-happy) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `jslint_happy` **Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) +Enable jslint-stricter mode (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "jslint_happy": false } } ``` +##### [Space after anon function](#space-after-anon-function) -### formatR - -##### [Indent size](#indent-size) - -**Namespace**: `r` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `space_after_anon_function` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`formatR`](#formatr) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation size/length (Supported by formatR) +Add a space before an anonymous function's parens, ie. function () (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "r": { - "indent_size": 4 + "js": { + "space_after_anon_function": false } } ``` +##### [Brace style](#brace-style) -### pybeautifier - -##### [Max line length](#max-line-length) +**Namespace**: `js` -**Namespace**: `python` +**Key**: `brace_style` -**Key**: `max_line_length` +**Default**: `collapse` -**Default**: `79` +**Type**: `string` -**Type**: `integer` +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -set maximum allowed line length (Supported by autopep8, pybeautifier) +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "max_line_length": 79 + "js": { + "brace_style": "collapse" } } ``` -##### [Indent size](#indent-size) - -**Namespace**: `python` +##### [Break chained methods](#break-chained-methods) -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation size/length (Supported by autopep8, pybeautifier) +Break chained method calls across subsequent lines (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "indent_size": 4 + "js": { + "break_chained_methods": false } } ``` -##### [Ignore](#ignore) - -**Namespace**: `python` +##### [Keep array indentation](#keep-array-indentation) -**Key**: `ignore` +**Namespace**: `js` -**Default**: `E24` +**Key**: `keep_array_indentation` -**Type**: `array` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -do not fix these errors/warnings (Supported by autopep8, pybeautifier) +Preserve array indentation (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "ignore": [ - "E24" - ] + "js": { + "keep_array_indentation": false } } ``` -##### [Formater](#formater) - -**Namespace**: `python` - -**Key**: `formater` +##### [Keep function indentation](#keep-function-indentation) -**Default**: `autopep8` +**Namespace**: `js` -**Type**: `string` +**Key**: `keep_function_indentation` -**Enum**: `autopep8` `yapf` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -formatter used by pybeautifier (Supported by autopep8, pybeautifier) + (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "formater": "autopep8" + "js": { + "keep_function_indentation": false } } ``` -##### [Style config](#style-config) +##### [Space before conditional](#space-before-conditional) -**Namespace**: `python` +**Namespace**: `js` -**Key**: `style_config` +**Key**: `space_before_conditional` -**Default**: `pep8` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -formatting style used by yapf (Supported by autopep8, pybeautifier) + (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "style_config": "pep8" + "js": { + "space_before_conditional": true } } ``` -##### [Sort imports](#sort-imports) +##### [Eval code](#eval-code) -**Namespace**: `python` +**Namespace**: `js` -**Key**: `sort_imports` +**Key**: `eval_code` **Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -sort imports (requires isort installed) (Supported by autopep8, pybeautifier) + (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "sort_imports": false + "js": { + "eval_code": false } } ``` -##### [Multi line output](#multi-line-output) - -**Namespace**: `python` - -**Key**: `multi_line_output` +##### [Unescape strings](#unescape-strings) -**Default**: `Hanging Grid Grouped` +**Namespace**: `js` -**Type**: `string` +**Key**: `unescape_strings` -**Enum**: `Grid` `Vertical` `Hanging Indent` `Vertical Hanging Indent` `Hanging Grid` `Hanging Grid Grouped` `NOQA` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier) +Decode printable characters encoded in xNN notation (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "multi_line_output": "Hanging Grid Grouped" + "js": { + "unescape_strings": false } } ``` +##### [Wrap line length](#wrap-line-length) -### rustfmt - -##### [Rustfmt path](#rustfmt-path) - -**Namespace**: `rust` +**Namespace**: `js` -**Key**: `rustfmt_path` +**Key**: `wrap_line_length` -**Type**: `string` +**Type**: `integer` -**Supported Beautifiers**: [`rustfmt`](#rustfmt) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Path to rustfmt program (Supported by rustfmt) +Wrap lines at next opportunity after N characters (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "rust": { - "rustfmt_path": "" + "js": { + "wrap_line_length": 0 } } ``` +##### [End with newline](#end-with-newline) -### sqlformat - -##### [Indent size](#indent-size) - -**Namespace**: `sql` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `end_with_newline` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`sqlformat`](#sqlformat) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Indentation size/length (Supported by sqlformat) +End output with newline (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "sql": { - "indent_size": 4 + "js": { + "end_with_newline": false } } ``` -##### [Keywords](#keywords) - -**Namespace**: `sql` - -**Key**: `keywords` +##### [End with comma](#end-with-comma) -**Default**: `upper` +**Namespace**: `js` -**Type**: `string` +**Key**: `end_with_comma` -**Enum**: `unchanged` `lower` `upper` `capitalize` +**Type**: `boolean` -**Supported Beautifiers**: [`sqlformat`](#sqlformat) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Change case of keywords (Supported by sqlformat) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "sql": { - "keywords": "upper" + "js": { + "end_with_comma": false } } ``` -##### [Identifiers](#identifiers) +##### [End of line](#end-of-line) -**Namespace**: `sql` +**Namespace**: `js` -**Key**: `identifiers` +**Key**: `end_of_line` -**Default**: `unchanged` +**Default**: `System Default` **Type**: `string` -**Enum**: `unchanged` `lower` `upper` `capitalize` +**Enum**: `CRLF` `LF` `System Default` -**Supported Beautifiers**: [`sqlformat`](#sqlformat) +**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) **Description**: -Change case of identifiers (Supported by sqlformat) +Override EOL from line-ending-selector (Supported by terraformfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "sql": { - "identifiers": "unchanged" + "js": { + "end_of_line": "System Default" } } ``` diff --git a/package.json b/package.json index 0b7659075..53c3507f9 100644 --- a/package.json +++ b/package.json @@ -271,7 +271,8 @@ "atom-beautify:beautify-language-visualforce", "atom-beautify:beautify-language-xml", "atom-beautify:beautify-language-xtemplate", - "atom-beautify:beautify-language-yaml" + "atom-beautify:beautify-language-yaml", + "atom-beautify:beautify-language-terraform" ], ".tree-view .file .name": [ "atom-beautify:beautify-file" @@ -404,7 +405,9 @@ "nginx beautify", "golang template", "align-yaml", - "goimports" + "goimports", + "terraform", + "terraformfmt" ], "devDependencies": { "coffeelint": "1.16.0" @@ -441,4 +444,4 @@ "prettydiff2" ] } -} +} \ No newline at end of file diff --git a/src/beautifiers/index.coffee b/src/beautifiers/index.coffee index 6d1441043..cc3f237a6 100644 --- a/src/beautifiers/index.coffee +++ b/src/beautifiers/index.coffee @@ -80,7 +80,7 @@ module.exports = class Beautifiers extends EventEmitter 'marko-beautifier' 'formatR' 'beautysh' - 'terraform' + 'terraformfmt' ] ### diff --git a/src/options.json b/src/options.json index 6f0e95aa5..3988bb136 100644 --- a/src/options.json +++ b/src/options.json @@ -6517,47 +6517,6 @@ "description": "Automatically beautify Rust files on save" } } - }, - "terraform": { - "title": "Terraform", - "type": "object", - "description": "Options for language Terraform", - "collapsed": true, - "beautifiers": [ - "terraformfmt" - ], - "grammars": [ - "Terraform" - ], - "extensions": [ - "tf" - ], - "properties": { - "disabled": { - "title": "Disable Beautifying Language", - "order": -3, - "type": "boolean", - "default": false, - "description": "Disable Rust Beautification" - }, - "default_beautifier": { - "title": "Default Beautifier", - "order": -2, - "type": "string", - "default": "terraformfmt", - "description": "Default Beautifier to be used for Terraform", - "enum": [ - "terraformfmt" - ] - }, - "beautify_on_save": { - "title": "Beautify On Save", - "order": -1, - "type": "boolean", - "default": false, - "description": "Automatically beautify Terraform files on save" - } - } }, "sass": { "title": "Sass", @@ -9169,6 +9128,340 @@ } } }, + "terraform": { + "title": "Terraform", + "type": "object", + "description": "Options for language Terraform", + "collapsed": true, + "beautifiers": [ + "terraformfmt" + ], + "grammars": [ + "Terraform" + ], + "extensions": [ + "tf" + ], + "properties": { + "indent_size": { + "type": "integer", + "default": null, + "minimum": 0, + "description": "Indentation size/length (Supported by terraformfmt)", + "title": "Indent size", + "beautifiers": [ + "terraformfmt" + ], + "key": "indent_size", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "indent_char": { + "type": "string", + "default": null, + "description": "Indentation character (Supported by terraformfmt)", + "title": "Indent char", + "beautifiers": [ + "terraformfmt" + ], + "key": "indent_char", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "indent_level": { + "type": "integer", + "default": 0, + "description": "Initial indentation level (Supported by terraformfmt)", + "title": "Indent level", + "beautifiers": [ + "terraformfmt" + ], + "key": "indent_level", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "indent_with_tabs": { + "type": "boolean", + "default": null, + "description": "Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by terraformfmt)", + "title": "Indent with tabs", + "beautifiers": [ + "terraformfmt" + ], + "key": "indent_with_tabs", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "preserve_newlines": { + "type": "boolean", + "default": true, + "description": "Preserve line-breaks (Supported by terraformfmt)", + "title": "Preserve newlines", + "beautifiers": [ + "terraformfmt" + ], + "key": "preserve_newlines", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "max_preserve_newlines": { + "type": "integer", + "default": 10, + "description": "Number of line-breaks to be preserved in one chunk (Supported by terraformfmt)", + "title": "Max preserve newlines", + "beautifiers": [ + "terraformfmt" + ], + "key": "max_preserve_newlines", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "space_in_paren": { + "type": "boolean", + "default": false, + "description": "Add padding spaces within paren, ie. f( a, b ) (Supported by terraformfmt)", + "title": "Space in paren", + "beautifiers": [ + "terraformfmt" + ], + "key": "space_in_paren", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "jslint_happy": { + "type": "boolean", + "default": false, + "description": "Enable jslint-stricter mode (Supported by terraformfmt)", + "title": "Jslint happy", + "beautifiers": [ + "terraformfmt" + ], + "key": "jslint_happy", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "space_after_anon_function": { + "type": "boolean", + "default": false, + "description": "Add a space before an anonymous function's parens, ie. function () (Supported by terraformfmt)", + "title": "Space after anon function", + "beautifiers": [ + "terraformfmt" + ], + "key": "space_after_anon_function", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "brace_style": { + "type": "string", + "default": "collapse", + "enum": [ + "collapse", + "collapse-preserve-inline", + "expand", + "end-expand", + "none" + ], + "description": "[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by terraformfmt)", + "title": "Brace style", + "beautifiers": [ + "terraformfmt" + ], + "key": "brace_style", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "break_chained_methods": { + "type": "boolean", + "default": false, + "description": "Break chained method calls across subsequent lines (Supported by terraformfmt)", + "title": "Break chained methods", + "beautifiers": [ + "terraformfmt" + ], + "key": "break_chained_methods", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "keep_array_indentation": { + "type": "boolean", + "default": false, + "description": "Preserve array indentation (Supported by terraformfmt)", + "title": "Keep array indentation", + "beautifiers": [ + "terraformfmt" + ], + "key": "keep_array_indentation", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "keep_function_indentation": { + "type": "boolean", + "default": false, + "description": " (Supported by terraformfmt)", + "title": "Keep function indentation", + "beautifiers": [ + "terraformfmt" + ], + "key": "keep_function_indentation", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "space_before_conditional": { + "type": "boolean", + "default": true, + "description": " (Supported by terraformfmt)", + "title": "Space before conditional", + "beautifiers": [ + "terraformfmt" + ], + "key": "space_before_conditional", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "eval_code": { + "type": "boolean", + "default": false, + "description": " (Supported by terraformfmt)", + "title": "Eval code", + "beautifiers": [ + "terraformfmt" + ], + "key": "eval_code", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "unescape_strings": { + "type": "boolean", + "default": false, + "description": "Decode printable characters encoded in xNN notation (Supported by terraformfmt)", + "title": "Unescape strings", + "beautifiers": [ + "terraformfmt" + ], + "key": "unescape_strings", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "wrap_line_length": { + "type": "integer", + "default": 0, + "description": "Wrap lines at next opportunity after N characters (Supported by terraformfmt)", + "title": "Wrap line length", + "beautifiers": [ + "terraformfmt" + ], + "key": "wrap_line_length", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "end_with_newline": { + "type": "boolean", + "default": false, + "description": "End output with newline (Supported by terraformfmt)", + "title": "End with newline", + "beautifiers": [ + "terraformfmt" + ], + "key": "end_with_newline", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "end_with_comma": { + "type": "boolean", + "default": false, + "description": "If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by terraformfmt)", + "title": "End with comma", + "beautifiers": [ + "terraformfmt" + ], + "key": "end_with_comma", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "end_of_line": { + "type": "string", + "default": "System Default", + "enum": [ + "CRLF", + "LF", + "System Default" + ], + "description": "Override EOL from line-ending-selector (Supported by terraformfmt)", + "title": "End of line", + "beautifiers": [ + "terraformfmt" + ], + "key": "end_of_line", + "language": { + "name": "JavaScript", + "namespace": "js" + } + }, + "disabled": { + "title": "Disable Beautifying Language", + "order": -3, + "type": "boolean", + "default": false, + "description": "Disable Terraform Beautification" + }, + "default_beautifier": { + "title": "Default Beautifier", + "order": -2, + "type": "string", + "default": "terraformfmt", + "description": "Default Beautifier to be used for Terraform", + "enum": [ + "terraformfmt" + ] + }, + "beautify_on_save": { + "title": "Beautify On Save", + "order": -1, + "type": "boolean", + "default": false, + "description": "Automatically beautify Terraform files on save" + } + } + }, "executables": { "title": "Executables", "type": "object", From 30d2264229e3325c8bcedff968560e5459ef5d79 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Mon, 9 Oct 2017 22:20:02 +0200 Subject: [PATCH 06/16] fix space --- src/beautifiers/terraformfmt.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/beautifiers/terraformfmt.coffee b/src/beautifiers/terraformfmt.coffee index fd08d02b6..9cd6d2ea0 100644 --- a/src/beautifiers/terraformfmt.coffee +++ b/src/beautifiers/terraformfmt.coffee @@ -20,5 +20,5 @@ module.exports = class Terraformfmt extends Beautifier tempFile = @tempFile("input", text) ]) .then(=> - @readFile(tempFile) + @readFile(tempFile) ) From 34b09fdd69491fc3b1960279e8f6622b71284cce Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Tue, 10 Oct 2017 16:49:52 +0200 Subject: [PATCH 07/16] update options --- src/beautifiers/terraformfmt.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/beautifiers/terraformfmt.coffee b/src/beautifiers/terraformfmt.coffee index 9cd6d2ea0..6075f4ee8 100644 --- a/src/beautifiers/terraformfmt.coffee +++ b/src/beautifiers/terraformfmt.coffee @@ -11,7 +11,7 @@ module.exports = class Terraformfmt extends Beautifier isPreInstalled: false options: { - Terraform: true + Terraform: false } beautify: (text, language, options) -> From 0b3a8ba1407621d83d9122a55b1b670696e201f7 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Tue, 10 Oct 2017 16:50:04 +0200 Subject: [PATCH 08/16] update docs --- docs/add-languages-and-beautifiers.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/add-languages-and-beautifiers.md b/docs/add-languages-and-beautifiers.md index b702f911e..5d9e05326 100644 --- a/docs/add-languages-and-beautifiers.md +++ b/docs/add-languages-and-beautifiers.md @@ -11,8 +11,6 @@ You can use [`codo`](https://github.com/coffeedoc/codo) to build your own docume After you make a change to language or beautifier `options` you will need to update the `options.json` file that is created on install. ```bash -# Update src/options.json file to have new/changed options -npm run postinstall # Update documentation to include information about those options npm run docs ``` From eeb65ea10602b3480f4baaf7ac7917da9281d446 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Tue, 10 Oct 2017 16:50:18 +0200 Subject: [PATCH 09/16] update changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6c6177d5..3bf9b53ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ # Next -- See [](). Add support for Terraform fmt. +- See [#645](https://github.com/Glavin001/atom-beautify/issues/645). Add support for Terraform fmt. - See [#881](https://github.com/Glavin001/atom-beautify/issues/881). Update to Prettydiff version 2! - ... From 11f35715384fce2c8c8393d4ea8c53f2ec320d83 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Tue, 10 Oct 2017 16:51:13 +0200 Subject: [PATCH 10/16] rerun create docs --- docs/options.md | 6127 +++++++++++++++++++--------------------------- src/options.json | 293 --- 2 files changed, 2554 insertions(+), 3866 deletions(-) diff --git a/docs/options.md b/docs/options.md index cd2a64e07..c94bbbd9f 100644 --- a/docs/options.md +++ b/docs/options.md @@ -12180,26 +12180,6 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff) | `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_of_line` | :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**: @@ -12260,161 +12240,164 @@ Automatically beautify Terraform files on save 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [Brace style](#brace-style) +#### [TSS](#tss) -**Namespace**: `js` +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) -**Key**: `brace_style` +| 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: | -**Default**: `collapse` +**Description**: -**Type**: `string` +Options for language TSS -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +##### [Disable Beautifying Language](#disable-beautifying-language) -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` **Description**: -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by terraformfmt) +Disable TSS Beautification -**Example `.jsbeautifyrc` Configuration** +**How to Configure** -```json -{ - "js": { - "brace_style": "collapse" - } -} -``` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. -##### [Break chained methods](#break-chained-methods) +##### [Default Beautifier](#default-beautifier) -**Namespace**: `js` +**Important**: This option is only configurable from within Atom Beautify's setting panel. -**Key**: `break_chained_methods` +**Default**: `Pretty Diff` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Enum**: `Pretty Diff` **Description**: -Break chained method calls across subsequent lines (Supported by terraformfmt) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "break_chained_methods": false - } -} -``` - -##### [End of line](#end-of-line) - -**Namespace**: `js` +Default Beautifier to be used for TSS -**Key**: `end_of_line` +**How to Configure** -**Default**: `System Default` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Default Beautifier*" and change it to your desired configuration. -**Type**: `string` +##### [Beautify On Save](#beautify-on-save) -**Enum**: `CRLF` `LF` `System Default` +**Important**: This option is only configurable from within Atom Beautify's setting panel. -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `boolean` **Description**: -Override EOL from line-ending-selector (Supported by terraformfmt) +Automatically beautify TSS files on save -**Example `.jsbeautifyrc` Configuration** +**How to Configure** -```json -{ - "js": { - "end_of_line": "System Default" - } -} -``` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [End with comma](#end-with-comma) +##### [Align assignments](#align-assignments) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `end_with_comma` +**Key**: `align_assignments` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by terraformfmt) +If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "css": { + "align_assignments": false } } ``` -##### [End with newline](#end-with-newline) +##### [Convert quotes](#convert-quotes) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `end_with_newline` +**Key**: `convert_quotes` -**Type**: `boolean` +**Default**: `none` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `string` + +**Enum**: `none` `double` `single` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -End output with newline (Supported by terraformfmt) +Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_newline": false + "css": { + "convert_quotes": "none" } } ``` -##### [Eval code](#eval-code) +##### [Force indentation](#force-indentation) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `eval_code` +**Key**: `force_indentation` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by terraformfmt) +if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "css": { + "force_indentation": false } } ``` ##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `css` **Key**: `indent_char` @@ -12422,49 +12405,51 @@ End output with newline (Supported by terraformfmt) **Type**: `string` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by terraformfmt) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { + "css": { "indent_char": " " } } ``` -##### [Indent level](#indent-level) +##### [Indent comments](#indent-comments) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `indent_level` +**Key**: `indent_comments` -**Type**: `integer` +**Default**: `true` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `boolean` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Initial indentation level (Supported by terraformfmt) +Determines whether comments should be indented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_level": 0 + "css": { + "indent_comments": true } } ``` ##### [Indent size](#indent-size) -**Namespace**: `js` +**Namespace**: `css` **Key**: `indent_size` @@ -12472,315 +12457,455 @@ Initial indentation level (Supported by terraformfmt) **Type**: `integer` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by terraformfmt) +Indentation size/length (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { + "css": { "indent_size": 4 } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Newline between rules](#newline-between-rules) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `indent_with_tabs` +**Key**: `newline_between_rules` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by terraformfmt) +Add a newline between CSS rules (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_with_tabs": false + "css": { + "newline_between_rules": true } } ``` -##### [Jslint happy](#jslint-happy) +##### [No lead zero](#no-lead-zero) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `jslint_happy` +**Key**: `no_lead_zero` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Enable jslint-stricter mode (Supported by terraformfmt) +If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "jslint_happy": false + "css": { + "no_lead_zero": false } } ``` -##### [Keep array indentation](#keep-array-indentation) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `keep_array_indentation` +**Key**: `preserve_newlines` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Preserve array indentation (Supported by terraformfmt) +Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "css": { + "preserve_newlines": false } } ``` -##### [Keep function indentation](#keep-function-indentation) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `keep_function_indentation` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by terraformfmt) +Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "css": { + "wrap_line_length": 0 } } ``` -##### [Max preserve newlines](#max-preserve-newlines) - -**Namespace**: `js` - -**Key**: `max_preserve_newlines` +#### [Twig](#twig) -**Default**: `10` +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) -**Type**: `integer` +| 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: | +| `space_in_paren` | :white_check_mark: | +| `wrap_line_length` | :white_check_mark: | -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Description**: + +Options for language Twig + +##### [Disable Beautifying Language](#disable-beautifying-language) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Disable Twig Beautification + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. + +##### [Default Beautifier](#default-beautifier) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Default**: `Pretty Diff` + +**Type**: `string` + +**Enum**: `Pretty Diff` + +**Description**: + +Default Beautifier to be used for Twig + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Default Beautifier*" and change it to your desired configuration. + +##### [Beautify On Save](#beautify-on-save) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Automatically beautify Twig files on save + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Beautify On Save*" and change it to your desired configuration. + +##### [Break chained methods](#break-chained-methods) + +**Namespace**: `js` + +**Key**: `break_chained_methods` + +**Type**: `boolean` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by terraformfmt) +Break chained method calls across subsequent lines (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "max_preserve_newlines": 10 + "break_chained_methods": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `preserve_newlines` - -**Default**: `true` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Preserve line-breaks (Supported by terraformfmt) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "preserve_newlines": true + "end_with_comma": false } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Indent char](#indent-char) + +**Namespace**: `html` + +**Key**: `indent_char` + +**Default**: ` ` + +**Type**: `string` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Indentation character (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "indent_char": " " + } +} +``` + +##### [Indent size](#indent-size) + +**Namespace**: `html` + +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) + +**Description**: + +Indentation size/length (Supported by Pretty Diff) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "html": { + "indent_size": 4 + } +} +``` + +##### [Indent with tabs](#indent-with-tabs) **Namespace**: `js` -**Key**: `space_after_anon_function` +**Key**: `indent_with_tabs` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by terraformfmt) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_after_anon_function": false + "indent_with_tabs": false } } ``` -##### [Space before conditional](#space-before-conditional) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_before_conditional` +**Key**: `preserve_newlines` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by terraformfmt) +Preserve line-breaks (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "html": { + "preserve_newlines": true } } ``` -##### [Space in paren](#space-in-paren) +##### [Space after anon function](#space-after-anon-function) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `space_after_anon_function` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by terraformfmt) +Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "space_after_anon_function": false } } ``` -##### [Unescape strings](#unescape-strings) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `unescape_strings` +**Key**: `space_in_paren` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Decode printable characters encoded in xNN notation (Supported by terraformfmt) +Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "unescape_strings": false + "space_in_paren": false } } ``` ##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +**Namespace**: `html` **Key**: `wrap_line_length` +**Default**: `250` + **Type**: `integer` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Wrap lines at next opportunity after N characters (Supported by terraformfmt) +Maximum characters per line (0 disables) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "wrap_line_length": 0 + "html": { + "wrap_line_length": 250 } } ``` -#### [TSS](#tss) +#### [TypeScript](#typescript) -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) -| Option | Pretty Diff | +| Option | TypeScript Formatter | | --- | --- | | `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: | +| `brace_style` | :white_check_mark: | +| `break_chained_methods` | :white_check_mark: | +| `end_of_line` | :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_comments` | :white_check_mark: | +| `indent_level` | :white_check_mark: | | `indent_size` | :white_check_mark: | -| `newline_between_rules` | :white_check_mark: | -| `no_lead_zero` | :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 TSS +Options for language TypeScript ##### [Disable Beautifying Language](#disable-beautifying-language) @@ -12790,7 +12915,7 @@ Options for language TSS **Description**: -Disable TSS Beautification +Disable TypeScript Beautification **How to Configure** @@ -12803,15 +12928,15 @@ Disable TSS Beautification **Important**: This option is only configurable from within Atom Beautify's setting panel. -**Default**: `Pretty Diff` +**Default**: `TypeScript Formatter` **Type**: `string` -**Enum**: `Pretty Diff` +**Enum**: `TypeScript Formatter` **Description**: -Default Beautifier to be used for TSS +Default Beautifier to be used for TypeScript **How to Configure** @@ -12828,7 +12953,7 @@ Default Beautifier to be used for TSS **Description**: -Automatically beautify TSS files on save +Automatically beautify TypeScript files on save **How to Configure** @@ -12837,85 +12962,161 @@ Automatically beautify TSS files on save 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [Align assignments](#align-assignments) +##### [Brace style](#brace-style) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `align_assignments` +**Key**: `brace_style` -**Type**: `boolean` +**Default**: `collapse` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `string` -**Description**: +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` -If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) -**Example `.jsbeautifyrc` Configuration** +**Description**: + +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "align_assignments": false + "js": { + "brace_style": "collapse" } } ``` -##### [Convert quotes](#convert-quotes) +##### [Break chained methods](#break-chained-methods) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `convert_quotes` +**Key**: `break_chained_methods` -**Default**: `none` +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +Break chained method calls across subsequent lines (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "break_chained_methods": false + } +} +``` + +##### [End of line](#end-of-line) + +**Namespace**: `js` + +**Key**: `end_of_line` + +**Default**: `System Default` **Type**: `string` -**Enum**: `none` `double` `single` +**Enum**: `CRLF` `LF` `System Default` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) +Override EOL from line-ending-selector (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "convert_quotes": "none" + "js": { + "end_of_line": "System Default" } } ``` -##### [Force indentation](#force-indentation) +##### [End with comma](#end-with-comma) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `force_indentation` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "force_indentation": false + "js": { + "end_with_comma": false + } +} +``` + +##### [End with newline](#end-with-newline) + +**Namespace**: `js` + +**Key**: `end_with_newline` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + +End output with newline (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "end_with_newline": false + } +} +``` + +##### [Eval code](#eval-code) + +**Namespace**: `js` + +**Key**: `eval_code` + +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + +**Description**: + + (Supported by TypeScript Formatter) + +**Example `.jsbeautifyrc` Configuration** + +```json +{ + "js": { + "eval_code": false } } ``` ##### [Indent char](#indent-char) -**Namespace**: `css` +**Namespace**: `js` **Key**: `indent_char` @@ -12923,51 +13124,49 @@ if indentation should be forcefully applied to markup even if it disruptively ad **Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation character (Supported by Pretty Diff) +Indentation character (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { + "js": { "indent_char": " " } } ``` -##### [Indent comments](#indent-comments) - -**Namespace**: `css` +##### [Indent level](#indent-level) -**Key**: `indent_comments` +**Namespace**: `js` -**Default**: `true` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Determines whether comments should be indented. (Supported by Pretty Diff) +Initial indentation level (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "indent_comments": true + "js": { + "indent_level": 0 } } ``` ##### [Indent size](#indent-size) -**Namespace**: `css` +**Namespace**: `js` **Key**: `indent_size` @@ -12975,377 +13174,424 @@ Determines whether comments should be indented. (Supported by Pretty Diff) **Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by Pretty Diff) +Indentation size/length (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { + "js": { "indent_size": 4 } } ``` -##### [Newline between rules](#newline-between-rules) - -**Namespace**: `css` +##### [Indent with tabs](#indent-with-tabs) -**Key**: `newline_between_rules` +**Namespace**: `js` -**Default**: `true` +**Key**: `indent_with_tabs` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Add a newline between CSS rules (Supported by Pretty Diff) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "newline_between_rules": true + "js": { + "indent_with_tabs": false } } ``` -##### [No lead zero](#no-lead-zero) +##### [Jslint happy](#jslint-happy) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `no_lead_zero` +**Key**: `jslint_happy` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) +Enable jslint-stricter mode (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "no_lead_zero": false + "js": { + "jslint_happy": false } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Keep array indentation](#keep-array-indentation) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `preserve_newlines` +**Key**: `keep_array_indentation` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff) +Preserve array indentation (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "preserve_newlines": false + "js": { + "keep_array_indentation": false } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Keep function indentation](#keep-function-indentation) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `wrap_line_length` +**Key**: `keep_function_indentation` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "wrap_line_length": 0 + "js": { + "keep_function_indentation": false } } ``` -#### [Twig](#twig) - -**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: | -| `space_in_paren` | :white_check_mark: | -| `wrap_line_length` | :white_check_mark: | +##### [Max preserve newlines](#max-preserve-newlines) -**Description**: +**Namespace**: `js` -Options for language Twig +**Key**: `max_preserve_newlines` -##### [Disable Beautifying Language](#disable-beautifying-language) +**Default**: `10` -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Type**: `integer` -**Type**: `boolean` +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Disable Twig Beautification +Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) -**How to Configure** +**Example `.jsbeautifyrc` Configuration** -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. +```json +{ + "js": { + "max_preserve_newlines": 10 + } +} +``` -##### [Default Beautifier](#default-beautifier) +##### [Preserve newlines](#preserve-newlines) -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Namespace**: `js` -**Default**: `Pretty Diff` +**Key**: `preserve_newlines` -**Type**: `string` +**Default**: `true` -**Enum**: `Pretty Diff` +**Type**: `boolean` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Default Beautifier to be used for Twig +Preserve line-breaks (Supported by TypeScript Formatter) -**How to Configure** +**Example `.jsbeautifyrc` Configuration** -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Default Beautifier*" and change it to your desired configuration. +```json +{ + "js": { + "preserve_newlines": true + } +} +``` -##### [Beautify On Save](#beautify-on-save) +##### [Space after anon function](#space-after-anon-function) -**Important**: This option is only configurable from within Atom Beautify's setting panel. +**Namespace**: `js` + +**Key**: `space_after_anon_function` **Type**: `boolean` +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) + **Description**: -Automatically beautify Twig files on save +Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) -**How to Configure** +**Example `.jsbeautifyrc` Configuration** -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Beautify On Save*" and change it to your desired configuration. +```json +{ + "js": { + "space_after_anon_function": false + } +} +``` -##### [Break chained methods](#break-chained-methods) +##### [Space before conditional](#space-before-conditional) **Namespace**: `js` -**Key**: `break_chained_methods` +**Key**: `space_before_conditional` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Break chained method calls across subsequent lines (Supported by Pretty Diff) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "break_chained_methods": false + "space_before_conditional": true } } ``` -##### [End with comma](#end-with-comma) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `end_with_comma` +**Key**: `space_in_paren` **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) +Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_comma": false + "space_in_paren": false } } ``` -##### [Indent char](#indent-char) - -**Namespace**: `html` +##### [Unescape strings](#unescape-strings) -**Key**: `indent_char` +**Namespace**: `js` -**Default**: ` ` +**Key**: `unescape_strings` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation character (Supported by Pretty Diff) +Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "unescape_strings": false } } ``` -##### [Indent size](#indent-size) - -**Namespace**: `html` +##### [Wrap line length](#wrap-line-length) -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `wrap_line_length` **Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by Pretty Diff) +Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "wrap_line_length": 0 } } ``` -##### [Indent with tabs](#indent-with-tabs) +#### [UX Markup](#ux-markup) -**Namespace**: `js` +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) -**Key**: `indent_with_tabs` +| 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 UX Markup + +##### [Disable Beautifying Language](#disable-beautifying-language) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Description**: + +Disable UX Markup Beautification + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. + +##### [Default Beautifier](#default-beautifier) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Default**: `Pretty Diff` + +**Type**: `string` + +**Enum**: `Pretty Diff` **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) +Default Beautifier to be used for UX Markup -**Example `.jsbeautifyrc` Configuration** +**How to Configure** -```json -{ - "js": { - "indent_with_tabs": false - } -} -``` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Default Beautifier*" and change it to your desired configuration. -##### [Preserve newlines](#preserve-newlines) +##### [Beautify On Save](#beautify-on-save) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` + +**Description**: + +Automatically beautify UX Markup files on save + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Beautify On Save*" and change it to your desired configuration. + +##### [Indent char](#indent-char) **Namespace**: `html` -**Key**: `preserve_newlines` +**Key**: `indent_char` -**Default**: `true` +**Default**: ` ` -**Type**: `boolean` +**Type**: `string` **Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Preserve line-breaks (Supported by Pretty Diff) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "preserve_newlines": true + "indent_char": " " } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Indent size](#indent-size) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_after_anon_function` +**Key**: `indent_size` -**Type**: `boolean` +**Default**: `4` + +**Type**: `integer` **Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) +Indentation size/length (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "html": { + "indent_size": 4 } } ``` -##### [Space in paren](#space-in-paren) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_in_paren` +**Key**: `preserve_newlines` + +**Default**: `true` **Type**: `boolean` @@ -13353,14 +13599,14 @@ Add a space before an anonymous function's parens, ie. function () (Supported by **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) +Preserve line-breaks (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_in_paren": false + "html": { + "preserve_newlines": true } } ``` @@ -13391,39 +13637,20 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff) } ``` -#### [TypeScript](#typescript) +#### [Vala](#vala) -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Uncrustify`](#uncrustify) -| Option | TypeScript Formatter | +| Option | Uncrustify | | --- | --- | | `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_of_line` | :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: | +| `configPath` | :white_check_mark: | **Description**: -Options for language TypeScript +Options for language Vala ##### [Disable Beautifying Language](#disable-beautifying-language) @@ -13433,7 +13660,7 @@ Options for language TypeScript **Description**: -Disable TypeScript Beautification +Disable Vala Beautification **How to Configure** @@ -13446,760 +13673,15 @@ Disable TypeScript Beautification **Important**: This option is only configurable from within Atom Beautify's setting panel. -**Default**: `TypeScript Formatter` +**Default**: `Uncrustify` **Type**: `string` -**Enum**: `TypeScript Formatter` +**Enum**: `Uncrustify` **Description**: -Default Beautifier to be used for TypeScript - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Default Beautifier*" and change it to your desired configuration. - -##### [Beautify On Save](#beautify-on-save) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Type**: `boolean` - -**Description**: - -Automatically beautify TypeScript files on save - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Beautify On Save*" and change it to your desired configuration. - -##### [Brace style](#brace-style) - -**Namespace**: `js` - -**Key**: `brace_style` - -**Default**: `collapse` - -**Type**: `string` - -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "brace_style": "collapse" - } -} -``` - -##### [Break chained methods](#break-chained-methods) - -**Namespace**: `js` - -**Key**: `break_chained_methods` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Break chained method calls across subsequent lines (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "break_chained_methods": false - } -} -``` - -##### [End of line](#end-of-line) - -**Namespace**: `js` - -**Key**: `end_of_line` - -**Default**: `System Default` - -**Type**: `string` - -**Enum**: `CRLF` `LF` `System Default` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Override EOL from line-ending-selector (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "end_of_line": "System Default" - } -} -``` - -##### [End with comma](#end-with-comma) - -**Namespace**: `js` - -**Key**: `end_with_comma` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "end_with_comma": false - } -} -``` - -##### [End with newline](#end-with-newline) - -**Namespace**: `js` - -**Key**: `end_with_newline` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -End output with newline (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "end_with_newline": false - } -} -``` - -##### [Eval code](#eval-code) - -**Namespace**: `js` - -**Key**: `eval_code` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - - (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "eval_code": false - } -} -``` - -##### [Indent char](#indent-char) - -**Namespace**: `js` - -**Key**: `indent_char` - -**Default**: ` ` - -**Type**: `string` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Indentation character (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_char": " " - } -} -``` - -##### [Indent level](#indent-level) - -**Namespace**: `js` - -**Key**: `indent_level` - -**Type**: `integer` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Initial indentation level (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_level": 0 - } -} -``` - -##### [Indent size](#indent-size) - -**Namespace**: `js` - -**Key**: `indent_size` - -**Default**: `4` - -**Type**: `integer` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Indentation size/length (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_size": 4 - } -} -``` - -##### [Indent with tabs](#indent-with-tabs) - -**Namespace**: `js` - -**Key**: `indent_with_tabs` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_with_tabs": false - } -} -``` - -##### [Jslint happy](#jslint-happy) - -**Namespace**: `js` - -**Key**: `jslint_happy` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Enable jslint-stricter mode (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "jslint_happy": false - } -} -``` - -##### [Keep array indentation](#keep-array-indentation) - -**Namespace**: `js` - -**Key**: `keep_array_indentation` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Preserve array indentation (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "keep_array_indentation": false - } -} -``` - -##### [Keep function indentation](#keep-function-indentation) - -**Namespace**: `js` - -**Key**: `keep_function_indentation` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - - (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "keep_function_indentation": false - } -} -``` - -##### [Max preserve newlines](#max-preserve-newlines) - -**Namespace**: `js` - -**Key**: `max_preserve_newlines` - -**Default**: `10` - -**Type**: `integer` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "max_preserve_newlines": 10 - } -} -``` - -##### [Preserve newlines](#preserve-newlines) - -**Namespace**: `js` - -**Key**: `preserve_newlines` - -**Default**: `true` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Preserve line-breaks (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "preserve_newlines": true - } -} -``` - -##### [Space after anon function](#space-after-anon-function) - -**Namespace**: `js` - -**Key**: `space_after_anon_function` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "space_after_anon_function": false - } -} -``` - -##### [Space before conditional](#space-before-conditional) - -**Namespace**: `js` - -**Key**: `space_before_conditional` - -**Default**: `true` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - - (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "space_before_conditional": true - } -} -``` - -##### [Space in paren](#space-in-paren) - -**Namespace**: `js` - -**Key**: `space_in_paren` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "space_in_paren": false - } -} -``` - -##### [Unescape strings](#unescape-strings) - -**Namespace**: `js` - -**Key**: `unescape_strings` - -**Type**: `boolean` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "unescape_strings": false - } -} -``` - -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `js` - -**Key**: `wrap_line_length` - -**Type**: `integer` - -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) - -**Description**: - -Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "wrap_line_length": 0 - } -} -``` - -#### [UX Markup](#ux-markup) - -**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 UX Markup - -##### [Disable Beautifying Language](#disable-beautifying-language) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Type**: `boolean` - -**Description**: - -Disable UX Markup Beautification - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. - -##### [Default Beautifier](#default-beautifier) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Default**: `Pretty Diff` - -**Type**: `string` - -**Enum**: `Pretty Diff` - -**Description**: - -Default Beautifier to be used for UX Markup - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Default Beautifier*" and change it to your desired configuration. - -##### [Beautify On Save](#beautify-on-save) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Type**: `boolean` - -**Description**: - -Automatically beautify UX Markup files on save - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Beautify On Save*" and change it to your desired configuration. - -##### [Indent char](#indent-char) - -**Namespace**: `html` - -**Key**: `indent_char` - -**Default**: ` ` - -**Type**: `string` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Indentation character (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "indent_char": " " - } -} -``` - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` - -**Default**: `4` - -**Type**: `integer` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Indentation size/length (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "indent_size": 4 - } -} -``` - -##### [Preserve newlines](#preserve-newlines) - -**Namespace**: `html` - -**Key**: `preserve_newlines` - -**Default**: `true` - -**Type**: `boolean` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Preserve line-breaks (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "preserve_newlines": true - } -} -``` - -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `html` - -**Key**: `wrap_line_length` - -**Default**: `250` - -**Type**: `integer` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Maximum characters per line (0 disables) (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "wrap_line_length": 250 - } -} -``` - -#### [Vala](#vala) - -**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 - -##### [Disable Beautifying Language](#disable-beautifying-language) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Type**: `boolean` - -**Description**: - -Disable Vala Beautification - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. - -##### [Default Beautifier](#default-beautifier) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Default**: `Uncrustify` - -**Type**: `string` - -**Enum**: `Uncrustify` - -**Description**: - -Default Beautifier to be used for Vala +Default Beautifier to be used for Vala **How to Configure** @@ -15620,280 +15102,103 @@ List of tags (defaults to inline) that should not be reformatted (Supported by J "kbd", "keygen", "label", - "map", - "mark", - "math", - "meter", - "noscript", - "object", - "output", - "progress", - "q", - "ruby", - "s", - "samp", - "select", - "small", - "span", - "strong", - "sub", - "sup", - "svg", - "template", - "textarea", - "time", - "u", - "var", - "video", - "wbr", - "text", - "acronym", - "address", - "big", - "dt", - "ins", - "small", - "strike", - "tt", - "pre", - "h1", - "h2", - "h3", - "h4", - "h5", - "h6" - ] - } -} -``` - -##### [Wrap attributes](#wrap-attributes) - -**Namespace**: `html` - -**Key**: `wrap_attributes` - -**Default**: `auto` - -**Type**: `string` - -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` - -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) - -**Description**: - -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "wrap_attributes": "auto" - } -} -``` - -##### [Wrap attributes indent size](#wrap-attributes-indent-size) - -**Namespace**: `html` - -**Key**: `wrap_attributes_indent_size` - -**Default**: `4` - -**Type**: `integer` - -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) - -**Description**: - -Indent wrapped attributes to after N characters (Supported by JS Beautify) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "wrap_attributes_indent_size": 4 - } -} -``` - -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `html` - -**Key**: `wrap_line_length` - -**Default**: `250` - -**Type**: `integer` - -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) - -**Description**: - -Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "wrap_line_length": 250 - } -} -``` - -#### [XTemplate](#xtemplate) - -**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 - -##### [Disable Beautifying Language](#disable-beautifying-language) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Type**: `boolean` - -**Description**: - -Disable XTemplate Beautification - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. - -##### [Default Beautifier](#default-beautifier) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Default**: `Pretty Diff` - -**Type**: `string` - -**Enum**: `Pretty Diff` - -**Description**: - -Default Beautifier to be used for XTemplate - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Default Beautifier*" and change it to your desired configuration. - -##### [Beautify On Save](#beautify-on-save) - -**Important**: This option is only configurable from within Atom Beautify's setting panel. - -**Type**: `boolean` - -**Description**: - -Automatically beautify XTemplate files on save - -**How to Configure** - -1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to -*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. -2. Go into *Packages* and search for "*Atom Beautify*" package. -3. Find the option "*Beautify On Save*" and change it to your desired configuration. - -##### [Indent char](#indent-char) - -**Namespace**: `html` - -**Key**: `indent_char` - -**Default**: ` ` - -**Type**: `string` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) - -**Description**: - -Indentation character (Supported by Pretty Diff) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "html": { - "indent_char": " " + "map", + "mark", + "math", + "meter", + "noscript", + "object", + "output", + "progress", + "q", + "ruby", + "s", + "samp", + "select", + "small", + "span", + "strong", + "sub", + "sup", + "svg", + "template", + "textarea", + "time", + "u", + "var", + "video", + "wbr", + "text", + "acronym", + "address", + "big", + "dt", + "ins", + "small", + "strike", + "tt", + "pre", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ] } } ``` -##### [Indent size](#indent-size) +##### [Wrap attributes](#wrap-attributes) **Namespace**: `html` -**Key**: `indent_size` +**Key**: `wrap_attributes` -**Default**: `4` +**Default**: `auto` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation size/length (Supported by Pretty Diff) +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_size": 4 + "wrap_attributes": "auto" } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [Wrap attributes indent size](#wrap-attributes-indent-size) **Namespace**: `html` -**Key**: `preserve_newlines` +**Key**: `wrap_attributes_indent_size` -**Default**: `true` +**Default**: `4` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Preserve line-breaks (Supported by Pretty Diff) +Indent wrapped attributes to after N characters (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "preserve_newlines": true + "wrap_attributes_indent_size": 4 } } ``` @@ -15908,11 +15213,11 @@ Preserve line-breaks (Supported by Pretty Diff) **Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Maximum characters per line (0 disables) (Supported by Pretty Diff) +Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** @@ -15924,20 +15229,23 @@ Maximum characters per line (0 disables) (Supported by Pretty Diff) } ``` -#### [YAML](#yaml) +#### [XTemplate](#xtemplate) -**Supported Beautifiers**: [`align-yaml`](#align-yaml) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) -| Option | align-yaml | +| Option | Pretty Diff | | --- | --- | | `disabled` | :white_check_mark: | | `default_beautifier` | :white_check_mark: | | `beautify_on_save` | :white_check_mark: | -| `padding` | :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 YAML +Options for language XTemplate ##### [Disable Beautifying Language](#disable-beautifying-language) @@ -15947,7 +15255,7 @@ Options for language YAML **Description**: -Disable YAML Beautification +Disable XTemplate Beautification **How to Configure** @@ -15960,15 +15268,15 @@ Disable YAML Beautification **Important**: This option is only configurable from within Atom Beautify's setting panel. -**Default**: `align-yaml` +**Default**: `Pretty Diff` **Type**: `string` -**Enum**: `align-yaml` +**Enum**: `Pretty Diff` **Description**: -Default Beautifier to be used for YAML +Default Beautifier to be used for XTemplate **How to Configure** @@ -15985,7 +15293,7 @@ Default Beautifier to be used for YAML **Description**: -Automatically beautify YAML files on save +Automatically beautify XTemplate files on save **How to Configure** @@ -15994,123 +15302,9 @@ Automatically beautify YAML files on save 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*Beautify On Save*" and change it to your desired configuration. -##### [Padding](#padding) - -**Namespace**: `yaml` - -**Key**: `padding` - -**Type**: `integer` - -**Supported Beautifiers**: [`align-yaml`](#align-yaml) - -**Description**: - -The amount of padding to add next to each line. (Supported by align-yaml) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "yaml": { - "padding": 0 - } -} -``` - - -## Beautifier Options - -Supported options for each beautifier. - ---- - -### CSScomb - -##### [comb custom config file](#comb-custom-config-file) - -**Namespace**: `css` - -**Key**: `configPath` - -**Type**: `string` - -**Supported Beautifiers**: [`CSScomb`](#csscomb) - -**Description**: - -Path to custom CSScomb config file, used in absence of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "css": { - "configPath": "" - } -} -``` - -##### [comb predefined config](#comb-predefined-config) - -**Namespace**: `css` - -**Key**: `predefinedConfig` - -**Default**: `csscomb` - -**Type**: `string` - -**Enum**: `csscomb` `yandex` `zen` - -**Supported Beautifiers**: [`CSScomb`](#csscomb) - -**Description**: - -Used if neither a project or custom config file exists. (Supported by CSScomb) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "css": { - "predefinedConfig": "csscomb" - } -} -``` - - -### Coffee Formatter - -##### [Indent size](#indent-size) - -**Namespace**: `js` - -**Key**: `indent_size` - -**Default**: `4` - -**Type**: `integer` - -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) - -**Description**: - -Indentation size/length (Supported by Coffee Formatter, coffee-fmt) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_size": 4 - } -} -``` - ##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` **Key**: `indent_char` @@ -16118,73 +15312,51 @@ Indentation size/length (Supported by Coffee Formatter, coffee-fmt) **Type**: `string` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by Coffee Formatter, coffee-fmt) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { + "html": { "indent_char": " " } } ``` -##### [Indent level](#indent-level) - -**Namespace**: `js` - -**Key**: `indent_level` - -**Type**: `integer` - -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) - -**Description**: - -Initial indentation level (Supported by Coffee Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_level": 0 - } -} -``` +##### [Indent size](#indent-size) -##### [Indent with tabs](#indent-with-tabs) +**Namespace**: `html` -**Namespace**: `js` +**Key**: `indent_size` -**Key**: `indent_with_tabs` +**Default**: `4` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) +Indentation size/length (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_with_tabs": false + "html": { + "indent_size": 4 } } ``` ##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` **Key**: `preserve_newlines` @@ -16192,323 +15364,313 @@ Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by C **Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Preserve line-breaks (Supported by Coffee Formatter) +Preserve line-breaks (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { + "html": { "preserve_newlines": true } } ``` -##### [Max preserve newlines](#max-preserve-newlines) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `max_preserve_newlines` +**Key**: `wrap_line_length` -**Default**: `10` +**Default**: `250` **Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter) +Maximum characters per line (0 disables) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "max_preserve_newlines": 10 + "html": { + "wrap_line_length": 250 } } ``` -##### [Space in paren](#space-in-paren) +#### [YAML](#yaml) -**Namespace**: `js` +**Supported Beautifiers**: [`align-yaml`](#align-yaml) -**Key**: `space_in_paren` +| Option | align-yaml | +| --- | --- | +| `disabled` | :white_check_mark: | +| `default_beautifier` | :white_check_mark: | +| `beautify_on_save` | :white_check_mark: | +| `padding` | :white_check_mark: | -**Type**: `boolean` +**Description**: -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +Options for language YAML + +##### [Disable Beautifying Language](#disable-beautifying-language) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `boolean` **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter) +Disable YAML Beautification -**Example `.jsbeautifyrc` Configuration** +**How to Configure** -```json -{ - "js": { - "space_in_paren": false - } -} -``` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration. -##### [Jslint happy](#jslint-happy) +##### [Default Beautifier](#default-beautifier) -**Namespace**: `js` +**Important**: This option is only configurable from within Atom Beautify's setting panel. -**Key**: `jslint_happy` +**Default**: `align-yaml` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Enum**: `align-yaml` **Description**: -Enable jslint-stricter mode (Supported by Coffee Formatter) - -**Example `.jsbeautifyrc` Configuration** +Default Beautifier to be used for YAML -```json -{ - "js": { - "jslint_happy": false - } -} -``` +**How to Configure** -##### [Space after anon function](#space-after-anon-function) +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Default Beautifier*" and change it to your desired configuration. -**Namespace**: `js` +##### [Beautify On Save](#beautify-on-save) -**Key**: `space_after_anon_function` +**Important**: This option is only configurable from within Atom Beautify's setting panel. **Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) - **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "space_after_anon_function": false - } -} -``` +Automatically beautify YAML files on save -##### [Brace style](#brace-style) +**How to Configure** -**Namespace**: `js` +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Beautify On Save*" and change it to your desired configuration. -**Key**: `brace_style` +##### [Padding](#padding) -**Default**: `collapse` +**Namespace**: `yaml` -**Type**: `string` +**Key**: `padding` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`align-yaml`](#align-yaml) **Description**: -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter) +The amount of padding to add next to each line. (Supported by align-yaml) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "brace_style": "collapse" + "yaml": { + "padding": 0 } } ``` -##### [Break chained methods](#break-chained-methods) - -**Namespace**: `js` - -**Key**: `break_chained_methods` - -**Type**: `boolean` - -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) -**Description**: +## Beautifier Options -Break chained method calls across subsequent lines (Supported by Coffee Formatter) +Supported options for each beautifier. -**Example `.jsbeautifyrc` Configuration** +--- -```json -{ - "js": { - "break_chained_methods": false - } -} -``` +### CSScomb -##### [Keep array indentation](#keep-array-indentation) +##### [comb custom config file](#comb-custom-config-file) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `keep_array_indentation` +**Key**: `configPath` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`CSScomb`](#csscomb) **Description**: -Preserve array indentation (Supported by Coffee Formatter) +Path to custom CSScomb config file, used in absence of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "css": { + "configPath": "" } } ``` -##### [Keep function indentation](#keep-function-indentation) +##### [comb predefined config](#comb-predefined-config) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `keep_function_indentation` +**Key**: `predefinedConfig` -**Type**: `boolean` +**Default**: `csscomb` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Type**: `string` + +**Enum**: `csscomb` `yandex` `zen` + +**Supported Beautifiers**: [`CSScomb`](#csscomb) **Description**: - (Supported by Coffee Formatter) +Used if neither a project or custom config file exists. (Supported by CSScomb) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "css": { + "predefinedConfig": "csscomb" } } ``` -##### [Space before conditional](#space-before-conditional) + +### Coffee Formatter + +##### [Indent size](#indent-size) **Namespace**: `js` -**Key**: `space_before_conditional` +**Key**: `indent_size` -**Default**: `true` +**Default**: `4` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: - (Supported by Coffee Formatter) +Indentation size/length (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_before_conditional": true + "indent_size": 4 } } ``` -##### [Eval code](#eval-code) +##### [Indent char](#indent-char) **Namespace**: `js` -**Key**: `eval_code` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Type**: `string` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: - (Supported by Coffee Formatter) +Indentation character (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "eval_code": false + "indent_char": " " } } ``` -##### [Unescape strings](#unescape-strings) +##### [Indent level](#indent-level) **Namespace**: `js` -**Key**: `unescape_strings` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` **Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Decode printable characters encoded in xNN notation (Supported by Coffee Formatter) +Initial indentation level (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "unescape_strings": false + "indent_level": 0 } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Indent with tabs](#indent-with-tabs) **Namespace**: `js` -**Key**: `wrap_line_length` +**Key**: `indent_with_tabs` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -Wrap lines at next opportunity after N characters (Supported by Coffee Formatter) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "wrap_line_length": 0 + "indent_with_tabs": false } } ``` -##### [End with newline](#end-with-newline) +##### [Preserve newlines](#preserve-newlines) **Namespace**: `js` -**Key**: `end_with_newline` +**Key**: `preserve_newlines` + +**Default**: `true` **Type**: `boolean` @@ -16516,589 +15678,585 @@ Wrap lines at next opportunity after N characters (Supported by Coffee Formatter **Description**: -End output with newline (Supported by Coffee Formatter) +Preserve line-breaks (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_newline": false + "preserve_newlines": true } } ``` -##### [End with comma](#end-with-comma) +##### [Max preserve newlines](#max-preserve-newlines) **Namespace**: `js` -**Key**: `end_with_comma` +**Key**: `max_preserve_newlines` -**Type**: `boolean` +**Default**: `10` + +**Type**: `integer` **Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter) +Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_comma": false + "max_preserve_newlines": 10 } } ``` -##### [End of line](#end-of-line) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `end_of_line` - -**Default**: `System Default` - -**Type**: `string` +**Key**: `space_in_paren` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `boolean` **Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Override EOL from line-ending-selector (Supported by Coffee Formatter) +Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_of_line": "System Default" + "space_in_paren": false } } ``` +##### [Jslint happy](#jslint-happy) -### Fortran Beautifier - -##### [Emacs path](#emacs-path) - -**Namespace**: `fortran` +**Namespace**: `js` -**Key**: `emacs_path` +**Key**: `jslint_happy` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Path to the `emacs` executable (Supported by Fortran Beautifier) +Enable jslint-stricter mode (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "fortran": { - "emacs_path": "" + "js": { + "jslint_happy": false } } ``` -##### [Emacs script path](#emacs-script-path) +##### [Space after anon function](#space-after-anon-function) -**Namespace**: `fortran` +**Namespace**: `js` -**Key**: `emacs_script_path` +**Key**: `space_after_anon_function` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Path to the emacs script (Supported by Fortran Beautifier) +Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "fortran": { - "emacs_script_path": "" + "js": { + "space_after_anon_function": false } } ``` +##### [Brace style](#brace-style) -### Gherkin formatter - -##### [Indent size](#indent-size) +**Namespace**: `js` -**Namespace**: `gherkin` +**Key**: `brace_style` -**Key**: `indent_size` +**Default**: `collapse` -**Default**: `4` +**Type**: `string` -**Type**: `integer` +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` -**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation size/length (Supported by Gherkin formatter) +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "gherkin": { - "indent_size": 4 + "js": { + "brace_style": "collapse" } } ``` -##### [Indent char](#indent-char) - -**Namespace**: `gherkin` +##### [Break chained methods](#break-chained-methods) -**Key**: `indent_char` +**Namespace**: `js` -**Default**: ` ` +**Key**: `break_chained_methods` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation character (Supported by Gherkin formatter) +Break chained method calls across subsequent lines (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "gherkin": { - "indent_char": " " + "js": { + "break_chained_methods": false } } ``` +##### [Keep array indentation](#keep-array-indentation) -### HTML Beautifier - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `keep_array_indentation` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`HTML Beautifier`](#html-beautifier) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation size/length (Supported by HTML Beautifier, Pretty Diff) +Preserve array indentation (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "keep_array_indentation": false } } ``` +##### [Keep function indentation](#keep-function-indentation) -### JS Beautify - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `keep_function_indentation` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation size/length (Supported by JS Beautify, Pretty Diff) + (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "keep_function_indentation": false } } ``` -##### [Indent char](#indent-char) +##### [Space before conditional](#space-before-conditional) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `indent_char` +**Key**: `space_before_conditional` -**Default**: ` ` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Indentation character (Supported by JS Beautify, Pretty Diff) + (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "space_before_conditional": true } } ``` -##### [Selector separator newline](#selector-separator-newline) +##### [Eval code](#eval-code) -**Namespace**: `css` +**Namespace**: `js` -**Key**: `selector_separator_newline` +**Key**: `eval_code` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Add a newline between multiple selectors (Supported by JS Beautify) + (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "selector_separator_newline": false + "js": { + "eval_code": false } } ``` -##### [Newline between rules](#newline-between-rules) - -**Namespace**: `css` +##### [Unescape strings](#unescape-strings) -**Key**: `newline_between_rules` +**Namespace**: `js` -**Default**: `true` +**Key**: `unescape_strings` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff) +Decode printable characters encoded in xNN notation (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "newline_between_rules": true + "js": { + "unescape_strings": false } } ``` -##### [Preserve newlines](#preserve-newlines) - -**Namespace**: `html` +##### [Wrap line length](#wrap-line-length) -**Key**: `preserve_newlines` +**Namespace**: `js` -**Default**: `true` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Preserve line-breaks (Supported by JS Beautify, Pretty Diff) +Wrap lines at next opportunity after N characters (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "js": { + "wrap_line_length": 0 } } ``` -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `html` +##### [End with newline](#end-with-newline) -**Key**: `wrap_line_length` +**Namespace**: `js` -**Default**: `250` +**Key**: `end_with_newline` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) +End output with newline (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "js": { + "end_with_newline": false } } ``` -##### [End with newline](#end-with-newline) +##### [End with comma](#end-with-comma) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `end_with_newline` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -End output with newline (Supported by JS Beautify) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "end_with_newline": false + "js": { + "end_with_comma": false } } ``` -##### [Indent level](#indent-level) +##### [End of line](#end-of-line) **Namespace**: `js` -**Key**: `indent_level` +**Key**: `end_of_line` -**Type**: `integer` +**Default**: `System Default` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) **Description**: -Initial indentation level (Supported by JS Beautify) +Override EOL from line-ending-selector (Supported by Coffee Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_level": 0 + "end_of_line": "System Default" } } ``` -##### [Indent with tabs](#indent-with-tabs) -**Namespace**: `js` +### Fortran Beautifier -**Key**: `indent_with_tabs` +##### [Emacs path](#emacs-path) -**Type**: `boolean` +**Namespace**: `fortran` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Key**: `emacs_path` + +**Type**: `string` + +**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff) +Path to the `emacs` executable (Supported by Fortran Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_with_tabs": false + "fortran": { + "emacs_path": "" } } ``` -##### [Max preserve newlines](#max-preserve-newlines) - -**Namespace**: `html` +##### [Emacs script path](#emacs-script-path) -**Key**: `max_preserve_newlines` +**Namespace**: `fortran` -**Default**: `10` +**Key**: `emacs_script_path` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`Fortran Beautifier`](#fortran-beautifier) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by JS Beautify) +Path to the emacs script (Supported by Fortran Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "max_preserve_newlines": 10 + "fortran": { + "emacs_script_path": "" } } ``` -##### [Space in paren](#space-in-paren) -**Namespace**: `js` +### Gherkin formatter -**Key**: `space_in_paren` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `gherkin` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff) +Indentation size/length (Supported by Gherkin formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_in_paren": false + "gherkin": { + "indent_size": 4 } } ``` -##### [Jslint happy](#jslint-happy) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `gherkin` -**Key**: `jslint_happy` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Type**: `string` + +**Supported Beautifiers**: [`Gherkin formatter`](#gherkin-formatter) **Description**: -Enable jslint-stricter mode (Supported by JS Beautify) +Indentation character (Supported by Gherkin formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "jslint_happy": false + "gherkin": { + "indent_char": " " } } ``` -##### [Space after anon function](#space-after-anon-function) -**Namespace**: `js` +### HTML Beautifier -**Key**: `space_after_anon_function` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `html` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`HTML Beautifier`](#html-beautifier) [`Pretty Diff`](#pretty-diff) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff) +Indentation size/length (Supported by HTML Beautifier, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "html": { + "indent_size": 4 } } ``` -##### [Brace style](#brace-style) -**Namespace**: `html` +### JS Beautify -**Key**: `brace_style` +##### [Indent size](#indent-size) -**Default**: `collapse` +**Namespace**: `html` -**Type**: `string` +**Key**: `indent_size` -**Enum**: `collapse` `expand` `end-expand` `none` +**Default**: `4` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -[collapse|expand|end-expand|none] (Supported by JS Beautify) +Indentation size/length (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "brace_style": "collapse" + "indent_size": 4 } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `break_chained_methods` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` + +**Type**: `string` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff) +Indentation character (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "html": { + "indent_char": " " } } ``` -##### [Keep array indentation](#keep-array-indentation) +##### [Selector separator newline](#selector-separator-newline) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `keep_array_indentation` +**Key**: `selector_separator_newline` **Type**: `boolean` @@ -17106,97 +16264,101 @@ Break chained method calls across subsequent lines (Supported by JS Beautify, Pr **Description**: -Preserve array indentation (Supported by JS Beautify) +Add a newline between multiple selectors (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "css": { + "selector_separator_newline": false } } ``` -##### [Keep function indentation](#keep-function-indentation) +##### [Newline between rules](#newline-between-rules) -**Namespace**: `js` +**Namespace**: `css` -**Key**: `keep_function_indentation` +**Key**: `newline_between_rules` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by JS Beautify) +Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "css": { + "newline_between_rules": true } } ``` -##### [Space before conditional](#space-before-conditional) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `space_before_conditional` +**Key**: `preserve_newlines` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by JS Beautify) +Preserve line-breaks (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "html": { + "preserve_newlines": true } } ``` -##### [Eval code](#eval-code) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `eval_code` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Default**: `250` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Type**: `integer` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: - (Supported by JS Beautify) +Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "html": { + "wrap_line_length": 250 } } ``` -##### [Unescape strings](#unescape-strings) +##### [End with newline](#end-with-newline) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `unescape_strings` +**Key**: `end_with_newline` **Type**: `boolean` @@ -17204,308 +16366,221 @@ Preserve array indentation (Supported by JS Beautify) **Description**: -Decode printable characters encoded in xNN notation (Supported by JS Beautify) +End output with newline (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "unescape_strings": false + "html": { + "end_with_newline": false } } ``` -##### [End with comma](#end-with-comma) +##### [Indent level](#indent-level) **Namespace**: `js` -**Key**: `end_with_comma` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff) +Initial indentation level (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_comma": false + "indent_level": 0 } } ``` -##### [End of line](#end-of-line) +##### [Indent with tabs](#indent-with-tabs) **Namespace**: `js` -**Key**: `end_of_line` - -**Default**: `System Default` - -**Type**: `string` +**Key**: `indent_with_tabs` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Override EOL from line-ending-selector (Supported by JS Beautify) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_of_line": "System Default" + "indent_with_tabs": false } } ``` -##### [Indent inner html](#indent-inner-html) +##### [Max preserve newlines](#max-preserve-newlines) **Namespace**: `html` -**Key**: `indent_inner_html` +**Key**: `max_preserve_newlines` -**Type**: `boolean` +**Default**: `10` + +**Type**: `integer` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indent and sections. (Supported by JS Beautify) +Number of line-breaks to be preserved in one chunk (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_inner_html": false + "max_preserve_newlines": 10 } } ``` -##### [Indent scripts](#indent-scripts) - -**Namespace**: `html` - -**Key**: `indent_scripts` +##### [Space in paren](#space-in-paren) -**Default**: `normal` +**Namespace**: `js` -**Type**: `string` +**Key**: `space_in_paren` -**Enum**: `keep` `separate` `normal` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -[keep|separate|normal] (Supported by JS Beautify) +Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_scripts": "normal" + "js": { + "space_in_paren": false } } ``` -##### [Wrap attributes](#wrap-attributes) - -**Namespace**: `html` - -**Key**: `wrap_attributes` +##### [Jslint happy](#jslint-happy) -**Default**: `auto` +**Namespace**: `js` -**Type**: `string` +**Key**: `jslint_happy` -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` +**Type**: `boolean` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) +Enable jslint-stricter mode (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes": "auto" + "js": { + "jslint_happy": false } } ``` -##### [Wrap attributes indent size](#wrap-attributes-indent-size) - -**Namespace**: `html` +##### [Space after anon function](#space-after-anon-function) -**Key**: `wrap_attributes_indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `space_after_anon_function` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -Indent wrapped attributes to after N characters (Supported by JS Beautify) +Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes_indent_size": 4 + "js": { + "space_after_anon_function": false } } ``` -##### [Unformatted](#unformatted) +##### [Brace style](#brace-style) **Namespace**: `html` -**Key**: `unformatted` +**Key**: `brace_style` -**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` +**Default**: `collapse` -**Type**: `array` +**Type**: `string` + +**Enum**: `collapse` `expand` `end-expand` `none` **Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify) +[collapse|expand|end-expand|none] (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "unformatted": [ - "a", - "abbr", - "area", - "audio", - "b", - "bdi", - "bdo", - "br", - "button", - "canvas", - "cite", - "code", - "data", - "datalist", - "del", - "dfn", - "em", - "embed", - "i", - "iframe", - "img", - "input", - "ins", - "kbd", - "keygen", - "label", - "map", - "mark", - "math", - "meter", - "noscript", - "object", - "output", - "progress", - "q", - "ruby", - "s", - "samp", - "select", - "small", - "span", - "strong", - "sub", - "sup", - "svg", - "template", - "textarea", - "time", - "u", - "var", - "video", - "wbr", - "text", - "acronym", - "address", - "big", - "dt", - "ins", - "small", - "strike", - "tt", - "pre", - "h1", - "h2", - "h3", - "h4", - "h5", - "h6" - ] + "brace_style": "collapse" } } ``` -##### [Extra liners](#extra-liners) - -**Namespace**: `html` +##### [Break chained methods](#break-chained-methods) -**Key**: `extra_liners` +**Namespace**: `js` -**Default**: `head,body,/html` +**Key**: `break_chained_methods` -**Type**: `array` +**Type**: `boolean` -**Supported Beautifiers**: [`JS Beautify`](#js-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify) +Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "extra_liners": [ - "head", - "body", - "/html" - ] + "js": { + "break_chained_methods": false } } ``` -##### [E4x](#e4x) - -**Namespace**: `jsx` +##### [Keep array indentation](#keep-array-indentation) -**Key**: `e4x` +**Namespace**: `js` -**Default**: `true` +**Key**: `keep_array_indentation` **Type**: `boolean` @@ -17513,2120 +16588,2207 @@ List of tags (defaults to [head,body,/html] that should have an extra newline be **Description**: -Support e4x/jsx syntax (Supported by JS Beautify) +Preserve array indentation (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "jsx": { - "e4x": true + "js": { + "keep_array_indentation": false } } ``` +##### [Keep function indentation](#keep-function-indentation) -### Latex Beautify - -##### [Indent char](#indent-char) - -**Namespace**: `latex` - -**Key**: `indent_char` +**Namespace**: `js` -**Default**: ` ` +**Key**: `keep_function_indentation` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation character (Supported by Latex Beautify) + (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "indent_char": " " + "js": { + "keep_function_indentation": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Space before conditional](#space-before-conditional) -**Namespace**: `latex` +**Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `space_before_conditional` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify) + (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "indent_with_tabs": false + "js": { + "space_before_conditional": true } } ``` -##### [Indent preamble](#indent-preamble) +##### [Eval code](#eval-code) -**Namespace**: `latex` +**Namespace**: `js` -**Key**: `indent_preamble` +**Key**: `eval_code` **Type**: `boolean` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indent the preamble (Supported by Latex Beautify) + (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "indent_preamble": false + "js": { + "eval_code": false } } ``` -##### [Always look for split braces](#always-look-for-split-braces) - -**Namespace**: `latex` +##### [Unescape strings](#unescape-strings) -**Key**: `always_look_for_split_braces` +**Namespace**: `js` -**Default**: `true` +**Key**: `unescape_strings` **Type**: `boolean` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -If `latexindent` should look for commands that split braces across lines (Supported by Latex Beautify) +Decode printable characters encoded in xNN notation (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "always_look_for_split_braces": true + "js": { + "unescape_strings": false } } ``` -##### [Always look for split brackets](#always-look-for-split-brackets) +##### [End with comma](#end-with-comma) -**Namespace**: `latex` +**Namespace**: `js` -**Key**: `always_look_for_split_brackets` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) [`Pretty Diff`](#pretty-diff) **Description**: -If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "always_look_for_split_brackets": false + "js": { + "end_with_comma": false } } ``` -##### [Remove trailing whitespace](#remove-trailing-whitespace) +##### [End of line](#end-of-line) -**Namespace**: `latex` +**Namespace**: `js` -**Key**: `remove_trailing_whitespace` +**Key**: `end_of_line` -**Type**: `boolean` +**Default**: `System Default` + +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Remove trailing whitespace (Supported by Latex Beautify) +Override EOL from line-ending-selector (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "remove_trailing_whitespace": false + "js": { + "end_of_line": "System Default" } } ``` -##### [Align columns in environments](#align-columns-in-environments) - -**Namespace**: `latex` +##### [Indent inner html](#indent-inner-html) -**Key**: `align_columns_in_environments` +**Namespace**: `html` -**Default**: `tabular,matrix,bmatrix,pmatrix` +**Key**: `indent_inner_html` -**Type**: `array` +**Type**: `boolean` -**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Aligns columns by the alignment tabs for environments specified (Supported by Latex Beautify) +Indent and sections. (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "latex": { - "align_columns_in_environments": [ - "tabular", - "matrix", - "bmatrix", - "pmatrix" - ] + "html": { + "indent_inner_html": false } } ``` +##### [Indent scripts](#indent-scripts) -### Lua beautifier - -##### [End of line](#end-of-line) - -**Namespace**: `lua` +**Namespace**: `html` -**Key**: `end_of_line` +**Key**: `indent_scripts` -**Default**: `System Default` +**Default**: `normal` **Type**: `string` -**Enum**: `CRLF` `LF` `System Default` +**Enum**: `keep` `separate` `normal` -**Supported Beautifiers**: [`Lua beautifier`](#lua-beautifier) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Override EOL from line-ending-selector (Supported by Lua beautifier) +[keep|separate|normal] (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "lua": { - "end_of_line": "System Default" + "html": { + "indent_scripts": "normal" } } ``` - -### Marko Beautifier - -##### [Indent size](#indent-size) +##### [Wrap attributes](#wrap-attributes) **Namespace**: `html` -**Key**: `indent_size` +**Key**: `wrap_attributes` -**Default**: `4` +**Default**: `auto` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation size/length (Supported by Marko Beautifier) +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_size": 4 + "wrap_attributes": "auto" } } ``` -##### [Indent char](#indent-char) +##### [Wrap attributes indent size](#wrap-attributes-indent-size) **Namespace**: `html` -**Key**: `indent_char` +**Key**: `wrap_attributes_indent_size` -**Default**: ` ` +**Default**: `4` -**Type**: `string` +**Type**: `integer` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indentation character (Supported by Marko Beautifier) +Indent wrapped attributes to after N characters (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_char": " " + "wrap_attributes_indent_size": 4 } } ``` -##### [Syntax](#syntax) - -**Namespace**: `marko` +##### [Unformatted](#unformatted) -**Key**: `syntax` +**Namespace**: `html` -**Default**: `html` +**Key**: `unformatted` -**Type**: `string` +**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` -**Enum**: `html` `concise` +**Type**: `array` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -[html|concise] (Supported by Marko Beautifier) +List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "marko": { - "syntax": "html" + "html": { + "unformatted": [ + "a", + "abbr", + "area", + "audio", + "b", + "bdi", + "bdo", + "br", + "button", + "canvas", + "cite", + "code", + "data", + "datalist", + "del", + "dfn", + "em", + "embed", + "i", + "iframe", + "img", + "input", + "ins", + "kbd", + "keygen", + "label", + "map", + "mark", + "math", + "meter", + "noscript", + "object", + "output", + "progress", + "q", + "ruby", + "s", + "samp", + "select", + "small", + "span", + "strong", + "sub", + "sup", + "svg", + "template", + "textarea", + "time", + "u", + "var", + "video", + "wbr", + "text", + "acronym", + "address", + "big", + "dt", + "ins", + "small", + "strike", + "tt", + "pre", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ] } } ``` -##### [Indent inner html](#indent-inner-html) +##### [Extra liners](#extra-liners) **Namespace**: `html` -**Key**: `indent_inner_html` +**Key**: `extra_liners` -**Type**: `boolean` +**Default**: `head,body,/html` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Type**: `array` + +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -Indent and sections. (Supported by Marko Beautifier) +List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_inner_html": false + "extra_liners": [ + "head", + "body", + "/html" + ] } } ``` -##### [Brace style](#brace-style) - -**Namespace**: `html` +##### [E4x](#e4x) -**Key**: `brace_style` +**Namespace**: `jsx` -**Default**: `collapse` +**Key**: `e4x` -**Type**: `string` +**Default**: `true` -**Enum**: `collapse` `expand` `end-expand` `none` +**Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`JS Beautify`](#js-beautify) **Description**: -[collapse|expand|end-expand|none] (Supported by Marko Beautifier) +Support e4x/jsx syntax (Supported by JS Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "brace_style": "collapse" + "jsx": { + "e4x": true } } ``` -##### [Indent scripts](#indent-scripts) -**Namespace**: `html` +### Latex Beautify -**Key**: `indent_scripts` +##### [Indent char](#indent-char) -**Default**: `normal` +**Namespace**: `latex` -**Type**: `string` +**Key**: `indent_char` -**Enum**: `keep` `separate` `normal` +**Default**: ` ` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Type**: `string` + +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -[keep|separate|normal] (Supported by Marko Beautifier) +Indentation character (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_scripts": "normal" + "latex": { + "indent_char": " " } } ``` -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `html` +##### [Indent with tabs](#indent-with-tabs) -**Key**: `wrap_line_length` +**Namespace**: `latex` -**Default**: `250` +**Key**: `indent_with_tabs` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Maximum characters per line (0 disables) (Supported by Marko Beautifier) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "latex": { + "indent_with_tabs": false } } -``` - -##### [Wrap attributes](#wrap-attributes) - -**Namespace**: `html` +``` -**Key**: `wrap_attributes` +##### [Indent preamble](#indent-preamble) -**Default**: `auto` +**Namespace**: `latex` -**Type**: `string` +**Key**: `indent_preamble` -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` +**Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier) +Indent the preamble (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes": "auto" + "latex": { + "indent_preamble": false } } ``` -##### [Wrap attributes indent size](#wrap-attributes-indent-size) +##### [Always look for split braces](#always-look-for-split-braces) -**Namespace**: `html` +**Namespace**: `latex` -**Key**: `wrap_attributes_indent_size` +**Key**: `always_look_for_split_braces` -**Default**: `4` +**Default**: `true` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Indent wrapped attributes to after N characters (Supported by Marko Beautifier) +If `latexindent` should look for commands that split braces across lines (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes_indent_size": 4 + "latex": { + "always_look_for_split_braces": true } } ``` -##### [Preserve newlines](#preserve-newlines) - -**Namespace**: `html` +##### [Always look for split brackets](#always-look-for-split-brackets) -**Key**: `preserve_newlines` +**Namespace**: `latex` -**Default**: `true` +**Key**: `always_look_for_split_brackets` **Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Preserve line-breaks (Supported by Marko Beautifier) +If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "latex": { + "always_look_for_split_brackets": false } } ``` -##### [Max preserve newlines](#max-preserve-newlines) - -**Namespace**: `html` +##### [Remove trailing whitespace](#remove-trailing-whitespace) -**Key**: `max_preserve_newlines` +**Namespace**: `latex` -**Default**: `10` +**Key**: `remove_trailing_whitespace` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier) +Remove trailing whitespace (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "max_preserve_newlines": 10 + "latex": { + "remove_trailing_whitespace": false } } ``` -##### [Unformatted](#unformatted) +##### [Align columns in environments](#align-columns-in-environments) -**Namespace**: `html` +**Namespace**: `latex` -**Key**: `unformatted` +**Key**: `align_columns_in_environments` -**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` +**Default**: `tabular,matrix,bmatrix,pmatrix` **Type**: `array` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Supported Beautifiers**: [`Latex Beautify`](#latex-beautify) **Description**: -List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier) +Aligns columns by the alignment tabs for environments specified (Supported by Latex Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "unformatted": [ - "a", - "abbr", - "area", - "audio", - "b", - "bdi", - "bdo", - "br", - "button", - "canvas", - "cite", - "code", - "data", - "datalist", - "del", - "dfn", - "em", - "embed", - "i", - "iframe", - "img", - "input", - "ins", - "kbd", - "keygen", - "label", - "map", - "mark", - "math", - "meter", - "noscript", - "object", - "output", - "progress", - "q", - "ruby", - "s", - "samp", - "select", - "small", - "span", - "strong", - "sub", - "sup", - "svg", - "template", - "textarea", - "time", - "u", - "var", - "video", - "wbr", - "text", - "acronym", - "address", - "big", - "dt", - "ins", - "small", - "strike", - "tt", - "pre", - "h1", - "h2", - "h3", - "h4", - "h5", - "h6" + "latex": { + "align_columns_in_environments": [ + "tabular", + "matrix", + "bmatrix", + "pmatrix" ] } } ``` -##### [End with newline](#end-with-newline) -**Namespace**: `html` +### Lua beautifier -**Key**: `end_with_newline` +##### [End of line](#end-of-line) -**Type**: `boolean` +**Namespace**: `lua` -**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) +**Key**: `end_of_line` + +**Default**: `System Default` + +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` + +**Supported Beautifiers**: [`Lua beautifier`](#lua-beautifier) **Description**: -End output with newline (Supported by Marko Beautifier) +Override EOL from line-ending-selector (Supported by Lua beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "end_with_newline": false + "lua": { + "end_of_line": "System Default" } } ``` -##### [Extra liners](#extra-liners) + +### Marko Beautifier + +##### [Indent size](#indent-size) **Namespace**: `html` -**Key**: `extra_liners` +**Key**: `indent_size` -**Default**: `head,body,/html` +**Default**: `4` -**Type**: `array` +**Type**: `integer` **Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Marko Beautifier) +Indentation size/length (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "extra_liners": [ - "head", - "body", - "/html" - ] + "indent_size": 4 } } ``` +##### [Indent char](#indent-char) -### Nginx Beautify - -##### [Indent size](#indent-size) - -**Namespace**: `nginx` +**Namespace**: `html` -**Key**: `indent_size` +**Key**: `indent_char` -**Default**: `4` +**Default**: ` ` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indentation size/length (Supported by Nginx Beautify) +Indentation character (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "indent_size": 4 + "html": { + "indent_char": " " } } ``` -##### [Indent char](#indent-char) +##### [Syntax](#syntax) -**Namespace**: `nginx` +**Namespace**: `marko` -**Key**: `indent_char` +**Key**: `syntax` -**Default**: ` ` +**Default**: `html` **Type**: `string` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Enum**: `html` `concise` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indentation character (Supported by Nginx Beautify) +[html|concise] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "indent_char": " " + "marko": { + "syntax": "html" } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Indent inner html](#indent-inner-html) -**Namespace**: `nginx` +**Namespace**: `html` -**Key**: `indent_with_tabs` +**Key**: `indent_inner_html` **Type**: `boolean` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify) +Indent and sections. (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "indent_with_tabs": false + "html": { + "indent_inner_html": false } } ``` -##### [Don't join curly brackets](#don't-join-curly-brackets) +##### [Brace style](#brace-style) + +**Namespace**: `html` -**Namespace**: `nginx` +**Key**: `brace_style` -**Key**: `dontJoinCurlyBracet` +**Default**: `collapse` -**Default**: `true` +**Type**: `string` -**Type**: `boolean` +**Enum**: `collapse` `expand` `end-expand` `none` -**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: - (Supported by Nginx Beautify) +[collapse|expand|end-expand|none] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "nginx": { - "dontJoinCurlyBracet": true + "html": { + "brace_style": "collapse" } } ``` +##### [Indent scripts](#indent-scripts) -### PHP-CS-Fixer - -##### [PHP-CS-Fixer Path](#php-cs-fixer-path) +**Namespace**: `html` -**Namespace**: `php` +**Key**: `indent_scripts` -**Key**: `cs_fixer_path` +**Default**: `normal` **Type**: `string` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Enum**: `keep` `separate` `normal` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer) +[keep|separate|normal] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "cs_fixer_path": "" + "html": { + "indent_scripts": "normal" } } ``` -##### [PHP-CS-Fixer Version](#php-cs-fixer-version) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `php` +**Namespace**: `html` -**Key**: `cs_fixer_version` +**Key**: `wrap_line_length` -**Default**: `2` +**Default**: `250` **Type**: `integer` -**Enum**: `1` `2` - -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: - (Supported by PHP-CS-Fixer) +Maximum characters per line (0 disables) (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "cs_fixer_version": 2 + "html": { + "wrap_line_length": 250 } } ``` -##### [PHP-CS-Fixer Config File](#php-cs-fixer-config-file) +##### [Wrap attributes](#wrap-attributes) -**Namespace**: `php` +**Namespace**: `html` -**Key**: `cs_fixer_config_file` +**Key**: `wrap_attributes` + +**Default**: `auto` **Type**: `string` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Path to php-cs-fixer config file. Will use local `.php_cs` or `.php_cs.dist` if found in the working directory or project root. (Supported by PHP-CS-Fixer) +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "cs_fixer_config_file": "" + "html": { + "wrap_attributes": "auto" } } ``` -##### [Fixers](#fixers) +##### [Wrap attributes indent size](#wrap-attributes-indent-size) -**Namespace**: `php` +**Namespace**: `html` -**Key**: `fixers` +**Key**: `wrap_attributes_indent_size` -**Type**: `string` +**Default**: `4` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Type**: `integer` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) +Indent wrapped attributes to after N characters (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "fixers": "" + "html": { + "wrap_attributes_indent_size": 4 } } ``` -##### [Level](#level) +##### [Preserve newlines](#preserve-newlines) -**Namespace**: `php` +**Namespace**: `html` -**Key**: `level` +**Key**: `preserve_newlines` -**Type**: `string` +**Default**: `true` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Type**: `boolean` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) +Preserve line-breaks (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "level": "" + "html": { + "preserve_newlines": true } } ``` -##### [Rules](#rules) +##### [Max preserve newlines](#max-preserve-newlines) -**Namespace**: `php` +**Namespace**: `html` -**Key**: `rules` +**Key**: `max_preserve_newlines` -**Type**: `string` +**Default**: `10` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Type**: `integer` + +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) +Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "rules": "" + "html": { + "max_preserve_newlines": 10 } } ``` -##### [Allow risky rules](#allow-risky-rules) - -**Namespace**: `php` +##### [Unformatted](#unformatted) -**Key**: `allow_risky` +**Namespace**: `html` -**Default**: `no` +**Key**: `unformatted` -**Type**: `string` +**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` -**Enum**: `no` `yes` +**Type**: `array` -**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) +List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "allow_risky": "no" + "html": { + "unformatted": [ + "a", + "abbr", + "area", + "audio", + "b", + "bdi", + "bdo", + "br", + "button", + "canvas", + "cite", + "code", + "data", + "datalist", + "del", + "dfn", + "em", + "embed", + "i", + "iframe", + "img", + "input", + "ins", + "kbd", + "keygen", + "label", + "map", + "mark", + "math", + "meter", + "noscript", + "object", + "output", + "progress", + "q", + "ruby", + "s", + "samp", + "select", + "small", + "span", + "strong", + "sub", + "sup", + "svg", + "template", + "textarea", + "time", + "u", + "var", + "video", + "wbr", + "text", + "acronym", + "address", + "big", + "dt", + "ins", + "small", + "strike", + "tt", + "pre", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ] } } ``` +##### [End with newline](#end-with-newline) -### PHPCBF - -##### [PHPCBF Path](#phpcbf-path) - -**Namespace**: `php` +**Namespace**: `html` -**Key**: `phpcbf_path` +**Key**: `end_with_newline` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: -Path to the `phpcbf` CLI executable (Supported by PHPCBF) +End output with newline (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "phpcbf_path": "" + "html": { + "end_with_newline": false } } ``` -##### [PHPCBF Version](#phpcbf-version) - -**Namespace**: `php` +##### [Extra liners](#extra-liners) -**Key**: `phpcbf_version` +**Namespace**: `html` -**Default**: `2` +**Key**: `extra_liners` -**Type**: `integer` +**Default**: `head,body,/html` -**Enum**: `1` `2` `3` +**Type**: `array` -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) +**Supported Beautifiers**: [`Marko Beautifier`](#marko-beautifier) **Description**: - (Supported by PHPCBF) +List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Marko Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "phpcbf_version": 2 + "html": { + "extra_liners": [ + "head", + "body", + "/html" + ] } } ``` -##### [PHPCBF Standard](#phpcbf-standard) -**Namespace**: `php` +### Nginx Beautify -**Key**: `standard` +##### [Indent size](#indent-size) -**Default**: `PEAR` +**Namespace**: `nginx` -**Type**: `string` +**Key**: `indent_size` -**Supported Beautifiers**: [`PHPCBF`](#phpcbf) +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHPCBF) +Indentation size/length (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "php": { - "standard": "PEAR" + "nginx": { + "indent_size": 4 } } ``` +##### [Indent char](#indent-char) -### Perltidy - -##### [Perltidy profile](#perltidy-profile) +**Namespace**: `nginx` -**Namespace**: `perl` +**Key**: `indent_char` -**Key**: `perltidy_profile` +**Default**: ` ` **Type**: `string` -**Supported Beautifiers**: [`Perltidy`](#perltidy) +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy) +Indentation character (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "perl": { - "perltidy_profile": "" + "nginx": { + "indent_char": " " } } ``` +##### [Indent with tabs](#indent-with-tabs) -### Pretty Diff - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `nginx` -**Default**: `4` +**Key**: `indent_with_tabs` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -Indentation size/length (Supported by Pretty Diff) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "nginx": { + "indent_with_tabs": false } } ``` -##### [Indent char](#indent-char) +##### [Don't join curly brackets](#don't-join-curly-brackets) -**Namespace**: `html` +**Namespace**: `nginx` -**Key**: `indent_char` +**Key**: `dontJoinCurlyBracet` -**Default**: ` ` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`Nginx Beautify`](#nginx-beautify) **Description**: -Indentation character (Supported by Pretty Diff) + (Supported by Nginx Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "nginx": { + "dontJoinCurlyBracet": true } } ``` -##### [Wrap line length](#wrap-line-length) -**Namespace**: `html` +### PHP-CS-Fixer -**Key**: `wrap_line_length` +##### [PHP-CS-Fixer Path](#php-cs-fixer-path) -**Default**: `250` +**Namespace**: `php` -**Type**: `integer` +**Key**: `cs_fixer_path` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `string` + +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Maximum characters per line (0 disables) (Supported by Pretty Diff) +Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "php": { + "cs_fixer_path": "" } } ``` -##### [Preserve newlines](#preserve-newlines) +##### [PHP-CS-Fixer Version](#php-cs-fixer-version) -**Namespace**: `html` +**Namespace**: `php` -**Key**: `preserve_newlines` +**Key**: `cs_fixer_version` -**Default**: `true` +**Default**: `2` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Enum**: `1` `2` + +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Preserve line-breaks (Supported by Pretty Diff) + (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "php": { + "cs_fixer_version": 2 } } ``` -##### [Newline between rules](#newline-between-rules) - -**Namespace**: `css` +##### [PHP-CS-Fixer Config File](#php-cs-fixer-config-file) -**Key**: `newline_between_rules` +**Namespace**: `php` -**Default**: `true` +**Key**: `cs_fixer_config_file` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Add a newline between CSS rules (Supported by Pretty Diff) +Path to php-cs-fixer config file. Will use local `.php_cs` or `.php_cs.dist` if found in the working directory or project root. (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "newline_between_rules": true + "php": { + "cs_fixer_config_file": "" } } ``` -##### [Indent comments](#indent-comments) - -**Namespace**: `css` +##### [Fixers](#fixers) -**Key**: `indent_comments` +**Namespace**: `php` -**Default**: `true` +**Key**: `fixers` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Determines whether comments should be indented. (Supported by Pretty Diff) +Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "indent_comments": true + "php": { + "fixers": "" } } ``` -##### [Force indentation](#force-indentation) +##### [Level](#level) -**Namespace**: `css` +**Namespace**: `php` -**Key**: `force_indentation` +**Key**: `level` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) +By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "force_indentation": false + "php": { + "level": "" } } ``` -##### [Convert quotes](#convert-quotes) - -**Namespace**: `css` +##### [Rules](#rules) -**Key**: `convert_quotes` +**Namespace**: `php` -**Default**: `none` +**Key**: `rules` **Type**: `string` -**Enum**: `none` `double` `single` - -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) +Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "convert_quotes": "none" + "php": { + "rules": "" } } ``` -##### [Align assignments](#align-assignments) +##### [Allow risky rules](#allow-risky-rules) -**Namespace**: `css` +**Namespace**: `php` -**Key**: `align_assignments` +**Key**: `allow_risky` -**Type**: `boolean` +**Default**: `no` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `string` + +**Enum**: `no` `yes` + +**Supported Beautifiers**: [`PHP-CS-Fixer`](#php-cs-fixer) **Description**: -If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) +Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "align_assignments": false + "php": { + "allow_risky": "no" } } ``` -##### [No lead zero](#no-lead-zero) -**Namespace**: `css` +### PHPCBF -**Key**: `no_lead_zero` +##### [PHPCBF Path](#phpcbf-path) -**Type**: `boolean` +**Namespace**: `php` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Key**: `phpcbf_path` + +**Type**: `string` + +**Supported Beautifiers**: [`PHPCBF`](#phpcbf) **Description**: -If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) +Path to the `phpcbf` CLI executable (Supported by PHPCBF) **Example `.jsbeautifyrc` Configuration** ```json { - "css": { - "no_lead_zero": false + "php": { + "phpcbf_path": "" } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [PHPCBF Version](#phpcbf-version) -**Namespace**: `js` +**Namespace**: `php` -**Key**: `indent_with_tabs` +**Key**: `phpcbf_version` -**Type**: `boolean` +**Default**: `2` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Type**: `integer` + +**Enum**: `1` `2` `3` + +**Supported Beautifiers**: [`PHPCBF`](#phpcbf) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) + (Supported by PHPCBF) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_with_tabs": false + "php": { + "phpcbf_version": 2 } } ``` -##### [Space in paren](#space-in-paren) +##### [PHPCBF Standard](#phpcbf-standard) -**Namespace**: `js` +**Namespace**: `php` -**Key**: `space_in_paren` +**Key**: `standard` -**Type**: `boolean` +**Default**: `PEAR` + +**Type**: `string` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Supported Beautifiers**: [`PHPCBF`](#phpcbf) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) +Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local `phpcs.xml`, `phpcs.xml.dist`, `phpcs.ruleset.xml` or `ruleset.xml` if found in the project root. (Supported by PHPCBF) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_in_paren": false + "php": { + "standard": "PEAR" } } ``` -##### [Space after anon function](#space-after-anon-function) -**Namespace**: `js` +### Perltidy -**Key**: `space_after_anon_function` +##### [Perltidy profile](#perltidy-profile) -**Type**: `boolean` +**Namespace**: `perl` -**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) +**Key**: `perltidy_profile` + +**Type**: `string` + +**Supported Beautifiers**: [`Perltidy`](#perltidy) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) +Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "perl": { + "perltidy_profile": "" } } ``` -##### [Break chained methods](#break-chained-methods) -**Namespace**: `js` +### Pretty Diff -**Key**: `break_chained_methods` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `html` + +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` **Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Break chained method calls across subsequent lines (Supported by Pretty Diff) +Indentation size/length (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "html": { + "indent_size": 4 } } ``` -##### [End with comma](#end-with-comma) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `end_with_comma` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` + +**Type**: `string` **Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) +Indentation character (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "html": { + "indent_char": " " } } ``` - -### Pug Beautify - -##### [Indent size](#indent-size) +##### [Wrap line length](#wrap-line-length) **Namespace**: `html` -**Key**: `indent_size` +**Key**: `wrap_line_length` -**Default**: `4` +**Default**: `250` **Type**: `integer` -**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by Pug Beautify) +Maximum characters per line (0 disables) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_size": 4 + "wrap_line_length": 250 } } ``` -##### [Indent char](#indent-char) +##### [Preserve newlines](#preserve-newlines) **Namespace**: `html` -**Key**: `indent_char` +**Key**: `preserve_newlines` -**Default**: ` ` +**Default**: `true` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by Pug Beautify) +Preserve line-breaks (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "indent_char": " " + "preserve_newlines": true } } ``` +##### [Newline between rules](#newline-between-rules) -### Remark - -##### [Gfm](#gfm) - -**Namespace**: `markdown` +**Namespace**: `css` -**Key**: `gfm` +**Key**: `newline_between_rules` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Remark`](#remark) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -GitHub Flavoured Markdown (Supported by Remark) +Add a newline between CSS rules (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "markdown": { - "gfm": true + "css": { + "newline_between_rules": true } } ``` -##### [Yaml](#yaml) +##### [Indent comments](#indent-comments) -**Namespace**: `markdown` +**Namespace**: `css` -**Key**: `yaml` +**Key**: `indent_comments` **Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`Remark`](#remark) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark) +Determines whether comments should be indented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "markdown": { - "yaml": true + "css": { + "indent_comments": true } } ``` -##### [Commonmark](#commonmark) +##### [Force indentation](#force-indentation) -**Namespace**: `markdown` +**Namespace**: `css` -**Key**: `commonmark` +**Key**: `force_indentation` **Type**: `boolean` -**Supported Beautifiers**: [`Remark`](#remark) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Allows and disallows several constructs. (Supported by Remark) +if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "markdown": { - "commonmark": false + "css": { + "force_indentation": false } } ``` +##### [Convert quotes](#convert-quotes) -### Rubocop - -##### [Indent size](#indent-size) +**Namespace**: `css` -**Namespace**: `ruby` +**Key**: `convert_quotes` -**Key**: `indent_size` +**Default**: `none` -**Default**: `4` +**Type**: `string` -**Type**: `integer` +**Enum**: `none` `double` `single` -**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by Rubocop, Ruby Beautify) +Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "indent_size": 4 + "css": { + "convert_quotes": "none" } } ``` -##### [Rubocop Path](#rubocop-path) +##### [Align assignments](#align-assignments) -**Namespace**: `ruby` +**Namespace**: `css` -**Key**: `rubocop_path` +**Key**: `align_assignments` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Rubocop`](#rubocop) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Path to the `rubocop` CLI executable (Supported by Rubocop) +If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "rubocop_path": "" + "css": { + "align_assignments": false } } ``` +##### [No lead zero](#no-lead-zero) -### Ruby Beautify - -##### [Indent size](#indent-size) - -**Namespace**: `ruby` - -**Key**: `indent_size` +**Namespace**: `css` -**Default**: `4` +**Key**: `no_lead_zero` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by Rubocop, Ruby Beautify) +If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "indent_size": 4 + "css": { + "no_lead_zero": false } } ``` -##### [Indent char](#indent-char) - -**Namespace**: `ruby` - -**Key**: `indent_char` +##### [Indent with tabs](#indent-with-tabs) -**Default**: ` ` +**Namespace**: `js` -**Type**: `string` +**Key**: `indent_with_tabs` -**Enum**: ` ` ` ` +**Type**: `boolean` -**Supported Beautifiers**: [`Ruby Beautify`](#ruby-beautify) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by Ruby Beautify) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { - "ruby": { - "indent_char": " " + "js": { + "indent_with_tabs": false } } ``` - -### TypeScript Formatter - -##### [Indent size](#indent-size) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `indent_size` - -**Default**: `4` +**Key**: `space_in_paren` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation size/length (Supported by TypeScript Formatter) +Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_size": 4 + "space_in_paren": false } } ``` -##### [Indent char](#indent-char) +##### [Space after anon function](#space-after-anon-function) **Namespace**: `js` -**Key**: `indent_char` - -**Default**: ` ` +**Key**: `space_after_anon_function` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation character (Supported by TypeScript Formatter) +Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_char": " " + "space_after_anon_function": false } } ``` -##### [Indent level](#indent-level) +##### [Break chained methods](#break-chained-methods) **Namespace**: `js` -**Key**: `indent_level` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Initial indentation level (Supported by TypeScript Formatter) +Break chained method calls across subsequent lines (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_level": 0 + "break_chained_methods": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pretty Diff`](#pretty-diff) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "end_with_comma": false } } ``` -##### [Preserve newlines](#preserve-newlines) -**Namespace**: `js` +### Pug Beautify -**Key**: `preserve_newlines` +##### [Indent size](#indent-size) -**Default**: `true` +**Namespace**: `html` -**Type**: `boolean` +**Key**: `indent_size` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) **Description**: -Preserve line-breaks (Supported by TypeScript Formatter) +Indentation size/length (Supported by Pug Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "preserve_newlines": true + "html": { + "indent_size": 4 } } ``` -##### [Max preserve newlines](#max-preserve-newlines) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `max_preserve_newlines` +**Key**: `indent_char` -**Default**: `10` +**Default**: ` ` -**Type**: `integer` +**Type**: `string` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Pug Beautify`](#pug-beautify) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) +Indentation character (Supported by Pug Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "max_preserve_newlines": 10 + "html": { + "indent_char": " " } } ``` -##### [Space in paren](#space-in-paren) -**Namespace**: `js` +### Remark -**Key**: `space_in_paren` +##### [Gfm](#gfm) + +**Namespace**: `markdown` + +**Key**: `gfm` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Remark`](#remark) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) +GitHub Flavoured Markdown (Supported by Remark) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_in_paren": false + "markdown": { + "gfm": true } } ``` -##### [Jslint happy](#jslint-happy) +##### [Yaml](#yaml) -**Namespace**: `js` +**Namespace**: `markdown` -**Key**: `jslint_happy` +**Key**: `yaml` + +**Default**: `true` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Remark`](#remark) **Description**: -Enable jslint-stricter mode (Supported by TypeScript Formatter) +Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "jslint_happy": false + "markdown": { + "yaml": true } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Commonmark](#commonmark) -**Namespace**: `js` +**Namespace**: `markdown` -**Key**: `space_after_anon_function` +**Key**: `commonmark` **Type**: `boolean` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Remark`](#remark) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) +Allows and disallows several constructs. (Supported by Remark) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "markdown": { + "commonmark": false } } ``` -##### [Brace style](#brace-style) -**Namespace**: `js` +### Rubocop -**Key**: `brace_style` +##### [Indent size](#indent-size) -**Default**: `collapse` +**Namespace**: `ruby` -**Type**: `string` +**Key**: `indent_size` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Default**: `4` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `integer` + +**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) **Description**: -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) +Indentation size/length (Supported by Rubocop, Ruby Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "brace_style": "collapse" + "ruby": { + "indent_size": 4 } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Rubocop Path](#rubocop-path) -**Namespace**: `js` +**Namespace**: `ruby` -**Key**: `break_chained_methods` +**Key**: `rubocop_path` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Supported Beautifiers**: [`Rubocop`](#rubocop) **Description**: -Break chained method calls across subsequent lines (Supported by TypeScript Formatter) +Path to the `rubocop` CLI executable (Supported by Rubocop) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "ruby": { + "rubocop_path": "" } } ``` -##### [Keep array indentation](#keep-array-indentation) -**Namespace**: `js` +### Ruby Beautify -**Key**: `keep_array_indentation` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `ruby` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`Rubocop`](#rubocop) [`Ruby Beautify`](#ruby-beautify) **Description**: -Preserve array indentation (Supported by TypeScript Formatter) +Indentation size/length (Supported by Rubocop, Ruby Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "ruby": { + "indent_size": 4 } } ``` -##### [Keep function indentation](#keep-function-indentation) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `ruby` -**Key**: `keep_function_indentation` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) +**Type**: `string` + +**Enum**: ` ` ` ` + +**Supported Beautifiers**: [`Ruby Beautify`](#ruby-beautify) **Description**: - (Supported by TypeScript Formatter) +Indentation character (Supported by Ruby Beautify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "ruby": { + "indent_char": " " } } ``` -##### [Space before conditional](#space-before-conditional) + +### TypeScript Formatter + +##### [Indent size](#indent-size) **Namespace**: `js` -**Key**: `space_before_conditional` +**Key**: `indent_size` -**Default**: `true` +**Default**: `4` -**Type**: `boolean` +**Type**: `integer` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: - (Supported by TypeScript Formatter) +Indentation size/length (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_before_conditional": true + "indent_size": 4 } } ``` -##### [Eval code](#eval-code) +##### [Indent char](#indent-char) **Namespace**: `js` -**Key**: `eval_code` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` + +**Type**: `string` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: - (Supported by TypeScript Formatter) +Indentation character (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "eval_code": false + "indent_char": " " } } ``` -##### [Unescape strings](#unescape-strings) +##### [Indent level](#indent-level) **Namespace**: `js` -**Key**: `unescape_strings` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) +Initial indentation level (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "unescape_strings": false + "indent_level": 0 } } ``` -##### [Wrap line length](#wrap-line-length) +##### [Indent with tabs](#indent-with-tabs) **Namespace**: `js` -**Key**: `wrap_line_length` +**Key**: `indent_with_tabs` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "wrap_line_length": 0 + "indent_with_tabs": false } } ``` -##### [End with newline](#end-with-newline) +##### [Preserve newlines](#preserve-newlines) **Namespace**: `js` -**Key**: `end_with_newline` +**Key**: `preserve_newlines` + +**Default**: `true` **Type**: `boolean` @@ -19634,529 +18796,527 @@ Wrap lines at next opportunity after N characters (Supported by TypeScript Forma **Description**: -End output with newline (Supported by TypeScript Formatter) +Preserve line-breaks (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_newline": false + "preserve_newlines": true } } ``` -##### [End with comma](#end-with-comma) +##### [Max preserve newlines](#max-preserve-newlines) **Namespace**: `js` -**Key**: `end_with_comma` +**Key**: `max_preserve_newlines` -**Type**: `boolean` +**Default**: `10` + +**Type**: `integer` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) +Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_with_comma": false + "max_preserve_newlines": 10 } } ``` -##### [End of line](#end-of-line) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `end_of_line` - -**Default**: `System Default` - -**Type**: `string` +**Key**: `space_in_paren` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `boolean` **Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Override EOL from line-ending-selector (Supported by TypeScript Formatter) +Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_of_line": "System Default" + "space_in_paren": false } } ``` +##### [Jslint happy](#jslint-happy) -### Uncrustify - -##### [Config Path](#config-path) - -**Namespace**: `vala` +**Namespace**: `js` -**Key**: `configPath` +**Key**: `jslint_happy` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`Uncrustify`](#uncrustify) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify) +Enable jslint-stricter mode (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "vala": { - "configPath": "" + "js": { + "jslint_happy": false } } ``` +##### [Space after anon function](#space-after-anon-function) -### Vue Beautifier - -##### [Indent size](#indent-size) - -**Namespace**: `html` - -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `space_after_anon_function` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation size/length (Supported by Vue Beautifier) +Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_size": 4 + "js": { + "space_after_anon_function": false } } ``` -##### [Indent char](#indent-char) +##### [Brace style](#brace-style) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `indent_char` +**Key**: `brace_style` -**Default**: ` ` +**Default**: `collapse` **Type**: `string` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation character (Supported by Vue Beautifier) +[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_char": " " + "js": { + "brace_style": "collapse" } } ``` -##### [Indent level](#indent-level) +##### [Break chained methods](#break-chained-methods) **Namespace**: `js` -**Key**: `indent_level` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Initial indentation level (Supported by Vue Beautifier) +Break chained method calls across subsequent lines (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_level": 0 + "break_chained_methods": false } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Keep array indentation](#keep-array-indentation) **Namespace**: `js` -**Key**: `indent_with_tabs` +**Key**: `keep_array_indentation` **Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Vue Beautifier) +Preserve array indentation (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "indent_with_tabs": false + "keep_array_indentation": false } } ``` -##### [Preserve newlines](#preserve-newlines) - -**Namespace**: `html` +##### [Keep function indentation](#keep-function-indentation) -**Key**: `preserve_newlines` +**Namespace**: `js` -**Default**: `true` +**Key**: `keep_function_indentation` **Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Preserve line-breaks (Supported by Vue Beautifier) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "preserve_newlines": true + "js": { + "keep_function_indentation": false } } ``` -##### [Max preserve newlines](#max-preserve-newlines) +##### [Space before conditional](#space-before-conditional) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `max_preserve_newlines` +**Key**: `space_before_conditional` -**Default**: `10` +**Default**: `true` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "max_preserve_newlines": 10 + "js": { + "space_before_conditional": true } } ``` -##### [Space in paren](#space-in-paren) +##### [Eval code](#eval-code) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `eval_code` **Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier) + (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "eval_code": false } } ``` -##### [Jslint happy](#jslint-happy) +##### [Unescape strings](#unescape-strings) **Namespace**: `js` -**Key**: `jslint_happy` +**Key**: `unescape_strings` **Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Enable jslint-stricter mode (Supported by Vue Beautifier) +Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "jslint_happy": false + "unescape_strings": false } } ``` -##### [Space after anon function](#space-after-anon-function) +##### [Wrap line length](#wrap-line-length) **Namespace**: `js` -**Key**: `space_after_anon_function` +**Key**: `wrap_line_length` -**Type**: `boolean` +**Type**: `integer` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier) +Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_after_anon_function": false + "wrap_line_length": 0 } } ``` -##### [Brace style](#brace-style) - -**Namespace**: `html` - -**Key**: `brace_style` +##### [End with newline](#end-with-newline) -**Default**: `collapse` +**Namespace**: `js` -**Type**: `string` +**Key**: `end_with_newline` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -[collapse|expand|end-expand|none] (Supported by Vue Beautifier) +End output with newline (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "brace_style": "collapse" + "js": { + "end_with_newline": false } } ``` -##### [Break chained methods](#break-chained-methods) +##### [End with comma](#end-with-comma) **Namespace**: `js` -**Key**: `break_chained_methods` +**Key**: `end_with_comma` **Type**: `boolean` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Break chained method calls across subsequent lines (Supported by Vue Beautifier) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "break_chained_methods": false + "end_with_comma": false } } ``` -##### [Keep array indentation](#keep-array-indentation) +##### [End of line](#end-of-line) **Namespace**: `js` -**Key**: `keep_array_indentation` +**Key**: `end_of_line` -**Type**: `boolean` +**Default**: `System Default` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` + +**Supported Beautifiers**: [`TypeScript Formatter`](#typescript-formatter) **Description**: -Preserve array indentation (Supported by Vue Beautifier) +Override EOL from line-ending-selector (Supported by TypeScript Formatter) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "keep_array_indentation": false + "end_of_line": "System Default" } } ``` -##### [Keep function indentation](#keep-function-indentation) -**Namespace**: `js` +### Uncrustify -**Key**: `keep_function_indentation` +##### [Config Path](#config-path) -**Type**: `boolean` +**Namespace**: `vala` -**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) +**Key**: `configPath` + +**Type**: `string` + +**Supported Beautifiers**: [`Uncrustify`](#uncrustify) **Description**: - (Supported by Vue Beautifier) +Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "vala": { + "configPath": "" } } ``` -##### [Space before conditional](#space-before-conditional) -**Namespace**: `js` +### Vue Beautifier -**Key**: `space_before_conditional` +##### [Indent size](#indent-size) -**Default**: `true` +**Namespace**: `html` -**Type**: `boolean` +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: - (Supported by Vue Beautifier) +Indentation size/length (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "html": { + "indent_size": 4 } } ``` -##### [Eval code](#eval-code) +##### [Indent char](#indent-char) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `eval_code` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` + +**Type**: `string` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: - (Supported by Vue Beautifier) +Indentation character (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "html": { + "indent_char": " " } } ``` -##### [Unescape strings](#unescape-strings) +##### [Indent level](#indent-level) **Namespace**: `js` -**Key**: `unescape_strings` +**Key**: `indent_level` -**Type**: `boolean` +**Type**: `integer` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Decode printable characters encoded in xNN notation (Supported by Vue Beautifier) +Initial indentation level (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "unescape_strings": false + "indent_level": 0 } } ``` -##### [Wrap line length](#wrap-line-length) - -**Namespace**: `html` +##### [Indent with tabs](#indent-with-tabs) -**Key**: `wrap_line_length` +**Namespace**: `js` -**Default**: `250` +**Key**: `indent_with_tabs` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Maximum characters per line (0 disables) (Supported by Vue Beautifier) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_line_length": 250 + "js": { + "indent_with_tabs": false } } ``` -##### [End with newline](#end-with-newline) +##### [Preserve newlines](#preserve-newlines) **Namespace**: `html` -**Key**: `end_with_newline` +**Key**: `preserve_newlines` + +**Default**: `true` **Type**: `boolean` @@ -20164,75 +19324,73 @@ Maximum characters per line (0 disables) (Supported by Vue Beautifier) **Description**: -End output with newline (Supported by Vue Beautifier) +Preserve line-breaks (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "end_with_newline": false + "preserve_newlines": true } } ``` -##### [End with comma](#end-with-comma) +##### [Max preserve newlines](#max-preserve-newlines) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `end_with_comma` +**Key**: `max_preserve_newlines` -**Type**: `boolean` +**Default**: `10` + +**Type**: `integer` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier) +Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "html": { + "max_preserve_newlines": 10 } } ``` -##### [End of line](#end-of-line) +##### [Space in paren](#space-in-paren) **Namespace**: `js` -**Key**: `end_of_line` - -**Default**: `System Default` - -**Type**: `string` +**Key**: `space_in_paren` -**Enum**: `CRLF` `LF` `System Default` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Override EOL from line-ending-selector (Supported by Vue Beautifier) +Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "end_of_line": "System Default" + "space_in_paren": false } } ``` -##### [Indent inner html](#indent-inner-html) +##### [Jslint happy](#jslint-happy) -**Namespace**: `html` +**Namespace**: `js` -**Key**: `indent_inner_html` +**Key**: `jslint_happy` **Type**: `boolean` @@ -20240,607 +19398,578 @@ Override EOL from line-ending-selector (Supported by Vue Beautifier) **Description**: -Indent and sections. (Supported by Vue Beautifier) +Enable jslint-stricter mode (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_inner_html": false + "js": { + "jslint_happy": false } } ``` -##### [Indent scripts](#indent-scripts) - -**Namespace**: `html` - -**Key**: `indent_scripts` +##### [Space after anon function](#space-after-anon-function) -**Default**: `normal` +**Namespace**: `js` -**Type**: `string` +**Key**: `space_after_anon_function` -**Enum**: `keep` `separate` `normal` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -[keep|separate|normal] (Supported by Vue Beautifier) +Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "indent_scripts": "normal" + "js": { + "space_after_anon_function": false } } ``` -##### [Wrap attributes](#wrap-attributes) +##### [Brace style](#brace-style) **Namespace**: `html` -**Key**: `wrap_attributes` +**Key**: `brace_style` -**Default**: `auto` +**Default**: `collapse` **Type**: `string` -**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` +**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier) +[collapse|expand|end-expand|none] (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { "html": { - "wrap_attributes": "auto" + "brace_style": "collapse" } } ``` -##### [Wrap attributes indent size](#wrap-attributes-indent-size) - -**Namespace**: `html` +##### [Break chained methods](#break-chained-methods) -**Key**: `wrap_attributes_indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `break_chained_methods` -**Type**: `integer` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indent wrapped attributes to after N characters (Supported by Vue Beautifier) +Break chained method calls across subsequent lines (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "wrap_attributes_indent_size": 4 + "js": { + "break_chained_methods": false } } ``` -##### [Unformatted](#unformatted) - -**Namespace**: `html` +##### [Keep array indentation](#keep-array-indentation) -**Key**: `unformatted` +**Namespace**: `js` -**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` +**Key**: `keep_array_indentation` -**Type**: `array` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier) +Preserve array indentation (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "unformatted": [ - "a", - "abbr", - "area", - "audio", - "b", - "bdi", - "bdo", - "br", - "button", - "canvas", - "cite", - "code", - "data", - "datalist", - "del", - "dfn", - "em", - "embed", - "i", - "iframe", - "img", - "input", - "ins", - "kbd", - "keygen", - "label", - "map", - "mark", - "math", - "meter", - "noscript", - "object", - "output", - "progress", - "q", - "ruby", - "s", - "samp", - "select", - "small", - "span", - "strong", - "sub", - "sup", - "svg", - "template", - "textarea", - "time", - "u", - "var", - "video", - "wbr", - "text", - "acronym", - "address", - "big", - "dt", - "ins", - "small", - "strike", - "tt", - "pre", - "h1", - "h2", - "h3", - "h4", - "h5", - "h6" - ] + "js": { + "keep_array_indentation": false } } ``` -##### [Extra liners](#extra-liners) - -**Namespace**: `html` +##### [Keep function indentation](#keep-function-indentation) -**Key**: `extra_liners` +**Namespace**: `js` -**Default**: `head,body,/html` +**Key**: `keep_function_indentation` -**Type**: `array` +**Type**: `boolean` **Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier) + (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "html": { - "extra_liners": [ - "head", - "body", - "/html" - ] + "js": { + "keep_function_indentation": false } } ``` +##### [Space before conditional](#space-before-conditional) -### align-yaml - -##### [Padding](#padding) +**Namespace**: `js` -**Namespace**: `yaml` +**Key**: `space_before_conditional` -**Key**: `padding` +**Default**: `true` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`align-yaml`](#align-yaml) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -The amount of padding to add next to each line. (Supported by align-yaml) + (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "yaml": { - "padding": 0 + "js": { + "space_before_conditional": true } } ``` +##### [Eval code](#eval-code) -### autopep8 - -##### [Max line length](#max-line-length) - -**Namespace**: `python` - -**Key**: `max_line_length` +**Namespace**: `js` -**Default**: `79` +**Key**: `eval_code` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -set maximum allowed line length (Supported by autopep8, pybeautifier) + (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "max_line_length": 79 + "js": { + "eval_code": false } } ``` -##### [Indent size](#indent-size) - -**Namespace**: `python` +##### [Unescape strings](#unescape-strings) -**Key**: `indent_size` +**Namespace**: `js` -**Default**: `4` +**Key**: `unescape_strings` -**Type**: `integer` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indentation size/length (Supported by autopep8, pybeautifier) +Decode printable characters encoded in xNN notation (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "indent_size": 4 + "js": { + "unescape_strings": false } } ``` -##### [Ignore](#ignore) +##### [Wrap line length](#wrap-line-length) -**Namespace**: `python` +**Namespace**: `html` -**Key**: `ignore` +**Key**: `wrap_line_length` -**Default**: `E24` +**Default**: `250` -**Type**: `array` +**Type**: `integer` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -do not fix these errors/warnings (Supported by autopep8, pybeautifier) +Maximum characters per line (0 disables) (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "ignore": [ - "E24" - ] + "html": { + "wrap_line_length": 250 } } ``` -##### [Formater](#formater) - -**Namespace**: `python` - -**Key**: `formater` +##### [End with newline](#end-with-newline) -**Default**: `autopep8` +**Namespace**: `html` -**Type**: `string` +**Key**: `end_with_newline` -**Enum**: `autopep8` `yapf` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -formatter used by pybeautifier (Supported by autopep8, pybeautifier) +End output with newline (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "formater": "autopep8" + "html": { + "end_with_newline": false } } ``` -##### [Style config](#style-config) - -**Namespace**: `python` +##### [End with comma](#end-with-comma) -**Key**: `style_config` +**Namespace**: `js` -**Default**: `pep8` +**Key**: `end_with_comma` -**Type**: `string` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -formatting style used by yapf (Supported by autopep8, pybeautifier) +If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "style_config": "pep8" + "js": { + "end_with_comma": false } } ``` -##### [Sort imports](#sort-imports) +##### [End of line](#end-of-line) -**Namespace**: `python` +**Namespace**: `js` -**Key**: `sort_imports` +**Key**: `end_of_line` -**Type**: `boolean` +**Default**: `System Default` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Type**: `string` + +**Enum**: `CRLF` `LF` `System Default` + +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -sort imports (requires isort installed) (Supported by autopep8, pybeautifier) +Override EOL from line-ending-selector (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "sort_imports": false + "js": { + "end_of_line": "System Default" } } ``` -##### [Multi line output](#multi-line-output) - -**Namespace**: `python` - -**Key**: `multi_line_output` +##### [Indent inner html](#indent-inner-html) -**Default**: `Hanging Grid Grouped` +**Namespace**: `html` -**Type**: `string` +**Key**: `indent_inner_html` -**Enum**: `Grid` `Vertical` `Hanging Indent` `Vertical Hanging Indent` `Hanging Grid` `Hanging Grid Grouped` `NOQA` +**Type**: `boolean` -**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier) +Indent and sections. (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "python": { - "multi_line_output": "Hanging Grid Grouped" + "html": { + "indent_inner_html": false } } ``` +##### [Indent scripts](#indent-scripts) -### beautysh - -##### [Indent size](#indent-size) +**Namespace**: `html` -**Namespace**: `bash` +**Key**: `indent_scripts` -**Key**: `indent_size` +**Default**: `normal` -**Default**: `4` +**Type**: `string` -**Type**: `integer` +**Enum**: `keep` `separate` `normal` -**Supported Beautifiers**: [`beautysh`](#beautysh) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indentation size/length (Supported by beautysh) +[keep|separate|normal] (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "bash": { - "indent_size": 4 + "html": { + "indent_scripts": "normal" } } ``` +##### [Wrap attributes](#wrap-attributes) -### clang-format - -##### [Config Path](#config-path) +**Namespace**: `html` -**Namespace**: `glsl` +**Key**: `wrap_attributes` -**Key**: `configPath` +**Default**: `auto` **Type**: `string` -**Supported Beautifiers**: [`clang-format`](#clang-format) +**Enum**: `auto` `force` `force-aligned` `force-expand-multiline` + +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format) +Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "glsl": { - "configPath": "" + "html": { + "wrap_attributes": "auto" } } ``` +##### [Wrap attributes indent size](#wrap-attributes-indent-size) -### coffee-fmt - -##### [Indent size](#indent-size) - -**Namespace**: `js` +**Namespace**: `html` -**Key**: `indent_size` +**Key**: `wrap_attributes_indent_size` **Default**: `4` **Type**: `integer` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indentation size/length (Supported by Coffee Formatter, coffee-fmt) +Indent wrapped attributes to after N characters (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_size": 4 + "html": { + "wrap_attributes_indent_size": 4 } } ``` -##### [Indent char](#indent-char) +##### [Unformatted](#unformatted) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `indent_char` +**Key**: `unformatted` -**Default**: ` ` +**Default**: `a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6` -**Type**: `string` +**Type**: `array` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indentation character (Supported by Coffee Formatter, coffee-fmt) +List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_char": " " + "html": { + "unformatted": [ + "a", + "abbr", + "area", + "audio", + "b", + "bdi", + "bdo", + "br", + "button", + "canvas", + "cite", + "code", + "data", + "datalist", + "del", + "dfn", + "em", + "embed", + "i", + "iframe", + "img", + "input", + "ins", + "kbd", + "keygen", + "label", + "map", + "mark", + "math", + "meter", + "noscript", + "object", + "output", + "progress", + "q", + "ruby", + "s", + "samp", + "select", + "small", + "span", + "strong", + "sub", + "sup", + "svg", + "template", + "textarea", + "time", + "u", + "var", + "video", + "wbr", + "text", + "acronym", + "address", + "big", + "dt", + "ins", + "small", + "strike", + "tt", + "pre", + "h1", + "h2", + "h3", + "h4", + "h5", + "h6" + ] } } ``` -##### [Indent with tabs](#indent-with-tabs) +##### [Extra liners](#extra-liners) -**Namespace**: `js` +**Namespace**: `html` -**Key**: `indent_with_tabs` +**Key**: `extra_liners` -**Type**: `boolean` +**Default**: `head,body,/html` -**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) +**Type**: `array` + +**Supported Beautifiers**: [`Vue Beautifier`](#vue-beautifier) **Description**: -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) +List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "indent_with_tabs": false + "html": { + "extra_liners": [ + "head", + "body", + "/html" + ] } } ``` -### formatR - -##### [Indent size](#indent-size) +### align-yaml -**Namespace**: `r` +##### [Padding](#padding) -**Key**: `indent_size` +**Namespace**: `yaml` -**Default**: `4` +**Key**: `padding` **Type**: `integer` -**Supported Beautifiers**: [`formatR`](#formatr) +**Supported Beautifiers**: [`align-yaml`](#align-yaml) **Description**: -Indentation size/length (Supported by formatR) +The amount of padding to add next to each line. (Supported by align-yaml) **Example `.jsbeautifyrc` Configuration** ```json { - "r": { - "indent_size": 4 + "yaml": { + "padding": 0 } } ``` -### pybeautifier +### autopep8 ##### [Max line length](#max-line-length) @@ -21029,38 +20158,11 @@ defines how from imports wrap (requires isort installed) (Supported by autopep8, ``` -### rustfmt - -##### [Rustfmt path](#rustfmt-path) - -**Namespace**: `rust` - -**Key**: `rustfmt_path` - -**Type**: `string` - -**Supported Beautifiers**: [`rustfmt`](#rustfmt) - -**Description**: - -Path to rustfmt program (Supported by rustfmt) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "rust": { - "rustfmt_path": "" - } -} -``` - - -### sqlformat +### beautysh ##### [Indent size](#indent-size) -**Namespace**: `sql` +**Namespace**: `bash` **Key**: `indent_size` @@ -21068,575 +20170,454 @@ Path to rustfmt program (Supported by rustfmt) **Type**: `integer` -**Supported Beautifiers**: [`sqlformat`](#sqlformat) +**Supported Beautifiers**: [`beautysh`](#beautysh) **Description**: -Indentation size/length (Supported by sqlformat) +Indentation size/length (Supported by beautysh) **Example `.jsbeautifyrc` Configuration** ```json { - "sql": { + "bash": { "indent_size": 4 } } ``` -##### [Keywords](#keywords) - -**Namespace**: `sql` - -**Key**: `keywords` - -**Default**: `upper` - -**Type**: `string` - -**Enum**: `unchanged` `lower` `upper` `capitalize` - -**Supported Beautifiers**: [`sqlformat`](#sqlformat) - -**Description**: - -Change case of keywords (Supported by sqlformat) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "sql": { - "keywords": "upper" - } -} -``` - -##### [Identifiers](#identifiers) - -**Namespace**: `sql` - -**Key**: `identifiers` - -**Default**: `unchanged` - -**Type**: `string` - -**Enum**: `unchanged` `lower` `upper` `capitalize` - -**Supported Beautifiers**: [`sqlformat`](#sqlformat) - -**Description**: - -Change case of identifiers (Supported by sqlformat) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "sql": { - "identifiers": "unchanged" - } -} -``` - - -### terraformfmt - -##### [Indent size](#indent-size) - -**Namespace**: `js` - -**Key**: `indent_size` - -**Default**: `4` - -**Type**: `integer` - -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) - -**Description**: - -Indentation size/length (Supported by terraformfmt) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_size": 4 - } -} -``` -##### [Indent char](#indent-char) +### clang-format -**Namespace**: `js` +##### [Config Path](#config-path) -**Key**: `indent_char` +**Namespace**: `glsl` -**Default**: ` ` +**Key**: `configPath` **Type**: `string` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) - -**Description**: - -Indentation character (Supported by terraformfmt) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_char": " " - } -} -``` - -##### [Indent level](#indent-level) - -**Namespace**: `js` - -**Key**: `indent_level` - -**Type**: `integer` - -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) - -**Description**: - -Initial indentation level (Supported by terraformfmt) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_level": 0 - } -} -``` - -##### [Indent with tabs](#indent-with-tabs) - -**Namespace**: `js` - -**Key**: `indent_with_tabs` - -**Type**: `boolean` - -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) - -**Description**: - -Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by terraformfmt) - -**Example `.jsbeautifyrc` Configuration** - -```json -{ - "js": { - "indent_with_tabs": false - } -} -``` - -##### [Preserve newlines](#preserve-newlines) - -**Namespace**: `js` - -**Key**: `preserve_newlines` - -**Default**: `true` - -**Type**: `boolean` - -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`clang-format`](#clang-format) **Description**: -Preserve line-breaks (Supported by terraformfmt) +Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "preserve_newlines": true + "glsl": { + "configPath": "" } } ``` -##### [Max preserve newlines](#max-preserve-newlines) + +### coffee-fmt + +##### [Indent size](#indent-size) **Namespace**: `js` -**Key**: `max_preserve_newlines` +**Key**: `indent_size` -**Default**: `10` +**Default**: `4` **Type**: `integer` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -Number of line-breaks to be preserved in one chunk (Supported by terraformfmt) +Indentation size/length (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "max_preserve_newlines": 10 + "indent_size": 4 } } ``` -##### [Space in paren](#space-in-paren) +##### [Indent char](#indent-char) **Namespace**: `js` -**Key**: `space_in_paren` +**Key**: `indent_char` -**Type**: `boolean` +**Default**: ` ` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `string` + +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -Add padding spaces within paren, ie. f( a, b ) (Supported by terraformfmt) +Indentation character (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "space_in_paren": false + "indent_char": " " } } ``` -##### [Jslint happy](#jslint-happy) +##### [Indent with tabs](#indent-with-tabs) **Namespace**: `js` -**Key**: `jslint_happy` +**Key**: `indent_with_tabs` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`Coffee Formatter`](#coffee-formatter) [`coffee-fmt`](#coffee-fmt) **Description**: -Enable jslint-stricter mode (Supported by terraformfmt) +Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt) **Example `.jsbeautifyrc` Configuration** ```json { "js": { - "jslint_happy": false + "indent_with_tabs": false } } ``` -##### [Space after anon function](#space-after-anon-function) -**Namespace**: `js` +### formatR -**Key**: `space_after_anon_function` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `r` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`formatR`](#formatr) **Description**: -Add a space before an anonymous function's parens, ie. function () (Supported by terraformfmt) +Indentation size/length (Supported by formatR) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_after_anon_function": false + "r": { + "indent_size": 4 } } ``` -##### [Brace style](#brace-style) -**Namespace**: `js` +### pybeautifier -**Key**: `brace_style` +##### [Max line length](#max-line-length) -**Default**: `collapse` +**Namespace**: `python` -**Type**: `string` +**Key**: `max_line_length` -**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none` +**Default**: `79` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `integer` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by terraformfmt) +set maximum allowed line length (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "brace_style": "collapse" + "python": { + "max_line_length": 79 } } ``` -##### [Break chained methods](#break-chained-methods) +##### [Indent size](#indent-size) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `break_chained_methods` +**Key**: `indent_size` -**Type**: `boolean` +**Default**: `4` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `integer` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -Break chained method calls across subsequent lines (Supported by terraformfmt) +Indentation size/length (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "break_chained_methods": false + "python": { + "indent_size": 4 } } ``` -##### [Keep array indentation](#keep-array-indentation) +##### [Ignore](#ignore) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `keep_array_indentation` +**Key**: `ignore` -**Type**: `boolean` +**Default**: `E24` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `array` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -Preserve array indentation (Supported by terraformfmt) +do not fix these errors/warnings (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_array_indentation": false + "python": { + "ignore": [ + "E24" + ] } } ``` -##### [Keep function indentation](#keep-function-indentation) +##### [Formater](#formater) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `keep_function_indentation` +**Key**: `formater` -**Type**: `boolean` +**Default**: `autopep8` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `string` + +**Enum**: `autopep8` `yapf` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: - (Supported by terraformfmt) +formatter used by pybeautifier (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "keep_function_indentation": false + "python": { + "formater": "autopep8" } } ``` -##### [Space before conditional](#space-before-conditional) +##### [Style config](#style-config) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `space_before_conditional` +**Key**: `style_config` -**Default**: `true` +**Default**: `pep8` -**Type**: `boolean` +**Type**: `string` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: - (Supported by terraformfmt) +formatting style used by yapf (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "space_before_conditional": true + "python": { + "style_config": "pep8" } } ``` -##### [Eval code](#eval-code) +##### [Sort imports](#sort-imports) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `eval_code` +**Key**: `sort_imports` **Type**: `boolean` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: - (Supported by terraformfmt) +sort imports (requires isort installed) (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "eval_code": false + "python": { + "sort_imports": false } } ``` -##### [Unescape strings](#unescape-strings) +##### [Multi line output](#multi-line-output) -**Namespace**: `js` +**Namespace**: `python` -**Key**: `unescape_strings` +**Key**: `multi_line_output` -**Type**: `boolean` +**Default**: `Hanging Grid Grouped` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `string` + +**Enum**: `Grid` `Vertical` `Hanging Indent` `Vertical Hanging Indent` `Hanging Grid` `Hanging Grid Grouped` `NOQA` + +**Supported Beautifiers**: [`autopep8`](#autopep8) [`pybeautifier`](#pybeautifier) **Description**: -Decode printable characters encoded in xNN notation (Supported by terraformfmt) +defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "unescape_strings": false + "python": { + "multi_line_output": "Hanging Grid Grouped" } } ``` -##### [Wrap line length](#wrap-line-length) -**Namespace**: `js` +### rustfmt -**Key**: `wrap_line_length` +##### [Rustfmt path](#rustfmt-path) -**Type**: `integer` +**Namespace**: `rust` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Key**: `rustfmt_path` + +**Type**: `string` + +**Supported Beautifiers**: [`rustfmt`](#rustfmt) **Description**: -Wrap lines at next opportunity after N characters (Supported by terraformfmt) +Path to rustfmt program (Supported by rustfmt) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "wrap_line_length": 0 + "rust": { + "rustfmt_path": "" } } ``` -##### [End with newline](#end-with-newline) -**Namespace**: `js` +### sqlformat -**Key**: `end_with_newline` +##### [Indent size](#indent-size) -**Type**: `boolean` +**Namespace**: `sql` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Key**: `indent_size` + +**Default**: `4` + +**Type**: `integer` + +**Supported Beautifiers**: [`sqlformat`](#sqlformat) **Description**: -End output with newline (Supported by terraformfmt) +Indentation size/length (Supported by sqlformat) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_newline": false + "sql": { + "indent_size": 4 } } ``` -##### [End with comma](#end-with-comma) +##### [Keywords](#keywords) -**Namespace**: `js` +**Namespace**: `sql` -**Key**: `end_with_comma` +**Key**: `keywords` -**Type**: `boolean` +**Default**: `upper` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Type**: `string` + +**Enum**: `unchanged` `lower` `upper` `capitalize` + +**Supported Beautifiers**: [`sqlformat`](#sqlformat) **Description**: -If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by terraformfmt) +Change case of keywords (Supported by sqlformat) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_with_comma": false + "sql": { + "keywords": "upper" } } ``` -##### [End of line](#end-of-line) +##### [Identifiers](#identifiers) -**Namespace**: `js` +**Namespace**: `sql` -**Key**: `end_of_line` +**Key**: `identifiers` -**Default**: `System Default` +**Default**: `unchanged` **Type**: `string` -**Enum**: `CRLF` `LF` `System Default` +**Enum**: `unchanged` `lower` `upper` `capitalize` -**Supported Beautifiers**: [`terraformfmt`](#terraformfmt) +**Supported Beautifiers**: [`sqlformat`](#sqlformat) **Description**: -Override EOL from line-ending-selector (Supported by terraformfmt) +Change case of identifiers (Supported by sqlformat) **Example `.jsbeautifyrc` Configuration** ```json { - "js": { - "end_of_line": "System Default" + "sql": { + "identifiers": "unchanged" } } ``` diff --git a/src/options.json b/src/options.json index 3988bb136..0bae28841 100644 --- a/src/options.json +++ b/src/options.json @@ -9143,299 +9143,6 @@ "tf" ], "properties": { - "indent_size": { - "type": "integer", - "default": null, - "minimum": 0, - "description": "Indentation size/length (Supported by terraformfmt)", - "title": "Indent size", - "beautifiers": [ - "terraformfmt" - ], - "key": "indent_size", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "indent_char": { - "type": "string", - "default": null, - "description": "Indentation character (Supported by terraformfmt)", - "title": "Indent char", - "beautifiers": [ - "terraformfmt" - ], - "key": "indent_char", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "indent_level": { - "type": "integer", - "default": 0, - "description": "Initial indentation level (Supported by terraformfmt)", - "title": "Indent level", - "beautifiers": [ - "terraformfmt" - ], - "key": "indent_level", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "indent_with_tabs": { - "type": "boolean", - "default": null, - "description": "Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by terraformfmt)", - "title": "Indent with tabs", - "beautifiers": [ - "terraformfmt" - ], - "key": "indent_with_tabs", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "preserve_newlines": { - "type": "boolean", - "default": true, - "description": "Preserve line-breaks (Supported by terraformfmt)", - "title": "Preserve newlines", - "beautifiers": [ - "terraformfmt" - ], - "key": "preserve_newlines", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "max_preserve_newlines": { - "type": "integer", - "default": 10, - "description": "Number of line-breaks to be preserved in one chunk (Supported by terraformfmt)", - "title": "Max preserve newlines", - "beautifiers": [ - "terraformfmt" - ], - "key": "max_preserve_newlines", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "space_in_paren": { - "type": "boolean", - "default": false, - "description": "Add padding spaces within paren, ie. f( a, b ) (Supported by terraformfmt)", - "title": "Space in paren", - "beautifiers": [ - "terraformfmt" - ], - "key": "space_in_paren", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "jslint_happy": { - "type": "boolean", - "default": false, - "description": "Enable jslint-stricter mode (Supported by terraformfmt)", - "title": "Jslint happy", - "beautifiers": [ - "terraformfmt" - ], - "key": "jslint_happy", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "space_after_anon_function": { - "type": "boolean", - "default": false, - "description": "Add a space before an anonymous function's parens, ie. function () (Supported by terraformfmt)", - "title": "Space after anon function", - "beautifiers": [ - "terraformfmt" - ], - "key": "space_after_anon_function", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "brace_style": { - "type": "string", - "default": "collapse", - "enum": [ - "collapse", - "collapse-preserve-inline", - "expand", - "end-expand", - "none" - ], - "description": "[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by terraformfmt)", - "title": "Brace style", - "beautifiers": [ - "terraformfmt" - ], - "key": "brace_style", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "break_chained_methods": { - "type": "boolean", - "default": false, - "description": "Break chained method calls across subsequent lines (Supported by terraformfmt)", - "title": "Break chained methods", - "beautifiers": [ - "terraformfmt" - ], - "key": "break_chained_methods", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "keep_array_indentation": { - "type": "boolean", - "default": false, - "description": "Preserve array indentation (Supported by terraformfmt)", - "title": "Keep array indentation", - "beautifiers": [ - "terraformfmt" - ], - "key": "keep_array_indentation", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "keep_function_indentation": { - "type": "boolean", - "default": false, - "description": " (Supported by terraformfmt)", - "title": "Keep function indentation", - "beautifiers": [ - "terraformfmt" - ], - "key": "keep_function_indentation", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "space_before_conditional": { - "type": "boolean", - "default": true, - "description": " (Supported by terraformfmt)", - "title": "Space before conditional", - "beautifiers": [ - "terraformfmt" - ], - "key": "space_before_conditional", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "eval_code": { - "type": "boolean", - "default": false, - "description": " (Supported by terraformfmt)", - "title": "Eval code", - "beautifiers": [ - "terraformfmt" - ], - "key": "eval_code", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "unescape_strings": { - "type": "boolean", - "default": false, - "description": "Decode printable characters encoded in xNN notation (Supported by terraformfmt)", - "title": "Unescape strings", - "beautifiers": [ - "terraformfmt" - ], - "key": "unescape_strings", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "wrap_line_length": { - "type": "integer", - "default": 0, - "description": "Wrap lines at next opportunity after N characters (Supported by terraformfmt)", - "title": "Wrap line length", - "beautifiers": [ - "terraformfmt" - ], - "key": "wrap_line_length", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "end_with_newline": { - "type": "boolean", - "default": false, - "description": "End output with newline (Supported by terraformfmt)", - "title": "End with newline", - "beautifiers": [ - "terraformfmt" - ], - "key": "end_with_newline", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "end_with_comma": { - "type": "boolean", - "default": false, - "description": "If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by terraformfmt)", - "title": "End with comma", - "beautifiers": [ - "terraformfmt" - ], - "key": "end_with_comma", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, - "end_of_line": { - "type": "string", - "default": "System Default", - "enum": [ - "CRLF", - "LF", - "System Default" - ], - "description": "Override EOL from line-ending-selector (Supported by terraformfmt)", - "title": "End of line", - "beautifiers": [ - "terraformfmt" - ], - "key": "end_of_line", - "language": { - "name": "JavaScript", - "namespace": "js" - } - }, "disabled": { "title": "Disable Beautifying Language", "order": -3, From fcb15dc55265e02d999d9897212f99ac3574c014 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Tue, 10 Oct 2017 16:57:18 +0200 Subject: [PATCH 11/16] add example --- .../terraform/expected/test.tf | 18 ++++++++++++++++ .../terraform/original/test.tf | 21 +++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 examples/simple-jsbeautifyrc/terraform/expected/test.tf create mode 100644 examples/simple-jsbeautifyrc/terraform/original/test.tf diff --git a/examples/simple-jsbeautifyrc/terraform/expected/test.tf b/examples/simple-jsbeautifyrc/terraform/expected/test.tf new file mode 100644 index 000000000..5f855b3fe --- /dev/null +++ b/examples/simple-jsbeautifyrc/terraform/expected/test.tf @@ -0,0 +1,18 @@ +resource "aws_db_instance" "wordpress" { + # worng spaces # to much spaces + + allocated_storage = 10 + storage_type = "gp2" + engine = "mariadb" + engine_version = "10.0.24" + + instance_class = "db.t2.micro" + identifier = "db-${var.env}" + name = "wordpress" + + username = "wordpress" + password = "${var.wordpress_db_pass}" + db_subnet_group_name = "${aws_db_subnet_group.default.name}" + vpc_security_group_ids = ["${aws_security_group.RuleWebServerIn.id}"] + apply_immediately = true +} diff --git a/examples/simple-jsbeautifyrc/terraform/original/test.tf b/examples/simple-jsbeautifyrc/terraform/original/test.tf new file mode 100644 index 000000000..702bfe844 --- /dev/null +++ b/examples/simple-jsbeautifyrc/terraform/original/test.tf @@ -0,0 +1,21 @@ +resource "aws_db_instance" "wordpress" { + # worng spaces + # to much spaces + + allocated_storage = 10 + storage_type = "gp2" + engine = "mariadb" + engine_version = "10.0.24" + +instance_class = "db.t2.micro" + identifier = "db-${var.env}" + name = "wordpress" + + + + username = "wordpress" + password = "${var.wordpress_db_pass}" + db_subnet_group_name = "${aws_db_subnet_group.default.name}" + vpc_security_group_ids = ["${aws_security_group.RuleWebServerIn.id}"] + apply_immediately = true +} From 91f7adb82477bf997f1c158d3f206c23dee5da4b Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Tue, 10 Oct 2017 17:36:29 +0200 Subject: [PATCH 12/16] update to run --- README.md | 2 +- docs/options.md | 17 +++++++++++++++++ src/beautifiers/terraformfmt.coffee | 21 ++++++++++++++++++--- src/options.json | 16 ++++++++++++++++ 4 files changed, 52 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e0e249be7..d76353f9b 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ Some of the supported beautifiers are developed for Node.js and are automaticall | SassConvert | :warning: 1 executable | :white_check_mark: :100:% of executables | :whale: With [Docker](https://www.docker.com/):
1. Install [SassConvert (`sass-convert`)](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#syntax) with `docker pull unibeautify/sass-convert`

:bookmark_tabs: Manually:
1. Install [SassConvert (`sass-convert`)](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#syntax) by following http://sass-lang.com/documentation/file.SASS_REFERENCE.html#syntax
| | sqlformat | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to https://github.com/andialbrecht/sqlparse and follow the instructions. | | stylish-haskell | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to https://github.com/jaspervdj/stylish-haskell and follow the instructions. | -| terraformfmt | :warning: Manual installation | :construction: Not an executable | :page_facing_up: Go to https://www.terraform.io/docs/commands/fmt.html and follow the instructions. | +| terraformfmt | :warning: 1 executable | :white_check_mark: :100:% of executables | :whale: With [Docker](https://www.docker.com/):
1. Install [Terraform (`terraform`)](https://www.terraform.io) with `docker pull hashicorp/terraform`

:bookmark_tabs: Manually:
1. Install [Terraform (`terraform`)](https://www.terraform.io) by following https://www.terraform.io
| | Tidy Markdown | :white_check_mark: | :ok_hand: Not necessary | :smiley: Nothing! | | TypeScript Formatter | :white_check_mark: | :ok_hand: Not necessary | :smiley: Nothing! | | Uncrustify | :warning: 1 executable | :white_check_mark: :100:% of executables | :whale: With [Docker](https://www.docker.com/):
1. Install [Uncrustify (`uncrustify`)](http://uncrustify.sourceforge.net/) with `docker pull unibeautify/uncrustify`

:bookmark_tabs: Manually:
1. Install [Uncrustify (`uncrustify`)](http://uncrustify.sourceforge.net/) by following https://github.com/uncrustify/uncrustify
| diff --git a/docs/options.md b/docs/options.md index c94bbbd9f..7f3311dd2 100644 --- a/docs/options.md +++ b/docs/options.md @@ -368,6 +368,23 @@ Options for SassConvert executable. 2. Go into *Packages* and search for "*Atom Beautify*" package. 3. Find the option "*SassConvert*" and change it to your desired configuration. +##### [Terraform](#terraform) + +**Important**: This option is only configurable from within Atom Beautify's setting panel. + +**Type**: `object` + +**Description**: + +Options for Terraform executable. + +**How to Configure** + +1. You can open the [Settings View](https://github.com/atom/settings-view) by navigating to +*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)*, or *File > Preferences (Windows)*. +2. Go into *Packages* and search for "*Atom Beautify*" package. +3. Find the option "*Terraform*" and change it to your desired configuration. + ##### [Uncrustify](#uncrustify) **Important**: This option is only configurable from within Atom Beautify's setting panel. diff --git a/src/beautifiers/terraformfmt.coffee b/src/beautifiers/terraformfmt.coffee index 6075f4ee8..b6035d728 100644 --- a/src/beautifiers/terraformfmt.coffee +++ b/src/beautifiers/terraformfmt.coffee @@ -14,11 +14,26 @@ module.exports = class Terraformfmt extends Beautifier Terraform: false } + executables: [ + { + name: "Terraform" + cmd: "terraform" + homepage: "https://www.terraform.io" + installation: "https://www.terraform.io" + version: { + parse: (text) -> text.match(/Terraform v(\d+\.\d+\.\d+)/)[1] + } + docker: { + image: "hashicorp/terraform" + } + } + ] + beautify: (text, language, options) -> - @run("terraform", [ + @exe("terraform").run([ "fmt" tempFile = @tempFile("input", text) ]) .then(=> - @readFile(tempFile) - ) + @readFile(tempFile) + ) \ No newline at end of file diff --git a/src/options.json b/src/options.json index 0bae28841..0eca25ed9 100644 --- a/src/options.json +++ b/src/options.json @@ -9415,6 +9415,22 @@ "description": "Absolute path to the \"beautysh\" executable's binary/script." } } + }, + "terraform": { + "key": "terraform", + "title": "Terraform", + "type": "object", + "collapsed": true, + "description": "Options for Terraform executable.", + "properties": { + "path": { + "key": "path", + "title": "Binary/Script Path", + "type": "string", + "default": "", + "description": "Absolute path to the \"terraform\" executable's binary/script." + } + } } } } From cf74a9821203b3e636cf307e47712d58b8bf9a9f Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Tue, 10 Oct 2017 17:49:09 +0200 Subject: [PATCH 13/16] remove space --- src/beautifiers/terraformfmt.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/beautifiers/terraformfmt.coffee b/src/beautifiers/terraformfmt.coffee index b6035d728..5da6d6e48 100644 --- a/src/beautifiers/terraformfmt.coffee +++ b/src/beautifiers/terraformfmt.coffee @@ -35,5 +35,5 @@ module.exports = class Terraformfmt extends Beautifier tempFile = @tempFile("input", text) ]) .then(=> - @readFile(tempFile) + @readFile(tempFile) ) \ No newline at end of file From b318eea93de5b4c347b93ce65eff5db92c5c26ac Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Wed, 11 Oct 2017 20:39:29 +0200 Subject: [PATCH 14/16] add travis and appveyor requirements --- .travis.yml | 6 ++++++ appveyor.yml | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/.travis.yml b/.travis.yml index fc65e27a9..b8f6995b7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -185,4 +185,10 @@ before_install: pip install --user beautysh; else pip install beautysh; + fi + # terraform + - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then + brew install terraform; + else + docker pull hashicorp/terraform; fi \ No newline at end of file diff --git a/appveyor.yml b/appveyor.yml index cbf504102..bf21dfb41 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -98,6 +98,10 @@ install: - cinst emacs -y - where emacs + # terraform + - cinst terraform -y + - where terraform + # FIXME: Enable allowEmptyChecksums, until someone fixes the checksum issue of php - choco feature enable -n allowEmptyChecksums # PHP From 0d266384f66a3698817bf836fee4d20d78d7e6d5 Mon Sep 17 00:00:00 2001 From: Malte Brodersen Date: Wed, 11 Oct 2017 23:11:41 +0200 Subject: [PATCH 15/16] workarround for travis issue" --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index b8f6995b7..7dc233b41 100644 --- a/.travis.yml +++ b/.travis.yml @@ -92,7 +92,7 @@ before_install: git clone --depth=1 https://github.com/Linuxbrew/brew.git ~/.linuxbrew || true; fi # Update Homebrew - # - brew update + - brew update - brew tap homebrew/dupes - brew tap homebrew/versions # Ruby language support From 3ec28ea375f2d92b419accd1033f1ec32ee488e1 Mon Sep 17 00:00:00 2001 From: Steven Zeck <8315038+szeck87@users.noreply.github.com> Date: Sun, 29 Oct 2017 17:13:46 -0500 Subject: [PATCH 16/16] Remove isPreInstalled attribute --- src/beautifiers/terraformfmt.coffee | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/beautifiers/terraformfmt.coffee b/src/beautifiers/terraformfmt.coffee index 5da6d6e48..f79989858 100644 --- a/src/beautifiers/terraformfmt.coffee +++ b/src/beautifiers/terraformfmt.coffee @@ -8,7 +8,6 @@ Beautifier = require('./beautifier') module.exports = class Terraformfmt extends Beautifier name: "terraformfmt" link: "https://www.terraform.io/docs/commands/fmt.html" - isPreInstalled: false options: { Terraform: false @@ -36,4 +35,4 @@ module.exports = class Terraformfmt extends Beautifier ]) .then(=> @readFile(tempFile) - ) \ No newline at end of file + )