.swiftLint.yml

# Below are all rules listed for each category. They are all listed because the list indicates
# the rules I have evaluated, and whether they should be enabled or not. Because the list is
# complete, it will be easier to spot new rules on 
# https://github.com/realm/SwiftLint/blob/master/Rules.md. If it appears there but not here,
# then I haven't evaluated it, and we should review whether we would like to add it here.

# Assume that the list here intentionally has rules commented out because we do not want to 
# implement them. If they are commented out for other reasons, leave a note next to the rule 
# explaining why it is commented out.

disabled_rules:
  # - block_based_kvo
  # - class_delegate_protocol
  # - closing_brace
  # - closure_parameter_position
  # - colon
  # - comma
  # - compiler_protocol_init
  # - control_statement
  # - custom_rules
  # - cyclomatic_complexity
  # - deployment_target
  # - discarded_notification_center_observer
  # - discouraged_direct_init
  # - duplicate_imports
  # - dynamic_inline
  # - empty_enum_arguments
  # - empty_parameters
  # - empty_parentheses_with_trailing_closure
  # - file_length
  # - for_where
  # - force_cast
  # - force_try
  # - function_body_length
  # - function_parameter_count
  # - generic_type_name
  - identifier_name # would like to enable. see if you can update parameter settings.
  # - implicit_getter
  # - inert_defer
  # - is_disjoint
  # - large_tuple
  # - leading_whitespace
  # - legacy_cggeometry_functions
  # - legacy_constant
  # - legacy_constructor
  # - legacy_hashing
  # - legacy_nsgeometry_functions
  # - mark
  # - multiple_closures_with_trailing_closure
  - nesting # won't enable this
  # - no_fallthrough_only
  # - notification_center_detachment
  # - nsobject_prefer_isequal
  # - opening_brace
  # - operator_whitespace
  # - private_over_fileprivate
  # - private_unit_test
  # - protocol_property_accessors_order
  # - redundant_discardable_let
  # - redundant_objc_attribute
  # - redundant_optional_initialization
  # - redundant_set_access_control
  # - redundant_string_enum_value
  # - redundant_void_return
  # - return_arrow_whitespace
  # - shorthand_operator
  # - statement_position
  # - superfluous_disable_command
  # - switch_case_alignment
  # - syntactic_sugar
  # - todo
  # - trailing_comma
  # - trailing_newline
  # - trailing_semicolon
  # - trailing_whitespace
  # - type_body_length
  # - type_name
  # - unneeded_break_in_switch
  # - unused_closure_parameter
  # - unused_control_flow_label
  # - unused_enumerated
  # - unused_optional_binding
  # - unused_setter_value
  # - valid_ibinspectable
  # - vertical_parameter_alignment
  # - vertical_whitespace
  # - void_return
  # - weak_computed_property
  # - weak_delegate
  # - xctfail_message

opt_in_rules:
  - anyobject_protocol
  - array_init
  - attributes
  - closure_body_length
  - closure_end_indentation
  - closure_spacing
  - collection_alignment
  - conditional_returns_on_newline
  - contains_over_first_not_nil
  - convenience_type
  - discouraged_object_literal
  - discouraged_optional_boolean
  - discouraged_optional_collection
  - empty_count
  - empty_string
  - empty_xctest_method
  # - explicit_acl - won't enable, at least yet
  # - explicit_enum_raw_value
  - explicit_init
  # - explicit_self
  - explicit_top_level_acl
  # - explicit_type_interface
  # - extension_access_modifier # won't enable
  - fallthrough
  - fatal_error_message
  # - file_header
  # - file_name - won't enable, at least yet
  - first_where
  - force_unwrapping
  # - function_default_parameter_at_end
  - identical_operands
  - implicit_return
  - implicitly_unwrapped_optional
  - joined_default_parameter
  - last_where
  - legacy_random
  - let_var_whitespace
  - literal_expression_end_indentation
  - lower_acl_than_parent
  # - missing_docs # do this one later
  - modifier_order
  - multiline_arguments
  # - multiline_arguments_brackets -- will only enable if can customize further
  - multiline_function_chains
  - multiline_literal_brackets
  - multiline_parameters
  - multiline_parameters_brackets
  - multiple_closures_with_trailing_closure
  # - nimble_operator
  - no_extension_access_modifier
  # - no_grouping_extension
  - nslocalizedstring_key
  - number_separator
  # - object_literal
  - operator_usage_whitespace
  - overridden_super_call
  - override_in_extension
  - pattern_matching_keywords
  # - prefixed_toplevel_constant
  - private_action
  # - private_outlet -- consider enabling later, and by default for new projects
  # - prohibited_interface_builder # would love to enforce this down the road
  - prohibited_super_call
  # - quick_discouraged_call
  # - quick_discouraged_focused_test
  # - quick_discouraged_pending_test
  - redundant_nil_coalescing
  - redundant_type_annotation
  # - required_deinit
  - required_enum_case
  - single_test_class
  - sorted_first_last
  - sorted_imports
  - static_operator
  - strict_fileprivate
  - strong_iboutlet
  - switch_case_on_newline
  - toggle_bool
  # - trailing_closure - won't do for now
  - unavailable_function
  - unneeded_parentheses_in_closure_argument
  - untyped_error_in_catch
  - unused_import
  - unused_private_declaration
  - vertical_parameter_alignment_on_call
  - vertical_whitespace_between_cases
  - vertical_whitespace_closing_braces
  - vertical_whitespace_opening_braces
  - weak_delegate
  - xct_specific_matcher
  - yoda_condition

excluded:
  - Pods

# In case of use in development pod
# included:
#   - ../PodProjectName

line_length:
  warning: 127
  ignores_function_declarations: true
  ignores_comments: true
  ignores_interpolated_strings: true
  ignores_urls: true