.swiftlint.yml

# refs: https://github.com/realm/SwiftLint/blob/master/Rules.md

disabled_rules:
  - block_based_kvo # Prefer the new block based KVO API with keypaths when using Swift 3.2 or later.
  - cyclomatic_complexity # Complexity of function bodies should be limited.
  - file_length # Files should not span too many lines.
  - for_where # where clauses are preferred over a single if inside a for.
  - force_cast # Force casts should be avoided.
  - force_try # Force tries should be avoided.
  - function_body_length # Functions bodies should not span too many lines.
  - multiple_closures_with_trailing_closure # Trailing closure syntax should not be used when passing more than one closure argument.
  - todo # TODOs and FIXMEs should be resolved.
  - trailing_whitespace # Lines should not have trailing whitespace.
  - unused_setter_value # Setter value is not used.

opt_in_rules:
  - anyobject_protocol # Prefer using `AnyObject` over class for class-only protocols.
  - array_init # Prefer using `Array(seq)` over `seq.map { $0 }` to convert a sequence into an Array.
  - closure_end_indentation # Closure end should have the same indentation as the line that started it.
  - closure_spacing # Closure expressions should have a single space inside each brace.
  - collection_alignment # All elements in a collection literal should be vertically aligned
  - contains_over_filter_count # Prefer `contains` over comparing `filter(where:).count` to `0`.
  - contains_over_filter_is_empty # Prefer `contains` over using `filter(where:).isEmpty`
  - contains_over_first_not_nil # Prefer `contains` over `first(where:) != nil` and `firstIndex(where:) != nil`.
  - contains_over_range_nil_comparison # Prefer `contains` over `range(of:) != nil` and `range(of:) == nil`.
  - discouraged_object_literal # Prefer initializers over object literals.
  - empty_collection_literal # Prefer checking `isEmpty` over comparing collection to an empty array or dictionary literal.
  - empty_count # Prefer checking `isEmpty` over comparing count to zero.
  - empty_string # Prefer checking `isEmpty` over comparing string to an empty string literal.
  - empty_xctest_method # Empty `XCTest` method should be avoided.
  - enum_case_associated_values_count # Number of associated values in an enum case should be low.
  - explicit_init # Explicitly calling `.init()` should be avoided.
  - fallthrough # Fallthrough should be avoided.
  - fatal_error_message # A `fatalError` call should have a message.
  - file_header # Header comments should be consistent with project patterns.
  - first_where # Prefer using `.first(where:)` over `.filter { }.first` in collections.
  - flatmap_over_map_reduce # Prefer `flatMap` over `map` followed by `reduce([], +)`.
  - function_default_parameter_at_end # Prefer to locate parameters with defaults toward the end of the parameter list.
  - implicitly_unwrapped_optional # Implicitly unwrapped optionals should be avoided when possible.
  - joined_default_parameter # Discouraged explicit usage of the default. separator.
  - last_where # Prefer using `.last(where:)` over `.filter { }.last` in collections.
  - legacy_multiple # Prefer using the `isMultiple(of:)` function instead of using the remainder operator (`%`).
  - legacy_random # Prefer using `type.random(in:)` over legacy functions.
  - literal_expression_end_indentation # Array and dictionary literal end should have the same indentation as the line that started it.
  - lower_acl_than_parent # Ensure definitions have a lower access control level than their enclosing parent.
  - multiline_literal_brackets # Multiline literals should have their surrounding brackets in a new line.
  - optional_enum_case_matching # Matching an enum case against an optional enum without ‘?’ is supported on Swift 5.1 and above.
  - prefer_self_type_over_type_of_self # Prefer `Self` over `type(of: self)` when accessing properties or calling methods.
  - prohibited_super_call # Some methods should not call super.
  - redundant_type_annotation # Variables should not have redundant type annotation
  - toggle_bool # Prefer `someBool.toggle()` over `someBool = !someBool`.
  - unneeded_parentheses_in_closure_argument # Parentheses are not needed when declaring closure arguments.
  - unused_declaration # Declarations should be referenced at least once within all files linted.
  - unused_import # All imported modules should be required to make the file compile.
  - vertical_parameter_alignment_on_call # Function parameters should be aligned vertically if they're in multiple lines in a method call.

custom_rules:
  trailing_logical_operator:
    name: 'Trailing logical operator'
    message: 'Leading logical operator should move to trailing.'
    regex: '^[\s]*(\|\||&&)'

# Prefer checking `isEmpty` over comparing count to zero.
empty_count:
  only_after_dot: true # Ignore variables named count.

# Forbid "Created by" line in file header
file_header:
  forbidden_pattern: \b(Created by)\b

# Identifier names should only contain alphanumeric characters and start with a lowercase character or should only contain capital letters.
# In an exception to the above, variable names may start with a capital letter when they are declared static and immutable. Variable names should not be too long or too short.
identifier_name:
  allowed_symbols: ['_']
  max_length:
    warning: 50
    error: 50
  min_length:
    warning: 1
    error: 1
  validates_start_with_lowercase: false

# Types should be nested at most 2 level deep, and statements should be nested at most 5 levels deep.
nesting:
  type_level:
    warning: 3
    error: 3

# Type bodies should not span too many lines.
type_body_length:
  warning: 1100
  error: 1100

# Type name should only contain alphanumeric characters, start with an uppercase character and span between 3 and 50 characters in length.
type_name:
  allowed_symbols: ['_']
  max_length:
    warning: 50
    error: 50

# Limit vertical whitespace to a single empty line.
vertical_whitespace:
  max_empty_lines: 2