Add .editorconfig file with google-java-format compatible options (#1136)

* Add .editorconfig file with google-java-format compatible options

* Add an example of pre-commit hook
This commit is contained in:
Nikita Salnikov-Tarnovski 2020-04-27 18:42:59 +03:00 committed by GitHub
parent 8dd6282893
commit a98aa54204
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 801 additions and 16 deletions

767
.editorconfig Normal file
View File

@ -0,0 +1,767 @@
[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = false
max_line_length = 100
tab_width = 2
ij_continuation_indent_size = 4
ij_formatter_off_tag = @formatter:off
ij_formatter_on_tag = @formatter:on
ij_formatter_tags_enabled = false
ij_smart_tabs = false
ij_wrap_on_typing = false
[*.java]
ij_java_align_consecutive_assignments = false
ij_java_align_consecutive_variable_declarations = false
ij_java_align_group_field_declarations = false
ij_java_align_multiline_annotation_parameters = false
ij_java_align_multiline_array_initializer_expression = false
ij_java_align_multiline_assignment = false
ij_java_align_multiline_binary_operation = false
ij_java_align_multiline_chained_methods = false
ij_java_align_multiline_extends_list = false
ij_java_align_multiline_for = false
ij_java_align_multiline_method_parentheses = false
ij_java_align_multiline_parameters = false
ij_java_align_multiline_parameters_in_calls = false
ij_java_align_multiline_parenthesized_expression = false
ij_java_align_multiline_records = true
ij_java_align_multiline_resources = false
ij_java_align_multiline_ternary_operation = false
ij_java_align_multiline_text_blocks = false
ij_java_align_multiline_throws_list = false
ij_java_align_subsequent_simple_methods = false
ij_java_align_throws_keyword = false
ij_java_annotation_parameter_wrap = off
ij_java_array_initializer_new_line_after_left_brace = false
ij_java_array_initializer_right_brace_on_new_line = false
ij_java_array_initializer_wrap = normal
ij_java_assert_statement_colon_on_next_line = false
ij_java_assert_statement_wrap = off
ij_java_assignment_wrap = off
ij_java_binary_operation_sign_on_next_line = true
ij_java_binary_operation_wrap = normal
ij_java_blank_lines_after_anonymous_class_header = 0
ij_java_blank_lines_after_class_header = 0
ij_java_blank_lines_after_imports = 1
ij_java_blank_lines_after_package = 1
ij_java_blank_lines_around_class = 1
ij_java_blank_lines_around_field = 0
ij_java_blank_lines_around_field_in_interface = 0
ij_java_blank_lines_around_initializer = 1
ij_java_blank_lines_around_method = 1
ij_java_blank_lines_around_method_in_interface = 1
ij_java_blank_lines_before_class_end = 0
ij_java_blank_lines_before_imports = 1
ij_java_blank_lines_before_method_body = 0
ij_java_blank_lines_before_package = 0
ij_java_block_brace_style = end_of_line
ij_java_block_comment_at_first_column = true
ij_java_call_parameters_new_line_after_left_paren = false
ij_java_call_parameters_right_paren_on_new_line = false
ij_java_call_parameters_wrap = normal
ij_java_case_statement_on_separate_line = true
ij_java_catch_on_new_line = false
ij_java_class_annotation_wrap = split_into_lines
ij_java_class_brace_style = end_of_line
ij_java_class_count_to_use_import_on_demand = 999
ij_java_class_names_in_javadoc = 1
ij_java_do_not_indent_top_level_class_members = false
ij_java_do_not_wrap_after_single_annotation = true
ij_java_do_while_brace_force = always
ij_java_doc_add_blank_line_after_description = true
ij_java_doc_add_blank_line_after_param_comments = false
ij_java_doc_add_blank_line_after_return = false
ij_java_doc_add_p_tag_on_empty_lines = true
ij_java_doc_align_exception_comments = false
ij_java_doc_align_param_comments = false
ij_java_doc_do_not_wrap_if_one_line = true
ij_java_doc_enable_formatting = true
ij_java_doc_enable_leading_asterisks = true
ij_java_doc_indent_on_continuation = true
ij_java_doc_keep_empty_lines = true
ij_java_doc_keep_empty_parameter_tag = false
ij_java_doc_keep_empty_return_tag = false
ij_java_doc_keep_empty_throws_tag = false
ij_java_doc_keep_invalid_tags = true
ij_java_doc_param_description_on_new_line = false
ij_java_doc_preserve_line_breaks = false
ij_java_doc_use_throws_not_exception_tag = true
ij_java_else_on_new_line = false
ij_java_entity_dd_suffix = EJB
ij_java_entity_eb_suffix = Bean
ij_java_entity_hi_suffix = Home
ij_java_entity_lhi_prefix = Local
ij_java_entity_lhi_suffix = Home
ij_java_entity_li_prefix = Local
ij_java_entity_pk_class = java.lang.String
ij_java_entity_vo_suffix = VO
ij_java_enum_constants_wrap = off
ij_java_extends_keyword_wrap = off
ij_java_extends_list_wrap = normal
ij_java_field_annotation_wrap = split_into_lines
ij_java_finally_on_new_line = false
ij_java_for_brace_force = always
ij_java_for_statement_new_line_after_left_paren = false
ij_java_for_statement_right_paren_on_new_line = false
ij_java_for_statement_wrap = normal
ij_java_generate_final_locals = false
ij_java_generate_final_parameters = false
ij_java_if_brace_force = always
ij_java_imports_layout = $*,|,*
ij_java_indent_case_from_switch = true
ij_java_insert_inner_class_imports = true
ij_java_insert_override_annotation = true
ij_java_keep_blank_lines_before_right_brace = 2
ij_java_keep_blank_lines_between_package_declaration_and_header = 2
ij_java_keep_blank_lines_in_code = 1
ij_java_keep_blank_lines_in_declarations = 2
ij_java_keep_control_statement_in_one_line = false
ij_java_keep_first_column_comment = true
ij_java_keep_indents_on_empty_lines = false
ij_java_keep_line_breaks = true
ij_java_keep_multiple_expressions_in_one_line = false
ij_java_keep_simple_blocks_in_one_line = false
ij_java_keep_simple_classes_in_one_line = true
ij_java_keep_simple_lambdas_in_one_line = false
ij_java_keep_simple_methods_in_one_line = true
ij_java_label_indent_absolute = false
ij_java_label_indent_size = 0
ij_java_lambda_brace_style = end_of_line
ij_java_layout_static_imports_separately = true
ij_java_line_comment_add_space = false
ij_java_line_comment_at_first_column = true
ij_java_message_dd_suffix = EJB
ij_java_message_eb_suffix = Bean
ij_java_method_annotation_wrap = split_into_lines
ij_java_method_brace_style = end_of_line
ij_java_method_call_chain_wrap = normal
ij_java_method_parameters_new_line_after_left_paren = false
ij_java_method_parameters_right_paren_on_new_line = false
ij_java_method_parameters_wrap = normal
ij_java_modifier_list_wrap = false
ij_java_names_count_to_use_import_on_demand = 999
ij_java_new_line_after_lparen_in_record_header = false
ij_java_parameter_annotation_wrap = off
ij_java_parentheses_expression_new_line_after_left_paren = false
ij_java_parentheses_expression_right_paren_on_new_line = false
ij_java_place_assignment_sign_on_next_line = false
ij_java_prefer_longer_names = true
ij_java_prefer_parameters_wrap = false
ij_java_record_components_wrap = normal
ij_java_repeat_synchronized = true
ij_java_replace_instanceof_and_cast = false
ij_java_replace_null_check = true
ij_java_replace_sum_lambda_with_method_ref = true
ij_java_resource_list_new_line_after_left_paren = false
ij_java_resource_list_right_paren_on_new_line = false
ij_java_resource_list_wrap = off
ij_java_rparen_on_new_line_in_record_header = false
ij_java_session_dd_suffix = EJB
ij_java_session_eb_suffix = Bean
ij_java_session_hi_suffix = Home
ij_java_session_lhi_prefix = Local
ij_java_session_lhi_suffix = Home
ij_java_session_li_prefix = Local
ij_java_session_si_suffix = Service
ij_java_space_after_closing_angle_bracket_in_type_argument = false
ij_java_space_after_colon = true
ij_java_space_after_comma = true
ij_java_space_after_comma_in_type_arguments = true
ij_java_space_after_for_semicolon = true
ij_java_space_after_quest = true
ij_java_space_after_type_cast = true
ij_java_space_before_annotation_array_initializer_left_brace = false
ij_java_space_before_annotation_parameter_list = false
ij_java_space_before_array_initializer_left_brace = true
ij_java_space_before_catch_keyword = true
ij_java_space_before_catch_left_brace = true
ij_java_space_before_catch_parentheses = true
ij_java_space_before_class_left_brace = true
ij_java_space_before_colon = true
ij_java_space_before_colon_in_foreach = true
ij_java_space_before_comma = false
ij_java_space_before_do_left_brace = true
ij_java_space_before_else_keyword = true
ij_java_space_before_else_left_brace = true
ij_java_space_before_finally_keyword = true
ij_java_space_before_finally_left_brace = true
ij_java_space_before_for_left_brace = true
ij_java_space_before_for_parentheses = true
ij_java_space_before_for_semicolon = false
ij_java_space_before_if_left_brace = true
ij_java_space_before_if_parentheses = true
ij_java_space_before_method_call_parentheses = false
ij_java_space_before_method_left_brace = true
ij_java_space_before_method_parentheses = false
ij_java_space_before_opening_angle_bracket_in_type_parameter = false
ij_java_space_before_quest = true
ij_java_space_before_switch_left_brace = true
ij_java_space_before_switch_parentheses = true
ij_java_space_before_synchronized_left_brace = true
ij_java_space_before_synchronized_parentheses = true
ij_java_space_before_try_left_brace = true
ij_java_space_before_try_parentheses = true
ij_java_space_before_type_parameter_list = false
ij_java_space_before_while_keyword = true
ij_java_space_before_while_left_brace = true
ij_java_space_before_while_parentheses = true
ij_java_space_inside_one_line_enum_braces = false
ij_java_space_within_empty_array_initializer_braces = false
ij_java_space_within_empty_method_call_parentheses = false
ij_java_space_within_empty_method_parentheses = false
ij_java_spaces_around_additive_operators = true
ij_java_spaces_around_assignment_operators = true
ij_java_spaces_around_bitwise_operators = true
ij_java_spaces_around_equality_operators = true
ij_java_spaces_around_lambda_arrow = true
ij_java_spaces_around_logical_operators = true
ij_java_spaces_around_method_ref_dbl_colon = false
ij_java_spaces_around_multiplicative_operators = true
ij_java_spaces_around_relational_operators = true
ij_java_spaces_around_shift_operators = true
ij_java_spaces_around_type_bounds_in_type_parameters = true
ij_java_spaces_around_unary_operator = false
ij_java_spaces_within_angle_brackets = false
ij_java_spaces_within_annotation_parentheses = false
ij_java_spaces_within_array_initializer_braces = false
ij_java_spaces_within_braces = false
ij_java_spaces_within_brackets = false
ij_java_spaces_within_cast_parentheses = false
ij_java_spaces_within_catch_parentheses = false
ij_java_spaces_within_for_parentheses = false
ij_java_spaces_within_if_parentheses = false
ij_java_spaces_within_method_call_parentheses = false
ij_java_spaces_within_method_parentheses = false
ij_java_spaces_within_parentheses = false
ij_java_spaces_within_switch_parentheses = false
ij_java_spaces_within_synchronized_parentheses = false
ij_java_spaces_within_try_parentheses = false
ij_java_spaces_within_while_parentheses = false
ij_java_special_else_if_treatment = true
ij_java_subclass_name_suffix = Impl
ij_java_ternary_operation_signs_on_next_line = true
ij_java_ternary_operation_wrap = normal
ij_java_test_name_suffix = Test
ij_java_throws_keyword_wrap = normal
ij_java_throws_list_wrap = off
ij_java_use_external_annotations = false
ij_java_use_fq_class_names = false
ij_java_use_relative_indents = false
ij_java_use_single_class_imports = true
ij_java_variable_annotation_wrap = off
ij_java_visibility = public
ij_java_while_brace_force = always
ij_java_while_on_new_line = false
ij_java_wrap_comments = false
ij_java_wrap_first_method_in_call_chain = false
ij_java_wrap_long_lines = false
[*.proto]
ij_continuation_indent_size = 2
ij_proto_keep_indents_on_empty_lines = false
[*.scala]
ij_continuation_indent_size = 2
ij_scala_align_composite_pattern = true
ij_scala_align_extends_with = 0
ij_scala_align_group_field_declarations = false
ij_scala_align_if_else = false
ij_scala_align_in_columns_case_branch = false
ij_scala_align_multiline_binary_operation = false
ij_scala_align_multiline_chained_methods = false
ij_scala_align_multiline_for = true
ij_scala_align_multiline_parameters = true
ij_scala_align_multiline_parameters_in_calls = false
ij_scala_align_multiline_parenthesized_expression = false
ij_scala_align_tuple_elements = false
ij_scala_align_types_in_multiline_declarations = false
ij_scala_alternate_continuation_indent_for_params = 4
ij_scala_binary_operation_wrap = off
ij_scala_blank_lines_after_anonymous_class_header = 0
ij_scala_blank_lines_after_class_header = 0
ij_scala_blank_lines_after_imports = 1
ij_scala_blank_lines_after_package = 1
ij_scala_blank_lines_around_class = 1
ij_scala_blank_lines_around_field = 0
ij_scala_blank_lines_around_field_in_inner_scopes = 0
ij_scala_blank_lines_around_field_in_interface = 0
ij_scala_blank_lines_around_method = 1
ij_scala_blank_lines_around_method_in_inner_scopes = 1
ij_scala_blank_lines_around_method_in_interface = 1
ij_scala_blank_lines_before_imports = 1
ij_scala_blank_lines_before_method_body = 0
ij_scala_blank_lines_before_package = 0
ij_scala_block_brace_style = end_of_line
ij_scala_block_comment_at_first_column = true
ij_scala_call_parameters_new_line_after_lparen = 0
ij_scala_call_parameters_right_paren_on_new_line = false
ij_scala_call_parameters_wrap = off
ij_scala_case_clause_brace_force = never
ij_scala_catch_on_new_line = false
ij_scala_class_annotation_wrap = split_into_lines
ij_scala_class_brace_style = end_of_line
ij_scala_closure_brace_force = never
ij_scala_do_not_align_block_expr_params = true
ij_scala_do_not_indent_case_clause_body = false
ij_scala_do_not_indent_tuples_close_brace = true
ij_scala_do_while_brace_force = never
ij_scala_else_on_new_line = false
ij_scala_enable_scaladoc_formatting = true
ij_scala_enforce_functional_syntax_for_unit = true
ij_scala_extends_keyword_wrap = off
ij_scala_extends_list_wrap = off
ij_scala_field_annotation_wrap = split_into_lines
ij_scala_finally_brace_force = never
ij_scala_finally_on_new_line = false
ij_scala_for_brace_force = never
ij_scala_for_statement_wrap = off
ij_scala_formatter = 0
ij_scala_if_brace_force = never
ij_scala_implicit_value_class_suffix = Ops
ij_scala_indent_braced_function_args = true
ij_scala_indent_case_from_switch = true
ij_scala_indent_first_parameter = true
ij_scala_indent_first_parameter_clause = false
ij_scala_indent_type_arguments = true
ij_scala_indent_type_parameters = true
ij_scala_insert_whitespaces_in_simple_one_line_method = true
ij_scala_keep_blank_lines_before_right_brace = 2
ij_scala_keep_blank_lines_in_code = 2
ij_scala_keep_blank_lines_in_declarations = 2
ij_scala_keep_comments_on_same_line = true
ij_scala_keep_first_column_comment = false
ij_scala_keep_indents_on_empty_lines = false
ij_scala_keep_line_breaks = true
ij_scala_keep_one_line_lambdas_in_arg_list = false
ij_scala_keep_simple_blocks_in_one_line = false
ij_scala_keep_simple_methods_in_one_line = false
ij_scala_keep_xml_formatting = false
ij_scala_line_comment_at_first_column = true
ij_scala_method_annotation_wrap = split_into_lines
ij_scala_method_brace_force = never
ij_scala_method_brace_style = end_of_line
ij_scala_method_call_chain_wrap = off
ij_scala_method_parameters_new_line_after_left_paren = false
ij_scala_method_parameters_right_paren_on_new_line = false
ij_scala_method_parameters_wrap = off
ij_scala_modifier_list_wrap = false
ij_scala_multiline_string_align_dangling_closing_quotes = false
ij_scala_multiline_string_closing_quotes_on_new_line = false
ij_scala_multiline_string_insert_margin_on_enter = true
ij_scala_multiline_string_margin_char = |
ij_scala_multiline_string_margin_indent = 2
ij_scala_multiline_string_opening_quotes_on_new_line = true
ij_scala_multiline_string_process_margin_on_copy_paste = true
ij_scala_newline_after_annotations = false
ij_scala_not_continuation_indent_for_params = false
ij_scala_parameter_annotation_wrap = off
ij_scala_parentheses_expression_new_line_after_left_paren = false
ij_scala_parentheses_expression_right_paren_on_new_line = false
ij_scala_place_closure_parameters_on_new_line = false
ij_scala_place_self_type_on_new_line = true
ij_scala_prefer_parameters_wrap = false
ij_scala_preserve_space_after_method_declaration_name = false
ij_scala_reformat_on_compile = false
ij_scala_replace_case_arrow_with_unicode_char = false
ij_scala_replace_for_generator_arrow_with_unicode_char = false
ij_scala_replace_lambda_with_greek_letter = false
ij_scala_replace_map_arrow_with_unicode_char = false
ij_scala_scalafmt_reformat_on_files_save = false
ij_scala_scalafmt_show_invalid_code_warnings = true
ij_scala_scalafmt_use_intellij_formatter_for_range_format = true
ij_scala_sd_align_exception_comments = true
ij_scala_sd_align_other_tags_comments = true
ij_scala_sd_align_parameters_comments = true
ij_scala_sd_align_return_comments = true
ij_scala_sd_blank_line_after_parameters_comments = false
ij_scala_sd_blank_line_after_return_comments = false
ij_scala_sd_blank_line_before_parameters = false
ij_scala_sd_blank_line_before_tags = true
ij_scala_sd_blank_line_between_parameters = false
ij_scala_sd_keep_blank_lines_between_tags = false
ij_scala_sd_preserve_spaces_in_tags = false
ij_scala_space_after_comma = true
ij_scala_space_after_for_semicolon = true
ij_scala_space_after_modifiers_constructor = false
ij_scala_space_after_type_colon = true
ij_scala_space_before_brace_method_call = true
ij_scala_space_before_class_left_brace = true
ij_scala_space_before_infix_like_method_parentheses = false
ij_scala_space_before_infix_method_call_parentheses = false
ij_scala_space_before_infix_operator_like_method_call_parentheses = true
ij_scala_space_before_method_call_parentheses = false
ij_scala_space_before_method_left_brace = true
ij_scala_space_before_method_parentheses = false
ij_scala_space_before_type_colon = false
ij_scala_space_before_type_parameter_in_def_list = false
ij_scala_space_before_type_parameter_leading_context_bound_colon = false
ij_scala_space_before_type_parameter_leading_context_bound_colon_hk = true
ij_scala_space_before_type_parameter_list = false
ij_scala_space_before_type_parameter_rest_context_bound_colons = true
ij_scala_space_inside_closure_braces = true
ij_scala_space_inside_self_type_braces = true
ij_scala_space_within_empty_method_call_parentheses = false
ij_scala_spaces_around_at_in_patterns = false
ij_scala_spaces_in_imports = false
ij_scala_spaces_in_one_line_blocks = false
ij_scala_spaces_within_brackets = false
ij_scala_spaces_within_for_parentheses = false
ij_scala_spaces_within_if_parentheses = false
ij_scala_spaces_within_method_call_parentheses = false
ij_scala_spaces_within_method_parentheses = false
ij_scala_spaces_within_parentheses = false
ij_scala_spaces_within_while_parentheses = false
ij_scala_special_else_if_treatment = true
ij_scala_trailing_comma_arg_list_enabled = true
ij_scala_trailing_comma_import_selector_enabled = false
ij_scala_trailing_comma_mode = trailing_comma_keep
ij_scala_trailing_comma_params_enabled = true
ij_scala_trailing_comma_pattern_arg_list_enabled = false
ij_scala_trailing_comma_tuple_enabled = false
ij_scala_trailing_comma_tuple_type_enabled = false
ij_scala_trailing_comma_type_params_enabled = false
ij_scala_try_brace_force = never
ij_scala_type_annotation_exclude_constant = true
ij_scala_type_annotation_exclude_in_dialect_sources = true
ij_scala_type_annotation_exclude_in_test_sources = false
ij_scala_type_annotation_exclude_member_of_anonymous_class = false
ij_scala_type_annotation_exclude_member_of_private_class = false
ij_scala_type_annotation_exclude_when_type_is_stable = true
ij_scala_type_annotation_function_parameter = false
ij_scala_type_annotation_implicit_modifier = true
ij_scala_type_annotation_local_definition = false
ij_scala_type_annotation_private_member = false
ij_scala_type_annotation_protected_member = true
ij_scala_type_annotation_public_member = true
ij_scala_type_annotation_structural_type = true
ij_scala_type_annotation_underscore_parameter = false
ij_scala_type_annotation_unit_type = true
ij_scala_use_alternate_continuation_indent_for_params = false
ij_scala_use_scaladoc2_formatting = false
ij_scala_variable_annotation_wrap = off
ij_scala_while_brace_force = never
ij_scala_while_on_new_line = false
ij_scala_wrap_before_with_keyword = false
ij_scala_wrap_first_method_in_call_chain = false
ij_scala_wrap_long_lines = false
[.editorconfig]
ij_editorconfig_align_group_field_declarations = false
ij_editorconfig_space_after_colon = false
ij_editorconfig_space_after_comma = true
ij_editorconfig_space_before_colon = false
ij_editorconfig_space_before_comma = false
ij_editorconfig_spaces_around_assignment_operators = true
[{*.ant,*.bpmn,*.fxml,*.jhm,*.jnlp,*.jrxml,*.plan,*.pom,*.rng,*.tld,*.wadl,*.wsdd,*.wsdl,*.xjb,*.xml,*.xsd,*.xsl,*.xslt,*.xul}]
ij_continuation_indent_size = 2
ij_xml_align_attributes = false
ij_xml_align_text = false
ij_xml_attribute_wrap = normal
ij_xml_block_comment_at_first_column = true
ij_xml_keep_blank_lines = 2
ij_xml_keep_indents_on_empty_lines = false
ij_xml_keep_line_breaks = true
ij_xml_keep_line_breaks_in_text = true
ij_xml_keep_whitespaces = false
ij_xml_keep_whitespaces_around_cdata = preserve
ij_xml_keep_whitespaces_inside_cdata = false
ij_xml_line_comment_at_first_column = true
ij_xml_space_after_tag_name = false
ij_xml_space_around_equals_in_attribute = false
ij_xml_space_inside_empty_tag = false
ij_xml_text_wrap = normal
ij_xml_use_custom_settings = true
[{*.bash,*.sh,*.zsh}]
ij_shell_binary_ops_start_line = false
ij_shell_keep_column_alignment_padding = false
ij_shell_minify_program = false
ij_shell_redirect_followed_by_space = false
ij_shell_switch_cases_indented = false
[{*.gant,*.gradle,*.groovy,*.gson,*.gy}]
indent_size = 4
tab_width = 4
ij_continuation_indent_size = 8
ij_groovy_align_group_field_declarations = false
ij_groovy_align_multiline_array_initializer_expression = false
ij_groovy_align_multiline_assignment = false
ij_groovy_align_multiline_binary_operation = false
ij_groovy_align_multiline_chained_methods = false
ij_groovy_align_multiline_extends_list = false
ij_groovy_align_multiline_for = true
ij_groovy_align_multiline_list_or_map = true
ij_groovy_align_multiline_method_parentheses = false
ij_groovy_align_multiline_parameters = true
ij_groovy_align_multiline_parameters_in_calls = false
ij_groovy_align_multiline_resources = true
ij_groovy_align_multiline_ternary_operation = false
ij_groovy_align_multiline_throws_list = false
ij_groovy_align_named_args_in_map = true
ij_groovy_align_throws_keyword = false
ij_groovy_array_initializer_new_line_after_left_brace = false
ij_groovy_array_initializer_right_brace_on_new_line = false
ij_groovy_array_initializer_wrap = off
ij_groovy_assert_statement_wrap = off
ij_groovy_assignment_wrap = off
ij_groovy_binary_operation_wrap = off
ij_groovy_blank_lines_after_class_header = 0
ij_groovy_blank_lines_after_imports = 1
ij_groovy_blank_lines_after_package = 1
ij_groovy_blank_lines_around_class = 1
ij_groovy_blank_lines_around_field = 0
ij_groovy_blank_lines_around_field_in_interface = 0
ij_groovy_blank_lines_around_method = 1
ij_groovy_blank_lines_around_method_in_interface = 1
ij_groovy_blank_lines_before_imports = 1
ij_groovy_blank_lines_before_method_body = 0
ij_groovy_blank_lines_before_package = 0
ij_groovy_block_brace_style = end_of_line
ij_groovy_block_comment_at_first_column = true
ij_groovy_call_parameters_new_line_after_left_paren = false
ij_groovy_call_parameters_right_paren_on_new_line = false
ij_groovy_call_parameters_wrap = off
ij_groovy_catch_on_new_line = false
ij_groovy_class_annotation_wrap = split_into_lines
ij_groovy_class_brace_style = end_of_line
ij_groovy_class_count_to_use_import_on_demand = 5
ij_groovy_do_while_brace_force = never
ij_groovy_else_on_new_line = false
ij_groovy_enum_constants_wrap = off
ij_groovy_extends_keyword_wrap = off
ij_groovy_extends_list_wrap = off
ij_groovy_field_annotation_wrap = split_into_lines
ij_groovy_finally_on_new_line = false
ij_groovy_for_brace_force = never
ij_groovy_for_statement_new_line_after_left_paren = false
ij_groovy_for_statement_right_paren_on_new_line = false
ij_groovy_for_statement_wrap = off
ij_groovy_if_brace_force = never
ij_groovy_import_annotation_wrap = 2
ij_groovy_indent_case_from_switch = true
ij_groovy_indent_label_blocks = true
ij_groovy_insert_inner_class_imports = false
ij_groovy_keep_blank_lines_before_right_brace = 2
ij_groovy_keep_blank_lines_in_code = 2
ij_groovy_keep_blank_lines_in_declarations = 2
ij_groovy_keep_control_statement_in_one_line = true
ij_groovy_keep_first_column_comment = true
ij_groovy_keep_indents_on_empty_lines = false
ij_groovy_keep_line_breaks = true
ij_groovy_keep_multiple_expressions_in_one_line = false
ij_groovy_keep_simple_blocks_in_one_line = false
ij_groovy_keep_simple_classes_in_one_line = true
ij_groovy_keep_simple_lambdas_in_one_line = true
ij_groovy_keep_simple_methods_in_one_line = true
ij_groovy_label_indent_absolute = false
ij_groovy_label_indent_size = 0
ij_groovy_lambda_brace_style = end_of_line
ij_groovy_layout_static_imports_separately = true
ij_groovy_line_comment_add_space = false
ij_groovy_line_comment_at_first_column = true
ij_groovy_method_annotation_wrap = split_into_lines
ij_groovy_method_brace_style = end_of_line
ij_groovy_method_call_chain_wrap = off
ij_groovy_method_parameters_new_line_after_left_paren = false
ij_groovy_method_parameters_right_paren_on_new_line = false
ij_groovy_method_parameters_wrap = off
ij_groovy_modifier_list_wrap = false
ij_groovy_names_count_to_use_import_on_demand = 3
ij_groovy_parameter_annotation_wrap = off
ij_groovy_parentheses_expression_new_line_after_left_paren = false
ij_groovy_parentheses_expression_right_paren_on_new_line = false
ij_groovy_prefer_parameters_wrap = false
ij_groovy_resource_list_new_line_after_left_paren = false
ij_groovy_resource_list_right_paren_on_new_line = false
ij_groovy_resource_list_wrap = off
ij_groovy_space_after_assert_separator = true
ij_groovy_space_after_colon = true
ij_groovy_space_after_comma = true
ij_groovy_space_after_comma_in_type_arguments = true
ij_groovy_space_after_for_semicolon = true
ij_groovy_space_after_quest = true
ij_groovy_space_after_type_cast = true
ij_groovy_space_before_annotation_parameter_list = false
ij_groovy_space_before_array_initializer_left_brace = false
ij_groovy_space_before_assert_separator = false
ij_groovy_space_before_catch_keyword = true
ij_groovy_space_before_catch_left_brace = true
ij_groovy_space_before_catch_parentheses = true
ij_groovy_space_before_class_left_brace = true
ij_groovy_space_before_closure_left_brace = true
ij_groovy_space_before_colon = true
ij_groovy_space_before_comma = false
ij_groovy_space_before_do_left_brace = true
ij_groovy_space_before_else_keyword = true
ij_groovy_space_before_else_left_brace = true
ij_groovy_space_before_finally_keyword = true
ij_groovy_space_before_finally_left_brace = true
ij_groovy_space_before_for_left_brace = true
ij_groovy_space_before_for_parentheses = true
ij_groovy_space_before_for_semicolon = false
ij_groovy_space_before_if_left_brace = true
ij_groovy_space_before_if_parentheses = true
ij_groovy_space_before_method_call_parentheses = false
ij_groovy_space_before_method_left_brace = true
ij_groovy_space_before_method_parentheses = false
ij_groovy_space_before_quest = true
ij_groovy_space_before_switch_left_brace = true
ij_groovy_space_before_switch_parentheses = true
ij_groovy_space_before_synchronized_left_brace = true
ij_groovy_space_before_synchronized_parentheses = true
ij_groovy_space_before_try_left_brace = true
ij_groovy_space_before_try_parentheses = true
ij_groovy_space_before_while_keyword = true
ij_groovy_space_before_while_left_brace = true
ij_groovy_space_before_while_parentheses = true
ij_groovy_space_in_named_argument = true
ij_groovy_space_in_named_argument_before_colon = false
ij_groovy_space_within_empty_array_initializer_braces = false
ij_groovy_space_within_empty_method_call_parentheses = false
ij_groovy_spaces_around_additive_operators = true
ij_groovy_spaces_around_assignment_operators = true
ij_groovy_spaces_around_bitwise_operators = true
ij_groovy_spaces_around_equality_operators = true
ij_groovy_spaces_around_lambda_arrow = true
ij_groovy_spaces_around_logical_operators = true
ij_groovy_spaces_around_multiplicative_operators = true
ij_groovy_spaces_around_regex_operators = true
ij_groovy_spaces_around_relational_operators = true
ij_groovy_spaces_around_shift_operators = true
ij_groovy_spaces_within_annotation_parentheses = false
ij_groovy_spaces_within_array_initializer_braces = false
ij_groovy_spaces_within_braces = true
ij_groovy_spaces_within_brackets = false
ij_groovy_spaces_within_cast_parentheses = false
ij_groovy_spaces_within_catch_parentheses = false
ij_groovy_spaces_within_for_parentheses = false
ij_groovy_spaces_within_gstring_injection_braces = false
ij_groovy_spaces_within_if_parentheses = false
ij_groovy_spaces_within_list_or_map = false
ij_groovy_spaces_within_method_call_parentheses = false
ij_groovy_spaces_within_method_parentheses = false
ij_groovy_spaces_within_parentheses = false
ij_groovy_spaces_within_switch_parentheses = false
ij_groovy_spaces_within_synchronized_parentheses = false
ij_groovy_spaces_within_try_parentheses = false
ij_groovy_spaces_within_tuple_expression = false
ij_groovy_spaces_within_while_parentheses = false
ij_groovy_special_else_if_treatment = true
ij_groovy_ternary_operation_wrap = off
ij_groovy_throws_keyword_wrap = off
ij_groovy_throws_list_wrap = off
ij_groovy_use_flying_geese_braces = false
ij_groovy_use_fq_class_names = false
ij_groovy_use_fq_class_names_in_javadoc = true
ij_groovy_use_relative_indents = false
ij_groovy_use_single_class_imports = true
ij_groovy_variable_annotation_wrap = off
ij_groovy_while_brace_force = never
ij_groovy_while_on_new_line = false
ij_groovy_wrap_long_lines = false
[{*.gradle.kts,*.kt,*.kts,*.main.kts}]
indent_size = 4
tab_width = 4
ij_continuation_indent_size = 8
ij_kotlin_align_in_columns_case_branch = false
ij_kotlin_align_multiline_binary_operation = false
ij_kotlin_align_multiline_extends_list = false
ij_kotlin_align_multiline_method_parentheses = false
ij_kotlin_align_multiline_parameters = true
ij_kotlin_align_multiline_parameters_in_calls = false
ij_kotlin_assignment_wrap = off
ij_kotlin_blank_lines_after_class_header = 0
ij_kotlin_blank_lines_around_block_when_branches = 0
ij_kotlin_block_comment_at_first_column = true
ij_kotlin_call_parameters_new_line_after_left_paren = false
ij_kotlin_call_parameters_right_paren_on_new_line = false
ij_kotlin_call_parameters_wrap = off
ij_kotlin_catch_on_new_line = false
ij_kotlin_class_annotation_wrap = split_into_lines
ij_kotlin_continuation_indent_for_chained_calls = true
ij_kotlin_continuation_indent_for_expression_bodies = true
ij_kotlin_continuation_indent_in_argument_lists = true
ij_kotlin_continuation_indent_in_elvis = true
ij_kotlin_continuation_indent_in_if_conditions = true
ij_kotlin_continuation_indent_in_parameter_lists = true
ij_kotlin_continuation_indent_in_supertype_lists = true
ij_kotlin_else_on_new_line = false
ij_kotlin_enum_constants_wrap = off
ij_kotlin_extends_list_wrap = off
ij_kotlin_field_annotation_wrap = split_into_lines
ij_kotlin_finally_on_new_line = false
ij_kotlin_if_rparen_on_new_line = false
ij_kotlin_import_nested_classes = false
ij_kotlin_insert_whitespaces_in_simple_one_line_method = true
ij_kotlin_keep_blank_lines_before_right_brace = 2
ij_kotlin_keep_blank_lines_in_code = 2
ij_kotlin_keep_blank_lines_in_declarations = 2
ij_kotlin_keep_first_column_comment = true
ij_kotlin_keep_indents_on_empty_lines = false
ij_kotlin_keep_line_breaks = true
ij_kotlin_lbrace_on_next_line = false
ij_kotlin_line_comment_add_space = false
ij_kotlin_line_comment_at_first_column = true
ij_kotlin_method_annotation_wrap = split_into_lines
ij_kotlin_method_call_chain_wrap = off
ij_kotlin_method_parameters_new_line_after_left_paren = false
ij_kotlin_method_parameters_right_paren_on_new_line = false
ij_kotlin_method_parameters_wrap = off
ij_kotlin_name_count_to_use_star_import = 5
ij_kotlin_name_count_to_use_star_import_for_members = 3
ij_kotlin_parameter_annotation_wrap = off
ij_kotlin_space_after_comma = true
ij_kotlin_space_after_extend_colon = true
ij_kotlin_space_after_type_colon = true
ij_kotlin_space_before_catch_parentheses = true
ij_kotlin_space_before_comma = false
ij_kotlin_space_before_extend_colon = true
ij_kotlin_space_before_for_parentheses = true
ij_kotlin_space_before_if_parentheses = true
ij_kotlin_space_before_lambda_arrow = true
ij_kotlin_space_before_type_colon = false
ij_kotlin_space_before_when_parentheses = true
ij_kotlin_space_before_while_parentheses = true
ij_kotlin_spaces_around_additive_operators = true
ij_kotlin_spaces_around_assignment_operators = true
ij_kotlin_spaces_around_equality_operators = true
ij_kotlin_spaces_around_function_type_arrow = true
ij_kotlin_spaces_around_logical_operators = true
ij_kotlin_spaces_around_multiplicative_operators = true
ij_kotlin_spaces_around_range = false
ij_kotlin_spaces_around_relational_operators = true
ij_kotlin_spaces_around_unary_operator = false
ij_kotlin_spaces_around_when_arrow = true
ij_kotlin_variable_annotation_wrap = off
ij_kotlin_while_on_new_line = false
ij_kotlin_wrap_elvis_expressions = 1
ij_kotlin_wrap_expression_body_functions = 0
ij_kotlin_wrap_first_method_in_call_chain = false
[{*.har,*.jsb2,*.jsb3,*.json,.babelrc,.eslintrc,.stylelintrc,bowerrc,jest.config}]
ij_json_keep_blank_lines_in_code = 0
ij_json_keep_indents_on_empty_lines = false
ij_json_keep_line_breaks = true
ij_json_space_after_colon = true
ij_json_space_after_comma = true
ij_json_space_before_colon = true
ij_json_space_before_comma = false
ij_json_spaces_within_braces = false
ij_json_spaces_within_brackets = false
ij_json_wrap_long_lines = false
[{*.properties,spring.handlers,spring.schemas}]
ij_properties_align_group_field_declarations = false
ij_properties_keep_blank_lines = false
ij_properties_key_value_delimiter = equals
ij_properties_spaces_around_key_value_delimiter = false
[{*.yaml,*.yml}]
ij_yaml_keep_indents_on_empty_lines = false
ij_yaml_keep_line_breaks = true

1
.gitignore vendored
View File

@ -10,7 +10,6 @@ target
# IntelliJ IDEA # IntelliJ IDEA
.idea .idea
*.iml *.iml
.editorconfig
# Eclipse # Eclipse
.classpath .classpath

View File

@ -16,22 +16,38 @@ automatic check once you submit a PR, but you can also sign it after opening you
## Style guideline ## Style guideline
We follow the [Google Java Style We follow the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html).
Guide](https://google.github.io/styleguide/javaguide.html). Our build Our build will fail if source code is not formatted according to that style.
automatically will provide warnings for simple style issues.
Run the following command to format all files. This formatter uses To verify code style manually run the following command,
[google-java-format](https://github.com/google/google-java-format): which uses [google-java-format](https://github.com/google/google-java-format) library:
### OS X or Linux `./gradlew verifyGoogleJavaFormat`
`./gradlew goJF` or on Windows
### Windows `gradlew.bat verifyGoogleJavaFormat`
`gradlew.bat goJF` Instead of fixing style inconsistencies by hand, you can run gradle task `googleJavaFormat`
to automatically fix all found issues:
We also follow these project-specific guidelines: `./gradlew googleJavaFormat`
or on Windows
`gradlew.bat googleJavaFormat`
### Pre-commit hook
To completely delegate code style formatting to the machine,
you can add [git pre-commit hook](https://git-scm.com/docs/githooks).
We provide an example script in `buildscripts/pre-commit` file.
Just copy or symlink it into `.git/hooks` folder.
### Editorconfig
As additional convenience for IntelliJ Idea users, we provide `.editorconfig` file.
Idea will automatically use it to adjust its code formatting settings.
It does not support all required rules, so you still have to run `googleJavaFormat` from time to time.
### Javadoc ### Javadoc

3
buildscripts/pre-commit Executable file
View File

@ -0,0 +1,3 @@
#!/usr/bin/env sh
./gradlew googleJavaFormat

View File

@ -633,9 +633,9 @@ public final class BatchSpansProcessor implements SpanProcessor {
* *
* <p>Default value is {@code true}. * <p>Default value is {@code true}.
* *
* @see BatchSpansProcessor.Config#DEFAULT_EXPORT_ONLY_SAMPLED
* @param sampled report only sampled spans. * @param sampled report only sampled spans.
* @return this. * @return this.
* @see BatchSpansProcessor.Config#DEFAULT_EXPORT_ONLY_SAMPLED
*/ */
public abstract Builder setExportOnlySampled(boolean sampled); public abstract Builder setExportOnlySampled(boolean sampled);
@ -645,9 +645,9 @@ public final class BatchSpansProcessor implements SpanProcessor {
* *
* <p>Default value is {@code 5000}ms. * <p>Default value is {@code 5000}ms.
* *
* @see BatchSpansProcessor.Config#DEFAULT_SCHEDULE_DELAY_MILLIS
* @param scheduleDelayMillis the delay interval between two consecutive exports. * @param scheduleDelayMillis the delay interval between two consecutive exports.
* @return this. * @return this.
* @see BatchSpansProcessor.Config#DEFAULT_SCHEDULE_DELAY_MILLIS
*/ */
public abstract Builder setScheduleDelayMillis(long scheduleDelayMillis); public abstract Builder setScheduleDelayMillis(long scheduleDelayMillis);
@ -656,9 +656,9 @@ public final class BatchSpansProcessor implements SpanProcessor {
* *
* <p>Default value is {@code 30000}ms * <p>Default value is {@code 30000}ms
* *
* @see BatchSpansProcessor.Config#DEFAULT_EXPORT_TIMEOUT_MILLIS
* @param exporterTimeoutMillis the timeout for exports in milliseconds. * @param exporterTimeoutMillis the timeout for exports in milliseconds.
* @return this * @return this
* @see BatchSpansProcessor.Config#DEFAULT_EXPORT_TIMEOUT_MILLIS
*/ */
public abstract Builder setExporterTimeoutMillis(int exporterTimeoutMillis); public abstract Builder setExporterTimeoutMillis(int exporterTimeoutMillis);
@ -670,10 +670,10 @@ public final class BatchSpansProcessor implements SpanProcessor {
* *
* <p>Default value is {@code 2048}. * <p>Default value is {@code 2048}.
* *
* @see BatchSpansProcessor.Config#DEFAULT_MAX_QUEUE_SIZE
* @param maxQueueSize the maximum number of Spans that are kept in the queue before start * @param maxQueueSize the maximum number of Spans that are kept in the queue before start
* dropping. * dropping.
* @return this. * @return this.
* @see BatchSpansProcessor.Config#DEFAULT_MAX_QUEUE_SIZE
*/ */
public abstract Builder setMaxQueueSize(int maxQueueSize); public abstract Builder setMaxQueueSize(int maxQueueSize);
@ -683,9 +683,9 @@ public final class BatchSpansProcessor implements SpanProcessor {
* *
* <p>Default value is {@code 512}. * <p>Default value is {@code 512}.
* *
* @see BatchSpansProcessor.Config#DEFAULT_MAX_EXPORT_BATCH_SIZE
* @param maxExportBatchSize the maximum batch size for every export. * @param maxExportBatchSize the maximum batch size for every export.
* @return this. * @return this.
* @see BatchSpansProcessor.Config#DEFAULT_MAX_EXPORT_BATCH_SIZE
*/ */
public abstract Builder setMaxExportBatchSize(int maxExportBatchSize); public abstract Builder setMaxExportBatchSize(int maxExportBatchSize);