mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-08-15 10:47:21 +00:00
cba156b3dc
Use EmmyLuaCodeStyle that comes with "Lua" VS Code extension (https://marketplace.visualstudio.com/items?itemName=sumneko.lua). More features and configurability than LuaFormatter, and no need for additional extension (beyond "Lua"). Formatting file set up from default template with some tweaks to correspond to most common coding style observed in the code base. Further tweaks are likely required.
167 lines
4.5 KiB
INI
167 lines
4.5 KiB
INI
# Repository: https://github.com/CppCXY/EmmyLuaCodeStyle
|
|
# English documentation: https://github.com/CppCXY/EmmyLuaCodeStyle/blob/master/README_EN.md
|
|
[*.lua]
|
|
# [basic]
|
|
|
|
# optional space/tab
|
|
indent_style = space
|
|
# if indent_style is space, this is valid
|
|
indent_size = 4
|
|
# if indent_style is tab, this is valid
|
|
tab_width = 4
|
|
# none/single/double
|
|
quote_style = none
|
|
|
|
# only support number
|
|
continuation_indent_size = 0
|
|
|
|
# optional crlf/lf/cr/auto, if it is 'auto', in windows it is crlf other platforms are lf
|
|
end_of_line = auto
|
|
|
|
detect_end_of_line = false
|
|
|
|
# this mean utf8 length , if this is 'unset' then the line width is no longer checked
|
|
# this option decides when to chopdown the code
|
|
max_line_length = 9999
|
|
|
|
# this will check text end with new line
|
|
insert_final_newline = true
|
|
|
|
# [function]
|
|
|
|
# function call expression's args will align to first arg
|
|
# optional true/false/only_after_more_indention_statement/only_not_exist_cross_row_expression
|
|
align_call_args = false
|
|
|
|
# if true, all function define params will align to first param
|
|
align_function_define_params = true
|
|
|
|
remove_expression_list_finish_comma = true
|
|
|
|
# keep/remove/remove_table_only/remove_string_only/unambiguous_remove_string_only
|
|
call_arg_parentheses = keep
|
|
|
|
# [table]
|
|
|
|
#optional none/comma/semicolon
|
|
table_separator_style = none
|
|
|
|
#optional keep/never/always/smart
|
|
trailing_table_separator = keep
|
|
|
|
# see document for detail
|
|
continuous_assign_table_field_align_to_equal_sign = true
|
|
|
|
# if true, format like this "local t = { 1, 2, 3 }"
|
|
keep_one_space_between_table_and_bracket = true
|
|
|
|
# if indent_style is tab, this option is invalid
|
|
align_table_field_to_first_field = true
|
|
|
|
# [statement]
|
|
|
|
align_chained_expression_statement = false
|
|
|
|
# continous line distance
|
|
max_continuous_line_distance = 1
|
|
|
|
# see document for detail
|
|
continuous_assign_statement_align_to_equal_sign = true
|
|
|
|
# if statement will align like switch case
|
|
if_condition_align_with_each_other = false
|
|
|
|
# if true, continuation_indent_size for local or assign statement is invalid
|
|
# however, if the expression list has cross row expression, it will not be aligned to the first expression
|
|
local_assign_continuation_align_to_first_expression = false
|
|
|
|
statement_inline_comment_space = 1
|
|
|
|
# [indentation]
|
|
|
|
# if true, the label loses its current indentation
|
|
label_no_indent = false
|
|
# if true, there will be no indentation in the do statement
|
|
do_statement_no_indent = false
|
|
# if true, the conditional expression of the if statement will not be a continuation line indent
|
|
if_condition_no_continuation_indent = false
|
|
|
|
if_branch_comments_after_block_no_indent = false
|
|
|
|
# [space]
|
|
|
|
# if true, t[#t+1] will not space wrapper '+'
|
|
table_append_expression_no_space = false
|
|
|
|
long_chain_expression_allow_one_space_after_colon = false
|
|
|
|
remove_empty_header_and_footer_lines_in_function = true
|
|
|
|
space_before_function_open_parenthesis = false
|
|
|
|
space_inside_function_call_parentheses = false
|
|
|
|
space_inside_function_param_list_parentheses = false
|
|
|
|
space_before_open_square_bracket = false
|
|
|
|
space_inside_square_brackets = false
|
|
|
|
# if true, ormat like this "local t <const> = 1"
|
|
keep_one_space_between_namedef_and_attribute = true
|
|
|
|
# [row_layout]
|
|
# The following configuration supports four expressions
|
|
# minLine:${n}
|
|
# keepLine
|
|
# keepLine:${n}
|
|
# maxLine:${n}
|
|
|
|
keep_line_after_if_statement = minLine:0
|
|
|
|
keep_line_after_do_statement = minLine:0
|
|
|
|
keep_line_after_while_statement = minLine:0
|
|
|
|
keep_line_after_repeat_statement = minLine:0
|
|
|
|
keep_line_after_for_statement = minLine:0
|
|
|
|
keep_line_after_local_or_assign_statement = keepLine
|
|
|
|
keep_line_after_function_define_statement = keepLine:1
|
|
|
|
keep_line_after_expression_statement = keepLine
|
|
|
|
# [diagnostic]
|
|
|
|
# the following is code diagnostic options
|
|
enable_check_codestyle = true
|
|
|
|
# [diagnostic.name_style]
|
|
enable_name_style_check = false
|
|
# the following is name style check rule
|
|
# base option off/camel_case/snake_case/upper_snake_case/pascal_case/same(filename/first_param/'<const string>', snake_case/pascal_case/camel_case)
|
|
# all option can use '|' represent or
|
|
# for example:
|
|
# snake_case | upper_snake_case
|
|
# same(first_param, snake_case)
|
|
# same('m')
|
|
local_name_define_style = snake_case
|
|
|
|
function_param_name_style = snake_case
|
|
|
|
function_name_define_style = snake_case
|
|
|
|
local_function_name_define_style = snake_case
|
|
|
|
table_field_name_define_style = snake_case
|
|
|
|
global_variable_name_define_style = snake_case|upper_snake_case
|
|
|
|
module_name_define_style = same('m')|same(filename, snake_case)
|
|
|
|
require_module_name_style = same(first_param, snake_case)
|
|
|
|
class_name_define_style = same(filename, snake_case)
|