atom-beautify/docs/options.md

412 KiB

Options

Automatically generated documentation for Atom Beautify's options.

Package Options

Configurable options for Atom Beautify.


General

Description:

General options for Atom Beautify

Analytics User Id

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: string

Description:

Unique identifier for this user for tracking usage analytics

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Analytics User Id" and change it to your desired configuration.
Beautify Entire File On Save

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: true

Type: boolean

Description:

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.

How to Configure

  1. You can open the Settings View by navigating to Edit > 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 Entire File On Save" and change it to your desired configuration.
Logger Level

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: warn

Type: string

Enum: verbose debug info warn error

Description:

Set the level for the logger

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Logger Level" and change it to your desired configuration.
Mute All Errors

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Do not show any/all errors when they occur

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Mute All Errors" and change it to your desired configuration.
Mute Unsupported Language Errors

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Do not show "Unsupported Language" errors when they occur

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Mute Unsupported Language Errors" and change it to your desired configuration.
Show Loading View

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: true

Type: boolean

Description:

Show loading view when beautifying

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Show Loading View" and change it to your desired configuration.

Executables

Description:

Configure executables used by beautifiers.

Rscript

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for Rscript executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Rscript" and change it to your desired configuration.
autopep8

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for autopep8 executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "autopep8" and change it to your desired configuration.
beautysh

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for beautysh executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "beautysh" and change it to your desired configuration.
ClangFormat

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for ClangFormat executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "ClangFormat" and change it to your desired configuration.
Crystal

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for Crystal executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Crystal" and change it to your desired configuration.
Dfmt

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for Dfmt executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Dfmt" and change it to your desired configuration.
Emacs

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for Emacs executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Emacs" and change it to your desired configuration.
isort

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for isort executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "isort" and change it to your desired configuration.
PHP

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for PHP executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "PHP" and change it to your desired configuration.
PHP-CS-Fixer

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for PHP-CS-Fixer executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "PHP-CS-Fixer" and change it to your desired configuration.
PHPCBF

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for PHPCBF executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "PHPCBF" and change it to your desired configuration.
Uncrustify

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: object

Description:

Options for Uncrustify executable.

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Uncrustify" and change it to your desired configuration.

Language Options

Supported options for each language.


Apex

Supported Beautifiers: Uncrustify

Option Uncrustify
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language Apex

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Apex Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 Apex

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Apex files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: apex

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "apex": {
        "configPath": ""
    }
}

Arduino

Supported Beautifiers: Uncrustify

Option Uncrustify
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language Arduino

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Arduino Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 Arduino

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Arduino files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: arduino

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "arduino": {
        "configPath": ""
    }
}

Bash

Supported Beautifiers: beautysh

Option beautysh
disabled
default_beautifier
beautify_on_save
indent_size

Description:

Options for language Bash

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Bash Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: beautysh

Type: string

Enum: beautysh

Description:

Default Beautifier to be used for Bash

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Bash files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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 size

Namespace: bash

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: beautysh

Description:

Indentation size/length (Supported by beautysh)

Example .jsbeautifyrc Configuration

{
    "bash": {
        "indent_size": 4
    }
}

C

Supported Beautifiers: Uncrustify clang-format

Option Uncrustify clang-format
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language C

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable C Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 C

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: c

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "c": {
        "configPath": ""
    }
}

Coldfusion

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language Coldfusion

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Coldfusion Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 Coldfusion

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Coldfusion files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: cfml

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "cfml": {
        "indent_char": " "
    }
}
Indent size

Namespace: cfml

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "cfml": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: cfml

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "cfml": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: cfml

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "cfml": {
        "wrap_line_length": 250
    }
}

Clojure

Supported Beautifiers: cljfmt

Option cljfmt
disabled
default_beautifier
beautify_on_save

Description:

Options for language Clojure

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Clojure Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: cljfmt

Type: string

Enum: cljfmt

Description:

Default Beautifier to be used for Clojure

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Clojure files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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.

CoffeeScript

Supported Beautifiers: Coffee Formatter coffee-fmt

Option Coffee Formatter coffee-fmt
disabled
default_beautifier
beautify_on_save
brace_style
break_chained_methods
end_of_line
end_with_comma
end_with_newline
eval_code
indent_char
indent_level
indent_size
indent_with_tabs
jslint_happy
keep_array_indentation
keep_function_indentation
max_preserve_newlines
preserve_newlines
space_after_anon_function
space_before_conditional
space_in_paren
unescape_strings
wrap_line_length

Description:

Options for language CoffeeScript

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable CoffeeScript Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: coffee-fmt

Type: string

Enum: Coffee Formatter coffee-fmt

Description:

Default Beautifier to be used for CoffeeScript

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify CoffeeScript files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: js

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: Coffee Formatter

Description:

[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Break chained method calls across subsequent lines (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: Coffee Formatter

Description:

Override EOL from line-ending-selector (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}
End with newline

Namespace: js

Key: end_with_newline

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

End output with newline (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_newline": false
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

(Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation character (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: Coffee Formatter

Description:

Initial indentation level (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation size/length (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Enable jslint-stricter mode (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Preserve array indentation (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

(Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Max preserve newlines

Namespace: js

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: Coffee Formatter

Description:

Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: js

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Preserve line-breaks (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

(Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Decode printable characters encoded in xNN notation (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: js

Key: wrap_line_length

Type: integer

Supported Beautifiers: Coffee Formatter

Description:

Wrap lines at next opportunity after N characters (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "wrap_line_length": 0
    }
}

C++

Supported Beautifiers: Uncrustify clang-format

Option Uncrustify clang-format
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language C++

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable C++ Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 C++

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: cpp

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "cpp": {
        "configPath": ""
    }
}

Crystal

Supported Beautifiers: Crystal

Option Crystal
disabled
default_beautifier
beautify_on_save

Description:

Options for language Crystal

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Crystal

Type: string

Enum: Crystal

Description:

Default Beautifier to be used for Crystal

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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.

C#

Supported Beautifiers: Uncrustify

Option Uncrustify
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language C#

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable C# Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: cs

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "cs": {
        "configPath": ""
    }
}

CSS

Supported Beautifiers: CSScomb JS Beautify Pretty Diff SassConvert

Option CSScomb JS Beautify Pretty Diff SassConvert
disabled
default_beautifier
beautify_on_save
align_assignments
configPath
convert_quotes
end_with_newline
force_indentation
indent_char
indent_comments
indent_size
newline_between_rules
no_lead_zero
predefinedConfig
preserve_newlines
selector_separator_newline
wrap_line_length

Description:

Options for language CSS

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable CSS Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: JS Beautify

Type: string

Enum: CSScomb JS Beautify Pretty Diff SassConvert

Description:

Default Beautifier to be used for CSS

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify CSS files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: css

Key: align_assignments

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "align_assignments": false
    }
}
comb custom config file

Namespace: css

Key: configPath

Type: string

Supported Beautifiers: 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

{
    "css": {
        "configPath": ""
    }
}
Convert quotes

Namespace: css

Key: convert_quotes

Default: none

Type: string

Enum: none double single

Supported Beautifiers: 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

{
    "css": {
        "convert_quotes": "none"
    }
}
End with newline

Namespace: css

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "css": {
        "end_with_newline": false
    }
}
Force indentation

Namespace: css

Key: force_indentation

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "force_indentation": false
    }
}
Indent char

Namespace: css

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_char": " "
    }
}
Indent comments

Namespace: css

Key: indent_comments

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Determines whether comments should be indented. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_comments": true
    }
}
Indent size

Namespace: css

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_size": 4
    }
}
Newline between rules

Namespace: css

Key: newline_between_rules

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "newline_between_rules": true
    }
}
No lead zero

Namespace: css

Key: no_lead_zero

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "no_lead_zero": false
    }
}
comb predefined config

Namespace: css

Key: predefinedConfig

Default: csscomb

Type: string

Enum: csscomb yandex zen

Supported Beautifiers: CSScomb

Description:

Used if neither a project or custom config file exists. (Supported by CSScomb)

Example .jsbeautifyrc Configuration

{
    "css": {
        "predefinedConfig": "csscomb"
    }
}
Preserve newlines

Namespace: css

Key: preserve_newlines

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "preserve_newlines": false
    }
}
Selector separator newline

Namespace: css

Key: selector_separator_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Add a newline between multiple selectors (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "css": {
        "selector_separator_newline": false
    }
}
Wrap line length

Namespace: css

Key: wrap_line_length

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Maximum amount of characters per line (0 = disable) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "wrap_line_length": 0
    }
}

CSV

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save

Description:

Options for language CSV

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable CSV Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 CSV

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify CSV files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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.

D

Supported Beautifiers: Uncrustify dfmt

Option Uncrustify dfmt
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language D

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable D Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Uncrustify

Type: string

Enum: Uncrustify dfmt

Description:

Default Beautifier to be used for D

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify D files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: d

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "d": {
        "configPath": ""
    }
}

EJS

Supported Beautifiers: JS Beautify Pretty Diff

Option JS Beautify Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
break_chained_methods
end_of_line
end_with_comma
end_with_newline
eval_code
extra_liners
indent_char
indent_inner_html
indent_level
indent_scripts
indent_size
indent_with_tabs
jslint_happy
keep_array_indentation
keep_function_indentation
max_preserve_newlines
preserve_newlines
space_after_anon_function
space_before_conditional
space_in_paren
unescape_strings
unformatted
wrap_attributes
wrap_attributes_indent_size
wrap_line_length

Description:

Options for language EJS

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable EJS Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 EJS

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify EJS files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: JS Beautify

Description:

Override EOL from line-ending-selector (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: JS Beautify 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

{
    "js": {
        "end_with_comma": false
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Indent <head> and sections. (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: JS Beautify

Description:

Initial indentation level (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: JS Beautify

Description:

[keep|separate|normal] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Enable jslint-stricter mode (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Preserve array indentation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Decode printable characters encoded in xNN notation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: JS Beautify

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: JS Beautify

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify

Description:

Indent wrapped attributes to after N characters (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Elm

Supported Beautifiers: elm-format

Option elm-format
disabled
default_beautifier
beautify_on_save

Description:

Options for language Elm

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Elm Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: elm-format

Type: string

Enum: elm-format

Description:

Default Beautifier to be used for Elm

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Elm files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Supported Beautifiers: HTML Beautifier Pretty Diff

Option HTML Beautifier Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language ERB

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Pretty Diff

Type: string

Enum: HTML Beautifier Pretty Diff

Description:

Default Beautifier to be used for ERB

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify ERB files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: HTML Beautifier Pretty Diff

Description:

Indentation size/length (Supported by HTML Beautifier, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Erlang

Supported Beautifiers: erl_tidy

Option erl_tidy
disabled
default_beautifier
beautify_on_save

Description:

Options for language Erlang

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Erlang Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: erl_tidy

Type: string

Enum: erl_tidy

Description:

Default Beautifier to be used for Erlang

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Erlang files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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.

Fortran

Supported Beautifiers: Fortran Beautifier

Option Fortran Beautifier
disabled
default_beautifier
beautify_on_save
emacs_path
emacs_script_path

Description:

Options for language Fortran

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Fortran Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Fortran Beautifier

Type: string

Enum: Fortran Beautifier

Description:

Default Beautifier to be used for Fortran

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Fortran files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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.
Emacs path

Namespace: fortran

Key: emacs_path

Type: string

Supported Beautifiers: Fortran Beautifier

Description:

Path to the emacs executable (Supported by Fortran Beautifier)

Example .jsbeautifyrc Configuration

{
    "fortran": {
        "emacs_path": ""
    }
}
Emacs script path

Namespace: fortran

Key: emacs_script_path

Type: string

Supported Beautifiers: Fortran Beautifier

Description:

Path to the emacs script (Supported by Fortran Beautifier)

Example .jsbeautifyrc Configuration

{
    "fortran": {
        "emacs_script_path": ""
    }
}

gherkin

Supported Beautifiers: Gherkin formatter

Option Gherkin formatter
disabled
default_beautifier
beautify_on_save
indent_char
indent_size

Description:

Options for language gherkin

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable gherkin Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Gherkin formatter

Type: string

Enum: Gherkin formatter

Description:

Default Beautifier to be used for gherkin

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify gherkin files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: gherkin

Key: indent_char

Default:

Type: string

Supported Beautifiers: Gherkin formatter

Description:

Indentation character (Supported by Gherkin formatter)

Example .jsbeautifyrc Configuration

{
    "gherkin": {
        "indent_char": " "
    }
}
Indent size

Namespace: gherkin

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Gherkin formatter

Description:

Indentation size/length (Supported by Gherkin formatter)

Example .jsbeautifyrc Configuration

{
    "gherkin": {
        "indent_size": 4
    }
}

GLSL

Supported Beautifiers: clang-format

Option clang-format
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language GLSL

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable GLSL Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: clang-format

Type: string

Enum: clang-format

Description:

Default Beautifier to be used for GLSL

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify GLSL files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: glsl

Key: configPath

Type: string

Supported Beautifiers: clang-format

Description:

Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format)

Example .jsbeautifyrc Configuration

{
    "glsl": {
        "configPath": ""
    }
}

Go

Supported Beautifiers: gofmt

Option gofmt
disabled
default_beautifier
beautify_on_save

Description:

Options for language Go

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Go Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: gofmt

Type: string

Enum: gofmt

Description:

Default Beautifier to be used for Go

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Go files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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.

Golang Template

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language Golang Template

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Golang Template Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 Golang Template

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Golang Template files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Handlebars

Supported Beautifiers: JS Beautify Pretty Diff

Option JS Beautify Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
end_with_newline
extra_liners
indent_char
indent_inner_html
indent_scripts
indent_size
max_preserve_newlines
preserve_newlines
unformatted
wrap_attributes
wrap_attributes_indent_size
wrap_line_length

Description:

Options for language Handlebars

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Handlebars Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 Handlebars

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Handlebars files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Indent <head> and sections. (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: JS Beautify

Description:

[keep|separate|normal] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: JS Beautify

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: JS Beautify

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify

Description:

Indent wrapped attributes to after N characters (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Haskell

Supported Beautifiers: stylish-haskell

Option stylish-haskell
disabled
default_beautifier
beautify_on_save

Description:

Options for language Haskell

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Haskell Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: stylish-haskell

Type: string

Enum: stylish-haskell

Description:

Default Beautifier to be used for Haskell

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Haskell files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Beautify On Save" and change it to your desired configuration.

HTML

Supported Beautifiers: JS Beautify Pretty Diff

Option JS Beautify Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
end_with_newline
extra_liners
indent_char
indent_inner_html
indent_scripts
indent_size
max_preserve_newlines
preserve_newlines
unformatted
wrap_attributes
wrap_attributes_indent_size
wrap_line_length

Description:

Options for language HTML

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable HTML Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 HTML

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify HTML files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Indent <head> and sections. (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: JS Beautify

Description:

[keep|separate|normal] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: JS Beautify

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: JS Beautify

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify

Description:

Indent wrapped attributes to after N characters (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Jade

Supported Beautifiers: Pug Beautify

Option Pug Beautify
disabled
default_beautifier
beautify_on_save
indent_char
indent_size

Description:

Options for language Jade

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pug Beautify

Description:

Indentation character (Supported by Pug Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pug Beautify

Description:

Indentation size/length (Supported by Pug Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}

Java

Supported Beautifiers: Uncrustify

Option Uncrustify
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language Java

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: java

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "java": {
        "configPath": ""
    }
}

JavaScript

Supported Beautifiers: JS Beautify JSCS Fixer ESLint Fixer Pretty Diff

Option ESLint Fixer JS Beautify JSCS Fixer Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
break_chained_methods
end_of_line
end_with_comma
end_with_newline
eval_code
indent_char
indent_level
indent_size
indent_with_tabs
jslint_happy
keep_array_indentation
keep_function_indentation
max_preserve_newlines
preserve_newlines
space_after_anon_function
space_before_conditional
space_in_paren
unescape_strings
wrap_line_length

Description:

Options for language JavaScript

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: JS Beautify

Type: string

Enum: JS Beautify JSCS Fixer ESLint Fixer Pretty Diff

Description:

Default Beautifier to be used for JavaScript

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: js

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: JS Beautify

Description:

Override EOL from line-ending-selector (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: JS Beautify 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

{
    "js": {
        "end_with_comma": false
    }
}
End with newline

Namespace: js

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_newline": false
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: JS Beautify

Description:

Initial indentation level (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Enable jslint-stricter mode (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Preserve array indentation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Max preserve newlines

Namespace: js

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: js

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Decode printable characters encoded in xNN notation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: js

Key: wrap_line_length

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "wrap_line_length": 0
    }
}

JSON

Supported Beautifiers: JS Beautify Pretty Diff

Option JS Beautify Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
break_chained_methods
end_of_line
end_with_comma
end_with_newline
eval_code
indent_char
indent_level
indent_size
indent_with_tabs
jslint_happy
keep_array_indentation
keep_function_indentation
max_preserve_newlines
preserve_newlines
space_after_anon_function
space_before_conditional
space_in_paren
unescape_strings
wrap_line_length

Description:

Options for language JSON

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: js

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: JS Beautify

Description:

Override EOL from line-ending-selector (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: JS Beautify 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

{
    "js": {
        "end_with_comma": false
    }
}
End with newline

Namespace: js

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_newline": false
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: JS Beautify

Description:

Initial indentation level (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Enable jslint-stricter mode (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Preserve array indentation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Max preserve newlines

Namespace: js

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: js

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Decode printable characters encoded in xNN notation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: js

Key: wrap_line_length

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "wrap_line_length": 0
    }
}

JSX

Supported Beautifiers: JS Beautify Pretty Diff

Option JS Beautify Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
break_chained_methods
e4x
end_of_line
end_with_comma
end_with_newline
eval_code
indent_char
indent_level
indent_size
indent_with_tabs
jslint_happy
keep_array_indentation
keep_function_indentation
max_preserve_newlines
preserve_newlines
space_after_anon_function
space_before_conditional
space_in_paren
unescape_strings
wrap_line_length

Description:

Options for language JSX

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Pretty Diff

Type: string

Enum: JS Beautify Pretty Diff

Description:

Default Beautifier to be used for JSX

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: js

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
E4x

Namespace: jsx

Key: e4x

Default: true

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Support e4x/jsx syntax (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "jsx": {
        "e4x": true
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: JS Beautify

Description:

Override EOL from line-ending-selector (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: JS Beautify 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

{
    "js": {
        "end_with_comma": false
    }
}
End with newline

Namespace: js

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_newline": false
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: JS Beautify

Description:

Initial indentation level (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Enable jslint-stricter mode (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Preserve array indentation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Max preserve newlines

Namespace: js

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: js

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Decode printable characters encoded in xNN notation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: js

Key: wrap_line_length

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Wrap lines at next opportunity after N characters (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "wrap_line_length": 0
    }
}

LaTeX

Supported Beautifiers: Latex Beautify

Option Latex Beautify
disabled
default_beautifier
beautify_on_save
align_columns_in_environments
always_look_for_split_braces
always_look_for_split_brackets
indent_char
indent_preamble
indent_with_tabs
remove_trailing_whitespace

Description:

Options for language LaTeX

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: latex

Key: align_columns_in_environments

Default: tabular,matrix,bmatrix,pmatrix

Type: array

Supported Beautifiers: Latex Beautify

Description:

(Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "align_columns_in_environments": [
            "tabular",
            "matrix",
            "bmatrix",
            "pmatrix"
        ]
    }
}
Always look for split braces

Namespace: latex

Key: always_look_for_split_braces

Default: true

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

If latexindent should look for commands that split braces across lines (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "always_look_for_split_braces": true
    }
}
Always look for split brackets

Namespace: latex

Key: always_look_for_split_brackets

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

If latexindent should look for commands that split brackets across lines (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "always_look_for_split_brackets": false
    }
}
Indent char

Namespace: latex

Key: indent_char

Default:

Type: string

Supported Beautifiers: Latex Beautify

Description:

Indentation character (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "indent_char": " "
    }
}
Indent preamble

Namespace: latex

Key: indent_preamble

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

Indent the preable (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "indent_preamble": false
    }
}
Indent with tabs

Namespace: latex

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "indent_with_tabs": false
    }
}
Remove trailing whitespace

Namespace: latex

Key: remove_trailing_whitespace

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

Remove trailing whitespace (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "remove_trailing_whitespace": false
    }
}

LESS

Supported Beautifiers: CSScomb Pretty Diff

Option CSScomb Pretty Diff
disabled
default_beautifier
beautify_on_save
align_assignments
configPath
convert_quotes
force_indentation
indent_char
indent_comments
indent_size
newline_between_rules
no_lead_zero
predefinedConfig
preserve_newlines
wrap_line_length

Description:

Options for language LESS

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: css

Key: align_assignments

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "align_assignments": false
    }
}
comb custom config file

Namespace: css

Key: configPath

Type: string

Supported Beautifiers: 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

{
    "css": {
        "configPath": ""
    }
}
Convert quotes

Namespace: css

Key: convert_quotes

Default: none

Type: string

Enum: none double single

Supported Beautifiers: 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

{
    "css": {
        "convert_quotes": "none"
    }
}
Force indentation

Namespace: css

Key: force_indentation

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "force_indentation": false
    }
}
Indent char

Namespace: css

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_char": " "
    }
}
Indent comments

Namespace: css

Key: indent_comments

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Determines whether comments should be indented. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_comments": true
    }
}
Indent size

Namespace: css

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_size": 4
    }
}
Newline between rules

Namespace: css

Key: newline_between_rules

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add a newline between CSS rules (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "newline_between_rules": true
    }
}
No lead zero

Namespace: css

Key: no_lead_zero

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "no_lead_zero": false
    }
}
comb predefined config

Namespace: css

Key: predefinedConfig

Default: csscomb

Type: string

Enum: csscomb yandex zen

Supported Beautifiers: CSScomb

Description:

Used if neither a project or custom config file exists. (Supported by CSScomb)

Example .jsbeautifyrc Configuration

{
    "css": {
        "predefinedConfig": "csscomb"
    }
}
Preserve newlines

Namespace: css

Key: preserve_newlines

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "preserve_newlines": false
    }
}
Wrap line length

Namespace: css

Key: wrap_line_length

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "wrap_line_length": 0
    }
}

Lua

Supported Beautifiers: Lua beautifier

Option Lua beautifier
disabled
default_beautifier
beautify_on_save
end_of_line

Description:

Options for language Lua

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Lua beautifier

Type: string

Enum: Lua beautifier

Description:

Default Beautifier to be used for Lua

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Beautify On Save" and change it to your desired configuration.
End of line

Namespace: lua

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: Lua beautifier

Description:

Override EOL from line-ending-selector (Supported by Lua beautifier)

Example .jsbeautifyrc Configuration

{
    "lua": {
        "end_of_line": "System Default"
    }
}

Markdown

Supported Beautifiers: Remark Tidy Markdown

Option Remark Tidy Markdown
disabled
default_beautifier
beautify_on_save
commonmark
gfm
yaml

Description:

Options for language Markdown

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: markdown

Key: commonmark

Type: boolean

Supported Beautifiers: Remark

Description:

Allows and disallows several constructs. (Supported by Remark)

Example .jsbeautifyrc Configuration

{
    "markdown": {
        "commonmark": false
    }
}
Gfm

Namespace: markdown

Key: gfm

Default: true

Type: boolean

Supported Beautifiers: Remark

Description:

GitHub Flavoured Markdown (Supported by Remark)

Example .jsbeautifyrc Configuration

{
    "markdown": {
        "gfm": true
    }
}
Yaml

Namespace: markdown

Key: yaml

Default: true

Type: boolean

Supported Beautifiers: Remark

Description:

Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark)

Example .jsbeautifyrc Configuration

{
    "markdown": {
        "yaml": true
    }
}

Marko

Supported Beautifiers: Marko Beautifier

Option Marko Beautifier
disabled
default_beautifier
beautify_on_save
brace_style
end_with_newline
extra_liners
indent_char
indent_inner_html
indent_scripts
indent_size
max_preserve_newlines
preserve_newlines
syntax
unformatted
wrap_attributes
wrap_attributes_indent_size
wrap_line_length

Description:

Options for language Marko

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Marko Beautifier

Type: string

Enum: Marko Beautifier

Description:

Default Beautifier to be used for Marko

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse expand end-expand none

Supported Beautifiers: Marko Beautifier

Description:

[collapse|expand|end-expand|none] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: Marko Beautifier

Description:

End output with newline (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Marko Beautifier

Description:

Indentation character (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: Marko Beautifier

Description:

Indent <head> and sections. (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: Marko Beautifier

Description:

[keep|separate|normal] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Indentation size/length (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Marko Beautifier

Description:

Preserve line-breaks (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Syntax

Namespace: marko

Key: syntax

Default: html

Type: string

Enum: html concise

Supported Beautifiers: Marko Beautifier

Description:

[html|concise] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "marko": {
        "syntax": "html"
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: Marko Beautifier

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: Marko Beautifier

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Indent wrapped attributes to after N characters (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Maximum characters per line (0 disables) (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Mustache

Supported Beautifiers: JS Beautify Pretty Diff

Option JS Beautify Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
end_with_newline
extra_liners
indent_char
indent_inner_html
indent_scripts
indent_size
max_preserve_newlines
preserve_newlines
unformatted
wrap_attributes
wrap_attributes_indent_size
wrap_line_length

Description:

Options for language Mustache

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 by navigating to Edit > 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

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 Mustache

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Indent <head> and sections. (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: JS Beautify

Description:

[keep|separate|normal] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: JS Beautify

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: JS Beautify

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify

Description:

Indent wrapped attributes to after N characters (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Nginx

Supported Beautifiers: Nginx Beautify

Option Nginx Beautify
disabled
default_beautifier
beautify_on_save
dontJoinCurlyBracet
indent_char
indent_size
indent_with_tabs

Description:

Options for language Nginx

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Nginx Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Nginx Beautify

Type: string

Enum: Nginx Beautify

Description:

Default Beautifier to be used for Nginx

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Nginx files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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.
Don't join curly brackets

Namespace: nginx

Key: dontJoinCurlyBracet

Default: true

Type: boolean

Supported Beautifiers: Nginx Beautify

Description:

(Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "dontJoinCurlyBracet": true
    }
}
Indent char

Namespace: nginx

Key: indent_char

Default:

Type: string

Supported Beautifiers: Nginx Beautify

Description:

Indentation character (Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "indent_char": " "
    }
}
Indent size

Namespace: nginx

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Nginx Beautify

Description:

Indentation size/length (Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: nginx

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Nginx Beautify

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "indent_with_tabs": false
    }
}

Nunjucks

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language Nunjucks

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Nunjucks Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 Nunjucks

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Nunjucks files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Objective-C

Supported Beautifiers: Uncrustify clang-format

Option Uncrustify clang-format
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language Objective-C

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: objectivec

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "objectivec": {
        "configPath": ""
    }
}

OCaml

Supported Beautifiers: ocp-indent

Option ocp-indent
disabled
default_beautifier
beautify_on_save

Description:

Options for language OCaml

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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.

Pawn

Supported Beautifiers: Uncrustify

Option Uncrustify
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language Pawn

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: pawn

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "pawn": {
        "configPath": ""
    }
}

Perl

Supported Beautifiers: Perltidy

Option Perltidy
disabled
default_beautifier
beautify_on_save
perltidy_profile

Description:

Options for language Perl

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: perl

Key: perltidy_profile

Type: string

Supported Beautifiers: Perltidy

Description:

Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy)

Example .jsbeautifyrc Configuration

{
    "perl": {
        "perltidy_profile": ""
    }
}

PHP

Supported Beautifiers: hh_format PHP-CS-Fixer PHPCBF

Option PHP-CS-Fixer PHPCBF hh_format
disabled
default_beautifier
beautify_on_save
allow_risky
cs_fixer_config_file
cs_fixer_path
cs_fixer_version
fixers
level
phpcbf_path
phpcbf_version
rules
standard

Description:

Options for language PHP

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: PHP-CS-Fixer

Type: string

Enum: hh_format PHP-CS-Fixer PHPCBF

Description:

Default Beautifier to be used for PHP

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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.
Allow risky rules

Namespace: php

Key: allow_risky

Default: no

Type: string

Enum: no yes

Supported Beautifiers: PHP-CS-Fixer

Description:

Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "allow_risky": "no"
    }
}
PHP-CS-Fixer Config File

Namespace: php

Key: cs_fixer_config_file

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Path to php-cs-fixer config file. Will use local .php_cs or .php_cs.dist if found in the working directory or project root. (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "cs_fixer_config_file": ""
    }
}
PHP-CS-Fixer Path

Namespace: php

Key: cs_fixer_path

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Absolute path to the php-cs-fixer CLI executable (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "cs_fixer_path": ""
    }
}
PHP-CS-Fixer Version

Namespace: php

Key: cs_fixer_version

Default: 2

Type: integer

Enum: 1 2

Supported Beautifiers: PHP-CS-Fixer

Description:

(Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "cs_fixer_version": 2
    }
}
Fixers

Namespace: php

Key: fixers

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "fixers": ""
    }
}
Level

Namespace: php

Key: level

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "level": ""
    }
}
PHPCBF Path

Namespace: php

Key: phpcbf_path

Type: string

Supported Beautifiers: PHPCBF

Description:

Path to the phpcbf CLI executable (Supported by PHPCBF)

Example .jsbeautifyrc Configuration

{
    "php": {
        "phpcbf_path": ""
    }
}
PHPCBF Version

Namespace: php

Key: phpcbf_version

Default: 2

Type: integer

Enum: 1 2 3

Supported Beautifiers: PHPCBF

Description:

(Supported by PHPCBF)

Example .jsbeautifyrc Configuration

{
    "php": {
        "phpcbf_version": 2
    }
}
Rules

Namespace: php

Key: rules

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "rules": ""
    }
}
PHPCBF Standard

Namespace: php

Key: standard

Default: PEAR

Type: string

Supported Beautifiers: PHPCBF

Description:

Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local phpcs.xml, phpcs.xml.dist, phpcs.ruleset.xml or ruleset.xml if found in the project root. (Supported by PHPCBF)

Example .jsbeautifyrc Configuration

{
    "php": {
        "standard": "PEAR"
    }
}

Puppet

Supported Beautifiers: puppet-lint

Option puppet-lint
disabled
default_beautifier
beautify_on_save

Description:

Options for language Puppet

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Supported Beautifiers: autopep8 pybeautifier yapf

Option autopep8 pybeautifier yapf
disabled
default_beautifier
beautify_on_save
formater
ignore
indent_size
max_line_length
multi_line_output
sort_imports
style_config

Description:

Options for language Python

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: autopep8

Type: string

Enum: autopep8 pybeautifier yapf

Description:

Default Beautifier to be used for Python

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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.
Formater

Namespace: python

Key: formater

Default: autopep8

Type: string

Enum: autopep8 yapf

Supported Beautifiers: autopep8 pybeautifier

Description:

formater used by pybeautifier (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "formater": "autopep8"
    }
}
Ignore

Namespace: python

Key: ignore

Default: E24

Type: array

Supported Beautifiers: autopep8 pybeautifier

Description:

do not fix these errors/warnings (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "ignore": [
            "E24"
        ]
    }
}
Indent size

Namespace: python

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: autopep8 pybeautifier

Description:

Indentation size/length (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "indent_size": 4
    }
}
Max line length

Namespace: python

Key: max_line_length

Default: 79

Type: integer

Supported Beautifiers: autopep8 pybeautifier

Description:

set maximum allowed line length (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "max_line_length": 79
    }
}
Multi line output

Namespace: python

Key: multi_line_output

Default: Hanging Grid Grouped

Type: string

Enum: Grid Vertical Hanging Indent Vertical Hanging Indent Hanging Grid Hanging Grid Grouped NOQA

Supported Beautifiers: autopep8 pybeautifier

Description:

defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "multi_line_output": "Hanging Grid Grouped"
    }
}
Sort imports

Namespace: python

Key: sort_imports

Type: boolean

Supported Beautifiers: autopep8 pybeautifier

Description:

sort imports (requires isort installed) (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "sort_imports": false
    }
}
Style config

Namespace: python

Key: style_config

Default: pep8

Type: string

Supported Beautifiers: autopep8 pybeautifier

Description:

formatting style used by yapf (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "style_config": "pep8"
    }
}

R

Supported Beautifiers: formatR

Option formatR
disabled
default_beautifier
beautify_on_save
indent_size

Description:

Options for language R

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable R Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: formatR

Type: string

Enum: formatR

Description:

Default Beautifier to be used for R

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify R files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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 size

Namespace: r

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: formatR

Description:

Indentation size/length (Supported by formatR)

Example .jsbeautifyrc Configuration

{
    "r": {
        "indent_size": 4
    }
}

Riot.js

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language Riot.js

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Ruby

Supported Beautifiers: Rubocop Ruby Beautify

Option Rubocop Ruby Beautify
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
rubocop_path

Description:

Options for language Ruby

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: ruby

Key: indent_char

Default:

Type: string

Enum:

Supported Beautifiers: Ruby Beautify

Description:

Indentation character (Supported by Ruby Beautify)

Example .jsbeautifyrc Configuration

{
    "ruby": {
        "indent_char": " "
    }
}
Indent size

Namespace: ruby

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Rubocop Ruby Beautify

Description:

Indentation size/length (Supported by Rubocop, Ruby Beautify)

Example .jsbeautifyrc Configuration

{
    "ruby": {
        "indent_size": 4
    }
}
Rubocop Path

Namespace: ruby

Key: rubocop_path

Type: string

Supported Beautifiers: Rubocop

Description:

Path to the rubocop CLI executable (Supported by Rubocop)

Example .jsbeautifyrc Configuration

{
    "ruby": {
        "rubocop_path": ""
    }
}

Rust

Supported Beautifiers: rustfmt

Option rustfmt
disabled
default_beautifier
beautify_on_save
rustfmt_path

Description:

Options for language Rust

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: rust

Key: rustfmt_path

Type: string

Supported Beautifiers: rustfmt

Description:

Path to rustfmt program (Supported by rustfmt)

Example .jsbeautifyrc Configuration

{
    "rust": {
        "rustfmt_path": ""
    }
}

Sass

Supported Beautifiers: SassConvert

Option SassConvert
disabled
default_beautifier
beautify_on_save

Description:

Options for language Sass

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: SassConvert

Type: string

Enum: SassConvert

Description:

Default Beautifier to be used for Sass

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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.

SCSS

Supported Beautifiers: CSScomb Pretty Diff SassConvert

Option CSScomb Pretty Diff SassConvert
disabled
default_beautifier
beautify_on_save
align_assignments
configPath
convert_quotes
force_indentation
indent_char
indent_comments
indent_size
newline_between_rules
no_lead_zero
predefinedConfig
preserve_newlines
wrap_line_length

Description:

Options for language SCSS

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 by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Pretty Diff

Type: string

Enum: CSScomb Pretty Diff SassConvert

Description:

Default Beautifier to be used for SCSS

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: css

Key: align_assignments

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "align_assignments": false
    }
}
comb custom config file

Namespace: css

Key: configPath

Type: string

Supported Beautifiers: 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

{
    "css": {
        "configPath": ""
    }
}
Convert quotes

Namespace: css

Key: convert_quotes

Default: none

Type: string

Enum: none double single

Supported Beautifiers: 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

{
    "css": {
        "convert_quotes": "none"
    }
}
Force indentation

Namespace: css

Key: force_indentation

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "force_indentation": false
    }
}
Indent char

Namespace: css

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_char": " "
    }
}
Indent comments

Namespace: css

Key: indent_comments

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Determines whether comments should be indented. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_comments": true
    }
}
Indent size

Namespace: css

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_size": 4
    }
}
Newline between rules

Namespace: css

Key: newline_between_rules

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add a newline between CSS rules (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "newline_between_rules": true
    }
}
No lead zero

Namespace: css

Key: no_lead_zero

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "no_lead_zero": false
    }
}
comb predefined config

Namespace: css

Key: predefinedConfig

Default: csscomb

Type: string

Enum: csscomb yandex zen

Supported Beautifiers: CSScomb

Description:

Used if neither a project or custom config file exists. (Supported by CSScomb)

Example .jsbeautifyrc Configuration

{
    "css": {
        "predefinedConfig": "csscomb"
    }
}
Preserve newlines

Namespace: css

Key: preserve_newlines

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "preserve_newlines": false
    }
}
Wrap line length

Namespace: css

Key: wrap_line_length

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "wrap_line_length": 0
    }
}

Spacebars

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language Spacebars

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

SQL

Supported Beautifiers: sqlformat

Option sqlformat
disabled
default_beautifier
beautify_on_save
identifiers
indent_size
keywords

Description:

Options for language SQL

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: sql

Key: identifiers

Default: unchanged

Type: string

Enum: unchanged lower upper capitalize

Supported Beautifiers: sqlformat

Description:

Change case of identifiers (Supported by sqlformat)

Example .jsbeautifyrc Configuration

{
    "sql": {
        "identifiers": "unchanged"
    }
}
Indent size

Namespace: sql

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: sqlformat

Description:

Indentation size/length (Supported by sqlformat)

Example .jsbeautifyrc Configuration

{
    "sql": {
        "indent_size": 4
    }
}
Keywords

Namespace: sql

Key: keywords

Default: upper

Type: string

Enum: unchanged lower upper capitalize

Supported Beautifiers: sqlformat

Description:

Change case of keywords (Supported by sqlformat)

Example .jsbeautifyrc Configuration

{
    "sql": {
        "keywords": "upper"
    }
}

SVG

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language SVG

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Swig

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language Swig

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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 by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

TSS

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
align_assignments
convert_quotes
force_indentation
indent_char
indent_comments
indent_size
newline_between_rules
no_lead_zero
preserve_newlines
wrap_line_length

Description:

Options for language TSS

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 by navigating to Edit > 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

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 by navigating to Edit > 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

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

  1. You can open the Settings View by navigating to Edit > 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

Namespace: css

Key: align_assignments

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "align_assignments": false
    }
}
Convert quotes

Namespace: css

Key: convert_quotes

Default: none

Type: string

Enum: none double single

Supported Beautifiers: 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

{
    "css": {
        "convert_quotes": "none"
    }
}
Force indentation

Namespace: css

Key: force_indentation

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "force_indentation": false
    }
}
Indent char

Namespace: css

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_char": " "
    }
}
Indent comments

Namespace: css

Key: indent_comments

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Determines whether comments should be indented. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_comments": true
    }
}
Indent size

Namespace: css

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_size": 4
    }
}
Newline between rules

Namespace: css

Key: newline_between_rules

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add a newline between CSS rules (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "newline_between_rules": true
    }
}
No lead zero

Namespace: css

Key: no_lead_zero

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "no_lead_zero": false
    }
}
Preserve newlines

Namespace: css

Key: preserve_newlines

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Retain empty lines. Consecutive empty lines will be converted to a single empty line. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "preserve_newlines": false
    }
}
Wrap line length

Namespace: css

Key: wrap_line_length

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum amount of characters per line (0 = disable) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "wrap_line_length": 0
    }
}

Twig

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
break_chained_methods
end_with_comma
indent_char
indent_size
indent_with_tabs
preserve_newlines
space_after_anon_function
space_in_paren
wrap_line_length

Description:

Options for language Twig

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Twig Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Pretty Diff

Type: string

Enum: Pretty Diff

Description:

Default Beautifier to be used for Twig

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Twig files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Break chained method calls across subsequent lines (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

TypeScript

Supported Beautifiers: TypeScript Formatter

Option TypeScript Formatter
disabled
default_beautifier
beautify_on_save
brace_style
break_chained_methods
end_of_line
end_with_comma
end_with_newline
eval_code
indent_char
indent_level
indent_size
indent_with_tabs
jslint_happy
keep_array_indentation
keep_function_indentation
max_preserve_newlines
preserve_newlines
space_after_anon_function
space_before_conditional
space_in_paren
unescape_strings
wrap_line_length

Description:

Options for language TypeScript

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable TypeScript Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: TypeScript Formatter

Type: string

Enum: TypeScript Formatter

Description:

Default Beautifier to be used for TypeScript

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify TypeScript files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: js

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: TypeScript Formatter

Description:

[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Break chained method calls across subsequent lines (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: TypeScript Formatter

Description:

Override EOL from line-ending-selector (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}
End with newline

Namespace: js

Key: end_with_newline

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

End output with newline (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_newline": false
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

(Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: TypeScript Formatter

Description:

Indentation character (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Initial indentation level (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Indentation size/length (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Enable jslint-stricter mode (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Preserve array indentation (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

(Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Max preserve newlines

Namespace: js

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: js

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Preserve line-breaks (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

(Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: js

Key: wrap_line_length

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "wrap_line_length": 0
    }
}

UX Markup

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language UX Markup

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable UX Markup Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Pretty Diff

Type: string

Enum: Pretty Diff

Description:

Default Beautifier to be used for UX Markup

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify UX Markup files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Vala

Supported Beautifiers: Uncrustify

Option Uncrustify
disabled
default_beautifier
beautify_on_save
configPath

Description:

Options for language Vala

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Vala Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Uncrustify

Type: string

Enum: Uncrustify

Description:

Default Beautifier to be used for Vala

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Vala files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: vala

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "vala": {
        "configPath": ""
    }
}

Visualforce

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language Visualforce

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Visualforce Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

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 Visualforce

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Visualforce files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

Vue

Supported Beautifiers: Vue Beautifier

Option Vue Beautifier
disabled
default_beautifier
beautify_on_save
brace_style
break_chained_methods
end_of_line
end_with_comma
end_with_newline
eval_code
extra_liners
indent_char
indent_inner_html
indent_level
indent_scripts
indent_size
indent_with_tabs
jslint_happy
keep_array_indentation
keep_function_indentation
max_preserve_newlines
preserve_newlines
space_after_anon_function
space_before_conditional
space_in_paren
unescape_strings
unformatted
wrap_attributes
wrap_attributes_indent_size
wrap_line_length

Description:

Options for language Vue

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable Vue Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Vue Beautifier

Type: string

Enum: Vue Beautifier

Description:

Default Beautifier to be used for Vue

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify Vue files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: Vue Beautifier

Description:

[collapse|expand|end-expand|none] (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Break chained method calls across subsequent lines (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: Vue Beautifier

Description:

Override EOL from line-ending-selector (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

End output with newline (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

(Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: Vue Beautifier

Description:

List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Vue Beautifier

Description:

Indentation character (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Indent <head> and sections. (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Initial indentation level (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: Vue Beautifier

Description:

[keep|separate|normal] (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Indentation size/length (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Enable jslint-stricter mode (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Preserve array indentation (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

(Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Preserve line-breaks (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

(Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Decode printable characters encoded in xNN notation (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: Vue Beautifier

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: Vue Beautifier

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Indent wrapped attributes to after N characters (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Maximum characters per line (0 disables) (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

XML

Supported Beautifiers: JS Beautify Pretty Diff

Option JS Beautify Pretty Diff
disabled
default_beautifier
beautify_on_save
brace_style
end_with_newline
extra_liners
indent_char
indent_inner_html
indent_scripts
indent_size
max_preserve_newlines
preserve_newlines
unformatted
wrap_attributes
wrap_attributes_indent_size
wrap_line_length

Description:

Options for language XML

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable XML Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Pretty Diff

Type: string

Enum: JS Beautify Pretty Diff

Description:

Default Beautifier to be used for XML

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify XML files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Indent <head> and sections. (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: JS Beautify

Description:

[keep|separate|normal] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: JS Beautify

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: JS Beautify

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify

Description:

Indent wrapped attributes to after N characters (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

XTemplate

Supported Beautifiers: Pretty Diff

Option Pretty Diff
disabled
default_beautifier
beautify_on_save
indent_char
indent_size
preserve_newlines
wrap_line_length

Description:

Options for language XTemplate

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable XTemplate Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: Pretty Diff

Type: string

Enum: Pretty Diff

Description:

Default Beautifier to be used for XTemplate

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify XTemplate files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}

YAML

Supported Beautifiers: align-yaml

Option align-yaml
disabled
default_beautifier
beautify_on_save
padding

Description:

Options for language YAML

Disable Beautifying Language

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Disable YAML Beautification

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Default: align-yaml

Type: string

Enum: align-yaml

Description:

Default Beautifier to be used for YAML

How to Configure

  1. You can open the Settings View by navigating to Edit > 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

Important: This option is only configurable from within Atom Beautify's setting panel.

Type: boolean

Description:

Automatically beautify YAML files on save

How to Configure

  1. You can open the Settings View by navigating to Edit > Preferences (Linux), Atom > Preferences (OS X), or File > Preferences (Windows).
  2. Go into Packages and search for "Atom Beautify" package.
  3. Find the option "Beautify On Save" and change it to your desired configuration.
Padding

Namespace: yaml

Key: padding

Type: integer

Supported Beautifiers: align-yaml

Description:

The amount of padding to add next to each line. (Supported by align-yaml)

Example .jsbeautifyrc Configuration

{
    "yaml": {
        "padding": 0
    }
}

Beautifier Options

Supported options for each beautifier.


CSScomb

comb custom config file

Namespace: css

Key: configPath

Type: string

Supported Beautifiers: 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

{
    "css": {
        "configPath": ""
    }
}
comb predefined config

Namespace: css

Key: predefinedConfig

Default: csscomb

Type: string

Enum: csscomb yandex zen

Supported Beautifiers: CSScomb

Description:

Used if neither a project or custom config file exists. (Supported by CSScomb)

Example .jsbeautifyrc Configuration

{
    "css": {
        "predefinedConfig": "csscomb"
    }
}

Coffee Formatter

Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation size/length (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation character (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: Coffee Formatter

Description:

Initial indentation level (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Preserve newlines

Namespace: js

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Preserve line-breaks (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "preserve_newlines": true
    }
}
Max preserve newlines

Namespace: js

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: Coffee Formatter

Description:

Number of line-breaks to be preserved in one chunk (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "max_preserve_newlines": 10
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Enable jslint-stricter mode (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Brace style

Namespace: js

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: Coffee Formatter

Description:

[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Break chained method calls across subsequent lines (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Preserve array indentation (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

(Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

(Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

(Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

Decode printable characters encoded in xNN notation (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: js

Key: wrap_line_length

Type: integer

Supported Beautifiers: Coffee Formatter

Description:

Wrap lines at next opportunity after N characters (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "wrap_line_length": 0
    }
}
End with newline

Namespace: js

Key: end_with_newline

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

End output with newline (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_newline": false
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: Coffee Formatter

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: Coffee Formatter

Description:

Override EOL from line-ending-selector (Supported by Coffee Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}

Fortran Beautifier

Emacs path

Namespace: fortran

Key: emacs_path

Type: string

Supported Beautifiers: Fortran Beautifier

Description:

Path to the emacs executable (Supported by Fortran Beautifier)

Example .jsbeautifyrc Configuration

{
    "fortran": {
        "emacs_path": ""
    }
}
Emacs script path

Namespace: fortran

Key: emacs_script_path

Type: string

Supported Beautifiers: Fortran Beautifier

Description:

Path to the emacs script (Supported by Fortran Beautifier)

Example .jsbeautifyrc Configuration

{
    "fortran": {
        "emacs_script_path": ""
    }
}

Gherkin formatter

Indent size

Namespace: gherkin

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Gherkin formatter

Description:

Indentation size/length (Supported by Gherkin formatter)

Example .jsbeautifyrc Configuration

{
    "gherkin": {
        "indent_size": 4
    }
}
Indent char

Namespace: gherkin

Key: indent_char

Default:

Type: string

Supported Beautifiers: Gherkin formatter

Description:

Indentation character (Supported by Gherkin formatter)

Example .jsbeautifyrc Configuration

{
    "gherkin": {
        "indent_char": " "
    }
}

HTML Beautifier

Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: HTML Beautifier Pretty Diff

Description:

Indentation size/length (Supported by HTML Beautifier, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}

JS Beautify

Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation size/length (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation character (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Selector separator newline

Namespace: css

Key: selector_separator_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Add a newline between multiple selectors (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "css": {
        "selector_separator_newline": false
    }
}
Newline between rules

Namespace: css

Key: newline_between_rules

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add a newline between CSS rules (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "newline_between_rules": true
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Preserve line-breaks (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: JS Beautify

Description:

End output with newline (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: JS Beautify

Description:

Initial indentation level (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: JS Beautify

Description:

Number of line-breaks to be preserved in one chunk (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Enable jslint-stricter mode (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Brace style

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse expand end-expand none

Supported Beautifiers: JS Beautify

Description:

[collapse|expand|end-expand|none] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: JS Beautify Pretty Diff

Description:

Break chained method calls across subsequent lines (Supported by JS Beautify, Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Preserve array indentation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: JS Beautify

Description:

(Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Decode printable characters encoded in xNN notation (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: JS Beautify 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

{
    "js": {
        "end_with_comma": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: JS Beautify

Description:

Override EOL from line-ending-selector (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Indent <head> and sections. (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: JS Beautify

Description:

[keep|separate|normal] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: JS Beautify

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: JS Beautify

Description:

Indent wrapped attributes to after N characters (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: JS Beautify

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}
E4x

Namespace: jsx

Key: e4x

Default: true

Type: boolean

Supported Beautifiers: JS Beautify

Description:

Support e4x/jsx syntax (Supported by JS Beautify)

Example .jsbeautifyrc Configuration

{
    "jsx": {
        "e4x": true
    }
}

Latex Beautify

Indent char

Namespace: latex

Key: indent_char

Default:

Type: string

Supported Beautifiers: Latex Beautify

Description:

Indentation character (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "indent_char": " "
    }
}
Indent with tabs

Namespace: latex

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "indent_with_tabs": false
    }
}
Indent preamble

Namespace: latex

Key: indent_preamble

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

Indent the preable (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "indent_preamble": false
    }
}
Always look for split braces

Namespace: latex

Key: always_look_for_split_braces

Default: true

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

If latexindent should look for commands that split braces across lines (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "always_look_for_split_braces": true
    }
}
Always look for split brackets

Namespace: latex

Key: always_look_for_split_brackets

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

If latexindent should look for commands that split brackets across lines (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "always_look_for_split_brackets": false
    }
}
Remove trailing whitespace

Namespace: latex

Key: remove_trailing_whitespace

Type: boolean

Supported Beautifiers: Latex Beautify

Description:

Remove trailing whitespace (Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "remove_trailing_whitespace": false
    }
}
Align columns in environments

Namespace: latex

Key: align_columns_in_environments

Default: tabular,matrix,bmatrix,pmatrix

Type: array

Supported Beautifiers: Latex Beautify

Description:

(Supported by Latex Beautify)

Example .jsbeautifyrc Configuration

{
    "latex": {
        "align_columns_in_environments": [
            "tabular",
            "matrix",
            "bmatrix",
            "pmatrix"
        ]
    }
}

Lua beautifier

End of line

Namespace: lua

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: Lua beautifier

Description:

Override EOL from line-ending-selector (Supported by Lua beautifier)

Example .jsbeautifyrc Configuration

{
    "lua": {
        "end_of_line": "System Default"
    }
}

Marko Beautifier

Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Indentation size/length (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Marko Beautifier

Description:

Indentation character (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Syntax

Namespace: marko

Key: syntax

Default: html

Type: string

Enum: html concise

Supported Beautifiers: Marko Beautifier

Description:

[html|concise] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "marko": {
        "syntax": "html"
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: Marko Beautifier

Description:

Indent <head> and sections. (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Brace style

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse expand end-expand none

Supported Beautifiers: Marko Beautifier

Description:

[collapse|expand|end-expand|none] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: Marko Beautifier

Description:

[keep|separate|normal] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Maximum characters per line (0 disables) (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: Marko Beautifier

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Indent wrapped attributes to after N characters (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Marko Beautifier

Description:

Preserve line-breaks (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: Marko Beautifier

Description:

Number of line-breaks to be preserved in one chunk (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: Marko Beautifier

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: Marko Beautifier

Description:

End output with newline (Supported by Marko Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: 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

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}

Nginx Beautify

Indent size

Namespace: nginx

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Nginx Beautify

Description:

Indentation size/length (Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "indent_size": 4
    }
}
Indent char

Namespace: nginx

Key: indent_char

Default:

Type: string

Supported Beautifiers: Nginx Beautify

Description:

Indentation character (Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "indent_char": " "
    }
}
Indent with tabs

Namespace: nginx

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Nginx Beautify

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "indent_with_tabs": false
    }
}
Don't join curly brackets

Namespace: nginx

Key: dontJoinCurlyBracet

Default: true

Type: boolean

Supported Beautifiers: Nginx Beautify

Description:

(Supported by Nginx Beautify)

Example .jsbeautifyrc Configuration

{
    "nginx": {
        "dontJoinCurlyBracet": true
    }
}

PHP-CS-Fixer

PHP-CS-Fixer Path

Namespace: php

Key: cs_fixer_path

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Absolute path to the php-cs-fixer CLI executable (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "cs_fixer_path": ""
    }
}
PHP-CS-Fixer Version

Namespace: php

Key: cs_fixer_version

Default: 2

Type: integer

Enum: 1 2

Supported Beautifiers: PHP-CS-Fixer

Description:

(Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "cs_fixer_version": 2
    }
}
PHP-CS-Fixer Config File

Namespace: php

Key: cs_fixer_config_file

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Path to php-cs-fixer config file. Will use local .php_cs or .php_cs.dist if found in the working directory or project root. (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "cs_fixer_config_file": ""
    }
}
Fixers

Namespace: php

Key: fixers

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Add fixer(s). i.e. linefeed,-short_tag,indentation (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "fixers": ""
    }
}
Level

Namespace: php

Key: level

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

By default, all PSR-2 fixers and some additional ones are run. (PHP-CS-Fixer 1 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "level": ""
    }
}
Rules

Namespace: php

Key: rules

Type: string

Supported Beautifiers: PHP-CS-Fixer

Description:

Add rule(s). i.e. line_ending,-full_opening_tag,@PSR2 (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "rules": ""
    }
}
Allow risky rules

Namespace: php

Key: allow_risky

Default: no

Type: string

Enum: no yes

Supported Beautifiers: PHP-CS-Fixer

Description:

Allow risky rules to be applied (PHP-CS-Fixer 2 only) (Supported by PHP-CS-Fixer)

Example .jsbeautifyrc Configuration

{
    "php": {
        "allow_risky": "no"
    }
}

PHPCBF

PHPCBF Path

Namespace: php

Key: phpcbf_path

Type: string

Supported Beautifiers: PHPCBF

Description:

Path to the phpcbf CLI executable (Supported by PHPCBF)

Example .jsbeautifyrc Configuration

{
    "php": {
        "phpcbf_path": ""
    }
}
PHPCBF Version

Namespace: php

Key: phpcbf_version

Default: 2

Type: integer

Enum: 1 2 3

Supported Beautifiers: PHPCBF

Description:

(Supported by PHPCBF)

Example .jsbeautifyrc Configuration

{
    "php": {
        "phpcbf_version": 2
    }
}
PHPCBF Standard

Namespace: php

Key: standard

Default: PEAR

Type: string

Supported Beautifiers: PHPCBF

Description:

Standard name Squiz, PSR2, PSR1, PHPCS, PEAR, Zend, MySource... or path to CS rules. Will use local phpcs.xml, phpcs.xml.dist, phpcs.ruleset.xml or ruleset.xml if found in the project root. (Supported by PHPCBF)

Example .jsbeautifyrc Configuration

{
    "php": {
        "standard": "PEAR"
    }
}

Perltidy

Perltidy profile

Namespace: perl

Key: perltidy_profile

Type: string

Supported Beautifiers: Perltidy

Description:

Specify a configuration file which will override the default name of .perltidyrc (Supported by Perltidy)

Example .jsbeautifyrc Configuration

{
    "perl": {
        "perltidy_profile": ""
    }
}

Pretty Diff

Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Indentation size/length (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pretty Diff

Description:

Indentation character (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Pretty Diff

Description:

Maximum characters per line (0 disables) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Preserve line-breaks (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Newline between rules

Namespace: css

Key: newline_between_rules

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add a newline between CSS rules (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "newline_between_rules": true
    }
}
Indent comments

Namespace: css

Key: indent_comments

Default: true

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Determines whether comments should be indented. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "css": {
        "indent_comments": true
    }
}
Force indentation

Namespace: css

Key: force_indentation

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "force_indentation": false
    }
}
Convert quotes

Namespace: css

Key: convert_quotes

Default: none

Type: string

Enum: none double single

Supported Beautifiers: 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

{
    "css": {
        "convert_quotes": "none"
    }
}
Align assignments

Namespace: css

Key: align_assignments

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "align_assignments": false
    }
}
No lead zero

Namespace: css

Key: no_lead_zero

Type: boolean

Supported Beautifiers: 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

{
    "css": {
        "no_lead_zero": false
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

Break chained method calls across subsequent lines (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: Pretty Diff

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Pretty Diff)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}

Pug Beautify

Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Pug Beautify

Description:

Indentation size/length (Supported by Pug Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Pug Beautify

Description:

Indentation character (Supported by Pug Beautify)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}

Remark

Gfm

Namespace: markdown

Key: gfm

Default: true

Type: boolean

Supported Beautifiers: Remark

Description:

GitHub Flavoured Markdown (Supported by Remark)

Example .jsbeautifyrc Configuration

{
    "markdown": {
        "gfm": true
    }
}
Yaml

Namespace: markdown

Key: yaml

Default: true

Type: boolean

Supported Beautifiers: Remark

Description:

Enables raw YAML front matter to be detected (thus ignoring markdown-like syntax). (Supported by Remark)

Example .jsbeautifyrc Configuration

{
    "markdown": {
        "yaml": true
    }
}
Commonmark

Namespace: markdown

Key: commonmark

Type: boolean

Supported Beautifiers: Remark

Description:

Allows and disallows several constructs. (Supported by Remark)

Example .jsbeautifyrc Configuration

{
    "markdown": {
        "commonmark": false
    }
}

Rubocop

Indent size

Namespace: ruby

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Rubocop Ruby Beautify

Description:

Indentation size/length (Supported by Rubocop, Ruby Beautify)

Example .jsbeautifyrc Configuration

{
    "ruby": {
        "indent_size": 4
    }
}
Rubocop Path

Namespace: ruby

Key: rubocop_path

Type: string

Supported Beautifiers: Rubocop

Description:

Path to the rubocop CLI executable (Supported by Rubocop)

Example .jsbeautifyrc Configuration

{
    "ruby": {
        "rubocop_path": ""
    }
}

Ruby Beautify

Indent size

Namespace: ruby

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Rubocop Ruby Beautify

Description:

Indentation size/length (Supported by Rubocop, Ruby Beautify)

Example .jsbeautifyrc Configuration

{
    "ruby": {
        "indent_size": 4
    }
}
Indent char

Namespace: ruby

Key: indent_char

Default:

Type: string

Enum:

Supported Beautifiers: Ruby Beautify

Description:

Indentation character (Supported by Ruby Beautify)

Example .jsbeautifyrc Configuration

{
    "ruby": {
        "indent_char": " "
    }
}

TypeScript Formatter

Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Indentation size/length (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: TypeScript Formatter

Description:

Indentation character (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Initial indentation level (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Preserve newlines

Namespace: js

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Preserve line-breaks (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "preserve_newlines": true
    }
}
Max preserve newlines

Namespace: js

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Number of line-breaks to be preserved in one chunk (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "max_preserve_newlines": 10
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Enable jslint-stricter mode (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Brace style

Namespace: js

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: TypeScript Formatter

Description:

[collapse|collapse-preserve-inline|expand|end-expand|none] (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Break chained method calls across subsequent lines (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Preserve array indentation (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

(Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

(Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

(Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

Decode printable characters encoded in xNN notation (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: js

Key: wrap_line_length

Type: integer

Supported Beautifiers: TypeScript Formatter

Description:

Wrap lines at next opportunity after N characters (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "wrap_line_length": 0
    }
}
End with newline

Namespace: js

Key: end_with_newline

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

End output with newline (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_newline": false
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: TypeScript Formatter

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: TypeScript Formatter

Description:

Override EOL from line-ending-selector (Supported by TypeScript Formatter)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}

Uncrustify

Config Path

Namespace: vala

Key: configPath

Type: string

Supported Beautifiers: Uncrustify

Description:

Path to uncrustify config file. i.e. uncrustify.cfg (Supported by Uncrustify)

Example .jsbeautifyrc Configuration

{
    "vala": {
        "configPath": ""
    }
}

Vue Beautifier

Indent size

Namespace: html

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Indentation size/length (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_size": 4
    }
}
Indent char

Namespace: html

Key: indent_char

Default:

Type: string

Supported Beautifiers: Vue Beautifier

Description:

Indentation character (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_char": " "
    }
}
Indent level

Namespace: js

Key: indent_level

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Initial indentation level (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_level": 0
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}
Preserve newlines

Namespace: html

Key: preserve_newlines

Default: true

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Preserve line-breaks (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "preserve_newlines": true
    }
}
Max preserve newlines

Namespace: html

Key: max_preserve_newlines

Default: 10

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Number of line-breaks to be preserved in one chunk (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "max_preserve_newlines": 10
    }
}
Space in paren

Namespace: js

Key: space_in_paren

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Add padding spaces within paren, ie. f( a, b ) (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_in_paren": false
    }
}
Jslint happy

Namespace: js

Key: jslint_happy

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Enable jslint-stricter mode (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "jslint_happy": false
    }
}
Space after anon function

Namespace: js

Key: space_after_anon_function

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Add a space before an anonymous function's parens, ie. function () (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_after_anon_function": false
    }
}
Brace style

Namespace: html

Key: brace_style

Default: collapse

Type: string

Enum: collapse collapse-preserve-inline expand end-expand none

Supported Beautifiers: Vue Beautifier

Description:

[collapse|expand|end-expand|none] (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "brace_style": "collapse"
    }
}
Break chained methods

Namespace: js

Key: break_chained_methods

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Break chained method calls across subsequent lines (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "break_chained_methods": false
    }
}
Keep array indentation

Namespace: js

Key: keep_array_indentation

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Preserve array indentation (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_array_indentation": false
    }
}
Keep function indentation

Namespace: js

Key: keep_function_indentation

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

(Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "keep_function_indentation": false
    }
}
Space before conditional

Namespace: js

Key: space_before_conditional

Default: true

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

(Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "space_before_conditional": true
    }
}
Eval code

Namespace: js

Key: eval_code

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

(Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "eval_code": false
    }
}
Unescape strings

Namespace: js

Key: unescape_strings

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Decode printable characters encoded in xNN notation (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "unescape_strings": false
    }
}
Wrap line length

Namespace: html

Key: wrap_line_length

Default: 250

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Maximum characters per line (0 disables) (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_line_length": 250
    }
}
End with newline

Namespace: html

Key: end_with_newline

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

End output with newline (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "end_with_newline": false
    }
}
End with comma

Namespace: js

Key: end_with_comma

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

If a terminating comma should be inserted into arrays, object literals, and destructured objects. (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_with_comma": false
    }
}
End of line

Namespace: js

Key: end_of_line

Default: System Default

Type: string

Enum: CRLF LF System Default

Supported Beautifiers: Vue Beautifier

Description:

Override EOL from line-ending-selector (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "js": {
        "end_of_line": "System Default"
    }
}
Indent inner html

Namespace: html

Key: indent_inner_html

Type: boolean

Supported Beautifiers: Vue Beautifier

Description:

Indent <head> and sections. (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_inner_html": false
    }
}
Indent scripts

Namespace: html

Key: indent_scripts

Default: normal

Type: string

Enum: keep separate normal

Supported Beautifiers: Vue Beautifier

Description:

[keep|separate|normal] (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "indent_scripts": "normal"
    }
}
Wrap attributes

Namespace: html

Key: wrap_attributes

Default: auto

Type: string

Enum: auto force force-aligned force-expand-multiline

Supported Beautifiers: Vue Beautifier

Description:

Wrap attributes to new lines [auto|force|force-aligned|force-expand-multiline] (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes": "auto"
    }
}
Wrap attributes indent size

Namespace: html

Key: wrap_attributes_indent_size

Default: 4

Type: integer

Supported Beautifiers: Vue Beautifier

Description:

Indent wrapped attributes to after N characters (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "wrap_attributes_indent_size": 4
    }
}
Unformatted

Namespace: html

Key: unformatted

Default: a,abbr,area,audio,b,bdi,bdo,br,button,canvas,cite,code,data,datalist,del,dfn,em,embed,i,iframe,img,input,ins,kbd,keygen,label,map,mark,math,meter,noscript,object,output,progress,q,ruby,s,samp,select,small,span,strong,sub,sup,svg,template,textarea,time,u,var,video,wbr,text,acronym,address,big,dt,ins,small,strike,tt,pre,h1,h2,h3,h4,h5,h6

Type: array

Supported Beautifiers: Vue Beautifier

Description:

List of tags (defaults to inline) that should not be reformatted (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "unformatted": [
            "a",
            "abbr",
            "area",
            "audio",
            "b",
            "bdi",
            "bdo",
            "br",
            "button",
            "canvas",
            "cite",
            "code",
            "data",
            "datalist",
            "del",
            "dfn",
            "em",
            "embed",
            "i",
            "iframe",
            "img",
            "input",
            "ins",
            "kbd",
            "keygen",
            "label",
            "map",
            "mark",
            "math",
            "meter",
            "noscript",
            "object",
            "output",
            "progress",
            "q",
            "ruby",
            "s",
            "samp",
            "select",
            "small",
            "span",
            "strong",
            "sub",
            "sup",
            "svg",
            "template",
            "textarea",
            "time",
            "u",
            "var",
            "video",
            "wbr",
            "text",
            "acronym",
            "address",
            "big",
            "dt",
            "ins",
            "small",
            "strike",
            "tt",
            "pre",
            "h1",
            "h2",
            "h3",
            "h4",
            "h5",
            "h6"
        ]
    }
}
Extra liners

Namespace: html

Key: extra_liners

Default: head,body,/html

Type: array

Supported Beautifiers: Vue Beautifier

Description:

List of tags (defaults to [head,body,/html] that should have an extra newline before them. (Supported by Vue Beautifier)

Example .jsbeautifyrc Configuration

{
    "html": {
        "extra_liners": [
            "head",
            "body",
            "/html"
        ]
    }
}

align-yaml

Padding

Namespace: yaml

Key: padding

Type: integer

Supported Beautifiers: align-yaml

Description:

The amount of padding to add next to each line. (Supported by align-yaml)

Example .jsbeautifyrc Configuration

{
    "yaml": {
        "padding": 0
    }
}

autopep8

Max line length

Namespace: python

Key: max_line_length

Default: 79

Type: integer

Supported Beautifiers: autopep8 pybeautifier

Description:

set maximum allowed line length (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "max_line_length": 79
    }
}
Indent size

Namespace: python

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: autopep8 pybeautifier

Description:

Indentation size/length (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "indent_size": 4
    }
}
Ignore

Namespace: python

Key: ignore

Default: E24

Type: array

Supported Beautifiers: autopep8 pybeautifier

Description:

do not fix these errors/warnings (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "ignore": [
            "E24"
        ]
    }
}
Formater

Namespace: python

Key: formater

Default: autopep8

Type: string

Enum: autopep8 yapf

Supported Beautifiers: autopep8 pybeautifier

Description:

formater used by pybeautifier (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "formater": "autopep8"
    }
}
Style config

Namespace: python

Key: style_config

Default: pep8

Type: string

Supported Beautifiers: autopep8 pybeautifier

Description:

formatting style used by yapf (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "style_config": "pep8"
    }
}
Sort imports

Namespace: python

Key: sort_imports

Type: boolean

Supported Beautifiers: autopep8 pybeautifier

Description:

sort imports (requires isort installed) (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "sort_imports": false
    }
}
Multi line output

Namespace: python

Key: multi_line_output

Default: Hanging Grid Grouped

Type: string

Enum: Grid Vertical Hanging Indent Vertical Hanging Indent Hanging Grid Hanging Grid Grouped NOQA

Supported Beautifiers: autopep8 pybeautifier

Description:

defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "multi_line_output": "Hanging Grid Grouped"
    }
}

beautysh

Indent size

Namespace: bash

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: beautysh

Description:

Indentation size/length (Supported by beautysh)

Example .jsbeautifyrc Configuration

{
    "bash": {
        "indent_size": 4
    }
}

clang-format

Config Path

Namespace: glsl

Key: configPath

Type: string

Supported Beautifiers: clang-format

Description:

Path to clang-format config file. i.e. clang-format.cfg (Supported by clang-format)

Example .jsbeautifyrc Configuration

{
    "glsl": {
        "configPath": ""
    }
}

coffee-fmt

Indent size

Namespace: js

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation size/length (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_size": 4
    }
}
Indent char

Namespace: js

Key: indent_char

Default:

Type: string

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation character (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_char": " "
    }
}
Indent with tabs

Namespace: js

Key: indent_with_tabs

Type: boolean

Supported Beautifiers: Coffee Formatter coffee-fmt

Description:

Indentation uses tabs, overrides Indent Size and Indent Char (Supported by Coffee Formatter, coffee-fmt)

Example .jsbeautifyrc Configuration

{
    "js": {
        "indent_with_tabs": false
    }
}

formatR

Indent size

Namespace: r

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: formatR

Description:

Indentation size/length (Supported by formatR)

Example .jsbeautifyrc Configuration

{
    "r": {
        "indent_size": 4
    }
}

pybeautifier

Max line length

Namespace: python

Key: max_line_length

Default: 79

Type: integer

Supported Beautifiers: autopep8 pybeautifier

Description:

set maximum allowed line length (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "max_line_length": 79
    }
}
Indent size

Namespace: python

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: autopep8 pybeautifier

Description:

Indentation size/length (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "indent_size": 4
    }
}
Ignore

Namespace: python

Key: ignore

Default: E24

Type: array

Supported Beautifiers: autopep8 pybeautifier

Description:

do not fix these errors/warnings (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "ignore": [
            "E24"
        ]
    }
}
Formater

Namespace: python

Key: formater

Default: autopep8

Type: string

Enum: autopep8 yapf

Supported Beautifiers: autopep8 pybeautifier

Description:

formater used by pybeautifier (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "formater": "autopep8"
    }
}
Style config

Namespace: python

Key: style_config

Default: pep8

Type: string

Supported Beautifiers: autopep8 pybeautifier

Description:

formatting style used by yapf (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "style_config": "pep8"
    }
}
Sort imports

Namespace: python

Key: sort_imports

Type: boolean

Supported Beautifiers: autopep8 pybeautifier

Description:

sort imports (requires isort installed) (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "sort_imports": false
    }
}
Multi line output

Namespace: python

Key: multi_line_output

Default: Hanging Grid Grouped

Type: string

Enum: Grid Vertical Hanging Indent Vertical Hanging Indent Hanging Grid Hanging Grid Grouped NOQA

Supported Beautifiers: autopep8 pybeautifier

Description:

defines how from imports wrap (requires isort installed) (Supported by autopep8, pybeautifier)

Example .jsbeautifyrc Configuration

{
    "python": {
        "multi_line_output": "Hanging Grid Grouped"
    }
}

rustfmt

Rustfmt path

Namespace: rust

Key: rustfmt_path

Type: string

Supported Beautifiers: rustfmt

Description:

Path to rustfmt program (Supported by rustfmt)

Example .jsbeautifyrc Configuration

{
    "rust": {
        "rustfmt_path": ""
    }
}

sqlformat

Indent size

Namespace: sql

Key: indent_size

Default: 4

Type: integer

Supported Beautifiers: sqlformat

Description:

Indentation size/length (Supported by sqlformat)

Example .jsbeautifyrc Configuration

{
    "sql": {
        "indent_size": 4
    }
}
Keywords

Namespace: sql

Key: keywords

Default: upper

Type: string

Enum: unchanged lower upper capitalize

Supported Beautifiers: sqlformat

Description:

Change case of keywords (Supported by sqlformat)

Example .jsbeautifyrc Configuration

{
    "sql": {
        "keywords": "upper"
    }
}
Identifiers

Namespace: sql

Key: identifiers

Default: unchanged

Type: string

Enum: unchanged lower upper capitalize

Supported Beautifiers: sqlformat

Description:

Change case of identifiers (Supported by sqlformat)

Example .jsbeautifyrc Configuration

{
    "sql": {
        "identifiers": "unchanged"
    }
}