2015-06-01 12:52:33 -06:00
# Options
2015-06-01 13:50:09 -06:00
Automatically generated documentation for Atom Beautify's options.
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
## Package Options
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
Configurable options for Atom Beautify.
---
2016-03-21 10:46:52 -06:00
#### [General](#general)
**Description**:
General options for Atom Beautify
2016-04-04 08:00:13 -06:00
##### [Analytics User Id](#analytics-user-id)
2015-06-01 13:50:09 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 13:50:09 -06:00
2016-04-04 08:00:13 -06:00
**Type**: `string`
2015-06-01 13:50:09 -06:00
**Description**:
2016-04-04 08:00:13 -06:00
Unique identifier for this user for tracking usage analytics
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**How to Configure**
2015-06-01 13:50:09 -06:00
2015-08-31 16:25:40 -06:00
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.
2016-04-04 08:00:13 -06:00
3. Find the option "*Analytics User Id*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify Entire File On Save](#beautify-entire-file-on-save)
2015-06-01 13:50:09 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
When beautifying on save, use the entire file, even if there is selected text in the editor. Important: The `beautify on save` option for the specific language must be enabled for this to be applicable. This option is not `beautify on save` .
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**How to Configure**
2015-06-01 13:50:09 -06:00
2015-08-31 16:25:40 -06:00
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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify Entire File On Save*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Logger Level](#logger-level)
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `warn`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Enum**: `verbose` `debug` `info` `warn` `error`
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Set the level for the logger
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Logger Level*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Mute All Errors](#mute-all-errors)
2015-06-01 13:50:09 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 13:50:09 -06:00
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Do not show any/all errors when they occur
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**How to Configure**
2015-06-01 13:50:09 -06:00
2015-08-31 16:25:40 -06:00
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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Mute All Errors*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Mute Unsupported Language Errors](#mute-unsupported-language-errors)
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 13:50:09 -06:00
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Do not show "Unsupported Language" errors when they occur
2015-06-01 13:50:09 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Mute Unsupported Language Errors*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2017-04-15 00:12:19 -06:00
##### [Show Loading View](#show-loading-view)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Default**: `true`
**Type**: `boolean`
**Description**:
Show loading view when beautifying
**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 "*Show Loading View*" and change it to your desired configuration.
2017-05-28 22:34:12 -06:00
#### [Executables](#executables)
**Description**:
Configure executables used by beautifiers.
2017-06-01 01:29:51 -06:00
##### [autopep8](#autopep8)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for autopep8 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 "*autopep8*" and change it to your desired configuration.
2017-06-02 14:48:52 -06:00
##### [beautysh](#beautysh)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for beautysh 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 "*beautysh*" and change it to your desired configuration.
##### [ClangFormat](#clangformat)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for ClangFormat 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 "*ClangFormat*" and change it to your desired configuration.
2017-06-02 15:22:32 -06:00
##### [Crystal](#crystal)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for Crystal 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 "*Crystal*" and change it to your desired configuration.
##### [Dfmt](#dfmt)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for Dfmt 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 "*Dfmt*" and change it to your desired configuration.
2017-06-03 23:43:02 -06:00
##### [elm-format](#elm-format)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for elm-format 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 "*elm-format*" and change it to your desired configuration.
2017-05-31 23:47:39 -06:00
##### [Emacs](#emacs)
2017-06-01 00:15:56 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-05-31 23:47:39 -06:00
**Type**: `object`
**Description**:
Options for Emacs 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 "*Emacs*" and change it to your desired configuration.
2018-01-05 01:09:16 -07:00
##### [gn](#gn)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for gn 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 "*gn*" and change it to your desired configuration.
2017-06-18 21:49:20 -06:00
##### [goimports](#goimports)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for goimports 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 "*goimports*" and change it to your desired configuration.
2017-06-01 01:29:51 -06:00
##### [isort](#isort)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for isort 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 "*isort*" and change it to your desired configuration.
2017-11-11 12:45:30 -07:00
##### [ocp-indent](#ocp-indent)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for ocp-indent 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 "*ocp-indent*" and change it to your desired configuration.
2017-05-28 22:34:12 -06:00
##### [PHP](#php)
2017-06-01 00:15:56 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-05-28 22:34:12 -06:00
**Type**: `object`
**Description**:
Options for PHP 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 "*PHP*" and change it to your desired configuration.
##### [PHP-CS-Fixer](#php-cs-fixer)
2017-06-01 00:15:56 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-05-28 22:34:12 -06:00
**Type**: `object`
**Description**:
Options for PHP-CS-Fixer 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 "*PHP-CS-Fixer*" and change it to your desired configuration.
##### [PHPCBF](#phpcbf)
2017-06-01 00:15:56 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-05-28 22:34:12 -06:00
**Type**: `object`
**Description**:
Options for PHPCBF 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 "*PHPCBF*" and change it to your desired configuration.
2018-01-08 12:31:30 -07:00
##### [puppet-lint](#puppet-lint)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for puppet-lint 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 "*puppet-lint*" and change it to your desired configuration.
2017-06-15 21:12:18 -06:00
##### [Rscript](#rscript)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for Rscript 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 "*Rscript*" and change it to your desired configuration.
2017-06-16 17:54:29 -06:00
##### [SassConvert](#sassconvert)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `object`
**Description**:
Options for SassConvert 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 "*SassConvert*" and change it to your desired configuration.
2017-06-15 21:12:18 -06:00
2017-10-10 09:36:29 -06:00
##### [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.
2017-05-31 23:59:55 -06:00
##### [Uncrustify](#uncrustify)
2017-06-01 00:15:56 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-05-31 23:59:55 -06:00
**Type**: `object`
**Description**:
Options for Uncrustify 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 "*Uncrustify*" and change it to your desired configuration.
2015-06-09 09:02:52 -06:00
2015-06-01 13:50:09 -06:00
## Language Options
Supported options for each language.
---
2016-03-21 10:46:52 -06:00
#### [Apex](#apex)
2015-08-05 08:56:11 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-07-04 20:42:22 -06:00
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
2015-08-05 08:56:11 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language Apex
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Disable Apex Beautification
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `Uncrustify`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `Uncrustify`
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Apex
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2016-02-20 14:02:43 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Automatically beautify Apex files on save
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Config Path](#config-path)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `apex`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `configPath`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"apex": {
"configPath": ""
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
#### [Arduino](#arduino)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-02-20 14:02:43 -07:00
2016-07-04 20:42:22 -06:00
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
Options for language Arduino
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Disable Arduino Beautification
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
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.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2016-02-20 14:02:43 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
**Default**: `Uncrustify`
2016-02-20 14:02:43 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `Uncrustify`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Arduino
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2016-02-20 14:02:43 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Automatically beautify Arduino files on save
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Config Path](#config-path)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `arduino`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `configPath`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"arduino": {
"configPath": ""
2016-02-20 14:02:43 -07:00
}
}
```
2016-09-23 10:37:44 -06:00
#### [Bash](#bash)
**Supported Beautifiers**: [`beautysh` ](#beautysh )
| Option | beautysh |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-12-29 16:37:03 -07:00
| `indent_size` | :white_check_mark: |
2018-03-01 18:26:08 -07:00
| `indent_with_tabs` | :white_check_mark: |
2016-09-23 10:37:44 -06:00
**Description**:
Options for language Bash
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Bash 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**: `beautysh`
**Type**: `string`
**Enum**: `beautysh`
**Description**:
Default Beautifier to be used for Bash
**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 Bash 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.
2016-12-29 16:37:03 -07:00
##### [Indent size](#indent-size)
**Namespace**: `bash`
**Key**: `indent_size`
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-12-29 16:37:03 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`beautysh` ](#beautysh )
**Description**:
Indentation size/length (Supported by beautysh)
**Example `.jsbeautifyrc` Configuration**
```json
{
"bash": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2016-12-29 16:37:03 -07:00
}
}
```
2018-03-01 18:26:08 -07:00
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `bash`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`beautysh` ](#beautysh )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by beautysh)
**Example `.jsbeautifyrc` Configuration**
```json
{
"bash": {
"indent_with_tabs": false
}
}
```
2016-03-21 10:46:52 -06:00
#### [C](#c)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify ) [`clang-format` ](#clang-format )
2016-02-20 14:02:43 -07:00
2016-07-04 20:42:22 -06:00
| Option | Uncrustify | clang-format |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
2016-03-21 10:46:52 -06:00
**Description**:
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
Options for language C
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Disable C Beautification
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2016-02-20 14:02:43 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
**Default**: `Uncrustify`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Enum**: `Uncrustify` `clang-format`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for C
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Description**:
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
Automatically beautify C files on save
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**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.
##### [Config Path](#config-path)
**Namespace**: `c`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"c": {
"configPath": ""
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
#### [Coldfusion](#coldfusion)
2016-02-20 14:02:43 -07:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-02-20 14:02:43 -07:00
2016-07-04 20:42:22 -06:00
| 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: |
2016-03-21 10:46:52 -06:00
**Description**:
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
Options for language Coldfusion
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Disable Coldfusion Beautification
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2016-02-20 14:02:43 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
**Default**: `Pretty Diff`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Enum**: `Pretty Diff`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Coldfusion
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2016-02-20 14:02:43 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Automatically beautify Coldfusion files on save
2016-02-20 14:02:43 -07:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `cfml`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2016-02-20 14:02:43 -07:00
2017-04-15 16:48:49 -06:00
**Default**: ` `
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Description**:
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"cfml": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `cfml`
2015-08-31 16:25:40 -06:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
2017-04-15 16:48:49 -06:00
**Default**: `4`
2015-06-01 12:52:33 -06:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"cfml": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Preserve newlines](#preserve-newlines)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `cfml`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `preserve_newlines`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve line-breaks (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"cfml": {
"preserve_newlines": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `cfml`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"cfml": {
"wrap_line_length": 250
2015-08-31 16:25:40 -06:00
}
}
```
2016-09-03 19:26:54 -06:00
#### [Clojure](#clojure)
2016-09-11 18:14:44 -06:00
**Supported Beautifiers**: [`cljfmt` ](#cljfmt )
2016-09-03 19:26:54 -06:00
2016-09-11 18:14:44 -06:00
| Option | cljfmt |
2016-09-03 19:26:54 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
**Description**:
Options for language Clojure
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Clojure 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**: `cljfmt`
**Type**: `string`
2016-09-11 18:14:44 -06:00
**Enum**: `cljfmt`
2016-09-03 19:26:54 -06:00
**Description**:
Default Beautifier to be used for Clojure
**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 Clojure 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.
2016-03-21 10:46:52 -06:00
#### [CoffeeScript](#coffeescript)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-06-08 16:05:03 -06:00
2016-07-04 20:42:22 -06:00
| Option | Coffee Formatter | coffee-fmt |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
2018-02-20 13:49:58 -07:00
| `indent_char` | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: |
| `indent_with_tabs` | :x: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language CoffeeScript
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Disable CoffeeScript Beautification
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `coffee-fmt`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Enum**: `Coffee Formatter` `coffee-fmt`
2015-06-08 16:05:03 -06:00
2015-06-08 15:34:56 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for CoffeeScript
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-08 15:34:56 -06:00
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Automatically beautify CoffeeScript files on save
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`coffee-fmt` ](#coffee-fmt )
2015-06-08 16:05:03 -06:00
2015-06-08 15:34:56 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by coffee-fmt)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
2018-02-20 13:49:58 -07:00
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
**Type**: `integer`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`coffee-fmt` ](#coffee-fmt )
2015-06-08 16:05:03 -06:00
2015-06-08 15:34:56 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by coffee-fmt)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
2018-02-20 13:49:58 -07:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent with tabs](#indent-with-tabs)
2017-01-24 07:26:19 -07:00
**Namespace**: `js`
2018-02-20 13:49:58 -07:00
**Key**: `indent_with_tabs`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`coffee-fmt` ](#coffee-fmt )
2017-01-24 07:26:19 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by coffee-fmt)
2017-01-24 07:26:19 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
2018-02-20 13:49:58 -07:00
"indent_with_tabs": false
2017-01-24 07:26:19 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [C++](#c-)
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify ) [`clang-format` ](#clang-format )
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
| Option | Uncrustify | clang-format |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
Options for language C++
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2015-06-08 15:34:56 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable C++ Beautification
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-09-10 13:05:19 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-09-10 13:05:19 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Uncrustify`
2015-09-10 13:05:19 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-09-10 13:05:19 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Uncrustify` `clang-format`
2015-09-10 13:05:19 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for C++
2015-09-10 13:05:19 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-09-10 13:05:19 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-10-27 19:31:21 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-10-27 19:31:21 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-10-27 19:31:21 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify C++ files on save
2015-10-27 19:31:21 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-10-27 19:31:21 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-10-27 19:31:21 -06:00
2018-02-20 13:49:58 -07:00
##### [Config Path](#config-path)
2015-10-27 19:31:21 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `cpp`
2015-10-27 19:31:21 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2017-04-15 16:09:27 -06:00
2015-10-27 19:31:21 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-10-27 19:31:21 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2015-10-27 19:31:21 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"cpp": {
"configPath": ""
2015-10-27 19:31:21 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Crystal](#crystal)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Crystal` ](#crystal )
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
| Option | Crystal |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Crystal
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Disable Crystal Beautification
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-04-15 16:09:27 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Crystal`
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Crystal`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Crystal
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-05 09:16:31 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify Crystal files on save
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 15:29:06 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
#### [C#](#c-)
2015-06-01 15:29:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-01 15:29:06 -06:00
2018-02-20 13:49:58 -07:00
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
2015-06-08 16:05:03 -06:00
2015-06-01 15:29:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language C#
2015-06-01 15:29:06 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 15:29:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable C# Beautification
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Uncrustify`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Uncrustify`
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for C#
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify C# 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.
##### [Config Path](#config-path)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `cs`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"cs": {
"configPath": ""
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [CSS](#css)
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb ) [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff ) [`SassConvert` ](#sassconvert )
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
| Option | CSScomb | JS Beautify | Prettier | Pretty Diff | SassConvert |
| --- | --- | --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :x: | :x: | :white_check_mark: | :x: |
| `configPath` | :white_check_mark: | :x: | :x: | :x: | :x: |
| `convert_quotes` | :x: | :x: | :x: | :white_check_mark: | :x: |
| `end_with_newline` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `force_indentation` | :x: | :x: | :x: | :white_check_mark: | :x: |
| `indent_char` | :x: | :white_check_mark: | :x: | :white_check_mark: | :x: |
| `indent_comments` | :x: | :x: | :x: | :white_check_mark: | :x: |
| `indent_size` | :x: | :white_check_mark: | :x: | :white_check_mark: | :x: |
| `newline_between_rules` | :x: | :white_check_mark: | :x: | :white_check_mark: | :x: |
| `no_lead_zero` | :x: | :x: | :x: | :white_check_mark: | :x: |
| `predefinedConfig` | :white_check_mark: | :x: | :x: | :x: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: | :x: | :white_check_mark: | :x: |
| `selector_separator_newline` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `wrap_line_length` | :x: | :white_check_mark: | :x: | :white_check_mark: | :x: |
**Description**:
Options for language CSS
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2018-02-19 11:51:23 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Description**:
Disable CSS 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**: `JS Beautify`
**Type**: `string`
**Enum**: `CSScomb` `JS Beautify` `Prettier` `Pretty Diff` `SassConvert`
2018-02-19 11:51:23 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for CSS
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
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.
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
Automatically beautify CSS 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.
##### [Align assignments](#align-assignments)
**Namespace**: `css`
**Key**: `align_assignments`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"align_assignments": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [comb custom config file](#comb-custom-config-file)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
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)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"configPath": ""
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Convert quotes](#convert-quotes)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `convert_quotes`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `none`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Enum**: `none` `double` `single`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"convert_quotes": "none"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_newline`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"end_with_newline": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Force indentation](#force-indentation)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `force_indentation`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"force_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent comments](#indent-comments)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_comments`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
Determines whether comments should be indented. (Supported by Pretty Diff)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"css": {
"indent_comments": true
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Pretty Diff)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"css": {
"indent_size": 4
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Newline between rules](#newline-between-rules)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
**Key**: `newline_between_rules`
**Default**: `true`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"css": {
"newline_between_rules": true
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [No lead zero](#no-lead-zero)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**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**
```json
{
"css": {
"no_lead_zero": false
}
}
```
##### [comb predefined config](#comb-predefined-config)
**Namespace**: `css`
**Key**: `predefinedConfig`
**Default**: `csscomb`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `csscomb` `yandex` `zen`
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Used if neither a project or custom config file exists. (Supported by CSScomb)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"predefinedConfig": "csscomb"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-04-08 13:38:07 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2016-04-08 13:38:07 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"preserve_newlines": false
}
}
```
##### [Selector separator newline](#selector-separator-newline)
**Namespace**: `css`
**Key**: `selector_separator_newline`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Add a newline between multiple selectors (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"selector_separator_newline": false
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `css`
**Key**: `wrap_line_length`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Maximum amount of characters per line (0 = disable) (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"wrap_line_length": 0
}
}
```
#### [CSV](#csv)
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
| Option | Pretty Diff |
2016-07-04 20:42:22 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-04-08 13:38:07 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language CSV
2016-04-08 13:38:07 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable CSV Beautification
2016-04-08 13:38:07 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2016-04-08 13:38:07 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Pretty Diff`
2016-04-08 13:38:07 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for CSV
2016-04-08 13:38:07 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify CSV files on save
2016-04-08 13:38:07 -06:00
**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.
2018-02-20 13:49:58 -07:00
#### [D](#d)
2015-09-08 16:47:30 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify ) [`dfmt` ](#dfmt )
2015-09-08 16:47:30 -06:00
2018-02-20 13:49:58 -07:00
| Option | Uncrustify | dfmt |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-09-08 16:47:30 -06:00
2018-02-20 13:49:58 -07:00
Options for language D
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2015-09-08 16:47:30 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable D Beautification
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Default**: `Uncrustify`
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Uncrustify` `dfmt`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for D
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify D files on save
2016-03-21 10:46:52 -06:00
**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.
##### [Config Path](#config-path)
2018-02-20 13:49:58 -07:00
**Namespace**: `d`
2015-08-31 16:25:40 -06:00
**Key**: `configPath`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"d": {
2015-08-31 16:25:40 -06:00
"configPath": ""
}
}
```
2018-02-20 13:49:58 -07:00
#### [EJS](#ejs)
2016-07-04 20:42:22 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `break_chained_methods` | :white_check_mark: | :white_check_mark: |
| `end_of_line` | :white_check_mark: | :x: |
| `end_with_comma` | :white_check_mark: | :white_check_mark: |
| `end_with_newline` | :white_check_mark: | :x: |
| `eval_code` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_level` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `object_curly_spacing` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: | :x: |
| `space_in_paren` | :white_check_mark: | :white_check_mark: |
| `unescape_strings` | :white_check_mark: | :x: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
**Description**:
Options for language EJS
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
Disable EJS Beautification
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `JS Beautify`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `JS Beautify` `Pretty Diff`
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for EJS
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify EJS files on save
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Brace style](#brace-style)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `brace_style`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `collapse`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|expand|end-expand|none] (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"brace_style": "collapse"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Break chained methods](#break-chained-methods)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `break_chained_methods`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"break_chained_methods": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End of line](#end-of-line)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_of_line`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `System Default`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `CRLF` `LF` `System Default`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Override EOL from line-ending-selector (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"end_of_line": "System Default"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with comma](#end-with-comma)
2016-07-30 14:45:17 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-07-30 14:45:17 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_comma`
2016-07-30 14:45:17 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-07-30 14:45:17 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff)
2016-07-30 14:45:17 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"end_with_comma": false
2016-07-30 14:45:17 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_newline`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"end_with_newline": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Eval code](#eval-code)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `eval_code`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"eval_code": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Extra liners](#extra-liners)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `extra_liners`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `head,body,/html`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent inner html](#indent-inner-html)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_inner_html`
2016-07-30 14:45:17 -06:00
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent < head > and < body > sections. (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_inner_html": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent level](#indent-level)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_level`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Initial indentation level (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"indent_level": 0
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent scripts](#indent-scripts)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_scripts`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `normal`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `keep` `separate` `normal`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[keep|separate|normal] (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_scripts": "normal"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent with tabs](#indent-with-tabs)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_with_tabs`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Jslint happy](#jslint-happy)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `jslint_happy`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Enable jslint-stricter mode (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"jslint_happy": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Keep array indentation](#keep-array-indentation)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `keep_array_indentation`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Preserve array indentation (Supported by JS Beautify)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"keep_array_indentation": false
}
}
```
##### [Keep function indentation](#keep-function-indentation)
**Namespace**: `js`
**Key**: `keep_function_indentation`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"keep_function_indentation": false
}
}
```
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `max_preserve_newlines`
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `10`
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2015-09-10 13:08:58 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"html": {
"max_preserve_newlines": 10
}
}
```
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
##### [Object curly spacing](#object-curly-spacing)
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
**Key**: `object_curly_spacing`
2016-01-28 05:11:09 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-01-28 05:11:09 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Insert spaces between brackets in object literals (Supported by JS Beautify)
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"object_curly_spacing": false
}
}
```
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"html": {
"preserve_newlines": true
}
}
```
##### [Space after anon function](#space-after-anon-function)
**Namespace**: `js`
**Key**: `space_after_anon_function`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-01-28 05:11:09 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"space_after_anon_function": false
}
}
```
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
##### [Space before conditional](#space-before-conditional)
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `space_before_conditional`
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-01-28 05:11:09 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-01-28 05:11:09 -07:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"space_before_conditional": true
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Space in paren](#space-in-paren)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
**Key**: `space_in_paren`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"space_in_paren": false
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Unescape strings](#unescape-strings)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `unescape_strings`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"unescape_strings": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Unformatted](#unformatted)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `unformatted`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**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`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2018-02-19 11:51:23 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)
2018-02-19 11:51:23 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"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"
]
2018-02-19 11:51:23 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes](#wrap-attributes)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `auto`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_attributes": "auto"
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes_indent_size`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent wrapped attributes to after N characters (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_attributes_indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_line_length": 250
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Elm](#elm)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`elm-format` ](#elm-format )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | elm-format |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Elm
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Disable Elm Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `elm-format`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `elm-format`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Elm
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify Elm files on save
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
#### [ERB](#erb)
**Supported Beautifiers**: [`HTML Beautifier` ](#html-beautifier ) [`Pretty Diff` ](#pretty-diff )
| Option | HTML Beautifier | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language ERB
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable ERB Beautification
2016-03-21 10:46:52 -06:00
**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.
2016-12-29 18:27:06 -07:00
**Default**: `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `HTML Beautifier` `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for ERB
2016-03-21 10:46:52 -06:00
**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.
2016-12-29 16:37:03 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-03-21 10:46:52 -06:00
2016-12-29 16:37:03 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify ERB files on save
2016-03-21 10:46:52 -06:00
2016-12-29 16:37:03 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2016-12-29 16:37:03 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2016-12-29 16:37:03 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`HTML Beautifier` ](#html-beautifier ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by HTML Beautifier, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2017-04-15 11:32:54 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-04-15 11:32:54 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2017-04-15 11:32:54 -06:00
**Default**: `true`
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-04-15 11:32:54 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2017-04-15 11:32:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"preserve_newlines": true
2017-04-15 11:32:54 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-24 07:26:19 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2017-01-24 07:26:19 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_line_length": 250
2017-01-24 07:26:19 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Erlang](#erlang)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`erl_tidy` ](#erl_tidy )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | erl_tidy |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Erlang
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2016-12-29 16:37:03 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Erlang Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `erl_tidy`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `erl_tidy`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Erlang
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2017-04-15 16:09:27 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify Erlang files on save
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
#### [Fortran](#fortran)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Fortran Beautifier |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `emacs_path` | :white_check_mark: |
| `emacs_script_path` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Options for language Fortran
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Fortran Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Fortran Beautifier`
2017-04-15 16:09:27 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Fortran Beautifier`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Fortran
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Fortran files on save
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Emacs path](#emacs-path)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `fortran`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `emacs_path`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to the `emacs` executable (Supported by Fortran Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"fortran": {
"emacs_path": ""
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Emacs script path](#emacs-script-path)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `fortran`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `emacs_script_path`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to the emacs script (Supported by Fortran Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"fortran": {
"emacs_script_path": ""
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [gherkin](#gherkin)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Gherkin formatter |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Options for language gherkin
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Disable gherkin Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Gherkin formatter`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Gherkin formatter`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for gherkin
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
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.
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2018-02-19 11:51:23 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify gherkin files on save
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
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.
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `gherkin`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Gherkin formatter)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"gherkin": {
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `gherkin`
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
2016-04-23 11:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Gherkin formatter)
2016-04-23 11:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"gherkin": {
"indent_size": 4
2016-04-23 11:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [GLSL](#glsl)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`clang-format` ](#clang-format )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | clang-format |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Options for language GLSL
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable GLSL Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `clang-format`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `clang-format`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for GLSL
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-09-15 05:07:43 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify GLSL files on save
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Config Path](#config-path)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `glsl`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Supported Beautifiers**: [`clang-format` ](#clang-format )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"glsl": {
"configPath": ""
2016-03-21 10:46:52 -06:00
}
}
```
2018-03-01 18:54:31 -07:00
#### [GN](#gn)
2016-12-29 16:37:03 -07:00
2018-03-01 18:54:31 -07:00
**Supported Beautifiers**: [`GN` ](#gn )
2016-12-29 16:37:03 -07:00
2018-03-01 18:54:31 -07:00
| Option | GN |
2016-07-04 20:42:22 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-02-20 14:02:43 -07:00
**Description**:
2018-03-01 18:54:31 -07:00
Options for language GN
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
**Type**: `boolean`
**Description**:
2018-03-01 18:54:31 -07:00
Disable GN Beautification
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
2018-03-01 18:54:31 -07:00
**Default**: `GN`
2015-08-05 09:16:31 -06:00
**Type**: `string`
2018-03-01 18:54:31 -07:00
**Enum**: `GN`
2015-08-05 09:16:31 -06:00
**Description**:
2018-03-01 18:54:31 -07:00
Default Beautifier to be used for GN
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
**Type**: `boolean`
**Description**:
2018-03-01 18:54:31 -07:00
Automatically beautify GN files on save
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2018-02-20 13:49:58 -07:00
#### [Go](#go)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`gofmt` ](#gofmt ) [`goimports` ](#goimports )
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
| Option | gofmt | goimports |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-29 11:41:43 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Go
2016-03-29 11:41:43 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Go Beautification
2016-03-29 11:41:43 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `gofmt`
2016-03-29 11:41:43 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `gofmt` `goimports`
2016-03-29 11:41:43 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Go
2016-03-29 11:41:43 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Go files on save
2016-03-29 11:41:43 -06:00
**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.
2018-02-20 13:49:58 -07:00
#### [Golang Template](#golang-template)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
| 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: |
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
Options for language Golang Template
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
Disable Golang Template Beautification
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Pretty Diff`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Golang Template
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-29 11:41:43 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Golang Template files on save
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-29 11:41:43 -06:00
##### [Indent char](#indent-char)
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-29 11:41:43 -06:00
**Key**: `indent_char`
2017-04-15 16:48:49 -06:00
**Default**: ` `
2016-03-29 11:41:43 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-29 11:41:43 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2016-03-29 11:41:43 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2016-03-29 11:41:43 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-29 11:41:43 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2016-03-29 11:41:43 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_size": 4
2016-03-29 11:41:43 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
**Default**: `true`
2016-03-29 11:41:43 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-29 11:41:43 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2016-03-29 11:41:43 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"preserve_newlines": true
2016-03-29 11:41:43 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2016-03-29 11:41:43 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-29 11:41:43 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2016-03-29 11:41:43 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_line_length": 250
2016-03-29 11:41:43 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Handlebars](#handlebars)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Handlebars
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Handlebars Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `JS Beautify`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `JS Beautify` `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Handlebars
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Handlebars files on save
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
##### [Brace style](#brace-style)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `brace_style`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `collapse`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Enum**: `collapse` `expand` `end-expand` `none`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|expand|end-expand|none] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"brace_style": "collapse"
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_newline`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"end_with_newline": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Extra liners](#extra-liners)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `extra_liners`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `head,body,/html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent inner html](#indent-inner-html)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_inner_html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent < head > and < body > sections. (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_inner_html": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent scripts](#indent-scripts)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_scripts`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `normal`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `keep` `separate` `normal`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[keep|separate|normal] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_scripts": "normal"
2016-03-21 10:46:52 -06:00
}
}
```
##### [Indent size](#indent-size)
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `max_preserve_newlines`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `10`
2016-07-30 14:45:17 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"max_preserve_newlines": 10
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
**Default**: `true`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"preserve_newlines": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Unformatted](#unformatted)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `unformatted`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**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`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"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"
]
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes](#wrap-attributes)
**Namespace**: `html`
**Key**: `wrap_attributes`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `auto`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_attributes": "auto"
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes_indent_size`
**Default**: `4`
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent wrapped attributes to after N characters (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_attributes_indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2017-04-25 00:40:27 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-04-25 00:40:27 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2017-05-28 01:07:51 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2017-05-28 01:07:51 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-04-25 00:40:27 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-04-25 00:40:27 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
2017-04-25 00:40:27 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_line_length": 250
2017-04-25 00:40:27 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Haskell](#haskell)
2016-03-21 10:46:52 -06:00
2018-03-01 17:27:34 -07:00
**Supported Beautifiers**: [`brittany` ](#brittany ) [`hindent` ](#hindent ) [`stylish-haskell` ](#stylish-haskell )
2016-03-21 10:46:52 -06:00
2018-03-01 17:27:34 -07:00
| Option | brittany | hindent | stylish-haskell |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Haskell
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Haskell Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `stylish-haskell`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-03-01 17:27:34 -07:00
**Enum**: `brittany` `hindent` `stylish-haskell`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Haskell
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Haskell files on save
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**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.
#### [HTML](#html)
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language HTML
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable HTML Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `JS Beautify`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `JS Beautify` `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for HTML
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify HTML files on save
2016-03-21 10:46:52 -06:00
**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**: `html`
**Key**: `brace_style`
**Default**: `collapse`
**Type**: `string`
**Enum**: `collapse` `expand` `end-expand` `none`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|expand|end-expand|none] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"brace_style": "collapse"
}
}
```
##### [End with newline](#end-with-newline)
**Namespace**: `html`
**Key**: `end_with_newline`
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"end_with_newline": false
}
}
```
##### [Extra liners](#extra-liners)
**Namespace**: `html`
**Key**: `extra_liners`
**Default**: `head,body,/html`
**Type**: `array`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
2017-04-15 16:48:49 -06:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
##### [Indent inner html](#indent-inner-html)
**Namespace**: `html`
**Key**: `indent_inner_html`
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent < head > and < body > sections. (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_inner_html": false
}
}
```
##### [Indent scripts](#indent-scripts)
**Namespace**: `html`
**Key**: `indent_scripts`
**Default**: `normal`
**Type**: `string`
**Enum**: `keep` `separate` `normal`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[keep|separate|normal] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_scripts": "normal"
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `html`
**Key**: `indent_size`
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
**Namespace**: `html`
**Key**: `max_preserve_newlines`
**Default**: `10`
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"max_preserve_newlines": 10
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `html`
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"preserve_newlines": true
}
}
```
##### [Unformatted](#unformatted)
**Namespace**: `html`
**Key**: `unformatted`
2016-08-25 22:32:59 -06:00
**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`
2016-03-21 10:46:52 -06:00
**Type**: `array`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"unformatted": [
"a",
2016-08-25 22:32:59 -06:00
"abbr",
"area",
"audio",
"b",
"bdi",
2016-03-21 10:46:52 -06:00
"bdo",
2016-08-25 22:32:59 -06:00
"br",
"button",
"canvas",
"cite",
2016-03-21 10:46:52 -06:00
"code",
2016-08-25 22:32:59 -06:00
"data",
"datalist",
"del",
"dfn",
"em",
"embed",
"i",
"iframe",
"img",
"input",
"ins",
2016-03-21 10:46:52 -06:00
"kbd",
2016-08-25 22:32:59 -06:00
"keygen",
"label",
"map",
"mark",
"math",
"meter",
"noscript",
"object",
"output",
"progress",
2016-03-21 10:46:52 -06:00
"q",
2016-08-25 22:32:59 -06:00
"ruby",
"s",
"samp",
"select",
"small",
"span",
"strong",
2016-03-21 10:46:52 -06:00
"sub",
"sup",
2016-08-25 22:32:59 -06:00
"svg",
"template",
"textarea",
"time",
"u",
"var",
"video",
"wbr",
"text",
"acronym",
"address",
2016-03-21 10:46:52 -06:00
"big",
2016-08-25 22:32:59 -06:00
"dt",
"ins",
2016-03-21 10:46:52 -06:00
"small",
"strike",
2016-08-25 22:32:59 -06:00
"tt",
2016-03-21 10:46:52 -06:00
"pre",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
}
}
```
##### [Wrap attributes](#wrap-attributes)
**Namespace**: `html`
**Key**: `wrap_attributes`
**Default**: `auto`
**Type**: `string`
2017-04-10 01:18:13 -06:00
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_attributes": "auto"
}
}
```
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
**Namespace**: `html`
**Key**: `wrap_attributes_indent_size`
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent wrapped attributes to after N characters (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2017-04-15 16:48:49 -06:00
"wrap_attributes_indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `html`
**Key**: `wrap_line_length`
**Default**: `250`
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_line_length": 250
}
}
```
2018-02-20 13:49:58 -07:00
#### [Jade](#jade)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Pug Beautify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Jade
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Jade Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `Pug Beautify`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Pug Beautify`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Jade
2016-03-21 10:46:52 -06:00
**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)
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Automatically beautify Jade 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.
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
2017-04-15 16:48:49 -06:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pug Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pug Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Java](#java)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Options for language Java
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Disable Java Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Uncrustify`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Uncrustify`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Java
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Java files on save
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Config Path](#config-path)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `java`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"java": {
"configPath": ""
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [JavaScript](#javascript)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`JSCS Fixer` ](#jscs-fixer ) [`ESLint Fixer` ](#eslint-fixer ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | ESLint Fixer | JS Beautify | JSCS Fixer | Prettier | Pretty Diff |
| --- | --- | --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `brace_style` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `break_chained_methods` | :x: | :white_check_mark: | :x: | :x: | :white_check_mark: |
| `end_of_line` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `end_with_comma` | :x: | :white_check_mark: | :x: | :x: | :white_check_mark: |
| `end_with_newline` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `eval_code` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `indent_char` | :x: | :white_check_mark: | :x: | :white_check_mark: | :white_check_mark: |
| `indent_level` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `indent_size` | :x: | :white_check_mark: | :x: | :white_check_mark: | :white_check_mark: |
| `indent_with_tabs` | :x: | :white_check_mark: | :x: | :white_check_mark: | :white_check_mark: |
| `jslint_happy` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `keep_array_indentation` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `keep_function_indentation` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `max_preserve_newlines` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `object_curly_spacing` | :x: | :white_check_mark: | :x: | :white_check_mark: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: | :x: | :x: | :white_check_mark: |
| `space_after_anon_function` | :x: | :white_check_mark: | :x: | :x: | :white_check_mark: |
| `space_before_conditional` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `space_in_paren` | :x: | :white_check_mark: | :x: | :x: | :white_check_mark: |
| `unescape_strings` | :x: | :white_check_mark: | :x: | :x: | :x: |
| `wrap_line_length` | :x: | :white_check_mark: | :x: | :x: | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language JavaScript
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Disable JavaScript Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**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**: `JS Beautify`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `JS Beautify` `JSCS Fixer` `ESLint Fixer` `Prettier` `Pretty Diff`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
Default Beautifier to be used for JavaScript
**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`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify JavaScript files on save
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Brace style](#brace-style)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `brace_style`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `collapse`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"brace_style": "collapse"
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Break chained methods](#break-chained-methods)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `break_chained_methods`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2017-04-12 15:59:38 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"break_chained_methods": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End of line](#end-of-line)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_of_line`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `System Default`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `CRLF` `LF` `System Default`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-09-11 15:48:16 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Override EOL from line-ending-selector (Supported by JS Beautify)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"end_of_line": "System Default"
}
}
```
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
##### [End with comma](#end-with-comma)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_comma`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-09-11 15:48:16 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"end_with_comma": false
}
}
```
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
**Key**: `end_with_newline`
2016-09-11 15:48:16 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"end_with_newline": false
}
}
```
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
##### [Eval code](#eval-code)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `eval_code`
2016-09-11 15:48:16 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-09-11 15:48:16 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-09-11 15:48:16 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"eval_code": false
2016-09-11 15:48:16 -06:00
}
}
```
2017-04-14 23:27:12 -06:00
##### [Indent char](#indent-char)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-11 15:48:16 -06:00
2017-04-14 23:27:12 -06:00
**Key**: `indent_char`
2016-09-11 15:48:16 -06:00
2017-04-15 16:48:49 -06:00
**Default**: ` `
2016-09-11 15:48:16 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-09-11 15:48:16 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by JS Beautify, Prettier, Pretty Diff)
2016-09-11 15:48:16 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2016-09-11 15:48:16 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent level](#indent-level)
**Namespace**: `js`
**Key**: `indent_level`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Initial indentation level (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_level": 0
}
}
```
2017-04-14 23:27:12 -06:00
##### [Indent size](#indent-size)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-11 15:48:16 -06:00
2017-04-14 23:27:12 -06:00
**Key**: `indent_size`
2016-09-11 15:48:16 -06:00
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-09-11 15:48:16 -06:00
2017-04-14 23:27:12 -06:00
**Type**: `integer`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-09-11 15:48:16 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Prettier, Pretty Diff)
2016-09-11 15:48:16 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2016-09-11 15:48:16 -06:00
}
}
```
2017-04-14 23:27:12 -06:00
##### [Indent with tabs](#indent-with-tabs)
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-11 15:48:16 -06:00
2017-04-14 23:27:12 -06:00
**Key**: `indent_with_tabs`
2016-09-11 15:48:16 -06:00
2017-04-14 23:27:12 -06:00
**Type**: `boolean`
2016-09-11 15:48:16 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-09-11 15:48:16 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Prettier, Pretty Diff)
2016-09-11 15:48:16 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
2017-04-15 16:48:49 -06:00
"indent_with_tabs": false
2016-09-11 15:48:16 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Jslint happy](#jslint-happy)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `jslint_happy`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Enable jslint-stricter mode (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"jslint_happy": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Keep array indentation](#keep-array-indentation)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `keep_array_indentation`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve array indentation (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"keep_array_indentation": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Keep function indentation](#keep-function-indentation)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
**Key**: `keep_function_indentation`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"keep_function_indentation": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `max_preserve_newlines`
2017-01-13 20:21:56 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `10`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"max_preserve_newlines": 10
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Object curly spacing](#object-curly-spacing)
2016-04-23 20:27:10 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `object_curly_spacing`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-13 20:21:56 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Insert spaces between brackets in object literals (Supported by JS Beautify, Prettier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"object_curly_spacing": false
2016-03-21 10:46:52 -06:00
}
}
```
2017-01-13 20:21:56 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2017-01-13 20:21:56 -07:00
**Key**: `preserve_newlines`
2016-03-21 10:46:52 -06:00
2017-01-13 20:21:56 -07:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
2017-01-13 20:21:56 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
2017-01-13 20:21:56 -07:00
"preserve_newlines": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space after anon function](#space-after-anon-function)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_after_anon_function`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-13 20:21:56 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"space_after_anon_function": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space before conditional](#space-before-conditional)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `space_before_conditional`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2017-01-14 00:47:27 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-01-14 00:47:27 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"space_before_conditional": true
}
}
```
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
##### [Space in paren](#space-in-paren)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `space_in_paren`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-01-14 00:47:27 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"space_in_paren": false
}
}
```
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
##### [Unescape strings](#unescape-strings)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
**Key**: `unescape_strings`
2017-01-14 00:47:27 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-01-14 00:47:27 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"unescape_strings": false
}
}
```
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-01-14 00:47:27 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)
2017-01-14 00:47:27 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"wrap_line_length": 0
2017-01-14 00:47:27 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [JSON](#json)
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2017-01-14 00:47:27 -07:00
2018-02-20 13:49:58 -07:00
| Option | JS Beautify | Prettier | Pretty Diff |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: | :x: |
| `break_chained_methods` | :white_check_mark: | :x: | :white_check_mark: |
| `end_of_line` | :white_check_mark: | :x: | :x: |
| `end_with_comma` | :white_check_mark: | :x: | :white_check_mark: |
| `end_with_newline` | :white_check_mark: | :x: | :x: |
| `eval_code` | :white_check_mark: | :x: | :x: |
| `indent_char` | :white_check_mark: | :x: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: | :x: |
| `indent_size` | :white_check_mark: | :x: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :x: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: | :x: |
| `object_curly_spacing` | :white_check_mark: | :x: | :x: |
| `preserve_newlines` | :white_check_mark: | :x: | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: | :x: | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: | :x: | :x: |
| `space_in_paren` | :white_check_mark: | :x: | :white_check_mark: |
| `unescape_strings` | :white_check_mark: | :x: | :x: |
| `wrap_line_length` | :white_check_mark: | :x: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-04-23 20:27:10 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language JSON
2016-04-23 20:27:10 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable JSON Beautification
2016-04-23 20:27:10 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `JS Beautify`
2016-04-23 20:27:10 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `JS Beautify` `Prettier` `Pretty Diff`
2016-04-23 20:27:10 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for JSON
2016-04-23 20:27:10 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify JSON files on save
2016-04-23 20:27:10 -06:00
**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.
2018-02-20 13:49:58 -07:00
##### [Brace style](#brace-style)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-07-04 20:42:22 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `brace_style`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `collapse`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"brace_style": "collapse"
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Break chained methods](#break-chained-methods)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `break_chained_methods`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"break_chained_methods": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [End of line](#end-of-line)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_of_line`
**Default**: `System Default`
**Type**: `string`
**Enum**: `CRLF` `LF` `System Default`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Override EOL from line-ending-selector (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"end_of_line": "System Default"
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [End with comma](#end-with-comma)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_comma`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"end_with_comma": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_newline`
2016-07-04 20:42:22 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"end_with_newline": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Eval code](#eval-code)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `eval_code`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"eval_code": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"indent_char": " "
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent level](#indent-level)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_level`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Initial indentation level (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"indent_level": 0
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-07-04 20:42:22 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"indent_size": 4
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent with tabs](#indent-with-tabs)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_with_tabs`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"indent_with_tabs": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Jslint happy](#jslint-happy)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `jslint_happy`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Enable jslint-stricter mode (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-04-21 08:07:32 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"jslint_happy": false
}
}
```
2017-04-21 08:07:32 -06:00
2018-02-20 13:49:58 -07:00
##### [Keep array indentation](#keep-array-indentation)
2017-04-21 08:07:32 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-04-21 08:07:32 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `keep_array_indentation`
2017-04-21 08:07:32 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-04-21 08:07:32 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-04-21 08:07:32 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve array indentation (Supported by JS Beautify)
2017-04-21 08:07:32 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"keep_array_indentation": false
2017-04-21 08:07:32 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Keep function indentation](#keep-function-indentation)
2017-05-12 20:27:55 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-05-12 20:27:55 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `keep_function_indentation`
2017-05-12 20:27:55 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-05-12 20:27:55 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-05-12 20:27:55 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2017-05-12 20:27:55 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"keep_function_indentation": false
2017-05-12 20:27:55 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `max_preserve_newlines`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `10`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"max_preserve_newlines": 10
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Object curly spacing](#object-curly-spacing)
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `object_curly_spacing`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-04-19 23:55:48 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Insert spaces between brackets in object literals (Supported by JS Beautify)
2017-04-19 23:55:48 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"object_curly_spacing": false
2017-04-19 23:55:48 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-04-19 23:55:48 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2017-04-19 23:55:48 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"preserve_newlines": true
2017-04-19 23:55:48 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space after anon function](#space-after-anon-function)
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_after_anon_function`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-04-19 23:55:48 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)
2017-04-19 23:55:48 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"space_after_anon_function": false
2017-04-19 23:55:48 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space before conditional](#space-before-conditional)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_before_conditional`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"space_before_conditional": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space in paren](#space-in-paren)
2017-05-05 13:24:17 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-05-05 13:24:17 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_in_paren`
2017-05-05 13:24:17 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-05-05 13:24:17 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-05-05 13:24:17 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)
2017-05-05 13:24:17 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"space_in_paren": false
2017-05-05 13:24:17 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Unescape strings](#unescape-strings)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `unescape_strings`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"unescape_strings": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2017-05-06 12:28:00 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"wrap_line_length": 0
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [JSX](#jsx)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `break_chained_methods` | :white_check_mark: | :white_check_mark: |
| `e4x` | :white_check_mark: | :x: |
| `end_of_line` | :white_check_mark: | :x: |
| `end_with_comma` | :white_check_mark: | :white_check_mark: |
| `end_with_newline` | :white_check_mark: | :x: |
| `eval_code` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `object_curly_spacing` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: | :x: |
| `space_in_paren` | :white_check_mark: | :white_check_mark: |
| `unescape_strings` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language JSX
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable JSX Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `JS Beautify` `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for JSX
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify JSX files on save
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
##### [Brace style](#brace-style)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-07-04 20:42:22 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `brace_style`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `collapse`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"brace_style": "collapse"
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Break chained methods](#break-chained-methods)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `break_chained_methods`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"break_chained_methods": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [E4x](#e4x)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `jsx`
**Key**: `e4x`
**Default**: `true`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Support e4x/jsx syntax (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"jsx": {
"e4x": true
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [End of line](#end-of-line)
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_of_line`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `System Default`
2017-04-15 00:12:19 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `CRLF` `LF` `System Default`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-04-15 00:12:19 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Override EOL from line-ending-selector (Supported by JS Beautify)
2017-04-15 00:12:19 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"end_of_line": "System Default"
2017-04-15 00:12:19 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with comma](#end-with-comma)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_comma`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"end_with_comma": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_newline`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"end_with_newline": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Eval code](#eval-code)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `eval_code`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"eval_code": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2017-04-15 00:12:19 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
Indentation character (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_char": " "
}
}
```
##### [Indent level](#indent-level)
**Namespace**: `js`
**Key**: `indent_level`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-04-15 00:12:19 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Initial indentation level (Supported by JS Beautify)
2017-04-15 00:12:19 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"indent_level": 0
2017-04-15 00:12:19 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent with tabs](#indent-with-tabs)
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_with_tabs`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-04-15 00:12:19 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-04-15 00:12:19 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff)
2017-04-15 00:12:19 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"indent_with_tabs": false
2017-04-15 00:12:19 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Jslint happy](#jslint-happy)
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `jslint_happy`
2016-09-02 03:15:30 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-09-02 03:15:30 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Enable jslint-stricter mode (Supported by JS Beautify)
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"jslint_happy": false
}
}
```
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
##### [Keep array indentation](#keep-array-indentation)
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `keep_array_indentation`
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-09-02 03:15:30 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve array indentation (Supported by JS Beautify)
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"keep_array_indentation": false
}
}
```
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
##### [Keep function indentation](#keep-function-indentation)
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
**Key**: `keep_function_indentation`
2016-09-02 03:15:30 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-09-02 03:15:30 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"keep_function_indentation": false
}
}
```
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `max_preserve_newlines`
2016-09-02 03:15:30 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `10`
2016-09-02 03:15:30 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-09-02 03:15:30 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2016-09-02 03:15:30 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"max_preserve_newlines": 10
2016-09-02 03:15:30 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Object curly spacing](#object-curly-spacing)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `object_curly_spacing`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Insert spaces between brackets in object literals (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"object_curly_spacing": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"preserve_newlines": true
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Space after anon function](#space-after-anon-function)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
**Key**: `space_after_anon_function`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"js": {
"space_after_anon_function": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Space before conditional](#space-before-conditional)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_before_conditional`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"space_before_conditional": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space in paren](#space-in-paren)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_in_paren`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"space_in_paren": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Unescape strings](#unescape-strings)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `unescape_strings`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"unescape_strings": false
2016-03-21 10:46:52 -06:00
}
}
```
##### [Wrap line length](#wrap-line-length)
2018-02-20 13:49:58 -07:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"js": {
"wrap_line_length": 0
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [LaTeX](#latex)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Latex Beautify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `align_columns_in_environments` | :white_check_mark: |
| `always_look_for_split_braces` | :white_check_mark: |
| `always_look_for_split_brackets` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_preamble` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `remove_trailing_whitespace` | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language LaTeX
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable LaTeX Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `Latex Beautify`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Latex Beautify`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for LaTeX
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify LaTeX files on save
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
##### [Align columns in environments](#align-columns-in-environments)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `latex`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `align_columns_in_environments`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `tabular,matrix,bmatrix,pmatrix`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Aligns columns by the alignment tabs for environments specified (Supported by Latex Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"latex": {
"align_columns_in_environments": [
"tabular",
"matrix",
"bmatrix",
"pmatrix"
]
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Always look for split braces](#always-look-for-split-braces)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `latex`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `always_look_for_split_braces`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If `latexindent` should look for commands that split braces across lines (Supported by Latex Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"latex": {
"always_look_for_split_braces": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Always look for split brackets](#always-look-for-split-brackets)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `latex`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `always_look_for_split_brackets`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"latex": {
"always_look_for_split_brackets": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `latex`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Latex Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"latex": {
"indent_char": " "
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent preamble](#indent-preamble)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `latex`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_preamble`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent the preamble (Supported by Latex Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"latex": {
"indent_preamble": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent with tabs](#indent-with-tabs)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `latex`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_with_tabs`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"indent_with_tabs": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Remove trailing whitespace](#remove-trailing-whitespace)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `latex`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `remove_trailing_whitespace`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Remove trailing whitespace (Supported by Latex Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"latex": {
"remove_trailing_whitespace": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
#### [LESS](#less)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | CSScomb | Prettier | Pretty Diff |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: | :x: |
| `convert_quotes` | :x: | :x: | :white_check_mark: |
| `force_indentation` | :x: | :x: | :white_check_mark: |
| `indent_char` | :x: | :x: | :white_check_mark: |
| `indent_comments` | :x: | :x: | :white_check_mark: |
| `indent_size` | :x: | :x: | :white_check_mark: |
| `newline_between_rules` | :x: | :x: | :white_check_mark: |
| `no_lead_zero` | :x: | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: | :x: |
| `preserve_newlines` | :x: | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :x: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language LESS
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable LESS Beautification
2016-03-21 10:46:52 -06:00
**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`
2018-02-20 13:49:58 -07:00
**Enum**: `CSScomb` `Prettier` `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for LESS
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify LESS files on save
2016-03-21 10:46:52 -06:00
**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.
##### [Align assignments](#align-assignments)
**Namespace**: `css`
**Key**: `align_assignments`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"align_assignments": false
}
}
```
##### [comb custom config file](#comb-custom-config-file)
**Namespace**: `css`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
**Description**:
2017-06-04 23:04:15 -06:00
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)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"configPath": ""
}
}
```
##### [Convert quotes](#convert-quotes)
**Namespace**: `css`
**Key**: `convert_quotes`
**Default**: `none`
**Type**: `string`
**Enum**: `none` `double` `single`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"convert_quotes": "none"
}
}
```
##### [Force indentation](#force-indentation)
**Namespace**: `css`
**Key**: `force_indentation`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**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)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"force_indentation": false
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `css`
**Key**: `indent_char`
2017-04-15 16:48:49 -06:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
##### [Indent comments](#indent-comments)
**Namespace**: `css`
**Key**: `indent_comments`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Determines whether comments should be indented. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_comments": true
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `css`
**Key**: `indent_size`
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation size/length (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
##### [Newline between rules](#newline-between-rules)
**Namespace**: `css`
**Key**: `newline_between_rules`
2016-07-30 14:45:17 -06:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Add a newline between CSS rules (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
2016-07-30 14:45:17 -06:00
"newline_between_rules": true
2016-03-21 10:46:52 -06:00
}
}
```
##### [No lead zero](#no-lead-zero)
**Namespace**: `css`
**Key**: `no_lead_zero`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
2017-06-04 23:04:15 -06:00
If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"no_lead_zero": false
}
}
```
##### [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"
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `css`
**Key**: `preserve_newlines`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"preserve_newlines": false
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `css`
**Key**: `wrap_line_length`
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"wrap_line_length": 0
}
}
```
2018-02-20 13:49:58 -07:00
#### [Lua](#lua)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Lua beautifier |
2016-07-04 20:42:22 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2018-02-20 13:49:58 -07:00
| `end_of_line` | :white_check_mark: |
2016-07-04 20:42:22 -06:00
| `indent_char` | :white_check_mark: |
2018-03-01 20:22:34 -07:00
| `indent_size` | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Lua
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Lua Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `Lua beautifier`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Lua beautifier`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Lua
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Lua files on save
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
##### [End of line](#end-of-line)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `lua`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_of_line`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `System Default`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `CRLF` `LF` `System Default`
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Override EOL from line-ending-selector (Supported by Lua beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"lua": {
"end_of_line": "System Default"
2016-03-21 10:46:52 -06:00
}
}
```
2018-03-01 20:22:34 -07:00
##### [Indent char](#indent-char)
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Namespace**: `lua`
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Key**: `indent_char`
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Default**: ` `
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Type**: `string`
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2016-03-29 11:41:43 -06:00
**Description**:
2018-03-01 20:22:34 -07:00
Indentation character (Supported by Lua beautifier)
2016-03-29 11:41:43 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-03-01 20:22:34 -07:00
"lua": {
"indent_char": " "
2016-03-29 11:41:43 -06:00
}
}
```
2018-03-01 20:22:34 -07:00
##### [Indent size](#indent-size)
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Namespace**: `lua`
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Key**: `indent_size`
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Default**: `4`
2016-03-29 11:41:43 -06:00
2018-03-01 20:22:34 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2016-03-29 11:41:43 -06:00
**Description**:
2018-03-01 20:22:34 -07:00
Indentation size/length (Supported by Lua beautifier)
2016-03-29 11:41:43 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-03-01 20:22:34 -07:00
"lua": {
"indent_size": 4
2016-03-29 11:41:43 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Markdown](#markdown)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Prettier` ](#prettier ) [`Remark` ](#remark ) [`Tidy Markdown` ](#tidy-markdown )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Prettier | Remark | Tidy Markdown |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `commonmark` | :x: | :white_check_mark: | :x: |
| `gfm` | :x: | :white_check_mark: | :x: |
| `yaml` | :x: | :white_check_mark: | :x: |
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
Options for language Markdown
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Markdown 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.
2018-03-01 19:39:35 -07:00
**Default**: `Remark`
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Enum**: `Prettier` `Remark` `Tidy Markdown`
**Description**:
Default Beautifier to be used for Markdown
**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 Markdown 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.
##### [Commonmark](#commonmark)
**Namespace**: `markdown`
**Key**: `commonmark`
**Type**: `boolean`
**Supported Beautifiers**: [`Remark` ](#remark )
**Description**:
Allows and disallows several constructs. (Supported by Remark)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"markdown": {
"commonmark": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Gfm](#gfm)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `markdown`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `gfm`
2016-03-21 10:46:52 -06:00
**Default**: `true`
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Remark` ](#remark )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
GitHub Flavoured Markdown (Supported by Remark)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"markdown": {
"gfm": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Yaml](#yaml)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `markdown`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `yaml`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Remark` ](#remark )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"markdown": {
"yaml": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Marko](#marko)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Marko Beautifier |
2016-07-04 20:42:22 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2018-02-20 13:49:58 -07:00
| `brace_style` | :white_check_mark: |
| `end_with_newline` | :white_check_mark: |
| `extra_liners` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: |
| `indent_scripts` | :white_check_mark: |
2016-07-04 20:42:22 -06:00
| `indent_size` | :white_check_mark: |
2018-02-20 13:49:58 -07:00
| `max_preserve_newlines` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `syntax` | :white_check_mark: |
| `unformatted` | :white_check_mark: |
| `wrap_attributes` | :white_check_mark: |
| `wrap_attributes_indent_size` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Marko
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Marko Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `Marko Beautifier`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Marko Beautifier`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Marko
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Marko files on save
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
##### [Brace style](#brace-style)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `brace_style`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `collapse`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `collapse` `expand` `end-expand` `none`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|expand|end-expand|none] (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"brace_style": "collapse"
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_newline`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
End output with newline (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"end_with_newline": false
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Extra liners](#extra-liners)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `extra_liners`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `head,body,/html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"html": {
"indent_char": " "
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent inner html](#indent-inner-html)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
**Key**: `indent_inner_html`
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent < head > and < body > sections. (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"html": {
"indent_inner_html": false
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent scripts](#indent-scripts)
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `indent_scripts`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `normal`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `keep` `separate` `normal`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[keep|separate|normal] (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"indent_scripts": "normal"
2016-03-21 10:46:52 -06:00
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `html`
**Key**: `indent_size`
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `max_preserve_newlines`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `10`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"max_preserve_newlines": 10
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"preserve_newlines": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Syntax](#syntax)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `marko`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `syntax`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `html` `concise`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[html|concise] (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"marko": {
"syntax": "html"
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Unformatted](#unformatted)
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `unformatted`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**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`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"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"
]
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes](#wrap-attributes)
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `auto`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"wrap_attributes": "auto"
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes_indent_size`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent wrapped attributes to after N characters (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"wrap_attributes_indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `html`
**Key**: `wrap_line_length`
**Default**: `250`
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_line_length": 250
}
}
```
2018-02-20 13:49:58 -07:00
#### [Mustache](#mustache)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Mustache
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Mustache Beautification
2016-03-21 10:46:52 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `JS Beautify`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `JS Beautify` `Pretty Diff`
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Mustache
2016-03-21 10:46:52 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Mustache files on save
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-08-31 16:25:40 -06:00
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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2018-02-20 13:49:58 -07:00
##### [Brace style](#brace-style)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `brace_style`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `collapse`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `collapse` `expand` `end-expand` `none`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-10-09 14:09:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[collapse|expand|end-expand|none] (Supported by JS Beautify)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"html": {
"brace_style": "collapse"
}
}
```
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
##### [End with newline](#end-with-newline)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_newline`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
End output with newline (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"html": {
"end_with_newline": false
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Extra liners](#extra-liners)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `extra_liners`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `head,body,/html`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
2017-10-09 14:09:06 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-10-09 14:09:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by JS Beautify, Pretty Diff)
2017-10-09 14:09:06 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_char": " "
2017-10-09 14:09:06 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent inner html](#indent-inner-html)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_inner_html`
2017-10-09 14:09:06 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-10-09 14:09:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indent < head > and < body > sections. (Supported by JS Beautify)
2017-10-09 14:09:06 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_inner_html": false
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent scripts](#indent-scripts)
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_scripts`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `normal`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `keep` `separate` `normal`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
[keep|separate|normal] (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_scripts": "normal"
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2015-10-29 20:36:40 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by JS Beautify, Pretty Diff)
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `max_preserve_newlines`
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `10`
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-10-29 20:36:40 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"max_preserve_newlines": 10
2016-03-21 10:46:52 -06:00
}
}
```
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-10-29 20:36:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2017-10-10 08:51:13 -06:00
**Default**: `true`
2016-07-30 14:45:17 -06:00
2015-10-29 20:36:40 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2015-10-29 20:36:40 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"preserve_newlines": true
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Unformatted](#unformatted)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `unformatted`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**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,strike,tt,pre,h1,h2,h3,h4,h5,h6`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"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",
"strike",
"tt",
"pre",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes](#wrap-attributes)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `auto`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
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)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_attributes_indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Wrap line length](#wrap-line-length)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `wrap_line_length`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2017-10-10 08:51:13 -06:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_line_length": 250
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Nginx](#nginx)
2018-01-30 16:35:23 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
2018-01-30 16:35:23 -07:00
2018-02-20 13:49:58 -07:00
| Option | Nginx Beautify |
2018-01-30 16:35:23 -07:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2018-02-20 13:49:58 -07:00
| `dontJoinCurlyBracet` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
2018-01-30 16:35:23 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Nginx
2018-01-30 16:35:23 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Nginx Beautification
2018-01-30 16:35:23 -07:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `Nginx Beautify`
2018-01-30 16:35:23 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Nginx Beautify`
2018-01-30 16:35:23 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Nginx
2018-01-30 16:35:23 -07:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Nginx files on save
2018-01-30 16:35:23 -07:00
**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.
2018-02-20 13:49:58 -07:00
##### [Don't join curly brackets](#don't-join-curly-brackets)
**Namespace**: `nginx`
**Key**: `dontJoinCurlyBracet`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
**Description**:
(Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"dontJoinCurlyBracet": true
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `nginx`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
**Description**:
Indentation character (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"indent_char": " "
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `nginx`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
**Description**:
Indentation size/length (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"indent_size": 4
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `nginx`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"indent_with_tabs": false
}
}
```
#### [Nunjucks](#nunjucks)
2015-10-29 20:36:40 -06:00
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2017-10-10 08:51:13 -06:00
| 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: |
2015-06-01 12:52:33 -06:00
2017-10-10 08:51:13 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Nunjucks
2017-10-10 08:51:13 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Nunjucks Beautification
2017-10-10 08:51:13 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Nunjucks
2017-10-10 08:51:13 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Nunjucks files on save
2017-10-10 08:51:13 -06:00
**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.
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
**Type**: `string`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2017-10-09 14:09:06 -06:00
**Example `.jsbeautifyrc` Configuration**
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2017-10-10 08:51:13 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"preserve_newlines": true
2017-10-10 08:51:13 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2017-10-10 08:51:13 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2017-10-10 08:51:13 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"wrap_line_length": 250
2017-10-10 08:51:13 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Objective-C](#objective-c)
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify ) [`clang-format` ](#clang-format )
| Option | Uncrustify | clang-format |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
**Description**:
Options for language Objective-C
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Objective-C 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` `clang-format`
**Description**:
Default Beautifier to be used for Objective-C
**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.
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-04-23 11:46:52 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Objective-C files on save
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Config Path](#config-path)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `objectivec`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"objectivec": {
"configPath": ""
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
#### [OCaml](#ocaml)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`ocp-indent` ](#ocp-indent )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | ocp-indent |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Options for language OCaml
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Disable OCaml Beautification
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `ocp-indent`
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `ocp-indent`
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for OCaml
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify OCaml files on save
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
#### [Pawn](#pawn)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
2016-07-04 20:42:22 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Pawn
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 12:52:33 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Pawn Beautification
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Uncrustify`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Uncrustify`
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Pawn
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Pawn files on save
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Config Path](#config-path)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `pawn`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2016-03-21 10:46:52 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-09 09:02:52 -06:00
2017-10-10 08:51:13 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2017-10-10 08:51:13 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"pawn": {
"configPath": ""
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
#### [Perl](#perl)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Perltidy` ](#perltidy )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | Perltidy |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `perltidy_profile` | :white_check_mark: |
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
Options for language Perl
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
Disable Perl Beautification
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
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.
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Default**: `Perltidy`
2015-06-01 12:52:33 -06:00
2017-10-09 14:09:06 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Perltidy`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
Default Beautifier to be used for Perl
**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`
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Perl files on save
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Perltidy profile](#perltidy-profile)
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `perl`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `perltidy_profile`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Perltidy` ](#perltidy )
2017-01-24 07:26:19 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy)
2017-01-24 07:26:19 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"perl": {
"perltidy_profile": ""
2017-10-10 08:51:13 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [PHP](#php)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`hh_format` ](#hh_format ) [`PHP-CS-Fixer` ](#php-cs-fixer ) [`PHPCBF` ](#phpcbf )
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
| Option | PHP-CS-Fixer | PHPCBF | hh_format |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `allow_risky` | :white_check_mark: | :x: | :x: |
| `cs_fixer_config_file` | :white_check_mark: | :x: | :x: |
| `cs_fixer_path` | :white_check_mark: | :x: | :x: |
| `cs_fixer_version` | :white_check_mark: | :x: | :x: |
| `fixers` | :white_check_mark: | :x: | :x: |
| `level` | :white_check_mark: | :x: | :x: |
| `phpcbf_path` | :x: | :white_check_mark: | :x: |
| `phpcbf_version` | :x: | :white_check_mark: | :x: |
| `rules` | :white_check_mark: | :x: | :x: |
| `standard` | :x: | :white_check_mark: | :x: |
2017-10-10 08:51:13 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language PHP
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable PHP Beautification
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `PHP-CS-Fixer`
2015-06-01 12:52:33 -06:00
2017-10-09 14:09:06 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `hh_format` `PHP-CS-Fixer` `PHPCBF`
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for PHP
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
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.
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify PHP files on save
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Allow risky rules](#allow-risky-rules)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `allow_risky`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `no`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `no` `yes`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"allow_risky": "no"
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [PHP-CS-Fixer Config File](#php-cs-fixer-config-file)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `cs_fixer_config_file`
2017-04-15 16:09:27 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
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)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"cs_fixer_config_file": ""
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [PHP-CS-Fixer Path](#php-cs-fixer-path)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `cs_fixer_path`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"cs_fixer_path": ""
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [PHP-CS-Fixer Version](#php-cs-fixer-version)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `cs_fixer_version`
2017-04-15 16:09:27 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `2`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Enum**: `1` `2`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by PHP-CS-Fixer)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"cs_fixer_version": 2
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Fixers](#fixers)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `fixers`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"fixers": ""
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Level](#level)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `level`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
2015-06-09 09:02:52 -06:00
2017-10-10 08:51:13 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"level": ""
2017-10-10 08:51:13 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [PHPCBF Path](#phpcbf-path)
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `phpcbf_path`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`PHPCBF` ](#phpcbf )
2018-02-19 11:51:23 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to the `phpcbf` CLI executable (Supported by PHPCBF)
2018-02-19 11:51:23 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"phpcbf_path": ""
2018-02-19 11:51:23 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [PHPCBF Version](#phpcbf-version)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `phpcbf_version`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `2`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `1` `2` `3`
**Supported Beautifiers**: [`PHPCBF` ](#phpcbf )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
(Supported by PHPCBF)
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"phpcbf_version": 2
2017-10-10 08:51:13 -06:00
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Rules](#rules)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `rules`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2017-10-10 08:51:13 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)
2015-06-09 09:02:52 -06:00
2017-10-10 08:51:13 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"rules": ""
2017-10-10 08:51:13 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [PHPCBF Standard](#phpcbf-standard)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `php`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `standard`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `PEAR`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`PHPCBF` ](#phpcbf )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
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)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"php": {
"standard": "PEAR"
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
#### [Puppet](#puppet)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`puppet-lint` ](#puppet-lint )
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
| Option | puppet-lint |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Options for language Puppet
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Disable Puppet Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `puppet-lint`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `puppet-lint`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Puppet
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
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.
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Puppet files on save
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
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.
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
#### [Python](#python)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier ) [`yapf` ](#yapf )
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
| Option | autopep8 | pybeautifier | yapf |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
2018-03-01 17:14:47 -07:00
| `formatter` | :white_check_mark: | :white_check_mark: | :x: |
2018-02-20 13:49:58 -07:00
| `ignore` | :white_check_mark: | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: | :x: |
| `max_line_length` | :white_check_mark: | :white_check_mark: | :x: |
| `multi_line_output` | :white_check_mark: | :white_check_mark: | :x: |
| `sort_imports` | :white_check_mark: | :white_check_mark: | :x: |
| `style_config` | :white_check_mark: | :white_check_mark: | :x: |
2017-10-10 08:51:13 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Python
2017-10-10 08:51:13 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-09 14:09:06 -06:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Python Beautification
2017-10-10 08:51:13 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `autopep8`
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `autopep8` `pybeautifier` `yapf`
2017-10-09 14:09:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Python
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**How to Configure**
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
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.
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
##### [Beautify On Save](#beautify-on-save)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Python files on save
2017-10-10 08:51:13 -06:00
**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.
2018-03-01 17:14:47 -07:00
##### [Formatter](#formatter)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `python`
2017-10-09 14:09:06 -06:00
2018-03-01 17:14:47 -07:00
**Key**: `formatter`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `autopep8`
2015-06-01 12:52:33 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `autopep8` `yapf`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
formatter used by pybeautifier (Supported by autopep8, pybeautifier)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"python": {
2018-03-01 17:14:47 -07:00
"formatter": "autopep8"
2018-02-20 13:49:58 -07:00
}
}
```
##### [Ignore](#ignore)
**Namespace**: `python`
**Key**: `ignore`
**Default**: `E24`
**Type**: `array`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
**Description**:
do not fix these errors/warnings (Supported by autopep8, pybeautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"ignore": [
"E24"
]
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `python`
2016-03-21 10:46:52 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
2017-10-10 08:51:13 -06:00
**Default**: `4`
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by autopep8, pybeautifier)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"python": {
2017-10-10 08:51:13 -06:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Max line length](#max-line-length)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `python`
**Key**: `max_line_length`
**Default**: `79`
**Type**: `integer`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
**Description**:
set maximum allowed line length (Supported by autopep8, pybeautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"max_line_length": 79
}
}
```
##### [Multi line output](#multi-line-output)
**Namespace**: `python`
**Key**: `multi_line_output`
**Default**: `Hanging Grid Grouped`
**Type**: `string`
**Enum**: `Grid` `Vertical` `Hanging Indent` `Vertical Hanging Indent` `Hanging Grid` `Hanging Grid Grouped` `NOQA`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
**Description**:
defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"multi_line_output": "Hanging Grid Grouped"
}
}
```
##### [Sort imports](#sort-imports)
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `python`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `sort_imports`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
sort imports (requires isort installed) (Supported by autopep8, pybeautifier)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"python": {
"sort_imports": false
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Style config](#style-config)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `python`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `style_config`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `pep8`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
formatting style used by yapf (Supported by autopep8, pybeautifier)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"python": {
"style_config": "pep8"
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
#### [R](#r)
2016-09-11 18:14:44 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`formatR` ](#formatr )
2016-09-11 18:14:44 -06:00
2018-02-20 13:49:58 -07:00
| Option | formatR |
2016-09-11 18:14:44 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2018-02-20 13:49:58 -07:00
| `indent_size` | :white_check_mark: |
2016-09-11 18:14:44 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language R
2016-09-11 18:14:44 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable R Beautification
2016-09-11 18:14:44 -06:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `formatR`
2016-09-11 18:14:44 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `formatR`
2016-09-11 18:14:44 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for R
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify R files on save
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `r`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`formatR` ](#formatr )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by formatR)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"r": {
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
#### [Riot.js](#riot.js)
2015-06-01 12:52:33 -06:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2016-07-04 20:42:22 -06:00
| 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: |
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Riot.js
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Riot.js Beautification
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `Pretty Diff`
2015-08-05 09:16:31 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `Pretty Diff`
2015-08-05 09:16:31 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Riot.js
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 09:16:31 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Riot.js files on save
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-06-01 13:50:09 -06:00
2017-04-15 16:48:49 -06:00
**Default**: ` `
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Pretty Diff)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-06-09 09:02:52 -06:00
2017-04-15 16:48:49 -06:00
**Default**: `4`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by Pretty Diff)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
##### [Preserve newlines](#preserve-newlines)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `preserve_newlines`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
2016-03-02 10:28:32 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-02 10:28:32 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve line-breaks (Supported by Pretty Diff)
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"preserve_newlines": true
}
}
```
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Description**:
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"wrap_line_length": 250
}
}
```
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
#### [Ruby](#ruby)
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Rubocop` ](#rubocop ) [`Ruby Beautify` ](#ruby-beautify )
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
| Option | Rubocop | Ruby Beautify |
2018-02-18 23:09:53 -07:00
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
2018-02-20 13:49:58 -07:00
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `rubocop_path` | :white_check_mark: | :x: |
2016-07-04 20:42:22 -06:00
2016-03-02 10:28:32 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Ruby
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 12:52:33 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Ruby Beautification
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Rubocop`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Rubocop` `Ruby Beautify`
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Ruby
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Default Beautifier*" and change it to your desired configuration.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2015-08-31 16:25:40 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Ruby files on save
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**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.
2016-03-21 10:46:52 -06:00
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
2015-06-06 10:45:56 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `ruby`
2015-06-06 10:45:56 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2015-06-06 10:45:56 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2015-06-06 10:45:56 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: ` ` ` `
2015-06-06 10:45:56 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Ruby Beautify` ](#ruby-beautify )
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Ruby Beautify)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"ruby": {
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-06 10:45:56 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `ruby`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Rubocop` ](#rubocop ) [`Ruby Beautify` ](#ruby-beautify )
**Description**:
Indentation size/length (Supported by Rubocop, Ruby Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"ruby": {
"indent_size": 4
}
}
```
##### [Rubocop Path](#rubocop-path)
**Namespace**: `ruby`
**Key**: `rubocop_path`
**Type**: `string`
**Supported Beautifiers**: [`Rubocop` ](#rubocop )
**Description**:
Path to the `rubocop` CLI executable (Supported by Rubocop)
**Example `.jsbeautifyrc` Configuration**
```json
{
"ruby": {
"rubocop_path": ""
}
}
```
#### [Rust](#rust)
**Supported Beautifiers**: [`rustfmt` ](#rustfmt )
| Option | rustfmt |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `rustfmt_path` | :white_check_mark: |
**Description**:
Options for language Rust
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Rust 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**: `rustfmt`
**Type**: `string`
**Enum**: `rustfmt`
**Description**:
Default Beautifier to be used for Rust
**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.
2017-01-01 23:46:52 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Description**:
Automatically beautify Rust 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.
##### [Rustfmt path](#rustfmt-path)
**Namespace**: `rust`
**Key**: `rustfmt_path`
**Type**: `string`
**Supported Beautifiers**: [`rustfmt` ](#rustfmt )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Path to rustfmt program (Supported by rustfmt)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"rust": {
"rustfmt_path": ""
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Sass](#sass)
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`SassConvert` ](#sassconvert )
| Option | SassConvert |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Description**:
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
Options for language Sass
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-24 07:26:19 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Sass Beautification
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
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.
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `SassConvert`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Enum**: `SassConvert`
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Sass
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
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.
2015-06-06 10:45:56 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-06 10:45:56 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify Sass files on save
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
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.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
#### [SCSS](#scss)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff ) [`SassConvert` ](#sassconvert )
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
| Option | CSScomb | Prettier | Pretty Diff | SassConvert |
| --- | --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :x: | :white_check_mark: | :x: |
| `configPath` | :white_check_mark: | :x: | :x: | :x: |
| `convert_quotes` | :x: | :x: | :white_check_mark: | :x: |
| `force_indentation` | :x: | :x: | :white_check_mark: | :x: |
| `indent_char` | :x: | :x: | :white_check_mark: | :x: |
| `indent_comments` | :x: | :x: | :white_check_mark: | :x: |
| `indent_size` | :x: | :x: | :white_check_mark: | :x: |
| `newline_between_rules` | :x: | :x: | :white_check_mark: | :x: |
| `no_lead_zero` | :x: | :x: | :white_check_mark: | :x: |
| `predefinedConfig` | :white_check_mark: | :x: | :x: | :x: |
| `preserve_newlines` | :x: | :x: | :white_check_mark: | :x: |
| `wrap_line_length` | :x: | :x: | :white_check_mark: | :x: |
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language SCSS
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
Disable SCSS Beautification
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `CSScomb` `Prettier` `Pretty Diff` `SassConvert`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for SCSS
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify SCSS files on save
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Align assignments](#align-assignments)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `align_assignments`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"align_assignments": false
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [comb custom config file](#comb-custom-config-file)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
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)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"configPath": ""
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Convert quotes](#convert-quotes)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `convert_quotes`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `none`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `none` `double` `single`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"convert_quotes": "none"
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Force indentation](#force-indentation)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `force_indentation`
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"force_indentation": false
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent comments](#indent-comments)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_comments`
**Default**: `true`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Determines whether comments should be indented. (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
2018-02-20 13:49:58 -07:00
{
"css": {
"indent_comments": true
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
**Type**: `integer`
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Newline between rules](#newline-between-rules)
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `newline_between_rules`
**Default**: `true`
2015-08-31 16:25:40 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Add a newline between CSS rules (Supported by Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"newline_between_rules": true
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
##### [No lead zero](#no-lead-zero)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `no_lead_zero`
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-05 08:56:11 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff)
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"no_lead_zero": false
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [comb predefined config](#comb-predefined-config)
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `predefinedConfig`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `csscomb`
**Type**: `string`
**Enum**: `csscomb` `yandex` `zen`
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
2018-02-19 11:51:23 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Used if neither a project or custom config file exists. (Supported by CSScomb)
2018-02-19 11:51:23 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"predefinedConfig": "csscomb"
2018-02-19 11:51:23 -07:00
}
}
```
2017-01-01 23:46:52 -07:00
##### [Preserve newlines](#preserve-newlines)
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-08-05 08:56:11 -06:00
2017-01-01 23:46:52 -07:00
**Key**: `preserve_newlines`
2015-08-05 08:56:11 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `boolean`
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"preserve_newlines": false
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 13:50:09 -06:00
2017-01-01 23:46:52 -07:00
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"wrap_line_length": 0
2017-01-01 23:46:52 -07:00
}
}
```
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
#### [Spacebars](#spacebars)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
| 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: |
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Options for language Spacebars
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-09 09:02:52 -06:00
2017-01-01 23:46:52 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Disable Spacebars Beautification
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Pretty Diff`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Spacebars
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2016-08-25 22:32:59 -06:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify Spacebars files on save
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2015-06-08 15:34:56 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2018-02-20 13:49:58 -07:00
```json
{
"html": {
"indent_char": " "
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-06-08 15:34:56 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 15:34:56 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"indent_size": 4
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2015-06-08 15:34:56 -06:00
2016-08-25 22:32:59 -06:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2016-08-25 22:32:59 -06:00
"html": {
2018-02-20 13:49:58 -07:00
"preserve_newlines": true
2016-03-21 10:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2017-01-01 23:46:52 -07:00
##### [Wrap line length](#wrap-line-length)
2015-06-01 12:52:33 -06:00
2016-08-25 22:32:59 -06:00
**Namespace**: `html`
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Key**: `wrap_line_length`
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Default**: `250`
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `integer`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2016-08-25 22:32:59 -06:00
"html": {
2017-01-01 23:46:52 -07:00
"wrap_line_length": 250
2016-03-21 10:46:52 -06:00
}
}
```
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
#### [SQL](#sql)
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
| Option | sqlformat |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `identifiers` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `keywords` | :white_check_mark: |
2018-03-01 17:35:26 -07:00
| `reindent` | :white_check_mark: |
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language SQL
2017-01-01 23:46:52 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable SQL Beautification
2017-01-01 23:46:52 -07:00
**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.
2018-02-20 13:49:58 -07:00
**Default**: `sqlformat`
2017-01-01 23:46:52 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `sqlformat`
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for SQL
2017-01-01 23:46:52 -07:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify SQL files on save
2017-01-01 23:46:52 -07:00
**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.
2018-02-20 13:49:58 -07:00
##### [Identifiers](#identifiers)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `sql`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `identifiers`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `unchanged`
2017-01-01 23:46:52 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `unchanged` `lower` `upper` `capitalize`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Change case of identifiers (Supported by sqlformat)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"sql": {
"identifiers": "unchanged"
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `sql`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by sqlformat)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"sql": {
"indent_size": 4
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Keywords](#keywords)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `sql`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `keywords`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `upper`
2017-01-01 23:46:52 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `unchanged` `lower` `upper` `capitalize`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Change case of keywords (Supported by sqlformat)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"sql": {
"keywords": "upper"
2017-01-01 23:46:52 -07:00
}
}
```
2018-03-01 17:35:26 -07:00
##### [Reindent](#reindent)
2017-10-09 14:09:06 -06:00
2018-03-01 17:35:26 -07:00
**Namespace**: `sql`
2017-10-09 14:09:06 -06:00
2018-03-01 17:35:26 -07:00
**Key**: `reindent`
2017-10-09 14:09:06 -06:00
2018-03-01 17:35:26 -07:00
**Default**: `true`
2017-10-09 14:09:06 -06:00
2018-03-01 17:35:26 -07:00
**Type**: `boolean`
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2017-10-09 14:09:06 -06:00
**Description**:
2018-03-01 17:35:26 -07:00
Change indentations of the statements. Uncheck this option to preserve indentation (Supported by sqlformat)
2017-10-09 14:09:06 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-03-01 17:35:26 -07:00
"sql": {
"reindent": true
2017-10-09 14:09:06 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [SVG](#svg)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
| 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: |
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language SVG
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable SVG Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Pretty Diff`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for SVG
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Automatically beautify SVG files on save
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2016-08-25 22:32:59 -06:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
2016-08-25 22:32:59 -06:00
"html": {
2018-02-20 13:49:58 -07:00
"indent_char": " "
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-08-25 22:32:59 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"indent_size": 4
2017-10-09 14:09:06 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2017-10-09 14:09:06 -06:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-10-09 14:09:06 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2017-10-09 14:09:06 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2018-02-20 13:49:58 -07:00
"preserve_newlines": true
2016-08-25 22:32:59 -06:00
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `html`
**Key**: `wrap_line_length`
**Default**: `250`
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_line_length": 250
}
}
```
2018-02-20 13:49:58 -07:00
#### [Swig](#swig)
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
| Option | Pretty Diff |
2016-08-25 22:32:59 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2017-10-10 08:51:13 -06:00
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language Swig
2016-08-25 22:32:59 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Disable Swig Beautification
2016-08-25 22:32:59 -06:00
**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.
2017-10-10 08:51:13 -06:00
**Default**: `Pretty Diff`
2016-08-25 22:32:59 -06:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
**Enum**: `Pretty Diff`
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Swig
2016-08-25 22:32:59 -06:00
**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**:
2018-02-20 13:49:58 -07:00
Automatically beautify Swig files on save
2016-08-25 22:32:59 -06:00
**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)
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
**Key**: `indent_char`
2017-04-15 16:48:49 -06:00
**Default**: ` `
2016-08-25 22:32:59 -06:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
Indentation character (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2017-04-15 16:48:49 -06:00
"indent_char": " "
2016-08-25 22:32:59 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Default**: `4`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `integer`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
Indentation size/length (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
"indent_size": 4
2016-08-25 22:32:59 -06:00
}
}
```
##### [Preserve newlines](#preserve-newlines)
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
Preserve line-breaks (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2017-01-01 23:46:52 -07:00
"preserve_newlines": true
}
}
```
2017-10-10 08:51:13 -06:00
##### [Wrap line length](#wrap-line-length)
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `wrap_line_length`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `250`
2017-01-01 23:46:52 -07:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
"wrap_line_length": 250
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Terraform](#terraform)
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`terraformfmt` ](#terraformfmt )
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
| Option | terraformfmt |
2017-10-10 08:51:13 -06:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
**Description**:
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
Options for language Terraform
2017-10-10 08:51:13 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2017-04-15 18:03:25 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Terraform Beautification
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
**How to Configure**
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
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.
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
##### [Default Beautifier](#default-beautifier)
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `terraformfmt`
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `terraformfmt`
**Description**:
Default Beautifier to be used for Terraform
**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 Terraform 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.
#### [TSS](#tss)
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
| Option | Pretty Diff |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `align_assignments` | :white_check_mark: |
| `convert_quotes` | :white_check_mark: |
| `force_indentation` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_comments` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `newline_between_rules` | :white_check_mark: |
| `no_lead_zero` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
**Description**:
Options for language TSS
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable TSS 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`
2017-04-15 18:03:25 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for TSS
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
**How to Configure**
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
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.
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
##### [Beautify On Save](#beautify-on-save)
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-04-15 18:03:25 -06:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify TSS files on save
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
**How to Configure**
2017-04-15 18:03:25 -06:00
2017-10-10 08:51:13 -06:00
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.
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
##### [Align assignments](#align-assignments)
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-04-15 18:03:25 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `align_assignments`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-04-15 18:03:25 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff)
2017-04-15 18:03:25 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"align_assignments": false
2017-04-15 18:03:25 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Convert quotes](#convert-quotes)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `convert_quotes`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `none`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Enum**: `none` `double` `single`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"convert_quotes": "none"
}
}
```
##### [Force indentation](#force-indentation)
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `css`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `force_indentation`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"css": {
2018-02-20 13:49:58 -07:00
"force_indentation": false
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `css`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"css": {
2018-02-20 13:49:58 -07:00
"indent_char": " "
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent comments](#indent-comments)
**Namespace**: `css`
**Key**: `indent_comments`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Determines whether comments should be indented. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
```json
{
"css": {
"indent_comments": true
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `4`
2017-04-15 16:09:27 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `integer`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
2017-10-10 08:51:13 -06:00
"indent_size": 4
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Newline between rules](#newline-between-rules)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `newline_between_rules`
2017-04-15 16:09:27 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Add a newline between CSS rules (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"newline_between_rules": true
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [No lead zero](#no-lead-zero)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `no_lead_zero`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"no_lead_zero": false
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"preserve_newlines": false
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `css`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"css": {
"wrap_line_length": 0
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [TSX](#tsx)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
| Option | TypeScript Formatter |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2018-02-20 14:28:42 -07:00
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
2018-02-20 13:49:58 -07:00
**Description**:
Options for language TSX
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable TSX 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**: `TypeScript Formatter`
**Type**: `string`
**Enum**: `TypeScript Formatter`
**Description**:
Default Beautifier to be used for TSX
**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 TSX 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.
2018-02-20 14:28:42 -07:00
##### [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
}
}
```
2018-02-20 13:49:58 -07:00
#### [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: |
**Description**:
Options for language Twig
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Twig Beautification
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
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.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Enum**: `Pretty Diff`
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Twig
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
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.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Twig files on save
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
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.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
##### [Break chained methods](#break-chained-methods)
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `break_chained_methods`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Break chained method calls across subsequent lines (Supported by Pretty Diff)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 13:49:58 -07:00
"break_chained_methods": false
2017-01-01 23:46:52 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [End with comma](#end-with-comma)
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `end_with_comma`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 13:49:58 -07:00
"end_with_comma": false
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_char": " "
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
**Type**: `integer`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_size": 4
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent with tabs](#indent-with-tabs)
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_with_tabs`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 13:49:58 -07:00
"indent_with_tabs": false
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Default**: `true`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"preserve_newlines": true
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space after anon function](#space-after-anon-function)
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_after_anon_function`
2016-08-25 22:32:59 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 13:49:58 -07:00
"space_after_anon_function": false
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Space in paren](#space-in-paren)
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `space_in_paren`
2016-08-25 22:32:59 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 13:49:58 -07:00
"space_in_paren": false
2016-08-25 22:32:59 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Wrap line length](#wrap-line-length)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `wrap_line_length`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2017-10-10 08:51:13 -06:00
**Type**: `integer`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_line_length": 250
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [TypeScript](#typescript)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Prettier` ](#prettier ) [`TypeScript Formatter` ](#typescript-formatter )
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
| Option | Prettier | TypeScript Formatter |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
2018-02-20 14:19:33 -07:00
| `indent_size` | :x: | :white_check_mark: |
| `indent_with_tabs` | :x: | :white_check_mark: |
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Options for language TypeScript
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-08-25 22:32:59 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable TypeScript Beautification
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
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.
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `TypeScript Formatter`
2017-01-24 07:26:19 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Enum**: `Prettier` `TypeScript Formatter`
2017-01-24 07:26:19 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for TypeScript
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
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.
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2018-02-19 10:13:43 -07:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify TypeScript files on save
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
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.
2018-02-20 14:19:33 -07:00
##### [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
}
}
```
2018-02-20 13:49:58 -07:00
#### [UX Markup](#ux-markup)
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
| 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: |
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
Options for language UX Markup
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable UX Markup Beautification
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Pretty Diff`
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for UX Markup
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
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.
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify UX Markup files on save
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
##### [Indent char](#indent-char)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_char`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Default**: ` `
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2017-10-10 08:51:13 -06:00
"indent_char": " "
2016-08-25 22:32:59 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
"indent_size": 4
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `true`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-01-01 23:46:52 -07:00
"html": {
2018-02-20 13:49:58 -07:00
"preserve_newlines": true
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 13:49:58 -07:00
"wrap_line_length": 250
2016-08-25 22:32:59 -06:00
}
2016-03-21 10:46:52 -06:00
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
#### [Vala](#vala)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
| Option | Uncrustify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `configPath` | :white_check_mark: |
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
Options for language Vala
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 13:50:09 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Disable Vala Beautification
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
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.
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Uncrustify`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-02-20 13:49:58 -07:00
**Enum**: `Uncrustify`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Vala
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
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.
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-02 10:28:32 -07:00
**Type**: `boolean`
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Vala files on save
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
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.
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
##### [Config Path](#config-path)
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `vala`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `configPath`
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Description**:
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
```json
{
"vala": {
"configPath": ""
}
}
```
2018-03-01 17:49:41 -07:00
#### [Verilog](#verilog)
2015-06-01 13:50:09 -06:00
2018-03-01 17:49:41 -07:00
**Supported Beautifiers**: [`Emacs Verilog Mode` ](#emacs-verilog-mode )
2015-06-09 09:02:52 -06:00
2018-03-01 17:49:41 -07:00
| Option | Emacs Verilog Mode |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `emacs_script_path` | :white_check_mark: |
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
Options for language Verilog
2015-06-01 12:52:33 -06:00
2018-03-01 17:49:41 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-01 12:52:33 -06:00
2018-03-01 17:49:41 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
2018-03-01 17:49:41 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-03-01 17:49:41 -07:00
**Description**:
2015-06-01 13:50:09 -06:00
2018-03-01 17:49:41 -07:00
Disable Verilog Beautification
2015-06-09 09:02:52 -06:00
2018-03-01 17:49:41 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
##### [Default Beautifier](#default-beautifier)
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
**Default**: `Emacs Verilog Mode`
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
**Type**: `string`
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
**Enum**: `Emacs Verilog Mode`
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
Default Beautifier to be used for Verilog
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
**How to Configure**
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
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.
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 08:56:11 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `boolean`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
Automatically beautify Verilog files on save
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
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.
2015-08-05 08:56:11 -06:00
2018-03-01 17:49:41 -07:00
##### [Emacs script path](#emacs-script-path)
2015-08-31 16:25:40 -06:00
2018-03-01 17:49:41 -07:00
**Namespace**: `verilog`
2015-06-01 12:52:33 -06:00
2018-03-01 17:49:41 -07:00
**Key**: `emacs_script_path`
2015-06-01 12:52:33 -06:00
2018-03-01 17:49:41 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-03-01 17:49:41 -07:00
**Supported Beautifiers**: [`Emacs Verilog Mode` ](#emacs-verilog-mode )
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-03-01 17:49:41 -07:00
Path to emacs init.el script with formatting settings. (Leave blank to use default one) (Supported by Emacs Verilog Mode)
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 13:50:09 -06:00
2017-01-01 23:46:52 -07:00
```json
{
2018-03-01 17:49:41 -07:00
"verilog": {
"emacs_script_path": ""
2017-01-01 23:46:52 -07:00
}
}
```
2015-06-09 09:02:52 -06:00
2018-03-01 18:10:48 -07:00
#### [VHDL](#vhdl)
2015-06-01 12:52:33 -06:00
2018-03-01 18:10:48 -07:00
**Supported Beautifiers**: [`VHDL Beautifier` ](#vhdl-beautifier )
2015-06-01 12:52:33 -06:00
2018-03-01 18:10:48 -07:00
| Option | VHDL Beautifier |
2018-03-01 18:02:50 -07:00
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `emacs_script_path` | :white_check_mark: |
2015-06-01 13:50:09 -06:00
2018-03-01 18:02:50 -07:00
**Description**:
2015-06-09 09:02:52 -06:00
2018-03-01 18:10:48 -07:00
Options for language VHDL
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-03-01 18:02:50 -07:00
**Type**: `boolean`
2015-06-01 12:52:33 -06:00
2018-03-01 18:02:50 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-03-01 18:10:48 -07:00
Disable VHDL Beautification
2015-06-01 13:50:09 -06:00
2018-03-01 18:02:50 -07:00
**How to Configure**
2015-06-09 09:02:52 -06:00
2018-03-01 18:02:50 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
##### [Default Beautifier](#default-beautifier)
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-01 12:52:33 -06:00
2018-03-01 18:10:48 -07:00
**Default**: `VHDL Beautifier`
2015-06-01 12:52:33 -06:00
2018-03-01 18:02:50 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-03-01 18:10:48 -07:00
**Enum**: `VHDL Beautifier`
2015-06-01 12:52:33 -06:00
2018-03-01 18:02:50 -07:00
**Description**:
2015-06-01 13:50:09 -06:00
2018-03-01 18:10:48 -07:00
Default Beautifier to be used for VHDL
2015-06-09 09:02:52 -06:00
2018-03-01 18:02:50 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-08-05 08:56:11 -06:00
2018-03-01 18:02:50 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 08:56:11 -06:00
2018-03-01 18:02:50 -07:00
**Type**: `boolean`
2015-08-05 08:56:11 -06:00
**Description**:
2018-03-01 18:10:48 -07:00
Automatically beautify VHDL files on save
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
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.
2015-08-05 08:56:11 -06:00
2018-03-01 18:02:50 -07:00
##### [Emacs script path](#emacs-script-path)
2015-08-31 16:25:40 -06:00
2018-03-01 18:02:50 -07:00
**Namespace**: `vhdl`
2015-06-01 12:52:33 -06:00
2018-03-01 18:02:50 -07:00
**Key**: `emacs_script_path`
2015-06-01 12:52:33 -06:00
2018-03-01 18:02:50 -07:00
**Type**: `string`
2015-06-01 12:52:33 -06:00
2018-03-01 18:10:48 -07:00
**Supported Beautifiers**: [`VHDL Beautifier` ](#vhdl-beautifier )
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Description**:
2015-06-01 12:52:33 -06:00
2018-03-01 18:10:48 -07:00
Path to the emacs script (Supported by VHDL Beautifier)
2015-06-01 12:52:33 -06:00
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 13:50:09 -06:00
2017-01-01 23:46:52 -07:00
```json
{
2018-03-01 18:02:50 -07:00
"vhdl": {
"emacs_script_path": ""
2017-01-01 23:46:52 -07:00
}
}
```
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
#### [Visualforce](#visualforce)
**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**:
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
Options for language Visualforce
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-03-02 10:28:32 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
Disable Visualforce Beautification
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**Enum**: `Pretty Diff`
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Visualforce
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Visualforce files on save
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2016-08-25 22:32:59 -06:00
2017-01-01 23:46:52 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-01-01 23:46:52 -07:00
"html": {
2018-02-20 13:49:58 -07:00
"indent_char": " "
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_size": 4
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `preserve_newlines`
**Default**: `true`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"preserve_newlines": true
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap line length](#wrap-line-length)
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_line_length`
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `250`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_line_length": 250
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
#### [Vue](#vue)
2016-08-25 22:32:59 -06:00
2018-03-01 20:48:23 -07:00
**Supported Beautifiers**: [`ESLint Fixer` ](#eslint-fixer ) [`Prettier` ](#prettier ) [`Vue Beautifier` ](#vue-beautifier )
2016-08-25 22:32:59 -06:00
2018-03-01 20:48:23 -07:00
| Option | ESLint Fixer | Prettier | Vue Beautifier |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `brace_style` | :x: | :x: | :white_check_mark: |
| `break_chained_methods` | :x: | :x: | :white_check_mark: |
| `end_of_line` | :x: | :x: | :white_check_mark: |
| `end_with_comma` | :x: | :x: | :white_check_mark: |
| `end_with_newline` | :x: | :x: | :white_check_mark: |
| `eval_code` | :x: | :x: | :white_check_mark: |
| `extra_liners` | :x: | :x: | :white_check_mark: |
| `indent_char` | :x: | :x: | :white_check_mark: |
| `indent_inner_html` | :x: | :x: | :white_check_mark: |
| `indent_level` | :x: | :x: | :white_check_mark: |
| `indent_scripts` | :x: | :x: | :white_check_mark: |
| `indent_size` | :x: | :x: | :white_check_mark: |
| `indent_with_tabs` | :x: | :x: | :white_check_mark: |
| `jslint_happy` | :x: | :x: | :white_check_mark: |
| `keep_array_indentation` | :x: | :x: | :white_check_mark: |
| `keep_function_indentation` | :x: | :x: | :white_check_mark: |
| `max_preserve_newlines` | :x: | :x: | :white_check_mark: |
| `object_curly_spacing` | :x: | :x: | :white_check_mark: |
| `preserve_newlines` | :x: | :x: | :white_check_mark: |
| `space_after_anon_function` | :x: | :x: | :white_check_mark: |
| `space_before_conditional` | :x: | :x: | :white_check_mark: |
| `space_in_paren` | :x: | :x: | :white_check_mark: |
| `unescape_strings` | :x: | :x: | :white_check_mark: |
| `unformatted` | :x: | :x: | :white_check_mark: |
| `wrap_attributes` | :x: | :x: | :white_check_mark: |
| `wrap_attributes_indent_size` | :x: | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :x: | :white_check_mark: |
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
Options for language Vue
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Disable Vue Beautification
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
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.
2016-08-25 22:32:59 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `Vue Beautifier`
2015-08-05 08:56:11 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-03-01 20:48:23 -07:00
**Enum**: `ESLint Fixer` `Prettier` `Vue Beautifier`
2015-08-05 08:56:11 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Default Beautifier to be used for Vue
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Automatically beautify Vue files on save
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
##### [Brace style](#brace-style)
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `brace_style`
**Default**: `collapse`
**Type**: `string`
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2018-02-20 13:49:58 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
[collapse|expand|end-expand|none] (Supported by Vue Beautifier)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
```json
{
"html": {
"brace_style": "collapse"
}
}
```
##### [Break chained methods](#break-chained-methods)
**Namespace**: `js`
**Key**: `break_chained_methods`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Break chained method calls across subsequent lines (Supported by Vue Beautifier)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
```json
{
"js": {
"break_chained_methods": false
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
##### [End of line](#end-of-line)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_of_line`
**Default**: `System Default`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Enum**: `CRLF` `LF` `System Default`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Override EOL from line-ending-selector (Supported by Vue Beautifier)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
```json
{
"js": {
"end_of_line": "System Default"
}
}
```
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
##### [End with comma](#end-with-comma)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
**Key**: `end_with_comma`
2015-06-08 16:05:03 -06:00
2016-08-25 22:32:59 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
```json
{
"js": {
"end_with_comma": false
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
##### [End with newline](#end-with-newline)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_with_newline`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
End output with newline (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"end_with_newline": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Eval code](#eval-code)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `eval_code`
2016-08-25 22:32:59 -06:00
2016-12-29 16:37:03 -07:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"eval_code": false
2015-08-31 16:25:40 -06:00
}
2017-10-09 14:09:06 -06:00
}
```
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
##### [Extra liners](#extra-liners)
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `extra_liners`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `head,body,/html`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2017-01-24 07:26:19 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2017-01-24 07:26:19 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier)
2017-01-24 07:26:19 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
2017-01-24 07:26:19 -07:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2018-02-19 10:13:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by Vue Beautifier)
2018-02-19 10:13:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"indent_char": " "
2018-02-19 10:13:43 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent inner html](#indent-inner-html)
2016-03-21 10:46:52 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_inner_html`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent < head > and < body > sections. (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
"indent_inner_html": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent level](#indent-level)
**Namespace**: `js`
**Key**: `indent_level`
**Type**: `integer`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Initial indentation level (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_level": 0
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent scripts](#indent-scripts)
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_scripts`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Default**: `normal`
2016-08-25 22:32:59 -06:00
2017-01-01 23:46:52 -07:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
**Enum**: `keep` `separate` `normal`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
[keep|separate|normal] (Supported by Vue Beautifier)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
"indent_scripts": "normal"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2017-10-09 14:09:06 -06:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-01-01 23:46:52 -07:00
"html": {
2018-02-20 13:49:58 -07:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent with tabs](#indent-with-tabs)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_with_tabs`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"indent_with_tabs": false
2018-02-20 13:49:58 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Jslint happy](#jslint-happy)
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `jslint_happy`
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2018-02-20 13:49:58 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Enable jslint-stricter mode (Supported by Vue Beautifier)
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"jslint_happy": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Keep array indentation](#keep-array-indentation)
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `keep_array_indentation`
**Type**: `boolean`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Preserve array indentation (Supported by Vue Beautifier)
**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**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
(Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"keep_function_indentation": false
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
**Namespace**: `html`
**Key**: `max_preserve_newlines`
**Default**: `10`
**Type**: `integer`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"max_preserve_newlines": 10
}
}
```
##### [Object curly spacing](#object-curly-spacing)
**Namespace**: `js`
**Key**: `object_curly_spacing`
**Type**: `boolean`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Insert spaces between brackets in object literals (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"object_curly_spacing": false
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `html`
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Preserve line-breaks (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"preserve_newlines": true
}
}
```
##### [Space after anon function](#space-after-anon-function)
**Namespace**: `js`
**Key**: `space_after_anon_function`
**Type**: `boolean`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier)
**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**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
(Supported by Vue Beautifier)
**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**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"space_in_paren": false
}
}
```
##### [Unescape strings](#unescape-strings)
**Namespace**: `js`
**Key**: `unescape_strings`
**Type**: `boolean`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Decode printable characters encoded in xNN notation (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"unescape_strings": false
}
}
```
##### [Unformatted](#unformatted)
**Namespace**: `html`
**Key**: `unformatted`
2016-12-29 16:37:03 -07:00
2017-10-10 08:51:13 -06:00
**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`
2016-02-20 14:02:43 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `array`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"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"
]
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes](#wrap-attributes)
2015-08-31 16:25:40 -06:00
2017-01-01 23:46:52 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Default**: `auto`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
2016-12-29 16:37:03 -07:00
```json
{
2017-01-01 23:46:52 -07:00
"html": {
2018-02-20 13:49:58 -07:00
"wrap_attributes": "auto"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `wrap_attributes_indent_size`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2017-04-10 01:18:13 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent wrapped attributes to after N characters (Supported by Vue Beautifier)
2017-04-10 01:18:13 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
"wrap_attributes_indent_size": 4
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `html`
**Key**: `wrap_line_length`
**Default**: `250`
**Type**: `integer`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2018-02-20 13:49:58 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Maximum characters per line (0 disables) (Supported by Vue Beautifier)
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_line_length": 250
2017-04-10 01:18:13 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
#### [XML](#xml)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
| Option | JS Beautify | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `extra_liners` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: | :x: |
| `indent_scripts` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `unformatted` | :white_check_mark: | :x: |
| `wrap_attributes` | :white_check_mark: | :x: |
| `wrap_attributes_indent_size` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
Options for language XML
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Disable XML Beautification
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
##### [Default Beautifier](#default-beautifier)
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `Pretty Diff`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Enum**: `JS Beautify` `Pretty Diff`
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Default Beautifier to be used for XML
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2016-12-29 16:37:03 -07:00
2018-02-20 13:49:58 -07:00
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.
2016-07-30 14:45:17 -06:00
2018-02-20 13:49:58 -07:00
##### [Beautify On Save](#beautify-on-save)
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Automatically beautify XML files on save
2015-06-09 09:02:52 -06:00
2018-02-20 13:49:58 -07:00
**How to Configure**
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
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.
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
##### [Brace style](#brace-style)
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `brace_style`
**Default**: `collapse`
**Type**: `string`
**Enum**: `collapse` `expand` `end-expand` `none`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
[collapse|expand|end-expand|none] (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"brace_style": "collapse"
}
}
```
##### [End with newline](#end-with-newline)
**Namespace**: `html`
**Key**: `end_with_newline`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
End output with newline (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"end_with_newline": false
}
}
```
##### [Extra liners](#extra-liners)
**Namespace**: `html`
**Key**: `extra_liners`
**Default**: `head,body,/html`
**Type**: `array`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
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": {
"extra_liners": [
"head",
"body",
"/html"
]
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_char": " "
}
}
```
##### [Indent inner html](#indent-inner-html)
**Namespace**: `html`
**Key**: `indent_inner_html`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Indent < head > and < body > sections. (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_inner_html": false
}
}
```
##### [Indent scripts](#indent-scripts)
**Namespace**: `html`
**Key**: `indent_scripts`
**Default**: `normal`
**Type**: `string`
**Enum**: `keep` `separate` `normal`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
[keep|separate|normal] (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_scripts": "normal"
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `html`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation size/length (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_size": 4
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
**Namespace**: `html`
**Key**: `max_preserve_newlines`
**Default**: `10`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"max_preserve_newlines": 10
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `html`
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"preserve_newlines": true
}
}
```
##### [Unformatted](#unformatted)
**Namespace**: `html`
**Key**: `unformatted`
**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**: [`JS Beautify` ](#js-beautify )
**Description**:
List of tags (defaults to inline) that should not be reformatted (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"
]
}
}
```
##### [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": " "
}
}
```
##### [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
}
}
```
#### [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
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable YAML 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**: `align-yaml`
**Type**: `string`
**Enum**: `align-yaml`
**Description**:
Default Beautifier to be used for YAML
**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 YAML 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.
##### [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"
}
}
```
2018-03-01 17:49:41 -07:00
### Emacs Verilog Mode
2016-08-25 22:32:59 -06:00
2018-03-01 17:49:41 -07:00
##### [Emacs script path](#emacs-script-path)
2016-08-25 22:32:59 -06:00
2018-03-01 17:49:41 -07:00
**Namespace**: `verilog`
2017-10-10 08:51:13 -06:00
2018-03-01 17:49:41 -07:00
**Key**: `emacs_script_path`
2016-08-25 22:32:59 -06:00
2018-03-01 17:49:41 -07:00
**Type**: `string`
**Supported Beautifiers**: [`Emacs Verilog Mode` ](#emacs-verilog-mode )
2016-08-25 22:32:59 -06:00
**Description**:
2018-03-01 17:49:41 -07:00
Path to emacs init.el script with formatting settings. (Leave blank to use default one) (Supported by Emacs Verilog Mode)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-03-01 17:49:41 -07:00
"verilog": {
"emacs_script_path": ""
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
### Fortran Beautifier
##### [Emacs path](#emacs-path)
**Namespace**: `fortran`
**Key**: `emacs_path`
**Type**: `string`
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
**Description**:
Path to the `emacs` executable (Supported by Fortran Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"fortran": {
"emacs_path": ""
}
}
```
##### [Emacs script path](#emacs-script-path)
**Namespace**: `fortran`
**Key**: `emacs_script_path`
**Type**: `string`
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
**Description**:
Path to the emacs script (Supported by Fortran Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"fortran": {
"emacs_script_path": ""
}
}
```
### Gherkin formatter
##### [Indent size](#indent-size)
**Namespace**: `gherkin`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
**Description**:
Indentation size/length (Supported by Gherkin formatter)
**Example `.jsbeautifyrc` Configuration**
```json
{
"gherkin": {
"indent_size": 4
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `gherkin`
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
**Description**:
Indentation character (Supported by Gherkin formatter)
**Example `.jsbeautifyrc` Configuration**
```json
{
"gherkin": {
"indent_char": " "
}
}
```
### HTML Beautifier
##### [Indent size](#indent-size)
**Namespace**: `html`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`HTML Beautifier` ](#html-beautifier ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation size/length (Supported by HTML Beautifier, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_size": 4
}
}
```
### JS Beautify
##### [Indent size](#indent-size)
**Namespace**: `html`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation size/length (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_size": 4
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_char": " "
}
}
```
##### [Selector separator newline](#selector-separator-newline)
**Namespace**: `css`
**Key**: `selector_separator_newline`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Add a newline between multiple selectors (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"selector_separator_newline": false
}
}
```
##### [Newline between rules](#newline-between-rules)
**Namespace**: `css`
**Key**: `newline_between_rules`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"newline_between_rules": true
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `html`
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"preserve_newlines": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap line length](#wrap-line-length)
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_line_length`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `250`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"wrap_line_length": 250
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End with newline](#end-with-newline)
2016-07-30 14:45:17 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2016-07-30 14:45:17 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_with_newline`
2016-07-30 14:45:17 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-07-30 14:45:17 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
End output with newline (Supported by JS Beautify)
2016-07-30 14:45:17 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"end_with_newline": false
2016-07-30 14:45:17 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent level](#indent-level)
**Namespace**: `js`
**Key**: `indent_level`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Initial indentation level (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_level": 0
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `max_preserve_newlines`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `10`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"max_preserve_newlines": 10
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Space in paren](#space-in-paren)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-05-28 01:07:51 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `space_in_paren`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2017-04-25 00:40:27 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
```json
{
"js": {
"space_in_paren": false
}
}
```
##### [Jslint happy](#jslint-happy)
**Namespace**: `js`
**Key**: `jslint_happy`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-04-25 00:40:27 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-04-25 00:40:27 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Enable jslint-stricter mode (Supported by JS Beautify)
2017-04-25 00:40:27 -06:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2017-04-25 00:40:27 -06:00
2018-02-20 14:19:33 -07:00
```json
{
"js": {
"jslint_happy": false
}
}
```
2017-04-25 00:40:27 -06:00
2018-02-20 14:19:33 -07:00
##### [Space after anon function](#space-after-anon-function)
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `space_after_anon_function`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"space_after_anon_function": false
}
}
```
##### [Brace style](#brace-style)
**Namespace**: `html`
**Key**: `brace_style`
**Default**: `collapse`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-12-29 16:37:03 -07:00
2018-02-20 14:19:33 -07:00
**Enum**: `collapse` `expand` `end-expand` `none`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-12-29 16:37:03 -07:00
2018-02-20 13:49:58 -07:00
**Description**:
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
[collapse|expand|end-expand|none] (Supported by JS Beautify)
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
```json
{
"html": {
"brace_style": "collapse"
}
}
```
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
##### [Break chained methods](#break-chained-methods)
2015-06-09 09:02:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
**Key**: `break_chained_methods`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2018-02-20 13:49:58 -07:00
**Description**:
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Example `.jsbeautifyrc` Configuration**
2016-12-29 16:37:03 -07:00
2018-02-20 14:19:33 -07:00
```json
{
"js": {
"break_chained_methods": false
}
}
```
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
##### [Keep array indentation](#keep-array-indentation)
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `keep_array_indentation`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Preserve array indentation (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
2018-02-20 13:49:58 -07:00
{
2018-02-20 14:19:33 -07:00
"js": {
"keep_array_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Keep function indentation](#keep-function-indentation)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `keep_function_indentation`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2016-12-29 16:37:03 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
(Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"keep_function_indentation": false
}
}
```
##### [Space before conditional](#space-before-conditional)
**Namespace**: `js`
**Key**: `space_before_conditional`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `true`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"space_before_conditional": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Eval code](#eval-code)
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `eval_code`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by JS Beautify)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"eval_code": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Unescape strings](#unescape-strings)
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `unescape_strings`
2016-12-29 16:37:03 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"unescape_strings": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End with comma](#end-with-comma)
2015-09-08 16:47:30 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-09-08 16:47:30 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_with_comma`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-09-08 16:47:30 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff)
2015-09-08 16:47:30 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"end_with_comma": false
2016-08-25 22:32:59 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End of line](#end-of-line)
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_of_line`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `System Default`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Enum**: `CRLF` `LF` `System Default`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-08-25 22:32:59 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Override EOL from line-ending-selector (Supported by JS Beautify)
2016-08-25 22:32:59 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"end_of_line": "System Default"
2015-09-08 16:47:30 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Object curly spacing](#object-curly-spacing)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `object_curly_spacing`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Insert spaces between brackets in object literals (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"object_curly_spacing": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent inner html](#indent-inner-html)
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_inner_html`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent < head > and < body > sections. (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 14:19:33 -07:00
"indent_inner_html": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent scripts](#indent-scripts)
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_scripts`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `normal`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Enum**: `keep` `separate` `normal`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
[keep|separate|normal] (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 14:19:33 -07:00
"indent_scripts": "normal"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap attributes](#wrap-attributes)
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_attributes`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `auto`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 14:19:33 -07:00
"wrap_attributes": "auto"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_attributes_indent_size`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `4`
**Type**: `integer`
2017-10-09 14:09:06 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent wrapped attributes to after N characters (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"wrap_attributes_indent_size": 4
2018-02-20 13:49:58 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Unformatted](#unformatted)
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `unformatted`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**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`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `array`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2018-02-20 13:49:58 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"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"
]
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Extra liners](#extra-liners)
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `extra_liners`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `head,body,/html`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `array`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 14:19:33 -07:00
"extra_liners": [
"head",
"body",
"/html"
]
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [E4x](#e4x)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `jsx`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `e4x`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `true`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Support e4x/jsx syntax (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"jsx": {
"e4x": true
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-09 09:02:52 -06:00
2018-02-20 14:19:33 -07:00
### Latex Beautify
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `latex`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_char`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Default**: ` `
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by Latex Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"latex": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent with tabs](#indent-with-tabs)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `latex`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_with_tabs`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-08-25 22:32:59 -06:00
2017-04-14 23:27:12 -06:00
**Description**:
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify)
2017-04-14 23:27:12 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"latex": {
2017-10-10 08:51:13 -06:00
"indent_with_tabs": false
2017-01-30 07:46:48 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent preamble](#indent-preamble)
2017-01-30 07:46:48 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `latex`
2017-01-30 07:46:48 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_preamble`
2017-01-30 07:46:48 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-01-30 07:46:48 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent the preamble (Supported by Latex Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"latex": {
"indent_preamble": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Always look for split braces](#always-look-for-split-braces)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `latex`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `always_look_for_split_braces`
**Default**: `true`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
If `latexindent` should look for commands that split braces across lines (Supported by Latex Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"latex": {
"always_look_for_split_braces": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Always look for split brackets](#always-look-for-split-brackets)
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `latex`
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `always_look_for_split_brackets`
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2017-04-19 23:55:48 -06:00
2018-02-20 13:49:58 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify)
2018-02-20 13:49:58 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"latex": {
"always_look_for_split_brackets": false
2018-02-20 13:49:58 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Remove trailing whitespace](#remove-trailing-whitespace)
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `latex`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `remove_trailing_whitespace`
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2017-04-19 23:55:48 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Remove trailing whitespace (Supported by Latex Beautify)
2017-04-19 23:55:48 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"latex": {
"remove_trailing_whitespace": false
2017-04-19 23:55:48 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Align columns in environments](#align-columns-in-environments)
2017-05-12 20:27:55 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `latex`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `align_columns_in_environments`
2017-05-12 20:27:55 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `tabular,matrix,bmatrix,pmatrix`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `array`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2017-05-12 20:27:55 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Aligns columns by the alignment tabs for environments specified (Supported by Latex Beautify)
2017-05-12 20:27:55 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"latex": {
"align_columns_in_environments": [
"tabular",
"matrix",
"bmatrix",
"pmatrix"
]
2017-05-12 20:27:55 -06:00
}
}
```
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
### Lua beautifier
2017-04-19 23:55:48 -06:00
2018-03-01 20:22:34 -07:00
##### [Indent size](#indent-size)
2017-10-09 14:09:06 -06:00
2018-03-01 20:22:34 -07:00
**Namespace**: `lua`
2017-10-09 14:09:06 -06:00
2018-03-01 20:22:34 -07:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-03-01 20:22:34 -07:00
Indentation size/length (Supported by Lua beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-03-01 20:22:34 -07:00
"lua": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-03-01 20:22:34 -07:00
##### [Indent char](#indent-char)
2015-06-08 16:05:03 -06:00
2018-03-01 20:22:34 -07:00
**Namespace**: `lua`
2015-06-08 16:05:03 -06:00
2018-03-01 20:22:34 -07:00
**Key**: `indent_char`
2016-02-20 14:02:43 -07:00
2018-03-01 20:22:34 -07:00
**Default**: ` `
2016-08-25 22:32:59 -06:00
2018-03-01 20:22:34 -07:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-03-01 20:22:34 -07:00
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2016-02-20 14:02:43 -07:00
**Description**:
2018-03-01 20:22:34 -07:00
Indentation character (Supported by Lua beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-03-01 20:22:34 -07:00
"lua": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End of line](#end-of-line)
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `lua`
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_of_line`
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `System Default`
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Enum**: `CRLF` `LF` `System Default`
2017-04-19 23:55:48 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2017-04-19 23:55:48 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Override EOL from line-ending-selector (Supported by Lua beautifier)
2017-04-19 23:55:48 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"lua": {
"end_of_line": "System Default"
2017-04-19 23:55:48 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
### Marko Beautifier
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by Marko Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent char](#indent-char)
2017-04-21 08:07:32 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2017-04-21 08:07:32 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_char`
2017-04-21 08:07:32 -06:00
2018-02-20 14:19:33 -07:00
**Default**: ` `
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2017-04-21 08:07:32 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by Marko Beautifier)
2017-04-21 08:07:32 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_char": " "
2017-04-21 08:07:32 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Syntax](#syntax)
**Namespace**: `marko`
**Key**: `syntax`
2017-05-05 13:24:17 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Enum**: `html` `concise`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
[html|concise] (Supported by Marko Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"marko": {
"syntax": "html"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent inner html](#indent-inner-html)
2017-05-05 13:24:17 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_inner_html`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent < head > and < body > sections. (Supported by Marko Beautifier)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_inner_html": false
2016-02-20 14:02:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Brace style](#brace-style)
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2017-05-06 12:28:00 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `brace_style`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `collapse`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
**Enum**: `collapse` `expand` `end-expand` `none`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
[collapse|expand|end-expand|none] (Supported by Marko Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"brace_style": "collapse"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent scripts](#indent-scripts)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_scripts`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `normal`
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Enum**: `keep` `separate` `normal`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
[keep|separate|normal] (Supported by Marko Beautifier)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_scripts": "normal"
2016-02-20 14:02:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap line length](#wrap-line-length)
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_line_length`
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `250`
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2018-02-19 10:13:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Maximum characters per line (0 disables) (Supported by Marko Beautifier)
2018-02-19 10:13:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"wrap_line_length": 250
2018-02-19 10:13:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap attributes](#wrap-attributes)
2018-02-19 11:51:23 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2018-02-19 11:51:23 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_attributes`
2018-02-19 11:51:23 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `auto`
2018-02-19 11:51:23 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2018-02-19 11:51:23 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier)
2018-02-19 11:51:23 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"wrap_attributes": "auto"
2018-02-19 11:51:23 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_attributes_indent_size`
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `4`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2018-02-19 10:13:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent wrapped attributes to after N characters (Supported by Marko Beautifier)
2018-02-19 10:13:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"wrap_attributes_indent_size": 4
2018-02-19 10:13:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Preserve newlines](#preserve-newlines)
2018-02-19 10:13:43 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `preserve_newlines`
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `true`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2018-02-19 10:13:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Preserve line-breaks (Supported by Marko Beautifier)
2018-02-19 10:13:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"preserve_newlines": true
2018-02-19 10:13:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2016-02-20 14:02:43 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2018-02-20 14:19:33 -07:00
**Key**: `max_preserve_newlines`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `10`
2017-10-10 08:51:13 -06:00
**Type**: `integer`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 14:19:33 -07:00
"max_preserve_newlines": 10
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Unformatted](#unformatted)
2016-02-20 14:02:43 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**Key**: `unformatted`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**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`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `array`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 13:49:58 -07:00
"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"
]
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End with newline](#end-with-newline)
**Namespace**: `html`
**Key**: `end_with_newline`
**Type**: `boolean`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
End output with newline (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"end_with_newline": false
}
}
```
##### [Extra liners](#extra-liners)
**Namespace**: `html`
**Key**: `extra_liners`
**Default**: `head,body,/html`
**Type**: `array`
**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)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
}
}
```
### Nginx Beautify
##### [Indent size](#indent-size)
**Namespace**: `nginx`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
**Description**:
Indentation size/length (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"indent_size": 4
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `nginx`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
**Description**:
Indentation character (Supported by Nginx Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"nginx": {
"indent_char": " "
}
}
```
##### [Indent with tabs](#indent-with-tabs)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `nginx`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_with_tabs`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2015-06-09 09:02:52 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
2015-08-31 16:25:40 -06:00
2017-01-01 23:46:52 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Nginx Beautify)
2017-01-01 23:46:52 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"nginx": {
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Don't join curly brackets](#don't-join-curly-brackets)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `nginx`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `dontJoinCurlyBracet`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `true`
2016-02-20 14:02:43 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Nginx Beautify` ](#nginx-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by Nginx Beautify)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"nginx": {
"dontJoinCurlyBracet": true
2015-08-31 16:25:40 -06:00
}
}
```
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
### PHP-CS-Fixer
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
##### [PHP-CS-Fixer Path](#php-cs-fixer-path)
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `cs_fixer_path`
2018-02-20 13:49:58 -07:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Absolute path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"cs_fixer_path": ""
2016-02-20 14:02:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [PHP-CS-Fixer Version](#php-cs-fixer-version)
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `cs_fixer_version`
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `2`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `integer`
**Enum**: `1` `2`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-09-10 13:08:58 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by PHP-CS-Fixer)
2015-09-10 13:08:58 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"cs_fixer_version": 2
2015-09-10 13:08:58 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [PHP-CS-Fixer Config File](#php-cs-fixer-config-file)
2015-06-09 09:02:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `cs_fixer_config_file`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
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)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"cs_fixer_config_file": ""
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Fixers](#fixers)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `fixers`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"fixers": ""
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Level](#level)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `level`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"level": ""
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Rules](#rules)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `rules`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"rules": ""
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Allow risky rules](#allow-risky-rules)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `allow_risky`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `no`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Enum**: `no` `yes`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"allow_risky": "no"
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
### PHPCBF
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
##### [PHPCBF Path](#phpcbf-path)
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `phpcbf_path`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`PHPCBF` ](#phpcbf )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Path to the `phpcbf` CLI executable (Supported by PHPCBF)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"phpcbf_path": ""
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [PHPCBF Version](#phpcbf-version)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `phpcbf_version`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `2`
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2018-02-20 14:19:33 -07:00
**Enum**: `1` `2` `3`
**Supported Beautifiers**: [`PHPCBF` ](#phpcbf )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by PHPCBF)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"phpcbf_version": 2
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [PHPCBF Standard](#phpcbf-standard)
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `php`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `standard`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `PEAR`
2016-06-24 12:30:54 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`PHPCBF` ](#phpcbf )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
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)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"php": {
"standard": "PEAR"
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
### Perltidy
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
##### [Perltidy profile](#perltidy-profile)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `perl`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `perltidy_profile`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Perltidy` ](#perltidy )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"perl": {
"perltidy_profile": ""
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
### Prettier
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
##### [Indent size](#indent-size)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by JS Beautify, Prettier, Pretty Diff)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"indent_size": 4
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent char](#indent-char)
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_char`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Default**: ` `
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by JS Beautify, Prettier, Pretty Diff)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"indent_char": " "
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent with tabs](#indent-with-tabs)
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_with_tabs`
2016-06-24 12:30:54 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier ) [`Pretty Diff` ](#pretty-diff )
2016-06-24 12:30:54 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Prettier, Pretty Diff)
2016-06-24 12:30:54 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"indent_with_tabs": false
2016-06-24 12:30:54 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Object curly spacing](#object-curly-spacing)
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `object_curly_spacing`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Prettier` ](#prettier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Insert spaces between brackets in object literals (Supported by JS Beautify, Prettier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"object_curly_spacing": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
### Pretty Diff
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
##### [Indent size](#indent-size)
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_size`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `4`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by Pretty Diff)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"indent_size": 4
2016-02-20 14:02:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent char](#indent-char)
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_char`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Default**: ` `
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap line length](#wrap-line-length)
2016-02-20 14:02:43 -07:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_line_length`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `250`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"wrap_line_length": 250
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Preserve newlines](#preserve-newlines)
2016-09-15 05:07:43 -06:00
2018-02-20 13:49:58 -07:00
**Namespace**: `html`
2017-04-15 16:09:27 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `preserve_newlines`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `true`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-09-15 05:07:43 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Preserve line-breaks (Supported by Pretty Diff)
2016-09-15 05:07:43 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 13:49:58 -07:00
"html": {
2018-02-20 14:19:33 -07:00
"preserve_newlines": true
2016-09-15 05:07:43 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Newline between rules](#newline-between-rules)
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `css`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `newline_between_rules`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `true`
2017-04-15 16:09:27 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Add a newline between CSS rules (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"css": {
"newline_between_rules": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent comments](#indent-comments)
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `css`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_comments`
**Default**: `true`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Determines whether comments should be indented. (Supported by Pretty Diff)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"css": {
"indent_comments": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Force indentation](#force-indentation)
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `css`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `force_indentation`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
if indentation should be forcefully applied to markup even if it disruptively adds unintended whitespace to the documents rendered output (Supported by Pretty Diff)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"css": {
"force_indentation": false
2016-02-20 14:02:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Convert quotes](#convert-quotes)
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `css`
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `convert_quotes`
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `none`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Enum**: `none` `double` `single`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-09-10 13:08:58 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Convert the quote characters delimiting strings from either double or single quotes to the other. (Supported by Pretty Diff)
2015-09-10 13:08:58 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"css": {
"convert_quotes": "none"
2015-09-10 13:08:58 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Align assignments](#align-assignments)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `css`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `align_assignments`
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Description**:
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
If lists of assignments or properties should be vertically aligned for faster and easier reading. (Supported by Pretty Diff)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"css": {
"align_assignments": false
2016-02-20 14:02:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [No lead zero](#no-lead-zero)
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `css`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `no_lead_zero`
2017-10-10 08:51:13 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
If in CSS values leading 0s immediately preceding a decimal should be removed or prevented. (Supported by Pretty Diff)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"css": {
"no_lead_zero": false
2016-02-20 14:02:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent with tabs](#indent-with-tabs)
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_with_tabs`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Space in paren](#space-in-paren)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `space_in_paren`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"space_in_paren": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Space after anon function](#space-after-anon-function)
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `space_after_anon_function`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"space_after_anon_function": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Break chained methods](#break-chained-methods)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `break_chained_methods`
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Break chained method calls across subsequent lines (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"break_chained_methods": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End with comma](#end-with-comma)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_with_comma`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"end_with_comma": false
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
### Pug Beautify
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
##### [Indent size](#indent-size)
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by Pug Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent char](#indent-char)
2016-04-23 11:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2016-04-23 11:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_char`
**Default**: ` `
2016-04-23 11:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `string`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2016-04-23 11:46:52 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by Pug Beautify)
2016-04-23 11:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_char": " "
2016-04-23 11:46:52 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
### Remark
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
##### [Gfm](#gfm)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `markdown`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `gfm`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `true`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
**Supported Beautifiers**: [`Remark` ](#remark )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
GitHub Flavoured Markdown (Supported by Remark)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"markdown": {
"gfm": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Yaml](#yaml)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `markdown`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `yaml`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `true`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Remark` ](#remark )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"markdown": {
"yaml": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Commonmark](#commonmark)
2015-09-10 13:05:19 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `markdown`
2015-09-10 13:05:19 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `commonmark`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Remark` ](#remark )
2015-09-10 13:05:19 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Allows and disallows several constructs. (Supported by Remark)
2015-09-10 13:05:19 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"markdown": {
"commonmark": false
2015-09-10 13:05:19 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
### Rubocop
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
##### [Indent size](#indent-size)
2016-04-01 07:40:26 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `ruby`
2016-04-01 07:40:26 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_size`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Rubocop` ](#rubocop ) [`Ruby Beautify` ](#ruby-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by Rubocop, Ruby Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"ruby": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Rubocop Path](#rubocop-path)
2015-06-25 06:10:47 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `ruby`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `rubocop_path`
2018-02-20 13:49:58 -07:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Rubocop` ](#rubocop )
2015-06-25 06:10:47 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Path to the `rubocop` CLI executable (Supported by Rubocop)
2015-06-25 06:10:47 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"ruby": {
"rubocop_path": ""
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
### Ruby Beautify
2018-02-20 13:49:58 -07:00
##### [Indent size](#indent-size)
2015-06-25 06:10:47 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `ruby`
2015-08-31 16:25:40 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_size`
2017-01-24 07:26:19 -07:00
2018-02-20 13:49:58 -07:00
**Default**: `4`
2016-04-01 07:40:26 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Rubocop` ](#rubocop ) [`Ruby Beautify` ](#ruby-beautify )
2015-06-25 06:10:47 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by Rubocop, Ruby Beautify)
2015-06-25 06:10:47 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"ruby": {
2018-02-20 13:49:58 -07:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent char](#indent-char)
2015-10-07 17:57:56 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `ruby`
2015-06-08 16:05:03 -06:00
2018-02-20 13:49:58 -07:00
**Key**: `indent_char`
2017-01-01 23:46:52 -07:00
2018-02-20 13:49:58 -07:00
**Default**: ` `
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Enum**: ` ` ` `
**Supported Beautifiers**: [`Ruby Beautify` ](#ruby-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by Ruby Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"ruby": {
2018-02-20 13:49:58 -07:00
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
### TypeScript Formatter
##### [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
}
}
```
2018-02-20 13:49:58 -07:00
##### [Indent with tabs](#indent-with-tabs)
2018-02-19 10:13:43 -07:00
**Namespace**: `js`
2018-02-20 13:49:58 -07:00
**Key**: `indent_with_tabs`
2018-02-19 10:13:43 -07:00
**Type**: `boolean`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2018-02-19 10:13:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter)
2018-02-19 10:13:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
2018-02-20 13:49:58 -07:00
"indent_with_tabs": false
2018-02-19 10:13:43 -07:00
}
}
```
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
### Uncrustify
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
##### [Config Path](#config-path)
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `vala`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"vala": {
"configPath": ""
2015-08-31 16:25:40 -06:00
}
}
```
2018-03-01 18:10:48 -07:00
### VHDL Beautifier
2017-12-07 09:11:02 -07:00
##### [Emacs script path](#emacs-script-path)
**Namespace**: `vhdl`
**Key**: `emacs_script_path`
**Type**: `string`
2018-03-01 18:10:48 -07:00
**Supported Beautifiers**: [`VHDL Beautifier` ](#vhdl-beautifier )
2017-12-07 09:11:02 -07:00
**Description**:
2018-03-01 18:10:48 -07:00
Path to the emacs script (Supported by VHDL Beautifier)
2017-12-07 09:11:02 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"vhdl": {
"emacs_script_path": ""
}
}
```
2018-02-20 14:19:33 -07:00
### Vue Beautifier
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation size/length (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_char`
2016-03-21 10:46:52 -06:00
2017-10-10 08:51:13 -06:00
**Default**: ` `
**Type**: `string`
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indentation character (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent level](#indent-level)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_level`
2016-03-21 10:46:52 -06:00
2018-02-20 13:49:58 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Initial indentation level (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"indent_level": 0
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Preserve newlines](#preserve-newlines)
2015-06-08 16:05:03 -06:00
2017-01-01 23:46:52 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `preserve_newlines`
**Default**: `true`
2017-01-01 23:46:52 -07:00
2017-10-09 14:09:06 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Preserve line-breaks (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-01-01 23:46:52 -07:00
"html": {
2017-10-10 08:51:13 -06:00
"preserve_newlines": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2015-10-07 17:57:56 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `max_preserve_newlines`
2015-10-07 17:57:56 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `10`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-10-07 17:57:56 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier)
2015-10-07 17:57:56 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"max_preserve_newlines": 10
2015-10-07 17:57:56 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Space in paren](#space-in-paren)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `space_in_paren`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
**Description**:
Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"space_in_paren": false
}
}
```
##### [Jslint happy](#jslint-happy)
**Namespace**: `js`
**Key**: `jslint_happy`
2015-06-08 16:05:03 -06:00
2016-08-25 22:32:59 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Enable jslint-stricter mode (Supported by Vue Beautifier)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"jslint_happy": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Space after anon function](#space-after-anon-function)
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-09-10 13:08:58 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `space_after_anon_function`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-09-10 13:08:58 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier)
2015-09-10 13:08:58 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"space_after_anon_function": false
2015-09-10 13:08:58 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Brace style](#brace-style)
2015-06-09 09:02:52 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2015-10-27 19:31:21 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `brace_style`
2015-10-27 19:31:21 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `collapse`
2017-10-09 14:09:06 -06:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
2015-10-27 19:31:21 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-10-27 19:31:21 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
[collapse|expand|end-expand|none] (Supported by Vue Beautifier)
2015-10-27 19:31:21 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"brace_style": "collapse"
2015-10-27 19:31:21 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Break chained methods](#break-chained-methods)
2015-10-27 19:31:21 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-10-27 19:31:21 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `break_chained_methods`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2015-10-27 19:31:21 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-10-27 19:31:21 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Break chained method calls across subsequent lines (Supported by Vue Beautifier)
2015-10-27 19:31:21 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"break_chained_methods": false
2015-10-27 19:31:21 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Keep array indentation](#keep-array-indentation)
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `keep_array_indentation`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2015-08-05 09:16:31 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-08-05 09:16:31 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Preserve array indentation (Supported by Vue Beautifier)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"keep_array_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Keep function indentation](#keep-function-indentation)
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `keep_function_indentation`
2015-08-05 09:16:31 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2015-08-05 09:16:31 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-08-05 09:16:31 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by Vue Beautifier)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 14:19:33 -07:00
"keep_function_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Space before conditional](#space-before-conditional)
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `space_before_conditional`
**Default**: `true`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 14:19:33 -07:00
"space_before_conditional": true
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Eval code](#eval-code)
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `eval_code`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
(Supported by Vue Beautifier)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 14:19:33 -07:00
"eval_code": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Unescape strings](#unescape-strings)
2016-01-28 05:11:09 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `js`
2016-01-28 05:11:09 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `unescape_strings`
2016-08-25 22:32:59 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2016-01-28 05:11:09 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Decode printable characters encoded in xNN notation (Supported by Vue Beautifier)
2016-01-28 05:11:09 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"js": {
2018-02-20 14:19:33 -07:00
"unescape_strings": false
2016-01-28 05:11:09 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap line length](#wrap-line-length)
2016-01-28 05:11:09 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_line_length`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `250`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `integer`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2016-01-28 05:11:09 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Maximum characters per line (0 disables) (Supported by Vue Beautifier)
2016-01-28 05:11:09 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"wrap_line_length": 250
2016-01-28 05:11:09 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End with newline](#end-with-newline)
2016-01-28 05:11:09 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `html`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_with_newline`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2016-01-28 05:11:09 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
End output with newline (Supported by Vue Beautifier)
2016-01-28 05:11:09 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"html": {
2018-02-20 14:19:33 -07:00
"end_with_newline": false
2016-01-28 05:11:09 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End with comma](#end-with-comma)
2017-01-24 07:26:19 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2017-01-24 07:26:19 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `end_with_comma`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `boolean`
2017-01-24 07:26:19 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2017-01-24 07:26:19 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier)
2017-01-24 07:26:19 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"end_with_comma": false
2017-01-24 07:26:19 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [End of line](#end-of-line)
2016-01-28 05:11:09 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `end_of_line`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `System Default`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Enum**: `CRLF` `LF` `System Default`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Override EOL from line-ending-selector (Supported by Vue Beautifier)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"end_of_line": "System Default"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Object curly spacing](#object-curly-spacing)
2018-02-19 10:13:43 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `js`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `object_curly_spacing`
2018-02-19 10:13:43 -07:00
**Type**: `boolean`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2018-02-19 10:13:43 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Insert spaces between brackets in object literals (Supported by Vue Beautifier)
2018-02-19 10:13:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"js": {
"object_curly_spacing": false
2018-02-19 10:13:43 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent inner html](#indent-inner-html)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_inner_html`
2017-01-01 23:46:52 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `boolean`
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent < head > and < body > sections. (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_inner_html": false
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Indent scripts](#indent-scripts)
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `indent_scripts`
2017-01-01 23:46:52 -07:00
2018-02-20 14:19:33 -07:00
**Default**: `normal`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Enum**: `keep` `separate` `normal`
2017-10-09 14:09:06 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
[keep|separate|normal] (Supported by Vue Beautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"indent_scripts": "normal"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap attributes](#wrap-attributes)
2016-08-25 22:32:59 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_attributes`
**Default**: `auto`
2015-06-08 16:05:03 -06:00
2017-10-09 14:09:06 -06:00
**Type**: `string`
2018-02-20 14:19:33 -07:00
**Enum**: `auto` `force` `force-aligned` `force-expand-multiline`
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"wrap_attributes": "auto"
2015-08-31 16:25:40 -06:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2016-01-13 09:05:57 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `wrap_attributes_indent_size`
2016-08-25 22:32:59 -06:00
2017-10-09 14:09:06 -06:00
**Default**: `4`
**Type**: `integer`
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2016-01-13 09:05:57 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
Indent wrapped attributes to after N characters (Supported by Vue Beautifier)
2016-01-13 09:05:57 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
2017-10-09 14:09:06 -06:00
{
2018-02-20 14:19:33 -07:00
"html": {
"wrap_attributes_indent_size": 4
2016-01-13 09:05:57 -07:00
}
}
```
2018-02-20 14:19:33 -07:00
##### [Unformatted](#unformatted)
2016-01-13 09:05:57 -07:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2016-01-13 09:05:57 -07:00
2018-02-20 14:19:33 -07:00
**Key**: `unformatted`
2016-01-13 09:05:57 -07:00
2018-02-20 14:19:33 -07:00
**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`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `array`
2016-01-13 09:05:57 -07:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2016-01-13 09:05:57 -07:00
**Description**:
2018-02-20 14:19:33 -07:00
List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier)
2016-01-13 09:05:57 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"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"
]
2016-01-13 09:05:57 -07:00
}
}
```
2017-04-15 18:03:25 -06:00
2018-02-20 14:19:33 -07:00
##### [Extra liners](#extra-liners)
2017-04-15 18:03:25 -06:00
2018-02-20 14:19:33 -07:00
**Namespace**: `html`
2017-04-15 18:03:25 -06:00
2018-02-20 14:19:33 -07:00
**Key**: `extra_liners`
2017-04-15 18:03:25 -06:00
2018-02-20 14:19:33 -07:00
**Default**: `head,body,/html`
2018-02-20 13:49:58 -07:00
2018-02-20 14:19:33 -07:00
**Type**: `array`
2017-10-10 08:51:13 -06:00
2018-02-20 14:19:33 -07:00
**Supported Beautifiers**: [`Vue Beautifier` ](#vue-beautifier )
2017-10-09 14:09:06 -06:00
**Description**:
2018-02-20 14:19:33 -07:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier)
2017-10-09 14:09:06 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2018-02-20 14:19:33 -07:00
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
2017-10-09 14:09:06 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
### align-yaml
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
##### [Padding](#padding)
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `yaml`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `padding`
2017-04-15 18:03:25 -06:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`align-yaml` ](#align-yaml )
2017-04-15 18:03:25 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
The amount of padding to add next to each line. (Supported by align-yaml)
2017-04-15 18:03:25 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"yaml": {
"padding": 0
2017-04-15 18:03:25 -06:00
}
}
```
2016-01-13 09:05:57 -07:00
2015-06-09 09:02:52 -06:00
2017-10-10 08:51:13 -06:00
### autopep8
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
##### [Max line length](#max-line-length)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `python`
**Key**: `max_line_length`
2015-06-08 16:05:03 -06:00
**Default**: `79`
**Type**: `integer`
2016-11-20 02:24:36 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2016-11-20 02:24:36 -07:00
set maximum allowed line length (Supported by autopep8, pybeautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"max_line_length": 79
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `python`
**Key**: `indent_size`
2015-06-08 16:05:03 -06:00
2017-04-15 16:48:49 -06:00
**Default**: `4`
2015-06-08 16:05:03 -06:00
**Type**: `integer`
2016-11-20 02:24:36 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2016-11-20 02:24:36 -07:00
Indentation size/length (Supported by autopep8, pybeautifier)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
2017-04-15 16:48:49 -06:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Ignore](#ignore)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `python`
**Key**: `ignore`
2015-06-08 16:05:03 -06:00
**Default**: `E24`
**Type**: `array`
2016-11-20 02:24:36 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2016-11-20 02:24:36 -07:00
do not fix these errors/warnings (Supported by autopep8, pybeautifier)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"ignore": [
"E24"
]
}
}
```
2017-10-19 09:41:26 -06:00
##### [Formatter](#formatter)
2016-11-20 02:24:36 -07:00
**Namespace**: `python`
2017-10-19 09:41:26 -06:00
**Key**: `formatter`
2016-11-20 02:24:36 -07:00
**Default**: `autopep8`
**Type**: `string`
**Enum**: `autopep8` `yapf`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
**Description**:
2017-06-05 09:38:52 -06:00
formatter used by pybeautifier (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
2017-10-19 09:41:26 -06:00
"formatter": "autopep8"
2016-11-20 02:24:36 -07:00
}
}
```
##### [Style config](#style-config)
**Namespace**: `python`
**Key**: `style_config`
**Default**: `pep8`
**Type**: `string`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
**Description**:
formatting style used by yapf (Supported by autopep8, pybeautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"style_config": "pep8"
}
}
```
2016-03-21 10:46:52 -06:00
##### [Sort imports](#sort-imports)
2015-12-10 18:40:30 -07:00
**Namespace**: `python`
**Key**: `sort_imports`
**Type**: `boolean`
2016-11-20 02:24:36 -07:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2015-12-10 18:40:30 -07:00
**Description**:
2016-11-20 02:24:36 -07:00
sort imports (requires isort installed) (Supported by autopep8, pybeautifier)
2015-12-10 18:40:30 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"sort_imports": false
}
}
```
2016-11-20 02:24:36 -07:00
##### [Multi line output](#multi-line-output)
**Namespace**: `python`
**Key**: `multi_line_output`
**Default**: `Hanging Grid Grouped`
**Type**: `string`
**Enum**: `Grid` `Vertical` `Hanging Indent` `Vertical Hanging Indent` `Hanging Grid` `Hanging Grid Grouped` `NOQA`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
**Description**:
defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"multi_line_output": "Hanging Grid Grouped"
}
}
```
2015-06-09 09:02:52 -06:00
2017-10-10 08:51:13 -06:00
### beautysh
2016-12-29 16:37:03 -07:00
##### [Indent size](#indent-size)
2017-10-10 08:51:13 -06:00
**Namespace**: `bash`
2016-12-29 16:37:03 -07:00
**Key**: `indent_size`
2017-04-15 16:48:49 -06:00
**Default**: `4`
2016-12-29 16:37:03 -07:00
**Type**: `integer`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`beautysh` ](#beautysh )
2016-12-29 16:37:03 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
Indentation size/length (Supported by beautysh)
2016-12-29 16:37:03 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"bash": {
2017-10-09 14:09:06 -06:00
"indent_size": 4
}
}
```
2018-03-01 18:26:08 -07:00
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `bash`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`beautysh` ](#beautysh )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by beautysh)
**Example `.jsbeautifyrc` Configuration**
```json
{
"bash": {
"indent_with_tabs": false
}
}
```
2016-12-29 16:37:03 -07:00
2017-10-10 08:51:13 -06:00
### clang-format
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
##### [Config Path](#config-path)
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `glsl`
2017-10-09 14:09:06 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `configPath`
2017-10-09 14:09:06 -06:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`clang-format` ](#clang-format )
2016-12-05 07:05:43 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format)
2016-12-05 07:05:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"glsl": {
"configPath": ""
2016-12-05 07:05:43 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
### coffee-fmt
##### [Indent size](#indent-size)
2015-06-10 10:57:47 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
2015-06-10 10:57:47 -06:00
2017-10-10 08:51:13 -06:00
**Default**: `4`
2017-04-15 16:09:27 -06:00
2015-06-10 10:57:47 -06:00
**Type**: `integer`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`coffee-fmt` ](#coffee-fmt )
2015-06-10 16:20:08 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation size/length (Supported by coffee-fmt)
2015-06-10 16:20:08 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
2017-10-10 08:51:13 -06:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent char](#indent-char)
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_char`
2017-04-15 16:09:27 -06:00
2017-10-10 08:51:13 -06:00
**Default**: ` `
2015-06-10 16:20:08 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`coffee-fmt` ](#coffee-fmt )
2015-06-10 16:20:08 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation character (Supported by coffee-fmt)
2015-06-10 16:20:08 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
2017-10-10 08:51:13 -06:00
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent with tabs](#indent-with-tabs)
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-10 16:20:08 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_with_tabs`
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-10 16:20:08 -06:00
2018-02-20 13:49:58 -07:00
**Supported Beautifiers**: [`coffee-fmt` ](#coffee-fmt )
2015-06-10 10:57:47 -06:00
**Description**:
2018-02-20 13:49:58 -07:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by coffee-fmt)
2015-06-10 10:57:47 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
2017-10-10 08:51:13 -06:00
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-10 10:57:47 -06:00
2017-10-10 08:51:13 -06:00
### formatR
2016-09-02 03:15:30 -06:00
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2016-09-02 03:15:30 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `r`
2016-09-02 03:15:30 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`formatR` ](#formatr )
2016-09-02 03:15:30 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
Indentation size/length (Supported by formatR)
2016-09-02 03:15:30 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"r": {
"indent_size": 4
2016-09-02 03:15:30 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
### pybeautifier
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
##### [Max line length](#max-line-length)
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `python`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `max_line_length`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `79`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-11-20 02:24:36 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
set maximum allowed line length (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"python": {
"max_line_length": 79
2016-11-20 02:24:36 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `python`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `4`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-11-20 02:24:36 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
Indentation size/length (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"python": {
"indent_size": 4
2016-11-20 02:24:36 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Ignore](#ignore)
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `python`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `ignore`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `E24`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `array`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-11-20 02:24:36 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
do not fix these errors/warnings (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"python": {
"ignore": [
"E24"
]
2016-11-20 02:24:36 -07:00
}
}
```
2017-10-19 09:41:26 -06:00
##### [Formatter](#formatter)
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `python`
2016-11-20 02:24:36 -07:00
2017-10-19 09:41:26 -06:00
**Key**: `formatter`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `autopep8`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
**Enum**: `autopep8` `yapf`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-11-20 02:24:36 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
formatter used by pybeautifier (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"python": {
2017-10-19 09:41:26 -06:00
"formatter": "autopep8"
2016-11-20 02:24:36 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Style config](#style-config)
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `python`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `style_config`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `pep8`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-11-20 02:24:36 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
formatting style used by yapf (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"python": {
"style_config": "pep8"
2016-11-20 02:24:36 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Sort imports](#sort-imports)
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `python`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `sort_imports`
2016-11-20 02:24:36 -07:00
**Type**: `boolean`
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-11-20 02:24:36 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
sort imports (requires isort installed) (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"python": {
"sort_imports": false
2016-11-20 02:24:36 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Multi line output](#multi-line-output)
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Namespace**: `python`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Key**: `multi_line_output`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Default**: `Hanging Grid Grouped`
2016-11-20 02:24:36 -07:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
**Enum**: `Grid` `Vertical` `Hanging Indent` `Vertical Hanging Indent` `Hanging Grid` `Hanging Grid Grouped` `NOQA`
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`pybeautifier` ](#pybeautifier )
2016-11-20 02:24:36 -07:00
**Description**:
2017-10-10 08:51:13 -06:00
defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier)
2016-11-20 02:24:36 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"python": {
"multi_line_output": "Hanging Grid Grouped"
2016-11-20 02:24:36 -07:00
}
}
```
2017-10-10 08:51:13 -06:00
### rustfmt
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
##### [Rustfmt path](#rustfmt-path)
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `rust`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `rustfmt_path`
**Type**: `string`
**Supported Beautifiers**: [`rustfmt` ](#rustfmt )
2015-06-08 16:05:03 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
Path to rustfmt program (Supported by rustfmt)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"rust": {
"rustfmt_path": ""
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-09 09:02:52 -06:00
2017-10-10 08:51:13 -06:00
### sqlformat
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `sql`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2015-06-08 16:05:03 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
Indentation size/length (Supported by sqlformat)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"sql": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2017-11-03 08:42:18 -06:00
##### [Reindent](#reindent)
**Namespace**: `sql`
**Key**: `reindent`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
**Description**:
Change indentations of the statements. Uncheck this option to preserve indentation (Supported by sqlformat)
**Example `.jsbeautifyrc` Configuration**
```json
{
"sql": {
"reindent": true
}
}
```
2017-10-10 08:51:13 -06:00
##### [Keywords](#keywords)
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `sql`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `keywords`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Default**: `upper`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Type**: `string`
**Enum**: `unchanged` `lower` `upper` `capitalize`
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2015-06-08 16:05:03 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
Change case of keywords (Supported by sqlformat)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"sql": {
"keywords": "upper"
2015-08-31 16:25:40 -06:00
}
}
```
2017-10-10 08:51:13 -06:00
##### [Identifiers](#identifiers)
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Namespace**: `sql`
2015-08-31 16:25:40 -06:00
2017-10-10 08:51:13 -06:00
**Key**: `identifiers`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Default**: `unchanged`
2015-06-08 16:05:03 -06:00
**Type**: `string`
2017-10-10 08:51:13 -06:00
**Enum**: `unchanged` `lower` `upper` `capitalize`
2015-06-08 16:05:03 -06:00
2017-10-10 08:51:13 -06:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2015-06-08 16:05:03 -06:00
**Description**:
2017-10-10 08:51:13 -06:00
Change case of identifiers (Supported by sqlformat)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2017-10-10 08:51:13 -06:00
"sql": {
"identifiers": "unchanged"
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-09 09:02:52 -06:00