Skip to content

Latest commit

 

History

History
668 lines (489 loc) · 9.6 KB

Style-Config.md

File metadata and controls

668 lines (489 loc) · 9.6 KB
Raw

Style config file

format with style config file

lua-format {your_source_file} -c {your_config_file}

style config file format

key: "string"
key2: 123
key3: true
# comment

Style options

column_limit

type: int, default: 80

The column limit of one line.

indent_width

type: int, default: 4

The number of spaces used for indentation.

-- indent_width: 2
function x()
  print(1)
end

-- indent_width: 4
function x()
    print(1)
end

use_tab

type: bool, default: false

Use tab for indent.

-- use_tab: false
function x()
  print(1)
end

-- use_tab: true
function x()
	print(1)
end

continuation_indent_width

type: int, default: 4

Indent width for continuations line.

-- continuation_indent_width: 2
local xxx, yyy = 
  111, 222

-- continuation_indent_width: 4
local xxx, yyy = 
    111, 222

keep_simple_control_block_one_line

type: bool, default: true

Allow format simple control block(e.g., if, while, for, ...) to one line.

-- keep_simple_control_block_one_line: true
if cond then xx() end

-- keep_simple_control_block_one_line: false
if cond then
    xx()
end

keep_simple_function_one_line

type: bool, default: true

Allow format simple function to one line.

-- keep_simple_function_one_line: true
function x() print(1) end

-- keep_simple_function_one_line: false
function x()
    print(1)
end

align_args

type: bool, default: true

Align arguments of a function call if there is a line break. If false, use continuation_indent_width to indentation.

-- align_args: true
xxxxxxx(qqqqqqqqq,
        wwwwww)

-- align_args: false
xxxxxxx(qqqqqqqqq,
    wwwwww)

break_after_functioncall_lp

type: bool, default: false

Break after '(' of function call if columns greater than column_limit.

-- break_after_functioncall_lp: true
xxxxxxx(
    qqqqqqqqq,
    wwwwww)

-- break_after_functioncall_lp: false
xxxxxxx(qqqqqqqqq,
        wwwwww)

break_before_functioncall_rp

type: bool, default: false

Break before ')' of function call if columns greater than column_limit.

-- break_before_functioncall_rp: true
xxxxxxx(
    qqqqqqqqq,
    wwwwww
)

-- break_before_functioncall_rp: false
xxxxxxx(
    qqqqqqqqq,
    wwwwww)

align_parameter

type: bool, default: true

Align parameter of function define if there is a line break. if false, use continuation_indent_width to indentation.

-- align_parameter: true
function xxx(aaa, bbb
             ccc, ddd)

-- align_parameter: false
function xxx(aaa, bbb
    ccc, ddd)

chop_down_parameter

type: bool, default: false

Chop down all parameters if the function declaration doesn’t fit on a line.

-- chop_down_parameter: true
function xxx(aaa, 
             bbb,
             ccc,
             ddd)

-- chop_down_parameter: false
function xxx(aaa, bbb
             ccc, ddd)

break_after_functiondef_lp

type: bool, default: false

Break after '(' of function define if columns greater than column_limit.

-- break_after_functiondef_lp: true
function xxx(
    aaa, bbb, ccc,
    ddd)

-- break_after_functiondef_lp: false
function xxx(aaa,bbb
             ccc,ddd)

break_before_functiondef_rp

type: bool, default: false

Break before ')' of function define if columns greater than column_limit.

-- break_before_functiondef_rp: true
function xxx(
    aaa, bbb, ccc,
    ddd
)

-- break_before_functiondef_rp: false
function xxx(
    aaa, bbb, ccc,
    ddd)

align_table_field

type: bool, default: true

Align fields of a table if there is a line break. if false, use indent_width to indentation.

-- align_table_field: true
x = {111, 222,
     333, 444}

-- align_table_field: false
x = {111, 222,
  333, 444}

break_after_table_lb

type: bool, default: true

Break after '{' of a table if columns greater than column_limit.

-- break_after_table_lb: true
x = {
  111, 222,
  333, 444}

-- break_after_table_lb: false
x = {111, 222,
     333, 444}

break_before_table_rb

type: bool, default: true

Break before '}' of a table if columns greater than column_limit.

-- break_before_table_rb: true
x = {
  111, 222,
  333, 444
}

-- break_before_table_rb: false
x = {
  111, 222,
  333, 444}

chop_down_table

type: bool, default: false

Chop down any table.

-- chop_down_table: true
x = {
    v1,
    v2,
    v3,
    v4
}

-- chop_down_table: false
x = {
    v1, v2,
    v3, v4
}

chop_down_kv_table

type: bool, default: true

Chop down table if a table contains a key.

-- chop_down_kv_table: true
x = {
    k1 = v1,
    k2 = v2,
    k3 = v3,
    k4 = v4
}

-- chop_down_kv_table: false
x = {
    k1 = v1, k2 = v2,
    k3 = v3, k4 = v4
}

column_table_limit

type: int, default: 0

The column limit of each line of a table. If set to 0 (the default), the value of column_limit is used.

--column_table_limit: 0
test = {
  image = "test",
  list = {
    {
      ref = "testRef",
      tags = {"tagTest"},
      time = 10,

      materials = {{materialId = 123, count = 10}}
    }
  }
}

--column_table_limit: 20
test = {
  image = "test",
  list = {
    {
      ref = "testRef",
      tags = {
        "tagTest"
      },
      time = 10,

      materials = {
        {
          materialId = 123,
          count = 10
        }
      }
    }
  }
}

column_table_limit_kv

type: int, default: 0

The column limit of each line of a k = v table. If set to 0 (the default), the value of column_table_limit is used.

--column_table_limit_kv: 80
--column_table_limit: 120

local a = {"one", "one", "one", "one", "one", "one", "one", "one", "one", "one", "one", "one", "one", "one"}

local some_list = {
  ['A'] = true,
  ['B'] = true,
  ['C'] = true,
  ['D'] = true,
  ['E'] = true
}

table_sep

type: str, default: ','

Define character to separate table fields.

-- table_sep: ','
x = {
    k1 = v1,
    k2 = v2,
    k3 = v3
}

-- table_sep: ';'
x = {
    k1 = v1;
    k2 = v2;
    k3 = v3
}

extra_sep_at_table_end

type: bool, default: false

Add an extra field separator after the last field unless the table is in a single line.

-- extra_sep_at_table_end: true
x = {
    k1 = v1,
    k2 = v2,
    k3 = v3,
}

-- extra_sep_at_table_end: false
x = {
    k1 = v1,
    k2 = v2,
    k3 = v3
}

break_after_operator

type: bool, default: true

Put break after operators if columns greater than column_limit. If false, put break before operators.

-- break_after_operator: true
x = 11111 + 11111 +
    11111 + 11111 +
    11111

-- break_after_operator: false
x = 11111 + 11111
    + 11111 + 11111
    + 11111

single_quote_to_double_quote

type: bool, default: false

Transform string literals to use double quotes.

-- original
local foo = 'a'
local foo = '"'
local bar = 'don\'t'
local foo = '\''
local foobar = '\\\\\''

-- transformed
local foo = "a"
local foo = "\""
local bar = "don't"
local foo = "'"
local foo = "\\\\'"

double_quote_to_single_quote

type: bool, default: false

Transform string literals to use a single quote.

-- original
local foo = "a"
local foo = "'"
local bar = "don't"
local bar = "\""
local foobar = "\\\\\""

-- transformed
local foo = 'a'
local foo = '\''
local bar = 'don\'t'
local bar = '"'
local foobar = '\\\\"'

spaces_before_call

type: int, default: 1

Inserts a space on function calls with parentheses omitted.

-- spaces_before_call: 1
require "foo"
f "a" "b"

-- spaces_before_call: 0
require"foo"
f"a" "b"

spaces_inside_functiondef_parens

type: bool, default: false

Inserts spaces inside the parenthesis in a function header.

-- original
function foo(x, y)
  print('hello')
end

foo = function(x, y)
  print('hello')
end

-- transformed
function foo( x, y )
  print('hello')
end

foo = function( x, y )
  print('hello')
end

spaces_inside_functioncall_parens

type: bool, default: false

Inserts spaces inside the parenthesis in a function call.

-- original
function foo(x, y)
  print('hello')
end

foo = function(x, y)
  print('hello', 2)
end

-- transformed
function foo(x, y)
  print( 'hello' )
end

foo = function(x, y)
  print( 'hello', 2 )
end

spaces_inside_table_braces

type: bool, default: false

Inserts spaces inside the braces in a table constructor.

-- original
x = {1, 2, 3}
point = {x = 1, y = 2}
point = Point{x = 1, y = 2}

-- transformed
x = { 1, 2, 3 }
point = { x = 1, y = 2 }
point = Point{ x = 1, y = 2 }

spaces_around_equals_in_field

type: bool, default: true

Inserts spaces around the equal sign in key/value fields. Other assignments are not affected, though they may be affected by other options or behavior of the formatter.

-- original
x = {1, 2, 3}
point={ x=1, y=2}
point = Point{x=1, y=2}

-- transformed (true)
x = {1, 2, 3}
point = {x = 1, y = 2}
point = Point{x = 1, y = 2}

-- transformed (false)
x = {1, 2, 3}
point = {x=1, y=2}
point = Point{x=1, y=2}

line_breaks_after_function_body

type: int, default: 1

Line breaks after the function body

-- original(1)
function foo()

end

function foo2()

end

-- transformed(2)
function foo()

end


function foo2()

end

line_separator

type: str, default: input

input: Determine line separator by the input content. This is the default.
os: Determine line separator by the operating system
lf: Use Unix Style ("\n")
cr: Use classic Mac Style ("\r")
crlf: Use Windows Style ("\r\n")

Auto change the line ending according to config

-- original
function foo()<\n>
<\n>
end<\n>

-- transformed (cr)
function foo()<\r>
<\r>
end<\r>

-- transformed (crlf)
function foo()<\r\n>
<\r\n>
end<\r\n>