"options" | Unibeautify

Index

Interfaces

Type aliases

SemVer

Object literals

Options

Type aliases

SemVer

SemVer: string

Object literals

Const Options

Options: object

align_assignments

align_assignments: object

default

default: boolean = false

description

description: string = "If lists of assignments or properties should be vertically aligned for faster " +"and easier reading."

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

arrow_parens

arrow_parens: object

default

default: string = "always"

description

description: string = "Require parenthesis in arrow function arguments"

enum

enum: string[] = ["always", "as-needed"]

since

since: string = "0.7.0"

type

type: "string" = "string"

brace_style

brace_style: object

default

default: string = "collapse"

description

description: string = "Brace style"

enum

enum: string[] = ["collapse","collapse-preserve-inline","expand","end-expand","none",]

since

since: string = "0.7.0"

type

type: "string" = "string"

break_chained_methods

break_chained_methods: object

default

default: boolean = false

description

description: string = "Break chained method calls across subsequent lines"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

comma_first

comma_first: object

default

default: boolean = false

description

description: string = "Put commas at the beginning of new line instead of end"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

end_of_line

end_of_line: object

default

default: string = "System Default"

description

description: string = "End-Of-Line (EOL) separator"

enum

enum: string[] = ["CRLF", "LF", "System Default"]

since

since: string = "0.7.0"

type

type: "string" = "string"

end_with_comma

end_with_comma: object

default

default: boolean = false

description

description: string = "If a terminating comma should be inserted into arrays, object literals, and de" +"structured objects."

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

end_with_newline

end_with_newline: object

default

default: boolean = false

description

description: string = "End output with newline"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

end_with_semicolon

end_with_semicolon: object

default

default: boolean = false

description

description: string = "Insert a semicolon at the end of statements"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

force_indentation

force_indentation: object

default

default: boolean = false

description

description: string = "if indentation should be forcefully applied to markup even if it disruptively " +"adds unintended whitespace to the documents rendered output"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

identifier_case

identifier_case: object

default

default: string = "lowercase"

description

description: string = "Case type for identifiers"

enum

enum: string[] = ["lowercase", "uppercase", "capitalize"]

since

since: string = "0.17.0"

type

type: "string" = "string"

indent_chained_methods

indent_chained_methods: object

default

default: boolean = true

description

description: string = "Indent chained method calls"

since

since: string = "0.10.0"

type

type: "boolean" = "boolean"

indent_char

indent_char: object

default

default: string = " "

deprecated

deprecated: string = "0.8.0"

description

description: string = "Indentation character"

enum

enum: string[] = [" ", "\t"]

since

since: string = "0.7.0"

type

type: "string" = "string"

indent_comments

indent_comments: object

default

default: boolean = true

description

description: string = "Determines whether comments should be indented."

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

indent_inner_html

indent_inner_html: object

default

default: boolean = false

description

description: string = "Indent <head> and <body> sections."

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

indent_level

indent_level: object

default

default: number = 0

description

description: string = "Initial indentation level"

minimum

minimum: number = 0

multipleOf

multipleOf: number = 1

since

since: string = "0.7.0"

type

type: "integer" = "integer"

indent_scripts

indent_scripts: object

default

default: string = "normal"

description

description: string = "Indent scripts"

enum

enum: string[] = ["keep", "separate", "normal"]

since

since: string = "0.7.0"

type

type: "string" = "string"

indent_size

indent_size: object

default

default: number = 2

description

description: string = "Indentation size/length"

minimum

minimum: number = 0

multipleOf

multipleOf: number = 1

since

since: string = "0.7.0"

type

type: "integer" = "integer"

indent_style

indent_style: object

default

default: string = "space"

description

description: string = "Indentation style"

enum

enum: string[] = ["space", "tab"]

since

since: string = "0.8.0"

type

type: "string" = "string"

indent_with_tabs

indent_with_tabs: object

default

default: boolean = true

deprecated

deprecated: string = "0.8.0"

description

description: string = "Indentation uses tabs, overrides `Indent Size` and `Indent Char`"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

jslint_happy

jslint_happy: object

default

default: boolean = false

description

description: string = "Enable jslint-stricter mode"

since

since: string = "0.7.0"

title

title: string = "JSLint Happy"

type

type: "boolean" = "boolean"

jsx_brackets

jsx_brackets: object

default

default: boolean = false

description

description: string = "Put the `>` of a multi-line JSX element at the end of the last line"

since

since: string = "0.7.0"

title

title: string = "JSX Brackets"

type

type: "boolean" = "boolean"

keep_array_indentation

keep_array_indentation: object

default

default: boolean = false

description

description: string = "Preserve array indentation"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

keyword_case

keyword_case: object

default

default: string = "lowercase"

description

description: string = "Case type for keywords"

enum

enum: string[] = ["lowercase", "uppercase", "capitalize"]

since

since: string = "0.17.0"

type

type: "string" = "string"

max_preserve_newlines

max_preserve_newlines: object

default

default: number = 10

description

description: string = "Number of line-breaks to be preserved in one chunk"

multipleOf

multipleOf: number = 1

since

since: string = "0.7.0"

type

type: "integer" = "integer"

multiline_ternary

multiline_ternary: object

default

default: string = "always"

description

description: string = "Enforces new lines between the operands of a ternary expression"

enum

enum: string[] = ["always", "always-multiline", "never"]

since

since: string = "0.7.0"

type

type: "string" = "string"

newline_before_tags

newline_before_tags: object

default

default: string[] = ["head", "body", "/html"]

description

description: string = "List of tags which should have an extra newline before them."

since

since: string = "0.7.0"

type

type: "array" = "array"

items

items: object

type

type: string = "string"

newline_between_rules

newline_between_rules: object

default

default: boolean = true

description

description: string = "Add a newline between CSS rules"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

no_leading_zero

no_leading_zero: object

default

default: boolean = false

description

description: string = "If in CSS values leading 0s immediately preceeding a decimal should be removed" +" or prevented."

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

object_curly_spacing

object_curly_spacing: object

default

default: boolean = true

description

description: string = "Inserts a space before/after brackets for object literals, destructuring assig" +"nments, and import/export specifiers"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

pragma_insert

pragma_insert: object

default

default: boolean = false

description

description: string = "Insert a marker at the top of a file specifying the file has been beautified"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

pragma_require

pragma_require: object

default

default: boolean = false

description

description: string = "Restrict beautifying files to only those with a pragma at the top"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

preserve_newlines

preserve_newlines: object

default

default: boolean = true

description

description: string = "Preserve line-breaks"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

quotes

quotes: object

default

default: string = "none"

description

description: string = "Convert the quote characters delimiting strings from either double or single q" +"uotes to the other."

enum

enum: string[] = ["none", "double", "single"]

since

since: string = "0.7.0"

type

type: "string" = "string"

remove_trailing_whitespace

remove_trailing_whitespace: object

default

default: boolean = false

description

description: string = "Remove trailing whitespace"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

selector_separator_newline

selector_separator_newline: object

default

default: boolean = false

description

description: string = "Add a newline between multiple selectors"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

space_after_anon_function

space_after_anon_function: object

default

default: boolean = false

description

description: string = "Add a space before an anonymous function's parentheses. ie. `function ()`"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

space_before_conditional

space_before_conditional: object

default

default: boolean = true

description

description: string = "Add a space before conditional, `if(true)` vs `if (true)`"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

space_in_empty_paren

space_in_empty_paren: object

default

default: boolean = false

description

description: string = "Add padding spaces within empty parentheses, ie. `f( )`"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

space_in_paren

space_in_paren: object

default

default: boolean = false

description

description: string = "Add padding spaces within parentheses, ie. `f( a, b )`"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

typesafe_equality_operators

typesafe_equality_operators: object

default

default: boolean = false

description

description: string = "Use typesafe equality operators (`===` and `!==` instead of `==` and `!=`)"

since

since: string = "0.10.0"

type

type: "boolean" = "boolean"

unescape_strings

unescape_strings: object

default

default: boolean = false

description

description: string = "Decode printable characters encoded in xNN notation"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

unformatted

unformatted: object

default

default: string[] = ["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",]

description

description: string = "List of tags (defaults to inline) that should not be reformatted"

since

since: string = "0.7.0"

type

type: "array" = "array"

items

items: object

type

type: string = "string"

unindent_chained_methods

unindent_chained_methods: object

default

default: boolean = false

deprecated

deprecated: string = "0.10.0"

description

description: string = "Do not indent chained method calls"

since

since: string = "0.7.0"

type

type: "boolean" = "boolean"

wrap_attributes

wrap_attributes: object

default

default: string = "auto"

description

description: string = "Wrap attributes to new lines"

enum

enum: string[] = ["auto", "force", "force-aligned"]

since

since: string = "0.7.0"

type

type: "string" = "string"

wrap_attributes_indent_size

wrap_attributes_indent_size: object

default

default: number = 4

description

description: string = "Indent wrapped attributes to after N characters"

minimum

minimum: number = 0

multipleOf

multipleOf: number = 1

since

since: string = "0.7.0"

type

type: "integer" = "integer"

wrap_line_length

wrap_line_length: object

default

default: number = 80

description

description: string = "Wrap lines at next opportunity after N characters"

minimum

minimum: number = 0

multipleOf

multipleOf: number = 1

since

since: string = "0.7.0"

type

type: "integer" = "integer"

wrap_prose

wrap_prose: object

default

default: string = "preserve"

description

description: string = "Wrap markdown text to new lines"

enum

enum: string[] = ["always", "never", "preserve"]

since

since: string = "0.7.0"

type

type: "string" = "string"