swiftlint.yml

excluded: # paths to ignore during linting. Takes precedence over `included`.
  - Pods

disabled_rules: # rule identifiers to exclude from running
  - type_name
  - nesting
  - missing_docs
  - function_parameter_count
  - large_tuple
  - legacy_constant
  - shorthand_operator
  - line_length
  - file_length
  - identifier_name
  - cyclomatic_complexity
  - todo # disable for pre-release development
  - closure_parameter_position
  - multiple_closures_with_trailing_closure
  - block_based_kvo
  - class_delegate_protocol
  
  #temporarily
  - operator_usage_whitespace
  - force_cast
  - force_try

opt_in_rules:
  - closure_end_indentation
  - closure_spacing
  - first_where
  # - force_unwrapping
  - empty_count
  - mark
  # - force_cast
  # - force_try
  # - operator_usage_whitespace
  # - private_outlet

closing_brace: error
closure_end_indentation: error
closure_spacing: error
comma: error
# colon:
#   severity: error
control_statement: error
empty_count: error
empty_parameters: error
empty_parentheses_with_trailing_closure: error
first_where: error
force_cast: error
force_try: error
force_unwrapping: error
implicit_getter: error
leading_whitespace: error
legacy_cggeometry_functions: error
legacy_constant: error
legacy_constructor: error
mark: error
opening_brace: error
operator_usage_whitespace: error
operator_whitespace: error
redundant_string_enum_value: error
return_arrow_whitespace: error
statement_position:
  statement_mode: default
  severity: error
syntactic_sugar: error
trailing_comma:
    severity: error
trailing_newline: error
trailing_semicolon: error
trailing_whitespace:
  ignores_empty_lines: true
  severity: error
unused_closure_parameter: error
unused_enumerated: error
vertical_whitespace: error
void_return: error

cyclomatic_complexity:
  warning: 10
todo: warning
private_outlet:
  allow_private_set: true
  severity: warning
trailing_comma:
  severity: warning
type_name:
  min_length:
    warning: 2
identifier_name:
  min_length:
    warning: 1
line_length:
  warning: 300
function_body_length:
  warning: 200
type_body_length:
  warning: 1000
file_length:
  warning: 2000

custom_rules:
    nslog_check:
        regex: 'NSLog\('
        message: "Use log instead"
        severity: error

    print_check:
        regex: 'print\('
        message: "Use log instead"
        severity: error

#    bounds_protection:
#        regex: '[A-Z0-9a-z]+\[[A-Z0-9a-z]+\]'
#        message: "Use [safe: index] instead"
#        severity: warning

#    first_element_access:
#        regex: '\[0\]'
#        message: "Use array.first instead of array[0]"
#        severity: warning

    # assert_protection:
    #     excluded: ".*Tests.swift" # regex that defines paths to exclude during linting. optional
    #     regex: '((assert\()|(assertionFailure\()|(precondition\()|(preconditionFailure\())'
    #     message: "Use Utility.assertOrAlert instead"
    #     severity: error

    excessive_void_identifier:
        regex: '\(\)[\s]*->[\s]*\(\) in' # matching pattern
        message: "no need to write out \"() -> () in\""
        severity: error

    opacity_with_variable:
        regex: 'opacity\([\D]'
        message: "should always use opacity() with a literal constant number, ex. opacity(0.7)"
        severity: error

    localizable_strings:
        regex: 'NSLocalizedString\(\"'
        message: "use localize(L10n enum) instead of hardcoded strings, ex. localize(.Error)"
        severity: warning

    # todo_formatting:
    #     regex: '((\/\/TODO)|(\/\/\sTODO[^:])|(\/\/\sTODO:[^\s]))'
    #     message: "TODO should be formatted as '// TODO: <comment> to work properly and be consistent"
    #     severity: error

    # excessive_import:
    #     regex: 'import (Foundation|UIKit)'
    #     message: "Foundation and UIKit has been imported for the entire project, please remove excessive import statements"
    #     severity: error

    internal_access_modifier:
        included: '.*.swift'
        regex: "internal ((static|override) )?(class |let |var |func )"
        message: "Internal is a default access modifier and can be omitted"
        severity: error

    unused_placeholder_parameters:
        regex: '\((_,\s*)*_\)'
        message: "use \"_\" in place of (_), (_, _), etc."
        severity: error

    swift_3_error:
        regex: 'caseInsensitiveCompare|NSIndexPath|Foundation\.|UIControlState\(\)|\!\!|JASON\.JSON|NSMutableURLRequest|as\sURL|NSNotification|as\sNotification|localize\(\.[A-Z]|AtIndex|NSURL|NSURLRequest'
        message: "use new Swift 3 syntax"
        severity: error

#    swift_3_warning:
#        regex: 'NSDate|NSError|NSData'
#        message: "please confirm if legacy type actually needed, especially in delegate methods, the signature might have changed"
#        severity: warning

    # settings_nsuserdefaults:
    #     regex: 'UserDefaults\.'
    #     message: "please confirm if using UserDefaults is needed, Settings should be used instead"
    #     severity: error