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-04-04 08:00:13 -06:00
##### [Anonymous Analytics](#anonymous-analytics)
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
**Default**: `true`
**Type**: `boolean`
2015-06-01 13:50:09 -06:00
**Description**:
2016-04-04 08:00:13 -06:00
There is [Segment.io ](https://segment.io/ ) which forwards data to [Google Analytics ](http://www.google.com/analytics/ ) to track what languages are being used the most, as well as other stats. Everything is anonymized and no personal information, such as source code, is sent. See https://github.com/Glavin001/atom-beautify/issues/47 for more details.
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-04-04 08:00:13 -06:00
3. Find the option "*Anonymous Analytics*" 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
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-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
2016-03-21 10:46:52 -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": {
"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
**Default**: `4`
**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": {
2015-08-31 16:25:40 -06:00
"indent_size": 4
}
}
```
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-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: |
| `brace_style` | :white_check_mark: | :x: |
| `break_chained_methods` | :white_check_mark: | :x: |
| `end_with_comma` | :white_check_mark: | :x: |
| `end_with_newline` | :white_check_mark: | :x: |
| `eval_code` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :x: |
| `space_after_anon_function` | :white_check_mark: | :x: |
| `space_before_conditional` | :white_check_mark: | :x: |
| `space_in_paren` | :white_check_mark: | :x: |
| `unescape_strings` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :x: |
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
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
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
2016-03-21 10:46:52 -06:00
**Key**: `brace_style`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `collapse`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter)
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": {
"brace_style": "collapse"
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
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
2016-03-21 10:46:52 -06:00
**Key**: `break_chained_methods`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
Break chained method calls across subsequent lines (Supported by Coffee Formatter)
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": {
"break_chained_methods": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with comma](#end-with-comma)
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
2016-03-21 10:46:52 -06:00
**Key**: `end_with_comma`
2015-06-08 15:34:56 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter)
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": {
"end_with_comma": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
2015-09-10 13:05:19 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-09-10 13:05:19 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_newline`
2015-09-10 13:05:19 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-09-10 13:05:19 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
End output with newline (Supported by Coffee Formatter)
2015-09-10 13:05:19 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"end_with_newline": false
2015-09-10 13:05:19 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Eval code](#eval-code)
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `eval_code`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-10-27 19:31:21 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by Coffee Formatter)
2015-10-27 19:31:21 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"eval_code": false
2015-10-27 19:31:21 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-10-27 19:31:21 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-10-27 19:31:21 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Coffee Formatter, coffee-fmt)
2015-10-27 19:31:21 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"indent_char": " "
2015-10-27 19:31:21 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent level](#indent-level)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_level`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
Initial indentation level (Supported by Coffee Formatter)
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": {
"indent_level": 0
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
**Key**: `indent_size`
2015-08-05 09:16:31 -06:00
**Default**: `4`
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-08-05 09:16:31 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by Coffee Formatter, coffee-fmt)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
2015-08-31 16:25:40 -06:00
"indent_size": 4
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_with_tabs`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-08-05 09:16:31 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Jslint happy](#jslint-happy)
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `jslint_happy`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
2015-06-01 15:29:06 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Enable jslint-stricter mode (Supported by Coffee Formatter)
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": {
"jslint_happy": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keep array indentation](#keep-array-indentation)
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_array_indentation`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
2015-06-01 15:29:06 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve array indentation (Supported by Coffee Formatter)
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": {
"keep_array_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keep function indentation](#keep-function-indentation)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_function_indentation`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
(Supported by Coffee Formatter)
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": {
"keep_function_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `max_preserve_newlines`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `10`
2015-06-01 12:52:33 -06:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter)
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": {
"max_preserve_newlines": 10
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**: `js`
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**: [`Coffee Formatter` ](#coffee-formatter )
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 Coffee Formatter)
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": {
"preserve_newlines": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_after_anon_function`
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**: [`Coffee Formatter` ](#coffee-formatter )
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
Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter)
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": {
"space_after_anon_function": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space before conditional](#space-before-conditional)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_before_conditional`
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**: [`Coffee Formatter` ](#coffee-formatter )
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
(Supported by Coffee Formatter)
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": {
"space_before_conditional": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space in paren](#space-in-paren)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_in_paren`
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**: [`Coffee Formatter` ](#coffee-formatter )
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
Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter)
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": {
"space_in_paren": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Unescape strings](#unescape-strings)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `unescape_strings`
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**: [`Coffee Formatter` ](#coffee-formatter )
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
Decode printable characters encoded in xNN notation (Supported by Coffee Formatter)
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": {
"unescape_strings": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-06-01 12:52:33 -06:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
Wrap lines at next opportunity after N characters (Supported by Coffee Formatter)
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": {
"wrap_line_length": 0
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
#### [C++](#c-)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify ) [`clang-format` ](#clang-format )
2015-08-31 16:25:40 -06: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**:
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
Options for language C++
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
2016-03-21 10:46:52 -06:00
Disable C++ 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**: `Uncrustify`
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
2016-03-21 10:46:52 -06:00
**Enum**: `Uncrustify` `clang-format`
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 C++
2015-06-01 12:52:33 -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-06-01 12:52:33 -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**:
2016-03-21 10:46:52 -06:00
Automatically beautify C++ 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
2016-03-21 10:46:52 -06:00
##### [Config Path](#config-path)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `cpp`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `configPath`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#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
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
{
2016-03-21 10:46:52 -06:00
"cpp": {
"configPath": ""
2015-08-31 16:25:40 -06:00
}
}
```
2016-04-08 13:38:07 -06:00
#### [Crystal](#crystal)
2016-07-02 16:28:01 -06:00
**Supported Beautifiers**: [`Crystal` ](#crystal )
2016-04-08 13:38:07 -06:00
2016-07-04 20:42:22 -06:00
| Option | Crystal |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-04-08 13:38:07 -06:00
**Description**:
Options for language Crystal
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Crystal 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.
2016-07-02 16:28:01 -06:00
**Default**: `Crystal`
2016-04-08 13:38:07 -06:00
**Type**: `string`
2016-07-02 16:28:01 -06:00
**Enum**: `Crystal`
2016-04-08 13:38:07 -06:00
**Description**:
Default Beautifier to be used for Crystal
**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 Crystal 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
#### [C#](#c-)
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-09-08 16:47:30 -06: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**:
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
Options for language C#
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**:
2016-03-21 10:46:52 -06:00
Disable C# 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`
**Enum**: `Uncrustify`
**Description**:
Default Beautifier to be used for 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.
##### [Beautify On Save](#beautify-on-save)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
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)
**Namespace**: `cs`
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
{
2016-03-21 10:46:52 -06:00
"cs": {
2015-08-31 16:25:40 -06:00
"configPath": ""
}
}
```
2016-03-21 10:46:52 -06:00
#### [CSS](#css)
2015-06-01 12:52:33 -06:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb ) [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-08-31 16:25:40 -06:00
2016-07-04 20:42:22 -06:00
| Option | CSScomb | JS Beautify | Pretty Diff |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: | :x: |
| `convert_quotes` | :x: | :x: | :white_check_mark: |
| `force_indentation` | :x: | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: | :white_check_mark: |
| `indent_comments` | :x: | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: | :white_check_mark: |
| `no_lead_zero` | :x: | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: | :white_check_mark: |
| `selector_separator_newline` | :x: | :white_check_mark: | :x: |
| `wrap_line_length` | :x: | :white_check_mark: | :white_check_mark: |
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
Options for language CSS
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
2016-03-21 10:46:52 -06:00
Disable CSS 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`
2016-03-21 10:46:52 -06:00
**Enum**: `CSScomb` `JS Beautify` `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
Default Beautifier to be used for CSS
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify CSS 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
2016-03-21 10:46:52 -06:00
##### [Align assignments](#align-assignments)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `align_assignments`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
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
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
{
2016-03-21 10:46:52 -06:00
"css": {
"align_assignments": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [comb custom config file](#comb-custom-config-file)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `configPath`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
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
Path to custom CSScomb config file, used in absense 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
{
2016-03-21 10:46:52 -06:00
"css": {
"configPath": ""
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Convert quotes](#convert-quotes)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `convert_quotes`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `none`
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
2016-03-21 10:46:52 -06:00
**Enum**: `none` `double` `single`
**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
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
{
2016-03-21 10:46:52 -06:00
"css": {
"convert_quotes": "none"
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Force indentation](#force-indentation)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `force_indentation`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
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
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
{
2016-03-21 10:46:52 -06:00
"css": {
"force_indentation": false
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**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**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**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"css": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent comments](#indent-comments)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_comments`
**Default**: `true`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
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
Determines whether comments should be indented. (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
"css": {
"indent_comments": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**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**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"css": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Newline between rules](#newline-between-rules)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `newline_between_rules`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-10-07 17:57:56 -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**:
2016-03-21 10:46:52 -06:00
Add a newline between CSS rules (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
{
2016-03-21 10:46:52 -06:00
"css": {
"newline_between_rules": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [No lead zero](#no-lead-zero)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `no_lead_zero`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
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
If in CSS values leading 0s immediately preceeding a decimal should be removed or prevented. (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
"css": {
"no_lead_zero": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [comb predefined config](#comb-predefined-config)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `predefinedConfig`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**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
2016-03-21 10:46:52 -06:00
**Enum**: `csscomb` `yandex` `zen`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
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
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
{
2016-03-21 10:46:52 -06:00
"css": {
"predefinedConfig": "csscomb"
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**: `css`
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
**Type**: `boolean`
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**:
2016-03-21 10:46:52 -06:00
Retain empty lines. Consecutive empty lines will be converted to a single empty line. (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
{
2016-03-21 10:46:52 -06:00
"css": {
"preserve_newlines": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Selector separator newline](#selector-separator-newline)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `selector_separator_newline`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
Add a newline between multiple selectors (Supported by JS Beautify)
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
"css": {
"selector_separator_newline": false
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**: `css`
2015-08-31 16:25:40 -06:00
**Key**: `wrap_line_length`
2015-06-01 12:52:33 -06:00
**Type**: `integer`
2015-06-09 09:02: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**:
2016-03-21 10:46:52 -06:00
Maximum amount of characters per line (0 = disable) (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
{
2016-03-21 10:46:52 -06:00
"css": {
2015-08-31 16:25:40 -06:00
"wrap_line_length": 0
}
}
```
2016-03-21 10:46:52 -06:00
#### [CSV](#csv)
2015-06-01 12:52:33 -06:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-31 16:25:40 -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: |
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
Options for language CSV
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-08 16:05:03 -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 13:50:09 -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
2016-03-21 10:46:52 -06:00
Disable CSV Beautification
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-09-10 13:08:58 -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-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `Pretty Diff`
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**Enum**: `Pretty Diff`
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
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for CSV
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2016-01-28 05:11:09 -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 "*Default Beautifier*" and change it to your desired configuration.
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-01-28 05:11:09 -07:00
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Automatically beautify CSV files on save
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2016-01-28 05:11:09 -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 "*Beautify On Save*" and change it to your desired configuration.
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
#### [D](#d)
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify ) [`dfmt` ](#dfmt )
2016-01-28 05:11:09 -07:00
2016-07-04 20:42:22 -06: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-03-21 10:46:52 -06:00
**Description**:
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
Options for language D
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2016-01-28 05:11:09 -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-01-28 05:11:09 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Disable D Beautification
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2016-01-28 05:11:09 -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-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `Uncrustify`
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Enum**: `Uncrustify` `dfmt`
2016-01-28 05:11:09 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for D
2016-01-28 05:11:09 -07: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**:
2016-03-21 10:46:52 -06:00
Automatically beautify D 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
2016-03-21 10:46:52 -06:00
##### [Config Path](#config-path)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"d": {
2015-08-31 16:25:40 -06:00
"configPath": ""
}
}
```
2016-03-21 10:46:52 -06:00
#### [EJS](#ejs)
2015-06-01 12:52:33 -06:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-31 16:25:40 -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: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
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
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)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**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 EJS 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**: `Pretty Diff`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `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
Default Beautifier to be used for EJS
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)
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
**Type**: `boolean`
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
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
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `break_chained_methods`
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
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
{
2016-03-21 10:46:52 -06:00
"js": {
"break_chained_methods": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with comma](#end-with-comma)
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_comma`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-01-13 09:05:57 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)
2016-01-13 09:05:57 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"end_with_comma": false
2016-01-13 09:05:57 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
**Default**: ` `
2016-01-13 09:05:57 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-01-13 09:05:57 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Pretty Diff)
2016-01-13 09:05:57 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"html": {
"indent_char": " "
2016-01-13 09:05:57 -07: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-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -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
"html": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-04-23 11:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
}
}
```
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**: `html`
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
"html": {
"preserve_newlines": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_after_anon_function`
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
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
{
2016-03-21 10:46:52 -06:00
"js": {
"space_after_anon_function": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2015-12-10 18:40:30 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-12-10 18:40:30 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-12-10 18:40:30 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2015-12-10 18:40:30 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-12-10 18:40:30 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Maximum characters per line (0 disables) (Supported by Pretty Diff)
2015-12-10 18:40:30 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"html": {
"wrap_line_length": 250
2015-12-10 18:40:30 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
#### [Elm](#elm)
2015-06-10 10:57:47 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`elm-format` ](#elm-format )
2015-08-31 16:25:40 -06:00
2016-07-04 20:42:22 -06: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**:
2015-06-10 10:57:47 -06:00
2016-03-21 10:46:52 -06:00
Options for language Elm
2015-06-10 10:57:47 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-06-10 10:57:47 -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-06-10 10:57:47 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Disable Elm Beautification
2015-06-10 16:20:08 -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-11-22 18:52:31 -07:00
2016-03-21 10:46:52 -06:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2015-11-22 18:52:31 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `elm-format`
2015-11-22 18:52:31 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `elm-format`
2015-11-22 18:52:31 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Elm
2015-11-22 18:52:31 -07:00
2016-03-21 10:46:52 -06:00
**How to Configure**
2015-11-22 18:52:31 -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 "*Default Beautifier*" and change it to your desired configuration.
2015-11-22 18:52:31 -07:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-06-10 16:20:08 -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
**Type**: `boolean`
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
Automatically beautify Elm 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.
#### [ERB](#erb)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`HTML Beautifier` ](#html-beautifier ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| 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-03-21 10:46:52 -06:00
**Description**:
Options for language ERB
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable ERB 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`
2015-06-10 16:20:08 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `HTML Beautifier` `Pretty Diff`
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
Default Beautifier to be used for ERB
**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`
2015-06-10 16:20:08 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Automatically beautify ERB files on save
2015-06-10 10:57:47 -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
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-06-06 10:45:56 -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**: `indent_char`
**Default**: ` `
2015-06-06 10:45:56 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2015-06-06 10:45:56 -06:00
**Description**:
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
"html": {
"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**: `html`
2015-08-31 16:25:40 -06:00
**Key**: `indent_size`
2015-06-01 12:52:33 -06:00
**Default**: `4`
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`HTML Beautifier` ](#html-beautifier ) [`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 HTML Beautifier, 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
"html": {
2015-08-31 16:25:40 -06:00
"indent_size": 4
}
}
```
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**: `html`
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
"html": {
"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**: `html`
2015-06-01 12:52:33 -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`
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
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
"html": {
"wrap_line_length": 250
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
#### [Erlang](#erlang)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`erl_tidy` ](#erl_tidy )
2015-06-08 16:05:03 -06:00
2016-07-04 20:42:22 -06:00
| Option | erl_tidy |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language Erlang
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Disable Beautifying Language](#disable-beautifying-language)
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
Disable Erlang 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**: `erl_tidy`
2016-02-20 14:02:43 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `erl_tidy`
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Erlang
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 Erlang 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.
#### [Fortran](#fortran)
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2016-07-04 20:42:22 -06: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
**Description**:
Options for language Fortran
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 08:56:11 -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 08:56:11 -06:00
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Disable Fortran Beautification
2015-08-05 08:56:11 -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 08:56:11 -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 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `Fortran Beautifier`
2015-08-05 08:56:11 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `Fortran Beautifier`
2015-08-05 08:56:11 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Fortran
2015-08-05 08:56:11 -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 08:56:11 -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 08:56:11 -06:00
**Type**: `boolean`
**Description**:
2016-03-21 10:46:52 -06:00
Automatically beautify Fortran files on save
2015-08-05 08:56:11 -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
##### [Emacs path](#emacs-path)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `fortran`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `emacs_path`
**Type**: `string`
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to the `emacs` executable (Supported by Fortran Beautifier)
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
{
"fortran": {
"emacs_path": ""
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Emacs script path](#emacs-script-path)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `fortran`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `emacs_script_path`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to the emacs script (Supported by Fortran Beautifier)
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
{
"fortran": {
"emacs_script_path": ""
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
#### [gherkin](#gherkin)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
2015-06-01 12:52:33 -06:00
2016-07-04 20:42:22 -06: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: |
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language gherkin
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**:
2016-03-21 10:46:52 -06:00
Disable gherkin 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
2016-03-21 10:46:52 -06:00
**Default**: `Gherkin formatter`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `Gherkin formatter`
2015-06-01 12:52:33 -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 gherkin
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify gherkin 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
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**: `gherkin`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
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
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Gherkin formatter)
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
{
"gherkin": {
"indent_char": " "
}
}
```
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**: `gherkin`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-09 09:02:52 -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**: [`Gherkin formatter` ](#gherkin-formatter )
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 size/length (Supported by Gherkin formatter)
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
{
"gherkin": {
"indent_size": 4
}
}
```
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
#### [Go](#go)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`gofmt` ](#gofmt )
2015-08-31 16:25:40 -06:00
2016-07-04 20:42:22 -06:00
| Option | gofmt |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
Options for language Go
##### [Disable Beautifying Language](#disable-beautifying-language)
2015-12-18 11:30:07 -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
Disable Go Beautification
2015-12-18 11:30:07 -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.
2015-12-18 11:30:07 -07:00
2016-03-21 10:46:52 -06:00
##### [Default Beautifier](#default-beautifier)
2015-12-18 11:30:07 -07:00
**Important**: This option is only configurable from within Atom Beautify's setting panel.
2016-03-21 10:46:52 -06:00
**Default**: `gofmt`
2015-12-18 11:30:07 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `gofmt`
2015-12-18 11:30:07 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Go
2015-12-18 11:30:07 -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.
2015-12-18 11:30:07 -07:00
2016-03-21 10:46:52 -06:00
##### [Beautify On Save](#beautify-on-save)
2015-12-18 11:30:07 -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 Go files on save
2015-12-18 11:30:07 -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.
#### [Handlebars](#handlebars)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-12-18 11:30:07 -07:00
2016-07-04 20:42:22 -06: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-03-21 10:46:52 -06:00
**Description**:
Options for language Handlebars
##### [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**:
2016-03-21 10:46:52 -06:00
Disable Handlebars 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
2016-03-21 10:46:52 -06:00
**Default**: `JS Beautify`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-04-16 13:15:14 -06:00
**Enum**: `JS Beautify` `Pretty Diff`
2015-06-01 12:52:33 -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 Handlebars
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify Handlebars 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
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
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**: `brace_style`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `collapse`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Enum**: `collapse` `expand` `end-expand` `none`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
[collapse|expand|end-expand|none] (Supported by JS Beautify)
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": {
"brace_style": "collapse"
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
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**: `end_with_newline`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
End output with newline (Supported by JS Beautify)
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": {
"end_with_newline": false
}
}
```
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
##### [Extra liners](#extra-liners)
2015-06-09 09:02:52 -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**: `extra_liners`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `head,body,/html`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `array`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify)
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -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 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-04-16 13:15:14 -06:00
Indentation character (Supported by JS Beautify, 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": {
"indent_char": " "
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent inner html](#indent-inner-html)
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_inner_html`
2015-06-01 12:52:33 -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
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-09 09:02:52 -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
Indent < head > and < body > sections. (Supported by JS 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
{
"html": {
"indent_inner_html": false
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent scripts](#indent-scripts)
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_scripts`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `normal`
2015-08-31 16:25:40 -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
**Enum**: `keep` `separate` `normal`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
[keep|separate|normal] (Supported by JS Beautify)
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": {
"indent_scripts": "normal"
}
}
```
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-09 09:02:52 -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**: `indent_size`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-04-16 13:15:14 -06:00
Indentation size/length (Supported by JS Beautify, 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": {
"indent_size": 4
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `max_preserve_newlines`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `10`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"max_preserve_newlines": 10
}
}
```
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
##### [Preserve newlines](#preserve-newlines)
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `preserve_newlines`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-12-10 20:04:11 -07:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-12-10 20:04:11 -07:00
2016-04-16 13:15:14 -06:00
Preserve line-breaks (Supported by JS Beautify, Pretty Diff)
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"preserve_newlines": true
}
}
```
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
##### [Unformatted](#unformatted)
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `unformatted`
2015-12-10 20:04:11 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `a,span,img,bdo,em,strong,dfn,code,samp,kbd,var,cite,abbr,acronym,q,sub,sup,tt,i,b,big,small,u,s,strike,font,ins,del,pre,address,dt,h1,h2,h3,h4,h5,h6`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `array`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
List of tags (defaults to inline) that should not be reformatted (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
{
"html": {
"unformatted": [
"a",
"span",
"img",
"bdo",
"em",
"strong",
"dfn",
"code",
"samp",
"kbd",
"var",
"cite",
"abbr",
"acronym",
"q",
"sub",
"sup",
"tt",
"i",
"b",
"big",
"small",
"u",
"s",
"strike",
"font",
"ins",
"del",
"pre",
"address",
"dt",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Wrap attributes](#wrap-attributes)
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**: `wrap_attributes`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `auto`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Enum**: `auto` `force`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
Wrap attributes to new lines [auto|force] (Supported by JS Beautify)
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": {
"wrap_attributes": "auto"
}
}
```
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2015-06-09 09:02:52 -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**: `wrap_attributes_indent_size`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Indent wrapped attributes to after N characters (Supported by JS Beautify)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"wrap_attributes_indent_size": 4
}
}
```
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2016-02-20 14:02:43 -07:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`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-04-16 13:15:14 -06:00
Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"wrap_line_length": 250
}
}
```
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
#### [Haskell](#haskell)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`stylish-haskell` ](#stylish-haskell )
2016-02-20 14:02:43 -07:00
2016-07-04 20:42:22 -06:00
| Option | stylish-haskell |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language Haskell
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**:
2016-03-21 10:46:52 -06:00
Disable Haskell 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**: `stylish-haskell`
2015-08-05 09:16:31 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `stylish-haskell`
2015-08-05 09:16:31 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Haskell
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify Haskell 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.
#### [HTML](#html)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06: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-03-21 10:46:52 -06:00
**Description**:
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
Options for language HTML
##### [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**:
2016-03-21 10:46:52 -06:00
Disable HTML 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
2016-03-21 10:46:52 -06:00
**Default**: `JS Beautify`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `JS Beautify` `Pretty Diff`
2015-06-01 12:52:33 -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 HTML
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify HTML 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
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `brace_style`
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `collapse`
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Enum**: `collapse` `expand` `end-expand` `none`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
[collapse|expand|end-expand|none] (Supported by JS Beautify)
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"brace_style": "collapse"
}
}
```
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_newline`
2015-06-09 09:02:52 -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
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
End output with newline (Supported by JS Beautify)
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"end_with_newline": false
}
}
```
2015-06-01 15:29:06 -06:00
2016-03-21 10:46:52 -06:00
##### [Extra liners](#extra-liners)
2015-06-09 09:02:52 -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**: `extra_liners`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `head,body,/html`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `array`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
}
}
```
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`
**Default**: ` `
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by JS Beautify, Pretty Diff)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**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,span,img,bdo,em,strong,dfn,code,samp,kbd,var,cite,abbr,acronym,q,sub,sup,tt,i,b,big,small,u,s,strike,font,ins,del,pre,address,dt,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",
"span",
"img",
"bdo",
"em",
"strong",
"dfn",
"code",
"samp",
"kbd",
"var",
"cite",
"abbr",
"acronym",
"q",
"sub",
"sup",
"tt",
"i",
"b",
"big",
"small",
"u",
"s",
"strike",
"font",
"ins",
"del",
"pre",
"address",
"dt",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
}
}
```
##### [Wrap attributes](#wrap-attributes)
**Namespace**: `html`
**Key**: `wrap_attributes`
**Default**: `auto`
**Type**: `string`
**Enum**: `auto` `force`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Wrap attributes to new lines [auto|force] (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
}
}
```
2016-04-01 07:40:26 -06:00
#### [Jade](#jade)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2016-04-01 07:40:26 -06:00
2016-07-04 20:42:22 -06: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-04-01 07:40:26 -06:00
**Description**:
Options for language Jade
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Jade 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**: `Pug Beautify`
**Type**: `string`
**Enum**: `Pug Beautify`
**Description**:
Default Beautifier to be used for Jade
**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 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.
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
**Description**:
Indentation character (Supported by Pug Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_char": " "
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `html`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
**Description**:
Indentation size/length (Supported by Pug Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_size": 4
}
}
```
2016-03-21 10:46:52 -06:00
#### [Java](#java)
**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: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Java
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Java Beautification
**How to Configure**
1. You can open the [Settings View ](https://github.com/atom/settings-view ) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)* , or *File > Preferences (Windows)* .
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
##### [Default Beautifier](#default-beautifier)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Default**: `Uncrustify`
**Type**: `string`
**Enum**: `Uncrustify`
**Description**:
Default Beautifier to be used for Java
**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 Java 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)
**Namespace**: `java`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
**Description**:
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"java": {
"configPath": ""
}
}
```
#### [JavaScript](#javascript)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`JSCS Fixer` ](#jscs-fixer ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| Option | JS Beautify | JSCS Fixer | Pretty Diff |
| --- | --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| `brace_style` | :white_check_mark: | :x: | :x: |
| `break_chained_methods` | :white_check_mark: | :x: | :white_check_mark: |
| `end_with_comma` | :white_check_mark: | :x: | :white_check_mark: |
| `end_with_newline` | :white_check_mark: | :x: | :x: |
| `eval_code` | :white_check_mark: | :x: | :x: |
| `indent_char` | :white_check_mark: | :x: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: | :x: |
| `indent_size` | :white_check_mark: | :x: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :x: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: | :x: |
| `preserve_newlines` | :white_check_mark: | :x: | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: | :x: | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: | :x: | :x: |
| `space_in_paren` | :white_check_mark: | :x: | :x: |
| `unescape_strings` | :white_check_mark: | :x: | :x: |
| `wrap_line_length` | :white_check_mark: | :x: | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language JavaScript
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable JavaScript 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**: `JS Beautify` `JSCS Fixer` `Pretty Diff`
**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`
**Description**:
Automatically beautify JavaScript files on save
**How to Configure**
1. You can open the [Settings View ](https://github.com/atom/settings-view ) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)* , or *File > Preferences (Windows)* .
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
##### [Brace style](#brace-style)
**Namespace**: `js`
**Key**: `brace_style`
**Default**: `collapse`
**Type**: `string`
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"brace_style": "collapse"
}
}
```
##### [Break chained methods](#break-chained-methods)
**Namespace**: `js`
**Key**: `break_chained_methods`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"break_chained_methods": false
}
}
```
##### [End with comma](#end-with-comma)
**Namespace**: `js`
**Key**: `end_with_comma`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"end_with_comma": false
}
}
```
##### [End with newline](#end-with-newline)
**Namespace**: `js`
**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
{
"js": {
"end_with_newline": false
}
}
```
##### [Eval code](#eval-code)
**Namespace**: `js`
**Key**: `eval_code`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
(Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"eval_code": false
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `js`
**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
{
"js": {
"indent_char": " "
}
}
```
##### [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 size](#indent-size)
**Namespace**: `js`
**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
{
"js": {
"indent_size": 4
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
2016-04-23 11:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2016-04-23 11:46:52 -06:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
}
}
```
##### [Jslint happy](#jslint-happy)
**Namespace**: `js`
**Key**: `jslint_happy`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Enable jslint-stricter mode (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"jslint_happy": false
}
}
```
##### [Keep array indentation](#keep-array-indentation)
**Namespace**: `js`
**Key**: `keep_array_indentation`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Preserve array indentation (Supported by JS Beautify)
**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**: [`JS Beautify` ](#js-beautify )
**Description**:
(Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"keep_function_indentation": false
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
**Namespace**: `js`
**Key**: `max_preserve_newlines`
**Default**: `10`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"max_preserve_newlines": 10
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `js`
**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
{
"js": {
"preserve_newlines": true
}
}
```
##### [Space after anon function](#space-after-anon-function)
**Namespace**: `js`
**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
}
}
```
##### [Space before conditional](#space-before-conditional)
**Namespace**: `js`
**Key**: `space_before_conditional`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
(Supported by JS Beautify)
**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**: [`JS Beautify` ](#js-beautify )
**Description**:
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"space_in_paren": false
}
}
```
##### [Unescape strings](#unescape-strings)
**Namespace**: `js`
**Key**: `unescape_strings`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"unescape_strings": false
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `js`
**Key**: `wrap_line_length`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"wrap_line_length": 0
}
}
```
#### [JSON](#json)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06: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_with_comma` | :white_check_mark: | :white_check_mark: |
| `end_with_newline` | :white_check_mark: | :x: |
| `eval_code` | :white_check_mark: | :x: |
| `indent_char` | :white_check_mark: | :white_check_mark: |
| `indent_level` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: | :white_check_mark: |
| `jslint_happy` | :white_check_mark: | :x: |
| `keep_array_indentation` | :white_check_mark: | :x: |
| `keep_function_indentation` | :white_check_mark: | :x: |
| `max_preserve_newlines` | :white_check_mark: | :x: |
| `preserve_newlines` | :white_check_mark: | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: | :x: |
| `space_in_paren` | :white_check_mark: | :x: |
| `unescape_strings` | :white_check_mark: | :x: |
| `wrap_line_length` | :white_check_mark: | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language JSON
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable JSON 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**: `JS Beautify` `Pretty Diff`
**Description**:
Default Beautifier to be used for JSON
**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 JSON files on save
**How to Configure**
1. You can open the [Settings View ](https://github.com/atom/settings-view ) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)* , or *File > Preferences (Windows)* .
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
##### [Brace style](#brace-style)
**Namespace**: `js`
**Key**: `brace_style`
**Default**: `collapse`
**Type**: `string`
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"brace_style": "collapse"
}
}
```
##### [Break chained methods](#break-chained-methods)
**Namespace**: `js`
**Key**: `break_chained_methods`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"break_chained_methods": false
}
}
```
##### [End with comma](#end-with-comma)
**Namespace**: `js`
**Key**: `end_with_comma`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"end_with_comma": false
}
}
```
##### [End with newline](#end-with-newline)
**Namespace**: `js`
**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
{
"js": {
"end_with_newline": false
}
}
```
##### [Eval code](#eval-code)
**Namespace**: `js`
**Key**: `eval_code`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
(Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"eval_code": false
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `js`
**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
{
"js": {
"indent_char": " "
}
}
```
##### [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 size](#indent-size)
**Namespace**: `js`
**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
{
"js": {
"indent_size": 4
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
2016-04-23 11:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
**Description**:
2016-04-23 11:46:52 -06:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by JS Beautify, Pretty Diff)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
}
}
```
##### [Jslint happy](#jslint-happy)
**Namespace**: `js`
**Key**: `jslint_happy`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Enable jslint-stricter mode (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"jslint_happy": false
}
}
```
##### [Keep array indentation](#keep-array-indentation)
**Namespace**: `js`
**Key**: `keep_array_indentation`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Preserve array indentation (Supported by JS Beautify)
**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**: [`JS Beautify` ](#js-beautify )
**Description**:
(Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"keep_function_indentation": false
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
**Namespace**: `js`
**Key**: `max_preserve_newlines`
**Default**: `10`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"max_preserve_newlines": 10
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `js`
**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
{
"js": {
"preserve_newlines": true
}
}
```
##### [Space after anon function](#space-after-anon-function)
**Namespace**: `js`
**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
}
}
```
##### [Space before conditional](#space-before-conditional)
**Namespace**: `js`
**Key**: `space_before_conditional`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
(Supported by JS Beautify)
**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**: [`JS Beautify` ](#js-beautify )
**Description**:
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"space_in_paren": false
}
}
```
##### [Unescape strings](#unescape-strings)
**Namespace**: `js`
**Key**: `unescape_strings`
**Type**: `boolean`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"unescape_strings": false
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `js`
**Key**: `wrap_line_length`
**Type**: `integer`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"wrap_line_length": 0
}
}
```
#### [JSX](#jsx)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -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: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language JSX
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable JSX 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 JSX
**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 JSX files on save
**How to Configure**
1. You can open the [Settings View ](https://github.com/atom/settings-view ) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)* , or *File > Preferences (Windows)* .
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
##### [Break chained methods](#break-chained-methods)
**Namespace**: `js`
**Key**: `break_chained_methods`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Break chained method calls across subsequent lines (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"break_chained_methods": false
}
}
```
##### [End with comma](#end-with-comma)
**Namespace**: `js`
**Key**: `end_with_comma`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"end_with_comma": false
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `js`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_char": " "
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `js`
**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
{
"js": {
"indent_size": 4
}
}
```
2016-04-23 11:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
}
}
```
2016-03-21 10:46:52 -06:00
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `js`
**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
{
"js": {
"preserve_newlines": true
}
}
```
##### [Space after anon function](#space-after-anon-function)
**Namespace**: `js`
**Key**: `space_after_anon_function`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"space_after_anon_function": false
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `js`
**Key**: `wrap_line_length`
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Wrap lines at next opportunity after N characters (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"wrap_line_length": 0
}
}
```
2016-03-29 11:41:43 -06:00
#### [LaTeX](#latex)
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-07-04 20:42:22 -06: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-03-29 11:41:43 -06:00
**Description**:
Options for language LaTeX
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable LaTeX 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**: `Latex Beautify`
**Type**: `string`
**Enum**: `Latex Beautify`
**Description**:
Default Beautifier to be used for LaTeX
**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 LaTeX 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 columns in environments](#align-columns-in-environments)
**Namespace**: `latex`
**Key**: `align_columns_in_environments`
**Default**: `tabular,matrix,bmatrix,pmatrix`
**Type**: `array`
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
**Description**:
undefined (Supported by Latex Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"align_columns_in_environments": [
"tabular",
"matrix",
"bmatrix",
"pmatrix"
]
}
}
```
##### [Always look for split braces](#always-look-for-split-braces)
**Namespace**: `latex`
**Key**: `always_look_for_split_braces`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
**Description**:
If `latexindent` should look for commands that split braces across lines (Supported by Latex Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"always_look_for_split_braces": true
}
}
```
##### [Always look for split brackets](#always-look-for-split-brackets)
**Namespace**: `latex`
**Key**: `always_look_for_split_brackets`
**Type**: `boolean`
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
**Description**:
If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"always_look_for_split_brackets": false
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `latex`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
**Description**:
Indentation character (Supported by Latex Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"indent_char": " "
}
}
```
##### [Indent preamble](#indent-preamble)
**Namespace**: `latex`
**Key**: `indent_preamble`
**Type**: `boolean`
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
**Description**:
Indent the preable (Supported by Latex Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"indent_preamble": false
}
}
```
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `latex`
**Key**: `indent_with_tabs`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"indent_with_tabs": true
}
}
```
##### [Remove trailing whitespace](#remove-trailing-whitespace)
**Namespace**: `latex`
**Key**: `remove_trailing_whitespace`
**Type**: `boolean`
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
**Description**:
Remove trailing whitespace (Supported by Latex Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"latex": {
"remove_trailing_whitespace": false
}
}
```
2016-03-21 10:46:52 -06:00
#### [LESS](#less)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| Option | CSScomb | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
| `convert_quotes` | :x: | :white_check_mark: |
| `force_indentation` | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_comments` | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: |
| `no_lead_zero` | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language LESS
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable LESS 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**: `CSScomb` `Pretty Diff`
**Description**:
Default Beautifier to be used for LESS
**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 LESS 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`
**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**:
Path to custom CSScomb config file, used in absense of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb)
**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`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_char": " "
}
}
```
##### [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`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation size/length (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_size": 4
}
}
```
##### [Newline between rules](#newline-between-rules)
**Namespace**: `css`
**Key**: `newline_between_rules`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Add a newline between CSS rules (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"newline_between_rules": false
}
}
```
##### [No lead zero](#no-lead-zero)
**Namespace**: `css`
**Key**: `no_lead_zero`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
If in CSS values leading 0s immediately preceeding 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`
**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
}
}
```
2016-06-24 12:30:54 -06:00
#### [Lua](#lua)
2016-07-02 16:28:01 -06:00
**Supported Beautifiers**: [`Lua beautifier` ](#lua-beautifier )
2016-06-24 12:30:54 -06:00
2016-07-04 20:42:22 -06:00
| Option | Lua beautifier |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-06-24 12:30:54 -06:00
**Description**:
Options for language Lua
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Lua 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.
2016-07-02 16:28:01 -06:00
**Default**: `Lua beautifier`
2016-06-24 12:30:54 -06:00
**Type**: `string`
2016-07-02 16:28:01 -06:00
**Enum**: `Lua beautifier`
2016-06-24 12:30:54 -06:00
**Description**:
Default Beautifier to be used for Lua
**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 Lua 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
#### [Markdown](#markdown)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Remark` ](#remark ) [`Tidy Markdown` ](#tidy-markdown )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| Option | Remark | Tidy Markdown |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `commonmark` | :white_check_mark: | :x: |
| `gfm` | :white_check_mark: | :x: |
| `yaml` | :white_check_mark: | :x: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Markdown
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
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.
**Default**: `Tidy Markdown`
**Type**: `string`
**Enum**: `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)
**Example `.jsbeautifyrc` Configuration**
```json
{
"markdown": {
"commonmark": false
}
}
```
##### [Gfm](#gfm)
**Namespace**: `markdown`
**Key**: `gfm`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Remark` ](#remark )
**Description**:
GitHub Flavoured Markdown (Supported by Remark)
**Example `.jsbeautifyrc` Configuration**
```json
{
"markdown": {
"gfm": true
}
}
```
##### [Yaml](#yaml)
**Namespace**: `markdown`
**Key**: `yaml`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Remark` ](#remark )
**Description**:
Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark)
**Example `.jsbeautifyrc` Configuration**
```json
{
"markdown": {
"yaml": true
}
}
```
#### [Marko](#marko)
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| Option | Marko Beautifier |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `brace_style` | :white_check_mark: |
| `end_with_newline` | :white_check_mark: |
| `extra_liners` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: |
| `indent_scripts` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `syntax` | :white_check_mark: |
| `unformatted` | :white_check_mark: |
| `wrap_attributes` | :white_check_mark: |
| `wrap_attributes_indent_size` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Marko
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Marko 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.
2016-06-24 12:30:54 -06:00
**Default**: `Marko Beautifier`
2016-03-21 10:46:52 -06:00
**Type**: `string`
2016-06-24 12:30:54 -06:00
**Enum**: `Marko Beautifier`
2016-03-21 10:46:52 -06:00
**Description**:
Default Beautifier to be used for Marko
**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 Marko files on save
**How to Configure**
1. You can open the [Settings View ](https://github.com/atom/settings-view ) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)* , or *File > Preferences (Windows)* .
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
##### [Brace style](#brace-style)
**Namespace**: `html`
**Key**: `brace_style`
**Default**: `collapse`
**Type**: `string`
**Enum**: `collapse` `expand` `end-expand` `none`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
[collapse|expand|end-expand|none] (Supported by Marko Beautifier)
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`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
End output with newline (Supported by Marko Beautifier)
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`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06: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
{
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
Indentation character (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_char": " "
}
}
```
##### [Indent inner html](#indent-inner-html)
**Namespace**: `html`
**Key**: `indent_inner_html`
**Type**: `boolean`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
Indent < head > and < body > sections. (Supported by Marko Beautifier)
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`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
[keep|separate|normal] (Supported by Marko Beautifier)
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`
**Default**: `4`
**Type**: `integer`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
Indentation size/length (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_size": 4
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
**Namespace**: `html`
**Key**: `max_preserve_newlines`
**Default**: `10`
**Type**: `integer`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06: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": {
"max_preserve_newlines": 10
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `html`
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
Preserve line-breaks (Supported by Marko Beautifier)
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"preserve_newlines": true
}
}
```
2016-06-24 12:30:54 -06:00
##### [Syntax](#syntax)
**Namespace**: `marko`
**Key**: `syntax`
**Default**: `html`
**Type**: `string`
**Enum**: `html` `concise`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
[html|concise] (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"marko": {
"syntax": "html"
}
}
```
2016-03-21 10:46:52 -06:00
##### [Unformatted](#unformatted)
**Namespace**: `html`
**Key**: `unformatted`
**Default**: `a,span,img,bdo,em,strong,dfn,code,samp,kbd,var,cite,abbr,acronym,q,sub,sup,tt,i,b,big,small,u,s,strike,font,ins,del,pre,address,dt,h1,h2,h3,h4,h5,h6`
**Type**: `array`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06: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": {
"unformatted": [
"a",
"span",
"img",
"bdo",
"em",
"strong",
"dfn",
"code",
"samp",
"kbd",
"var",
"cite",
"abbr",
"acronym",
"q",
"sub",
"sup",
"tt",
"i",
"b",
"big",
"small",
"u",
"s",
"strike",
"font",
"ins",
"del",
"pre",
"address",
"dt",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
}
}
```
##### [Wrap attributes](#wrap-attributes)
**Namespace**: `html`
**Key**: `wrap_attributes`
**Default**: `auto`
**Type**: `string`
**Enum**: `auto` `force`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06:00
Wrap attributes to new lines [auto|force] (Supported by Marko Beautifier)
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`
**Default**: `4`
**Type**: `integer`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06: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": {
"wrap_attributes_indent_size": 4
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `html`
**Key**: `wrap_line_length`
**Default**: `250`
**Type**: `integer`
2016-06-24 12:30:54 -06:00
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
2016-03-21 10:46:52 -06:00
**Description**:
2016-06-24 12:30:54 -06: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
}
}
```
#### [Mustache](#mustache)
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-07-04 20:42:22 -06:00
| Option | JS Beautify |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `brace_style` | :white_check_mark: |
| `end_with_newline` | :white_check_mark: |
| `extra_liners` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_inner_html` | :white_check_mark: |
| `indent_scripts` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `unformatted` | :white_check_mark: |
| `wrap_attributes` | :white_check_mark: |
| `wrap_attributes_indent_size` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Mustache
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Mustache 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**: `JS Beautify`
**Description**:
Default Beautifier to be used for Mustache
**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 Mustache files on save
**How to Configure**
1. You can open the [Settings View ](https://github.com/atom/settings-view ) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)* , or *File > Preferences (Windows)* .
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Beautify On Save*" and change it to your desired configuration.
##### [Brace style](#brace-style)
**Namespace**: `html`
**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 )
**Description**:
Indentation character (Supported by JS Beautify)
**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 )
**Description**:
Indentation size/length (Supported by JS Beautify)
**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 )
**Description**:
Preserve line-breaks (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"preserve_newlines": true
}
}
```
##### [Unformatted](#unformatted)
**Namespace**: `html`
**Key**: `unformatted`
**Default**: `a,span,img,bdo,em,strong,dfn,code,samp,kbd,var,cite,abbr,acronym,q,sub,sup,tt,i,b,big,small,u,s,strike,font,ins,del,pre,address,dt,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",
"span",
"img",
"bdo",
"em",
"strong",
"dfn",
"code",
"samp",
"kbd",
"var",
"cite",
"abbr",
"acronym",
"q",
"sub",
"sup",
"tt",
"i",
"b",
"big",
"small",
"u",
"s",
"strike",
"font",
"ins",
"del",
"pre",
"address",
"dt",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
}
}
```
##### [Wrap attributes](#wrap-attributes)
**Namespace**: `html`
**Key**: `wrap_attributes`
**Default**: `auto`
**Type**: `string`
**Enum**: `auto` `force`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
**Description**:
Wrap attributes to new lines [auto|force] (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 )
**Description**:
Maximum characters per line (0 disables) (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_line_length": 250
}
}
```
#### [Objective-C](#objective-c)
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify ) [`clang-format` ](#clang-format )
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**:
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.
##### [Beautify On Save](#beautify-on-save)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Automatically beautify Objective-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)
**Namespace**: `objectivec`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
**Description**:
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"objectivec": {
"configPath": ""
}
}
```
2016-04-23 20:27:10 -06:00
#### [OCaml](#ocaml)
**Supported Beautifiers**: [`ocp-indent` ](#ocp-indent )
2016-07-04 20:42:22 -06:00
| Option | ocp-indent |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-04-23 20:27:10 -06:00
**Description**:
Options for language OCaml
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable OCaml 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**: `ocp-indent`
**Type**: `string`
**Enum**: `ocp-indent`
**Description**:
Default Beautifier to be used for OCaml
**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 OCaml 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
#### [Pawn](#pawn)
**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: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Pawn
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Pawn Beautification
**How to Configure**
1. You can open the [Settings View ](https://github.com/atom/settings-view ) by navigating to
*Edit > Preferences (Linux)*, *Atom > Preferences (OS X)* , or *File > Preferences (Windows)* .
2. Go into *Packages* and search for "*Atom Beautify*" package.
3. Find the option "*Disable Beautifying Language*" and change it to your desired configuration.
##### [Default Beautifier](#default-beautifier)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Default**: `Uncrustify`
**Type**: `string`
**Enum**: `Uncrustify`
**Description**:
Default Beautifier to be used for Pawn
**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 Pawn 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)
**Namespace**: `pawn`
**Key**: `configPath`
**Type**: `string`
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
**Description**:
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"pawn": {
"configPath": ""
}
}
```
#### [Perl](#perl)
**Supported Beautifiers**: [`Perltidy` ](#perltidy )
2016-07-04 20:42:22 -06:00
| Option | Perltidy |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `perltidy_profile` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Perl
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Perl 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**: `Perltidy`
**Type**: `string`
**Enum**: `Perltidy`
**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`
**Description**:
Automatically beautify Perl 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.
##### [Perltidy profile](#perltidy-profile)
**Namespace**: `perl`
**Key**: `perltidy_profile`
**Type**: `string`
**Supported Beautifiers**: [`Perltidy` ](#perltidy )
**Description**:
Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy)
**Example `.jsbeautifyrc` Configuration**
```json
{
"perl": {
"perltidy_profile": ""
}
}
```
#### [PHP](#php)
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer ) [`PHPCBF` ](#phpcbf )
2016-07-04 20:42:22 -06:00
| Option | PHP-CS-Fixer | PHPCBF |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `cs_fixer_path` | :white_check_mark: | :x: |
| `fixers` | :white_check_mark: | :x: |
| `level` | :white_check_mark: | :x: |
| `phpcbf_path` | :white_check_mark: | :x: |
| `standard` | :white_check_mark: | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language PHP
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable PHP 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**: `PHP-CS-Fixer`
**Type**: `string`
**Enum**: `PHP-CS-Fixer` `PHPCBF`
**Description**:
Default Beautifier to be used for PHP
**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 PHP 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.
##### [PHP-CS-Fixer Path](#php-cs-fixer-path)
**Namespace**: `php`
**Key**: `cs_fixer_path`
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
**Description**:
Path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer)
**Example `.jsbeautifyrc` Configuration**
```json
{
"php": {
"cs_fixer_path": ""
}
}
```
##### [Fixers](#fixers)
**Namespace**: `php`
**Key**: `fixers`
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
**Description**:
Add fixer(s). i.e. linefeed,-short_tag,indentation (Supported by PHP-CS-Fixer)
**Example `.jsbeautifyrc` Configuration**
```json
{
"php": {
"fixers": ""
}
}
```
##### [Level](#level)
**Namespace**: `php`
**Key**: `level`
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
**Description**:
By default, all PSR-2 fixers and some additional ones are run. (Supported by PHP-CS-Fixer)
**Example `.jsbeautifyrc` Configuration**
```json
{
"php": {
"level": ""
}
}
```
##### [PHPCBF Path](#phpcbf-path)
**Namespace**: `php`
**Key**: `phpcbf_path`
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
**Description**:
Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)
**Example `.jsbeautifyrc` Configuration**
```json
{
"php": {
"phpcbf_path": ""
}
}
```
##### [PHPCBF Standard](#phpcbf-standard)
**Namespace**: `php`
**Key**: `standard`
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer ) [`PHPCBF` ](#phpcbf )
**Description**:
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules (Supported by PHP-CS-Fixer, PHPCBF)
**Example `.jsbeautifyrc` Configuration**
```json
{
"php": {
"standard": ""
}
}
```
#### [Puppet](#puppet)
**Supported Beautifiers**: [`puppet-lint` ](#puppet-lint )
2016-07-04 20:42:22 -06:00
| Option | puppet-lint |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Puppet
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Puppet 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**: `puppet-lint`
**Type**: `string`
**Enum**: `puppet-lint`
**Description**:
Default Beautifier to be used for Puppet
**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 Puppet 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.
#### [Python](#python)
**Supported Beautifiers**: [`autopep8` ](#autopep8 ) [`yapf` ](#yapf )
2016-07-04 20:42:22 -06:00
| Option | autopep8 | yapf |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `ignore` | :white_check_mark: | :x: |
| `indent_size` | :white_check_mark: | :x: |
| `max_line_length` | :white_check_mark: | :x: |
| `sort_imports` | :white_check_mark: | :x: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Python
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Python 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**: `autopep8`
**Type**: `string`
**Enum**: `autopep8` `yapf`
**Description**:
Default Beautifier to be used for Python
**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 Python 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.
##### [Ignore](#ignore)
**Namespace**: `python`
**Key**: `ignore`
**Default**: `E24`
**Type**: `array`
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
**Description**:
do not fix these errors/warnings (Supported by autopep8)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"ignore": [
"E24"
]
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `python`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
**Description**:
Indentation size/length (Supported by autopep8)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"indent_size": 4
}
}
```
##### [Max line length](#max-line-length)
**Namespace**: `python`
**Key**: `max_line_length`
**Default**: `79`
**Type**: `integer`
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
**Description**:
set maximum allowed line length (Supported by autopep8)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"max_line_length": 79
}
}
```
##### [Sort imports](#sort-imports)
**Namespace**: `python`
**Key**: `sort_imports`
**Type**: `boolean`
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
**Description**:
sort imports (requires isort installed) (Supported by autopep8)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"sort_imports": false
}
}
```
#### [Riot.js](#riot.js)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -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: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Riot.js
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Riot.js 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 Riot.js
**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 Riot.js 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
}
}
```
#### [Ruby](#ruby)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Rubocop` ](#rubocop ) [`Ruby Beautify` ](#ruby-beautify )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| Option | Rubocop | Ruby Beautify |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_size` | :white_check_mark: | :white_check_mark: |
| `rubocop_path` | :white_check_mark: | :x: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Ruby
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Ruby 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**: `Rubocop`
**Type**: `string`
**Enum**: `Rubocop` `Ruby Beautify`
**Description**:
Default Beautifier to be used for Ruby
**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 Ruby 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**: `ruby`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Enum**: ` ` ` `
**Supported Beautifiers**: [`Ruby Beautify` ](#ruby-beautify )
**Description**:
Indentation character (Supported by Ruby Beautify)
**Example `.jsbeautifyrc` Configuration**
```json
{
"ruby": {
"indent_char": " "
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `ruby`
**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 )
2016-07-04 20:42:22 -06:00
| Option | rustfmt |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `rustfmt_path` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**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.
**Type**: `boolean`
**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 )
**Description**:
Path to rustfmt program (Supported by rustfmt)
**Example `.jsbeautifyrc` Configuration**
```json
{
"rust": {
"rustfmt_path": ""
}
}
```
#### [Sass](#sass)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| Option | CSScomb | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
| `convert_quotes` | :x: | :white_check_mark: |
| `force_indentation` | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_comments` | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: |
| `no_lead_zero` | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Sass
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Sass 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**: `CSScomb` `Pretty Diff`
**Description**:
Default Beautifier to be used for Sass
**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 Sass 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`
**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**:
Path to custom CSScomb config file, used in absense of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb)
**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`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_char": " "
}
}
```
##### [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`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation size/length (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_size": 4
}
}
```
##### [Newline between rules](#newline-between-rules)
**Namespace**: `css`
**Key**: `newline_between_rules`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Add a newline between CSS rules (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"newline_between_rules": false
}
}
```
##### [No lead zero](#no-lead-zero)
**Namespace**: `css`
**Key**: `no_lead_zero`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
If in CSS values leading 0s immediately preceeding 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`
**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
}
}
```
#### [SCSS](#scss)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb ) [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -06:00
2016-07-04 20:42:22 -06:00
| Option | CSScomb | Pretty Diff |
| --- | --- | --- |
| `disabled` | :white_check_mark: | :white_check_mark: |
| `default_beautifier` | :white_check_mark: | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: | :white_check_mark: |
| `align_assignments` | :x: | :white_check_mark: |
| `configPath` | :white_check_mark: | :x: |
| `convert_quotes` | :x: | :white_check_mark: |
| `force_indentation` | :x: | :white_check_mark: |
| `indent_char` | :x: | :white_check_mark: |
| `indent_comments` | :x: | :white_check_mark: |
| `indent_size` | :x: | :white_check_mark: |
| `newline_between_rules` | :x: | :white_check_mark: |
| `no_lead_zero` | :x: | :white_check_mark: |
| `predefinedConfig` | :white_check_mark: | :x: |
| `preserve_newlines` | :x: | :white_check_mark: |
| `wrap_line_length` | :x: | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language SCSS
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable SCSS 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**: `CSScomb` `Pretty Diff`
**Description**:
Default Beautifier to be used for SCSS
**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 SCSS 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`
**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**:
Path to custom CSScomb config file, used in absense of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb)
**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`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_char": " "
}
}
```
##### [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`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation size/length (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_size": 4
}
}
```
##### [Newline between rules](#newline-between-rules)
**Namespace**: `css`
**Key**: `newline_between_rules`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Add a newline between CSS rules (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"newline_between_rules": false
}
}
```
##### [No lead zero](#no-lead-zero)
**Namespace**: `css`
**Key**: `no_lead_zero`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
If in CSS values leading 0s immediately preceeding 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`
**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
}
}
```
#### [Spacebars](#spacebars)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -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: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Spacebars
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Spacebars 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 Spacebars
**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 Spacebars 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
}
}
```
#### [SQL](#sql)
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2016-07-04 20:42:22 -06: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: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language SQL
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable SQL 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**: `sqlformat`
**Type**: `string`
**Enum**: `sqlformat`
**Description**:
Default Beautifier to be used for SQL
**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 SQL 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.
##### [Identifiers](#identifiers)
**Namespace**: `sql`
**Key**: `identifiers`
**Default**: `unchanged`
**Type**: `string`
**Enum**: `unchanged` `lower` `upper` `capitalize`
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
**Description**:
Change case of identifiers (Supported by sqlformat)
**Example `.jsbeautifyrc` Configuration**
```json
{
"sql": {
"identifiers": "unchanged"
}
}
```
##### [Indent size](#indent-size)
**Namespace**: `sql`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
**Description**:
Indentation size/length (Supported by sqlformat)
**Example `.jsbeautifyrc` Configuration**
```json
{
"sql": {
"indent_size": 4
}
}
```
##### [Keywords](#keywords)
**Namespace**: `sql`
**Key**: `keywords`
**Default**: `upper`
**Type**: `string`
**Enum**: `unchanged` `lower` `upper` `capitalize`
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
**Description**:
Change case of keywords (Supported by sqlformat)
**Example `.jsbeautifyrc` Configuration**
```json
{
"sql": {
"keywords": "upper"
}
}
```
#### [SVG](#svg)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -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: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language SVG
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable SVG 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 SVG
**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 SVG 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
}
}
```
#### [Swig](#swig)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -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: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Swig
##### [Disable Beautifying Language](#disable-beautifying-language)
**Important**: This option is only configurable from within Atom Beautify's setting panel.
**Type**: `boolean`
**Description**:
Disable Swig 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 Swig
**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 Swig 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
}
}
```
#### [TSS](#tss)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -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: |
| `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: |
2016-03-21 10:46:52 -06:00
**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`
**Description**:
Default Beautifier to be used for TSS
**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 TSS files on save
**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.
##### [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
}
}
```
##### [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**
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"css": {
"convert_quotes": "none"
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Force indentation](#force-indentation)
**Namespace**: `css`
**Key**: `force_indentation`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
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
{
"css": {
"force_indentation": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"indent_char": " "
}
}
```
##### [Indent comments](#indent-comments)
**Namespace**: `css`
**Key**: `indent_comments`
**Default**: `true`
2015-10-29 20:36:40 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-10-29 20:36:40 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Determines whether comments should be indented. (Supported by 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
{
"css": {
"indent_comments": true
}
}
```
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-10-29 20:36:40 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by 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
{
"css": {
"indent_size": 4
}
}
```
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Newline between rules](#newline-between-rules)
2015-10-29 20:36:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
**Key**: `newline_between_rules`
2015-10-29 20:36:40 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-10-29 20:36:40 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a newline between CSS rules (Supported by 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
{
"css": {
"newline_between_rules": false
}
}
```
##### [No lead zero](#no-lead-zero)
**Namespace**: `css`
**Key**: `no_lead_zero`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
If in CSS values leading 0s immediately preceeding a decimal should be removed or prevented. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"css": {
"no_lead_zero": false
}
}
```
##### [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
}
}
```
#### [Twig](#twig)
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2016-03-21 10:46:52 -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: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
2016-03-21 10:46:52 -06:00
**Description**:
Options for language Twig
2015-10-29 20:36: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**:
2016-03-21 10:46:52 -06:00
Disable Twig 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
2016-03-21 10:46:52 -06:00
**Default**: `Pretty Diff`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `Pretty Diff`
2016-03-02 10:28:32 -07:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Twig
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify Twig 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
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `break_chained_methods`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Break chained method calls across subsequent lines (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"break_chained_methods": false
}
}
```
##### [End with comma](#end-with-comma)
**Namespace**: `js`
**Key**: `end_with_comma`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"end_with_comma": false
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation character (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"indent_char": " "
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-08-31 16:25:40 -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_size`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -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**:
2016-03-21 10:46:52 -06: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": {
"indent_size": 4
}
}
```
2015-08-31 16:25:40 -06:00
2016-04-23 11:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
}
}
```
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**: `html`
**Key**: `preserve_newlines`
**Default**: `true`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
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
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": {
"preserve_newlines": true
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `space_after_anon_function`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a space before an anonymous function's parens, ie. function () (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
{
"js": {
"space_after_anon_function": false
}
}
```
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**: `html`
2015-06-01 12:52:33 -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`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06: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
2016-03-21 10:46:52 -06: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-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"wrap_line_length": 250
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
#### [TypeScript](#typescript)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2016-07-04 20:42:22 -06:00
| Option | TypeScript Formatter |
| --- | --- |
| `disabled` | :white_check_mark: |
| `default_beautifier` | :white_check_mark: |
| `beautify_on_save` | :white_check_mark: |
| `brace_style` | :white_check_mark: |
| `break_chained_methods` | :white_check_mark: |
| `end_with_comma` | :white_check_mark: |
| `end_with_newline` | :white_check_mark: |
| `eval_code` | :white_check_mark: |
| `indent_char` | :white_check_mark: |
| `indent_level` | :white_check_mark: |
| `indent_size` | :white_check_mark: |
| `indent_with_tabs` | :white_check_mark: |
| `jslint_happy` | :white_check_mark: |
| `keep_array_indentation` | :white_check_mark: |
| `keep_function_indentation` | :white_check_mark: |
| `max_preserve_newlines` | :white_check_mark: |
| `preserve_newlines` | :white_check_mark: |
| `space_after_anon_function` | :white_check_mark: |
| `space_before_conditional` | :white_check_mark: |
| `space_in_paren` | :white_check_mark: |
| `unescape_strings` | :white_check_mark: |
| `wrap_line_length` | :white_check_mark: |
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language TypeScript
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**:
2016-03-21 10:46:52 -06:00
Disable TypeScript 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
2016-03-21 10:46:52 -06:00
**Default**: `TypeScript Formatter`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `TypeScript Formatter`
2015-06-01 12:52:33 -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 TypeScript
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify TypeScript 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
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `brace_style`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `collapse`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter)
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
{
"js": {
"brace_style": "collapse"
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `break_chained_methods`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Break chained method calls across subsequent lines (Supported by TypeScript Formatter)
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
{
"js": {
"break_chained_methods": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [End with comma](#end-with-comma)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `end_with_comma`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter)
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
{
"js": {
"end_with_comma": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06: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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
End output with newline (Supported by TypeScript Formatter)
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
{
"js": {
"end_with_newline": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Eval code](#eval-code)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `eval_code`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by TypeScript Formatter)
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
{
"js": {
"eval_code": false
}
}
```
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**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by TypeScript Formatter)
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
{
"js": {
"indent_char": " "
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent level](#indent-level)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_level`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Initial indentation level (Supported by TypeScript Formatter)
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
{
"js": {
"indent_level": 0
}
}
```
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**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by TypeScript Formatter)
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
{
"js": {
"indent_size": 4
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `indent_with_tabs`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter)
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
{
"js": {
"indent_with_tabs": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Jslint happy](#jslint-happy)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `jslint_happy`
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**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Enable jslint-stricter mode (Supported by TypeScript Formatter)
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
{
"js": {
"jslint_happy": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Keep array indentation](#keep-array-indentation)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `keep_array_indentation`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve array indentation (Supported by TypeScript Formatter)
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
{
"js": {
"keep_array_indentation": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Keep function indentation](#keep-function-indentation)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `keep_function_indentation`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by TypeScript Formatter)
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
{
"js": {
"keep_function_indentation": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `max_preserve_newlines`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `10`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter)
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
{
"js": {
"max_preserve_newlines": 10
}
}
```
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**: `js`
**Key**: `preserve_newlines`
**Default**: `true`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve line-breaks (Supported by TypeScript Formatter)
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
{
"js": {
"preserve_newlines": true
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `space_after_anon_function`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter)
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
{
"js": {
"space_after_anon_function": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Space before conditional](#space-before-conditional)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_before_conditional`
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`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by TypeScript Formatter)
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
{
"js": {
"space_before_conditional": true
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Space in paren](#space-in-paren)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `space_in_paren`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter)
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
{
"js": {
"space_in_paren": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Unescape strings](#unescape-strings)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `unescape_strings`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter)
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
{
"js": {
"unescape_strings": false
}
}
```
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**: `js`
2015-06-01 12:52:33 -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
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter)
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
{
"js": {
"wrap_line_length": 0
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
#### [Vala](#vala)
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-09 09:02:52 -06: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**:
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
Options for language Vala
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**:
2016-03-21 10:46:52 -06:00
Disable Vala 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
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-01 12:52:33 -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 Vala
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify Vala 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
2016-03-21 10:46:52 -06:00
##### [Config Path](#config-path)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `vala`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `configPath`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
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
{
"vala": {
"configPath": ""
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
#### [Visualforce](#visualforce)
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**:
2016-03-21 10:46:52 -06:00
Options for language Visualforce
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**:
2016-03-21 10:46:52 -06:00
Disable Visualforce 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**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for Visualforce
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify Visualforce 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
2016-03-21 10:46:52 -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": {
"indent_char": " "
}
}
```
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
2016-03-21 10:46:52 -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": {
"indent_size": 4
}
}
```
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
2016-03-21 10:46:52 -06:00
#### [XML](#xml)
2016-03-02 10:28:32 -07:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2016-03-02 10:28:32 -07:00
2016-07-04 20:42:22 -06: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-03-02 10:28:32 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language XML
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**:
2016-03-21 10:46:52 -06:00
Disable XML 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
2016-03-21 10:46:52 -06:00
**Default**: `Pretty Diff`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `JS Beautify` `Pretty Diff`
2015-06-01 12:52:33 -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 XML
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify XML 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
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `brace_style`
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `collapse`
2015-06-06 10:45:56 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `collapse` `expand` `end-expand` `none`
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-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
2016-03-21 10:46:52 -06:00
[collapse|expand|end-expand|none] (Supported by JS 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
{
"html": {
"brace_style": "collapse"
}
}
```
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-06 10:45:56 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_newline`
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
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
2016-03-21 10:46:52 -06:00
End output with newline (Supported by JS Beautify)
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": {
"end_with_newline": false
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Extra liners](#extra-liners)
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `extra_liners`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `head,body,/html`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `array`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by JS Beautify)
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": {
"extra_liners": [
"head",
"body",
"/html"
]
}
}
```
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-06-09 09:02:52 -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**: `indent_char`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by JS Beautify, 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": {
"indent_char": " "
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent inner html](#indent-inner-html)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
**Key**: `indent_inner_html`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indent < head > and < body > sections. (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
{
"html": {
"indent_inner_html": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent scripts](#indent-scripts)
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_scripts`
**Default**: `normal`
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `keep` `separate` `normal`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
2016-03-21 10:46:52 -06:00
[keep|separate|normal] (Supported by JS 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
{
"html": {
"indent_scripts": "normal"
}
}
```
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 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-09 09:02:52 -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**: [`JS Beautify` ](#js-beautify ) [`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 size/length (Supported by JS Beautify, 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": {
"indent_size": 4
}
}
```
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-06-09 09:02:52 -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**: `max_preserve_newlines`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `10`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)
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": {
"max_preserve_newlines": 10
}
}
```
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`
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
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve line-breaks (Supported by JS Beautify, 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": {
"preserve_newlines": true
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Unformatted](#unformatted)
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**: `unformatted`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `a,span,img,bdo,em,strong,dfn,code,samp,kbd,var,cite,abbr,acronym,q,sub,sup,tt,i,b,big,small,u,s,strike,font,ins,del,pre,address,dt,h1,h2,h3,h4,h5,h6`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `array`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
2016-03-21 10:46:52 -06:00
List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)
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": {
"unformatted": [
"a",
"span",
"img",
"bdo",
"em",
"strong",
"dfn",
"code",
"samp",
"kbd",
"var",
"cite",
"abbr",
"acronym",
"q",
"sub",
"sup",
"tt",
"i",
"b",
"big",
"small",
"u",
"s",
"strike",
"font",
"ins",
"del",
"pre",
"address",
"dt",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Wrap attributes](#wrap-attributes)
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**: `wrap_attributes`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `auto`
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
**Enum**: `auto` `force`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
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
Wrap attributes to new lines [auto|force] (Supported by JS Beautify)
**Example `.jsbeautifyrc` Configuration**
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"html": {
"wrap_attributes": "auto"
}
}
```
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2015-06-09 09:02:52 -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**: `wrap_attributes_indent_size`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-08-05 08:56:11 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indent wrapped attributes to after N characters (Supported by JS Beautify)
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
{
"html": {
"wrap_attributes_indent_size": 4
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`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
2016-03-21 10:46:52 -06:00
Maximum characters per line (0 disables) (Supported by JS Beautify, 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
{
"html": {
"wrap_line_length": 250
}
}
```
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
#### [XTemplate](#xtemplate)
2015-08-05 08:56:11 -06:00
2016-04-16 13:15:14 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-08-05 08:56:11 -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-08-05 08:56:11 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Options for language XTemplate
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**:
2016-03-21 10:46:52 -06:00
Disable XTemplate 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
**Default**: `Pretty Diff`
**Type**: `string`
**Enum**: `Pretty Diff`
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Default Beautifier to be used for XTemplate
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**:
2016-03-21 10:46:52 -06:00
Automatically beautify XTemplate 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-01 12:52:33 -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
2016-03-21 10:46:52 -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": {
"indent_char": " "
}
}
```
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
2016-03-21 10:46:52 -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": {
"indent_size": 4
}
}
```
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`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
2015-06-08 15:34:56 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 15:34:56 -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
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": {
"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-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 15:34:56 -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
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": {
"wrap_line_length": 250
}
}
```
2015-08-31 16:25:40 -06:00
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
## Beautifier Options
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
Supported options for each beautifier.
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
---
2015-06-08 15:34:56 -06:00
2016-03-21 10:46:52 -06:00
### CSScomb
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
##### [comb custom config file](#comb-custom-config-file)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `configPath`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to custom CSScomb config file, used in absense of a `.csscomb.json` or `.csscomb.cson` at the root of your project. (Supported by CSScomb)
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
{
"css": {
"configPath": ""
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [comb predefined config](#comb-predefined-config)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `predefinedConfig`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**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
2016-03-21 10:46:52 -06:00
**Enum**: `csscomb` `yandex` `zen`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`CSScomb` ](#csscomb )
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
2016-03-21 10:46:52 -06:00
Used if neither a project or custom config file exists. (Supported by CSScomb)
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
{
"css": {
"predefinedConfig": "csscomb"
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
### Coffee Formatter
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
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-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by Coffee Formatter, coffee-fmt)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_size": 4
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-06-01 12:52:33 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Coffee Formatter, coffee-fmt)
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
{
"js": {
"indent_char": " "
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent level](#indent-level)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_level`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
2016-03-21 10:46:52 -06:00
Initial indentation level (Supported by Coffee Formatter)
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
{
"js": {
"indent_level": 0
}
}
```
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_with_tabs`
2015-06-09 09:02:52 -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
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
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 uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, coffee-fmt)
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
{
"js": {
"indent_with_tabs": false
}
}
```
2015-06-01 12:52:33 -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**: `js`
2015-06-01 13:50:09 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `preserve_newlines`
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
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
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
Preserve line-breaks (Supported by Coffee Formatter)
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
{
"js": {
"preserve_newlines": true
}
}
```
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `max_preserve_newlines`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `10`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter)
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
{
"js": {
"max_preserve_newlines": 10
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Space in paren](#space-in-paren)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_in_paren`
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**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-01 12:52:33 -06:00
2015-06-01 13:50:09 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter)
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
{
"js": {
"space_in_paren": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Jslint happy](#jslint-happy)
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `jslint_happy`
2015-06-01 12:52:33 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-01 13:50:09 -06:00
**Description**:
2015-06-01 12:52:33 -06:00
2016-03-21 10:46:52 -06:00
Enable jslint-stricter mode (Supported by Coffee Formatter)
2015-06-08 16:05:03 -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
{
"js": {
"jslint_happy": false
}
}
```
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
**Key**: `space_after_anon_function`
2016-03-02 10:28:32 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2016-03-02 10:28:32 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter)
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
{
"js": {
"space_after_anon_function": false
}
}
```
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `brace_style`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `collapse`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
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
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter)
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
{
"js": {
"brace_style": "collapse"
}
}
```
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-03-02 10:28:32 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `break_chained_methods`
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
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Description**:
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
Break chained method calls across subsequent lines (Supported by Coffee Formatter)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Example `.jsbeautifyrc` Configuration**
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
```json
{
"js": {
"break_chained_methods": false
}
}
```
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
##### [Keep array indentation](#keep-array-indentation)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_array_indentation`
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
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve array indentation (Supported by Coffee Formatter)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"keep_array_indentation": false
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keep function indentation](#keep-function-indentation)
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_function_indentation`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-08-05 08:56:11 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-08-05 08:56:11 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by Coffee Formatter)
2015-08-05 08:56:11 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"keep_function_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space before conditional](#space-before-conditional)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_before_conditional`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by Coffee Formatter)
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": {
"space_before_conditional": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Eval code](#eval-code)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `eval_code`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by Coffee Formatter)
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": {
"eval_code": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Unescape strings](#unescape-strings)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `unescape_strings`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Decode printable characters encoded in xNN notation (Supported by Coffee Formatter)
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": {
"unescape_strings": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Wrap lines at next opportunity after N characters (Supported by Coffee Formatter)
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": {
"wrap_line_length": 0
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_newline`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
End output with newline (Supported by Coffee Formatter)
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": {
"end_with_newline": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with comma](#end-with-comma)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_comma`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter)
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": {
"end_with_comma": false
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
### Fortran Beautifier
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Emacs path](#emacs-path)
**Namespace**: `fortran`
**Key**: `emacs_path`
2015-06-08 16:05:03 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to the `emacs` executable (Supported by Fortran Beautifier)
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
"fortran": {
"emacs_path": ""
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Emacs script path](#emacs-script-path)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `fortran`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `emacs_script_path`
2015-06-08 16:05:03 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Fortran Beautifier` ](#fortran-beautifier )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to the emacs script (Supported by Fortran Beautifier)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"fortran": {
"emacs_script_path": ""
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
### Gherkin formatter
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `gherkin`
2015-08-31 16:25:40 -06:00
**Key**: `indent_size`
2015-06-08 16:05:03 -06:00
**Default**: `4`
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by Gherkin formatter)
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
"gherkin": {
2015-08-31 16:25:40 -06:00
"indent_size": 4
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `gherkin`
2015-08-31 16:25:40 -06:00
**Key**: `indent_char`
2015-06-08 16:05:03 -06:00
**Default**: ` `
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Gherkin formatter` ](#gherkin-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Gherkin formatter)
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
"gherkin": {
2015-08-31 16:25:40 -06:00
"indent_char": " "
}
}
```
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
### HTML Beautifier
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
**Key**: `indent_size`
**Default**: `4`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`HTML Beautifier` ](#html-beautifier ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by HTML Beautifier, 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
"html": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
### JS Beautify
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2016-02-20 14:02:43 -07:00
**Key**: `indent_size`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Default**: `4`
**Type**: `integer`
2015-06-08 16:05:03 -06:00
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-02-20 14:02:43 -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
{
2016-03-21 10:46:52 -06:00
"html": {
2016-02-20 14:02:43 -07:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2016-02-20 14:02:43 -07:00
**Key**: `indent_char`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Default**: ` `
**Type**: `string`
2015-06-08 16:05:03 -06:00
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-02-20 14:02:43 -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
{
2016-03-21 10:46:52 -06:00
"html": {
2016-02-20 14:02:43 -07:00
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Selector separator newline](#selector-separator-newline)
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `selector_separator_newline`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a newline between multiple selectors (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-02-20 14:02:43 -07:00
"css": {
2016-03-21 10:46:52 -06:00
"selector_separator_newline": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Newline between rules](#newline-between-rules)
2015-08-31 16:25:40 -06:00
2016-02-20 14:02:43 -07:00
**Namespace**: `css`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `newline_between_rules`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a newline between CSS rules (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
{
2016-02-20 14:02:43 -07:00
"css": {
2016-03-21 10:46:52 -06:00
"newline_between_rules": false
2015-08-31 16:25:40 -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-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `preserve_newlines`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"html": {
"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-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-08 16:05:03 -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
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"html": {
"wrap_line_length": 250
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent inner html](#indent-inner-html)
2015-06-08 16:05:03 -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**: `indent_inner_html`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"html": {
"indent_inner_html": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
2015-06-08 16:05:03 -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**: `brace_style`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `collapse`
2015-06-08 16:05:03 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `collapse` `expand` `end-expand` `none`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"html": {
"brace_style": "collapse"
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent scripts](#indent-scripts)
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**: `indent_scripts`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `normal`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Enum**: `keep` `separate` `normal`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"html": {
"indent_scripts": "normal"
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap attributes](#wrap-attributes)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
**Key**: `wrap_attributes`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `auto`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Enum**: `auto` `force`
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Wrap attributes to new lines [auto|force] (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2016-03-21 10:46:52 -06:00
"wrap_attributes": "auto"
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap attributes indent size](#wrap-attributes-indent-size)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
**Key**: `wrap_attributes_indent_size`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
"html": {
2016-03-21 10:46:52 -06:00
"wrap_attributes_indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
**Key**: `max_preserve_newlines`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `10`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
"html": {
2016-03-21 10:46:52 -06:00
"max_preserve_newlines": 10
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Unformatted](#unformatted)
2015-09-08 16:47:30 -06:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
**Key**: `unformatted`
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `a,span,img,bdo,em,strong,dfn,code,samp,kbd,var,cite,abbr,acronym,q,sub,sup,tt,i,b,big,small,u,s,strike,font,ins,del,pre,address,dt,h1,h2,h3,h4,h5,h6`
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `array`
2015-09-08 16:47:30 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-09-08 16:47:30 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)
2015-09-08 16:47:30 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2016-03-21 10:46:52 -06:00
"unformatted": [
"a",
"span",
"img",
"bdo",
"em",
"strong",
"dfn",
"code",
"samp",
"kbd",
"var",
"cite",
"abbr",
"acronym",
"q",
"sub",
"sup",
"tt",
"i",
"b",
"big",
"small",
"u",
"s",
"strike",
"font",
"ins",
"del",
"pre",
"address",
"dt",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
2015-09-08 16:47:30 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_newline`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"html": {
"end_with_newline": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Extra liners](#extra-liners)
2015-06-08 16:05:03 -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**: `extra_liners`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `head,body,/html`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `array`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"html": {
"extra_liners": [
"head",
"body",
"/html"
]
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent level](#indent-level)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `indent_level`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
"js": {
2016-03-21 10:46:52 -06:00
"indent_level": 0
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `indent_with_tabs`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-04-23 11:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-04-23 11:46:52 -06: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
{
"js": {
2016-03-21 10:46:52 -06:00
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space in paren](#space-in-paren)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `space_in_paren`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
2016-03-21 10:46:52 -06:00
"space_in_paren": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Jslint happy](#jslint-happy)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `jslint_happy`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
"js": {
2016-03-21 10:46:52 -06:00
"jslint_happy": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `space_after_anon_function`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a space before an anonymous function's parens, ie. function () (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
{
"js": {
2016-03-21 10:46:52 -06:00
"space_after_anon_function": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `break_chained_methods`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify ) [`Pretty Diff` ](#pretty-diff )
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"js": {
"break_chained_methods": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keep array indentation](#keep-array-indentation)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_array_indentation`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"js": {
"keep_array_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keep function indentation](#keep-function-indentation)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_function_indentation`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"js": {
"keep_function_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space before conditional](#space-before-conditional)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_before_conditional`
**Default**: `true`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"js": {
"space_before_conditional": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Eval code](#eval-code)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `eval_code`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"js": {
"eval_code": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Unescape strings](#unescape-strings)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `unescape_strings`
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
**Supported Beautifiers**: [`JS Beautify` ](#js-beautify )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Decode printable characters encoded in xNN notation (Supported by JS Beautify)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"unescape_strings": false
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with comma](#end-with-comma)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_comma`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
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
**Description**:
2016-03-21 10:46:52 -06:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (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
{
2016-03-21 10:46:52 -06:00
"js": {
"end_with_comma": false
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
### Latex Beautify
##### [Indent char](#indent-char)
**Namespace**: `latex`
2015-08-31 16:25:40 -06:00
2016-02-20 14:02:43 -07:00
**Key**: `indent_char`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Default**: ` `
**Type**: `string`
2016-03-29 11:41:43 -06:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-29 11:41:43 -06:00
Indentation character (Supported by Latex Beautify)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-29 11:41:43 -06:00
"latex": {
2016-02-20 14:02:43 -07:00
"indent_char": " "
}
}
```
2016-03-29 11:41:43 -06:00
##### [Indent with tabs](#indent-with-tabs)
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Namespace**: `latex`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Key**: `indent_with_tabs`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Default**: `true`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-29 11:41:43 -06:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Latex Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-29 11:41:43 -06:00
"latex": {
"indent_with_tabs": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-29 11:41:43 -06:00
##### [Indent preamble](#indent-preamble)
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Namespace**: `latex`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Key**: `indent_preamble`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-29 11:41:43 -06:00
Indent the preable (Supported by Latex Beautify)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-29 11:41:43 -06:00
"latex": {
"indent_preamble": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-29 11:41:43 -06:00
##### [Always look for split braces](#always-look-for-split-braces)
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Namespace**: `latex`
2015-08-31 16:25:40 -06:00
2016-03-29 11:41:43 -06:00
**Key**: `always_look_for_split_braces`
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Default**: `true`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-29 11:41:43 -06: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
{
2016-03-29 11:41:43 -06:00
"latex": {
"always_look_for_split_braces": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-29 11:41:43 -06:00
##### [Always look for split brackets](#always-look-for-split-brackets)
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Namespace**: `latex`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Key**: `always_look_for_split_brackets`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-29 11:41:43 -06:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-29 11:41:43 -06:00
If `latexindent` should look for commands that split brackets across lines (Supported by Latex Beautify)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-29 11:41:43 -06:00
"latex": {
"always_look_for_split_brackets": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-29 11:41:43 -06:00
##### [Remove trailing whitespace](#remove-trailing-whitespace)
2015-09-10 13:08:58 -06:00
2016-03-29 11:41:43 -06:00
**Namespace**: `latex`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Key**: `remove_trailing_whitespace`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Type**: `boolean`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-29 11:41:43 -06:00
Remove trailing whitespace (Supported by Latex Beautify)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-29 11:41:43 -06:00
"latex": {
"remove_trailing_whitespace": false
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-29 11:41:43 -06:00
##### [Align columns in environments](#align-columns-in-environments)
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Namespace**: `latex`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Key**: `align_columns_in_environments`
2016-02-20 14:02:43 -07:00
2016-03-29 11:41:43 -06:00
**Default**: `tabular,matrix,bmatrix,pmatrix`
2015-09-10 13:08:58 -06:00
2016-03-29 11:41:43 -06:00
**Type**: `array`
2015-09-10 13:08:58 -06:00
2016-03-29 11:41:43 -06:00
**Supported Beautifiers**: [`Latex Beautify` ](#latex-beautify )
2015-09-10 13:08:58 -06:00
**Description**:
2016-03-29 11:41:43 -06:00
undefined (Supported by Latex Beautify)
2015-09-10 13:08:58 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-29 11:41:43 -06:00
"latex": {
"align_columns_in_environments": [
"tabular",
"matrix",
"bmatrix",
"pmatrix"
]
2015-09-10 13:08:58 -06:00
}
}
```
2015-06-09 09:02:52 -06:00
2016-06-24 12:30:54 -06:00
### Marko Beautifier
##### [Indent size](#indent-size)
**Namespace**: `html`
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Indentation size/length (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_size": 4
}
}
```
##### [Indent char](#indent-char)
**Namespace**: `html`
**Key**: `indent_char`
**Default**: ` `
**Type**: `string`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Indentation character (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_char": " "
}
}
```
##### [Syntax](#syntax)
**Namespace**: `marko`
**Key**: `syntax`
**Default**: `html`
**Type**: `string`
**Enum**: `html` `concise`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
[html|concise] (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"marko": {
"syntax": "html"
}
}
```
##### [Indent inner html](#indent-inner-html)
**Namespace**: `html`
**Key**: `indent_inner_html`
**Type**: `boolean`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Indent < head > and < body > sections. (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_inner_html": false
}
}
```
##### [Brace style](#brace-style)
**Namespace**: `html`
**Key**: `brace_style`
**Default**: `collapse`
**Type**: `string`
**Enum**: `collapse` `expand` `end-expand` `none`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
[collapse|expand|end-expand|none] (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"brace_style": "collapse"
}
}
```
##### [Indent scripts](#indent-scripts)
**Namespace**: `html`
**Key**: `indent_scripts`
**Default**: `normal`
**Type**: `string`
**Enum**: `keep` `separate` `normal`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
[keep|separate|normal] (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"indent_scripts": "normal"
}
}
```
##### [Wrap line length](#wrap-line-length)
**Namespace**: `html`
**Key**: `wrap_line_length`
**Default**: `250`
**Type**: `integer`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Maximum characters per line (0 disables) (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_line_length": 250
}
}
```
##### [Wrap attributes](#wrap-attributes)
**Namespace**: `html`
**Key**: `wrap_attributes`
**Default**: `auto`
**Type**: `string`
**Enum**: `auto` `force`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Wrap attributes to new lines [auto|force] (Supported by Marko Beautifier)
**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**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Indent wrapped attributes to after N characters (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"wrap_attributes_indent_size": 4
}
}
```
##### [Preserve newlines](#preserve-newlines)
**Namespace**: `html`
**Key**: `preserve_newlines`
**Default**: `true`
**Type**: `boolean`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Preserve line-breaks (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"preserve_newlines": true
}
}
```
##### [Max preserve newlines](#max-preserve-newlines)
**Namespace**: `html`
**Key**: `max_preserve_newlines`
**Default**: `10`
**Type**: `integer`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"max_preserve_newlines": 10
}
}
```
##### [Unformatted](#unformatted)
**Namespace**: `html`
**Key**: `unformatted`
**Default**: `a,span,img,bdo,em,strong,dfn,code,samp,kbd,var,cite,abbr,acronym,q,sub,sup,tt,i,b,big,small,u,s,strike,font,ins,del,pre,address,dt,h1,h2,h3,h4,h5,h6`
**Type**: `array`
**Supported Beautifiers**: [`Marko Beautifier` ](#marko-beautifier )
**Description**:
List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier)
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
"unformatted": [
"a",
"span",
"img",
"bdo",
"em",
"strong",
"dfn",
"code",
"samp",
"kbd",
"var",
"cite",
"abbr",
"acronym",
"q",
"sub",
"sup",
"tt",
"i",
"b",
"big",
"small",
"u",
"s",
"strike",
"font",
"ins",
"del",
"pre",
"address",
"dt",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6"
]
}
}
```
##### [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"
]
}
}
```
2016-03-21 10:46:52 -06:00
### PHP-CS-Fixer
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [PHP-CS-Fixer Path](#php-cs-fixer-path)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `php`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `cs_fixer_path`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to the `php-cs-fixer` CLI executable (Supported by PHP-CS-Fixer)
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
"php": {
"cs_fixer_path": ""
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Fixers](#fixers)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `php`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `fixers`
2016-02-20 14:02:43 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Add fixer(s). i.e. linefeed,-short_tag,indentation (Supported by PHP-CS-Fixer)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"php": {
"fixers": ""
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Level](#level)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `php`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `level`
2016-02-20 14:02:43 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
By default, all PSR-2 fixers and some additional ones are run. (Supported by PHP-CS-Fixer)
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
"php": {
"level": ""
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [PHPCBF Path](#phpcbf-path)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `php`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `phpcbf_path`
2016-02-20 14:02:43 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to the `phpcbf` CLI executable (Supported by PHP-CS-Fixer)
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
"php": {
"phpcbf_path": ""
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [PHPCBF Standard](#phpcbf-standard)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `php`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `standard`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer ) [`PHPCBF` ](#phpcbf )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules (Supported by PHP-CS-Fixer, PHPCBF)
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
"php": {
"standard": ""
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
### PHPCBF
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [PHPCBF Standard](#phpcbf-standard)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `php`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `standard`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`PHP-CS-Fixer` ](#php-cs-fixer ) [`PHPCBF` ](#phpcbf )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules (Supported by PHP-CS-Fixer, PHPCBF)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"php": {
"standard": ""
2015-08-31 16:25:40 -06:00
}
}
```
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
### Perltidy
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
##### [Perltidy profile](#perltidy-profile)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `perl`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `perltidy_profile`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Supported Beautifiers**: [`Perltidy` ](#perltidy )
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"perl": {
"perltidy_profile": ""
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
### Pretty Diff
##### [Indent size](#indent-size)
2016-02-20 14:02:43 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-09-10 13:08:58 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-09-10 13:08:58 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by Pretty Diff)
2015-09-10 13:08:58 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-02-20 14:02:43 -07:00
"html": {
2016-03-21 10:46:52 -06:00
"indent_size": 4
2015-09-10 13:08:58 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-06-09 09:02:52 -06:00
2016-02-20 14:02:43 -07:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06: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
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Pretty Diff)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2016-03-21 10:46:52 -06:00
"indent_char": " "
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2016-02-20 14:02:43 -07:00
**Namespace**: `html`
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `250`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -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-02-20 14:02:43 -07:00
"html": {
2016-03-21 10:46:52 -06:00
"wrap_line_length": 250
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Preserve newlines](#preserve-newlines)
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `preserve_newlines`
**Default**: `true`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve line-breaks (Supported by Pretty Diff)
2016-02-20 14:02:43 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"html": {
2016-03-21 10:46:52 -06:00
"preserve_newlines": true
2016-02-20 14:02:43 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Newline between rules](#newline-between-rules)
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `newline_between_rules`
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
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"css": {
"newline_between_rules": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent comments](#indent-comments)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_comments`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Determines whether comments should be indented. (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
"css": {
"indent_comments": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Force indentation](#force-indentation)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `force_indentation`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"css": {
"force_indentation": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Convert quotes](#convert-quotes)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `convert_quotes`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `none`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Enum**: `none` `double` `single`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"css": {
"convert_quotes": "none"
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Align assignments](#align-assignments)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `align_assignments`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"css": {
"align_assignments": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [No lead zero](#no-lead-zero)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `css`
2016-02-20 14:02:43 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `no_lead_zero`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
If in CSS values leading 0s immediately preceeding a decimal should be removed or prevented. (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
"css": {
"no_lead_zero": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-04-23 11:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
**Namespace**: `js`
**Key**: `indent_with_tabs`
**Type**: `boolean`
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
**Description**:
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Pretty Diff)
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
"indent_with_tabs": false
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2015-08-31 16:25:40 -06:00
2016-02-20 14:02:43 -07:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_after_anon_function`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-02-20 14:02:43 -07:00
"js": {
2016-03-21 10:46:52 -06:00
"space_after_anon_function": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `break_chained_methods`
2015-06-08 16:05:03 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-02-20 14:02:43 -07:00
"js": {
2016-03-21 10:46:52 -06:00
"break_chained_methods": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with comma](#end-with-comma)
2015-09-10 13:05:19 -06:00
2016-02-20 14:02:43 -07:00
**Namespace**: `js`
2015-09-10 13:05:19 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_comma`
2015-09-10 13:05:19 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Pretty Diff` ](#pretty-diff )
2015-09-10 13:05:19 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)
2015-09-10 13:05:19 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-02-20 14:02:43 -07:00
"js": {
2016-03-21 10:46:52 -06:00
"end_with_comma": false
2015-09-10 13:05:19 -06:00
}
}
```
2015-08-31 16:25:40 -06:00
2016-04-01 07:40:26 -06:00
### Pug Beautify
2015-08-31 16:25:40 -06:00
2016-04-01 07:40:26 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2016-04-01 07:40:26 -06:00
**Namespace**: `html`
2015-06-08 16:05:03 -06:00
2016-04-01 07:40:26 -06:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-04-01 07:40:26 -06: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
{
2016-04-01 07:40:26 -06:00
"html": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-04-01 07:40:26 -06:00
##### [Indent char](#indent-char)
2015-06-25 06:10:47 -06:00
2016-04-01 07:40:26 -06:00
**Namespace**: `html`
2015-08-31 16:25:40 -06:00
2016-04-01 07:40:26 -06:00
**Key**: `indent_char`
2015-06-25 06:10:47 -06:00
2016-04-01 07:40:26 -06:00
**Default**: ` `
2015-06-25 06:10:47 -06:00
2016-04-01 07:40:26 -06:00
**Type**: `string`
**Supported Beautifiers**: [`Pug Beautify` ](#pug-beautify )
2015-06-25 06:10:47 -06:00
**Description**:
2016-04-01 07:40:26 -06:00
Indentation character (Supported by Pug Beautify)
2015-06-25 06:10:47 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-04-01 07:40:26 -06:00
"html": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2015-10-07 17:57:56 -06:00
2016-03-21 10:46:52 -06:00
### Remark
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
##### [Gfm](#gfm)
**Namespace**: `markdown`
**Key**: `gfm`
**Default**: `true`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Remark` ](#remark )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"markdown": {
"gfm": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Yaml](#yaml)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `markdown`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `yaml`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
2015-06-08 16:05:03 -06: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
**Supported Beautifiers**: [`Remark` ](#remark )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"markdown": {
"yaml": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Commonmark](#commonmark)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `markdown`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `commonmark`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Type**: `boolean`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Remark` ](#remark )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Allows and disallows several constructs. (Supported by Remark)
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
"markdown": {
"commonmark": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
### Rubocop
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `ruby`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Rubocop` ](#rubocop ) [`Ruby Beautify` ](#ruby-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"ruby": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Rubocop Path](#rubocop-path)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `ruby`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `rubocop_path`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Rubocop` ](#rubocop )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to the `rubocop` CLI executable (Supported by Rubocop)
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
"ruby": {
"rubocop_path": ""
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
### Ruby Beautify
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
##### [Indent size](#indent-size)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `ruby`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
**Type**: `integer`
**Supported Beautifiers**: [`Rubocop` ](#rubocop ) [`Ruby Beautify` ](#ruby-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"ruby": {
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `ruby`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Enum**: ` ` ` `
**Supported Beautifiers**: [`Ruby Beautify` ](#ruby-beautify )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06: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
{
2016-03-21 10:46:52 -06:00
"ruby": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
### TypeScript Formatter
##### [Indent size](#indent-size)
2015-06-25 06:10:47 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `indent_size`
2015-06-25 06:10:47 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `4`
2015-06-25 06:10:47 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-25 06:10:47 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by TypeScript Formatter)
2015-06-25 06:10:47 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
2016-03-21 10:46:52 -06:00
"indent_size": 4
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent char](#indent-char)
2015-10-07 17:57:56 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-10-07 17:57:56 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-10-07 17:57:56 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-10-07 17:57:56 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by TypeScript Formatter)
2015-10-07 17:57:56 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
2016-03-21 10:46:52 -06:00
"indent_char": " "
2015-10-07 17:57:56 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent level](#indent-level)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `indent_level`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Initial indentation level (Supported by TypeScript Formatter)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
2016-03-21 10:46:52 -06:00
"indent_level": 0
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Indent with tabs](#indent-with-tabs)
2015-09-10 13:08:58 -06:00
**Namespace**: `js`
2016-03-21 10:46:52 -06:00
**Key**: `indent_with_tabs`
2015-09-10 13:08:58 -06:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-09-10 13:08:58 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by TypeScript Formatter)
2015-09-10 13:08:58 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"js": {
2016-03-21 10:46:52 -06:00
"indent_with_tabs": false
2015-09-10 13:08:58 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Preserve newlines](#preserve-newlines)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `preserve_newlines`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-10-27 19:31:21 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve line-breaks (Supported by TypeScript Formatter)
2015-10-27 19:31:21 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"preserve_newlines": true
2015-10-27 19:31:21 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Max preserve newlines](#max-preserve-newlines)
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `max_preserve_newlines`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `10`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-10-27 19:31:21 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter)
2015-10-27 19:31:21 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"max_preserve_newlines": 10
2015-10-27 19:31:21 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space in paren](#space-in-paren)
2015-10-27 19:31:21 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_in_paren`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-08-05 09:16:31 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"space_in_paren": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Jslint happy](#jslint-happy)
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `jslint_happy`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-08-05 09:16:31 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Enable jslint-stricter mode (Supported by TypeScript Formatter)
2015-08-05 09:16:31 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"jslint_happy": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space after anon function](#space-after-anon-function)
2015-08-05 09:16:31 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_after_anon_function`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter)
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": {
"space_after_anon_function": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Brace style](#brace-style)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `brace_style`
**Default**: `collapse`
2015-06-08 16:05:03 -06:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Enum**: `collapse` `collapse-preserve-inline` `expand` `end-expand` `none`
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"brace_style": "collapse"
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Break chained methods](#break-chained-methods)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `break_chained_methods`
2016-01-28 05:11:09 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2016-01-28 05:11:09 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Break chained method calls across subsequent lines (Supported by TypeScript Formatter)
2016-01-28 05:11:09 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"break_chained_methods": false
2016-01-28 05:11:09 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keep array indentation](#keep-array-indentation)
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_array_indentation`
2016-01-28 05:11:09 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2016-01-28 05:11:09 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Preserve array indentation (Supported by TypeScript Formatter)
2016-01-28 05:11:09 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"keep_array_indentation": false
2016-01-28 05:11:09 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keep function indentation](#keep-function-indentation)
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `keep_function_indentation`
2016-01-28 05:11:09 -07:00
**Type**: `boolean`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2016-01-28 05:11:09 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by TypeScript Formatter)
2016-01-28 05:11:09 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"keep_function_indentation": false
2016-01-28 05:11:09 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Space before conditional](#space-before-conditional)
2016-01-28 05:11:09 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `space_before_conditional`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Default**: `true`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by TypeScript Formatter)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"space_before_conditional": true
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Eval code](#eval-code)
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `eval_code`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
(Supported by TypeScript Formatter)
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": {
"eval_code": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Unescape strings](#unescape-strings)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `unescape_strings`
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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter)
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": {
"unescape_strings": false
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [Wrap line length](#wrap-line-length)
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2015-08-31 16:25:40 -06:00
2016-03-21 10:46:52 -06:00
**Key**: `wrap_line_length`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `integer`
2015-06-08 16:05:03 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2015-06-08 16:05:03 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"wrap_line_length": 0
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with newline](#end-with-newline)
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_newline`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2016-01-13 09:05:57 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
End output with newline (Supported by TypeScript Formatter)
2016-01-13 09:05:57 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"end_with_newline": false
2016-01-13 09:05:57 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
##### [End with comma](#end-with-comma)
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `js`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `end_with_comma`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Type**: `boolean`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`TypeScript Formatter` ](#typescript-formatter )
2016-01-13 09:05:57 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter)
2016-01-13 09:05:57 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"js": {
"end_with_comma": false
2016-01-13 09:05:57 -07:00
}
}
```
2016-03-21 10:46:52 -06:00
### Uncrustify
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
##### [Config Path](#config-path)
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Namespace**: `vala`
2016-01-13 09:05:57 -07:00
2016-03-21 10:46:52 -06:00
**Key**: `configPath`
2016-01-13 09:05:57 -07:00
**Type**: `string`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Uncrustify` ](#uncrustify )
2016-01-13 09:05:57 -07:00
**Description**:
2016-03-21 10:46:52 -06:00
Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)
2016-01-13 09:05:57 -07:00
**Example `.jsbeautifyrc` Configuration**
```json
{
2016-03-21 10:46:52 -06:00
"vala": {
"configPath": ""
2016-01-13 09:05:57 -07:00
}
}
```
2015-06-09 09:02:52 -06:00
2015-06-08 16:05:03 -06:00
### autopep8
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`
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
2015-06-08 16:05:03 -06:00
**Description**:
set maximum allowed line length (Supported by autopep8)
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
**Default**: `4`
**Type**: `integer`
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
2015-06-08 16:05:03 -06:00
**Description**:
Indentation size/length (Supported by autopep8)
2015-06-09 09:02:52 -06:00
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"indent_size": 4
}
}
```
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`
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
2015-06-08 16:05:03 -06:00
**Description**:
do not fix these errors/warnings (Supported by autopep8)
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"ignore": [
"E24"
]
}
}
```
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`
**Supported Beautifiers**: [`autopep8` ](#autopep8 )
**Description**:
sort imports (requires isort installed) (Supported by autopep8)
**Example `.jsbeautifyrc` Configuration**
```json
{
"python": {
"sort_imports": false
}
}
```
2015-06-09 09:02:52 -06:00
2016-03-21 10:46:52 -06:00
### coffee-fmt
2015-06-10 10:57:47 -06:00
2016-03-21 10:46:52 -06:00
##### [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
**Key**: `indent_size`
2015-06-10 10:57:47 -06:00
**Default**: `4`
**Type**: `integer`
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-06-10 16:20:08 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation size/length (Supported by Coffee Formatter, 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": {
2015-08-31 16:25:40 -06:00
"indent_size": 4
}
}
```
2016-03-21 10:46:52 -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
2016-03-21 10:46:52 -06:00
**Key**: `indent_char`
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Default**: ` `
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Type**: `string`
2015-06-10 16:20:08 -06:00
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-06-10 16:20:08 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation character (Supported by Coffee Formatter, 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": {
"indent_char": " "
2015-08-31 16:25:40 -06:00
}
}
```
2016-03-21 10:46:52 -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
2016-03-21 10:46:52 -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
2016-03-21 10:46:52 -06:00
**Supported Beautifiers**: [`Coffee Formatter` ](#coffee-formatter ) [`coffee-fmt` ](#coffee-fmt )
2015-06-10 10:57:47 -06:00
**Description**:
2016-03-21 10:46:52 -06:00
Indentation uses tabs, overrides `Indent Size` and `Indent Char` (Supported by Coffee Formatter, 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": {
"indent_with_tabs": false
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-10 10:57:47 -06:00
2015-06-08 16:05:03 -06:00
### rustfmt
2016-03-21 10:46:52 -06:00
##### [Rustfmt path](#rustfmt-path)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `rust`
**Key**: `rustfmt_path`
2015-06-08 16:05:03 -06:00
**Type**: `string`
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`rustfmt` ](#rustfmt )
2015-06-08 16:05:03 -06:00
**Description**:
Path to rustfmt program (Supported by rustfmt)
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"rust": {
"rustfmt_path": ""
}
}
```
2015-06-09 09:02:52 -06:00
2015-06-08 16:05:03 -06:00
### sqlformat
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**: `sql`
**Key**: `indent_size`
2015-06-08 16:05:03 -06:00
**Default**: `4`
**Type**: `integer`
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2015-06-08 16:05:03 -06:00
**Description**:
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
{
"sql": {
"indent_size": 4
}
}
```
2016-03-21 10:46:52 -06:00
##### [Keywords](#keywords)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `sql`
**Key**: `keywords`
2015-06-08 16:05:03 -06:00
**Default**: `upper`
**Type**: `string`
2016-02-20 14:02:43 -07:00
**Enum**: `unchanged` `lower` `upper` `capitalize`
2015-06-08 16:05:03 -06:00
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2015-06-08 16:05:03 -06:00
**Description**:
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
{
"sql": {
"keywords": "upper"
}
}
```
2016-03-21 10:46:52 -06:00
##### [Identifiers](#identifiers)
2015-06-08 16:05:03 -06:00
2015-08-31 16:25:40 -06:00
**Namespace**: `sql`
**Key**: `identifiers`
2015-06-08 16:05:03 -06:00
2016-02-20 14:02:43 -07:00
**Default**: `unchanged`
2015-06-08 16:05:03 -06:00
**Type**: `string`
2016-02-20 14:02:43 -07:00
**Enum**: `unchanged` `lower` `upper` `capitalize`
2015-06-08 16:05:03 -06:00
2015-06-09 09:02:52 -06:00
**Supported Beautifiers**: [`sqlformat` ](#sqlformat )
2015-06-08 16:05:03 -06:00
**Description**:
Change case of identifiers (Supported by sqlformat)
2015-08-31 16:25:40 -06:00
**Example `.jsbeautifyrc` Configuration**
```json
{
"sql": {
2016-02-20 14:02:43 -07:00
"identifiers": "unchanged"
2015-08-31 16:25:40 -06:00
}
}
```
2015-06-09 09:02:52 -06:00