Beam/.swiftlint.yml

disabled_rules:
  - trailing_whitespace
  - unused_setter_value
  - redundant_discardable_let
  - identifier_name

opt_in_rules:  
  - force_unwrapping
  - private_action
  - explicit_init
  - shorthand_optional_binding
  - trailing_closure

included:
  - ElementX
  - UnitTests
  - UITests
  - Tools/Scripts/Templates
excluded:
  - IntegrationTests
  - ElementX/Sources/Generated

line_length:
  warning: 250
  error: 1000

file_length:
  warning: 2000

type_name:
  min_length: 3
  max_length:
    warning: 150
    error: 1000

type_body_length:
  warning: 1000
  error: 1000

function_body_length:
  warning: 100
  error: 100

cyclomatic_complexity:
  ignores_case_statements: true

nesting:
  type_level:
    warning: 5

custom_rules:
  vstack_spacing:
    regex: "(?-s)VStack((?!spacing:).)*\\s*\\{"
    match_kinds: identifier
    message: "Please use explicit spacing in VStacks."
    severity: warning

  hstack_spacing:
    regex: "(?-s)HStack((?!spacing:).)*\\s*\\{"
    match_kinds: identifier
    message: "Please use explicit spacing in HStacks."
    severity: warning

  compound_color_conversion:
    regex: "UIColor\\(\\.compound"
    match_kinds: identifier
    message: "Please use the UIColor token directly to ensure the colour scheme is honoured."
    severity: warning

  print_deprecation:
    regex: "\\b(print)\\b"
    match_kinds: identifier
    message: "MXLog should be used instead of print()"
    severity: error

  print_ln_deprecation:
    regex: "\\b(println)\\b"
    match_kinds: identifier
    message: "MXLog should be used instead of println()"
    severity: error

  os_log_deprecation:
    regex: "\\b(os_log)\\b"
    match_kinds: identifier
    message: "MXLog should be used instead of os_log()"
    severity: error
Initial project setup. 2022-02-14 18:05:21 +02:00			`disabled_rules:`
			`- trailing_whitespace`
			`- unused_setter_value`
Added room timeline screen with live events listening and back pagination. Rearranged project files. 2022-03-08 14:24:33 +02:00			`- redundant_discardable_let`
Opt out of the `identifier_name` swiflint rule. 2022-04-29 12:36:49 +03:00			`- identifier_name`
Initial project setup. 2022-02-14 18:05:21 +02:00
			`opt_in_rules:`
			`- force_unwrapping`
			`- private_action`
			`- explicit_init`
Enable shorthand_optional_binding SwiftLint rule. (#582) 2023-02-15 09:34:48 +00:00			`- shorthand_optional_binding`
Media gallery - part 1(#3588) * Introduce a `MediaEventsTimelineFlowCoordinator` * Update SDK API and architecture * Add a feature flag, add translations * Move the media events timeline presentation under the room flow coordinator state machine * Rename `TimelineViewState.timelineViewState` of type `TimelineState` to `timelineState` * Enabled SwiftLint's `trailing_closure` rule and fix the warnings. 2024-12-06 16:58:14 +02:00			`- trailing_closure`
Initial project setup. 2022-02-14 18:05:21 +02:00
			`included:`
			`- ElementX`
Fixes vector-im/element-x-ios/issues/117 - Event permalink timeline action * moved NSRegularExpression outside of the AttributedString builder into the MatrixEntityRegex * fixed eventId v3 regex * added permalink builders for users, room identifiers and aliases, and events * added timeline item permalink contextual menu actions and error alerts * added an app wide ServiceLocator and moved the top level userIndicatorPresenter to it. * added URL constructor that takes a StaticString and returns an non-optional * Include Unit and UI tests in the swiftlint search paths 2022-09-12 21:34:53 +03:00			`- UnitTests`
			`- UITests`
Include templates in the swiftlint search path. Fixed warnings. 2022-05-12 12:44:07 +03:00			`- Tools/Scripts/Templates`
#49, #123 - Setup UI integration and performance testing (#148) 2022-08-18 16:32:29 +03:00			`excluded:`
			`- IntegrationTests`
Adopt batched timeline diffs and other RustSDK changes 2023-08-01 16:55:59 +03:00			`- ElementX/Sources/Generated`
Initial project setup. 2022-02-14 18:05:21 +02:00
			`line_length:`
			`warning: 250`
			`error: 1000`

			`file_length:`
Pinning items Feature Flag (#3063) 2024-07-18 18:28:30 +02:00			`warning: 2000`
Initial project setup. 2022-02-14 18:05:21 +02:00
			`type_name:`
Add `function_body_length` swiftlint rule with default values in an attempt to fix false positives on the CI (DangerSwift) 2023-02-06 16:38:54 +02:00			`min_length: 3`
			`max_length:`
Initial project setup. 2022-02-14 18:05:21 +02:00			`warning: 150`
			`error: 1000`

Increase allowed type body lengths from 200 to 700 2022-06-06 13:05:47 +03:00			`type_body_length:`
Advanced settings fixes (#1857) * vector-im/element-meta/issues/2042 - Fix advanced options ordering and capitalisation * Bump swiftlint's type_body_length warning to 1000, make it match error. * Fix unit tests 2023-10-05 17:26:02 +03:00			`warning: 1000`
Increase allowed type body lengths from 200 to 700 2022-06-06 13:05:47 +03:00			`error: 1000`

Add `function_body_length` swiftlint rule with default values in an attempt to fix false positives on the CI (DangerSwift) 2023-02-06 16:38:54 +02:00			`function_body_length:`
Tweak swiftlint settings 2023-08-08 09:50:43 +03:00			`warning: 100`
Add `function_body_length` swiftlint rule with default values in an attempt to fix false positives on the CI (DangerSwift) 2023-02-06 16:38:54 +02:00			`error: 100`

Tweak swiftlint settings 2023-08-08 09:50:43 +03:00			`cyclomatic_complexity:`
			`ignores_case_statements: true`

Use files instead of UDP for signalling. (#585) 2023-02-15 14:02:50 +00:00			`nesting:`
			`type_level:`
			`warning: 5`

Initial project setup. 2022-02-14 18:05:21 +02:00			`custom_rules:`
Add SwiftLint rule to enforce stack spacing. (#2080) Xcode 15 changes the default behaviour and given we're always working from designs, we shouldn't rely on it for our layout. 2023-11-14 12:38:38 +00:00			`vstack_spacing:`
			`regex: "(?-s)VStack((?!spacing:).)\\s\\{"`
			`match_kinds: identifier`
			`message: "Please use explicit spacing in VStacks."`
			`severity: warning`

			`hstack_spacing:`
			`regex: "(?-s)HStack((?!spacing:).)\\s\\{"`
			`match_kinds: identifier`
			`message: "Please use explicit spacing in HStacks."`
			`severity: warning`

Use the UIColors directly instead of wrapping the SwiftUI Colors. (#3324) 2024-09-24 12:24:03 +01:00			`compound_color_conversion:`
			`regex: "UIColor\\(\\.compound"`
			`match_kinds: identifier`
			`message: "Please use the UIColor token directly to ensure the colour scheme is honoured."`
			`severity: warning`

Initial project setup. 2022-02-14 18:05:21 +02:00			`print_deprecation:`
			`regex: "\\b(print)\\b"`
			`match_kinds: identifier`
			`message: "MXLog should be used instead of print()"`
			`severity: error`

			`print_ln_deprecation:`
			`regex: "\\b(println)\\b"`
			`match_kinds: identifier`
			`message: "MXLog should be used instead of println()"`
			`severity: error`

			`os_log_deprecation:`
			`regex: "\\b(os_log)\\b"`
			`match_kinds: identifier`
			`message: "MXLog should be used instead of os_log()"`
			`severity: error`