aequitas/macos-menubar-wireguard

View on GitHub
WireGuardStatusbarHelper/SKQueue.swift

Summary

Maintainability
A
3 hrs
Test Coverage

Function addPathToQueue has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  private func addPathToQueue(_ path: String, notifyingAbout notification: SKQueueNotification) -> SKQueuePath? {
    var pathEntry = watchedPaths[path]

    if pathEntry != nil {
      if pathEntry!.notification.contains(notification) {
Severity: Minor
Found in WireGuardStatusbarHelper/SKQueue.swift - About 1 hr to fix

    Function ev_create has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    func ev_create(ident: UInt, filter: Int16, flags: UInt16, fflags: UInt32, data: Int, udata: UnsafeMutableRawPointer) -> kevent {
    Severity: Minor
    Found in WireGuardStatusbarHelper/SKQueue.swift - About 45 mins to fix

      Function toStrings has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

        public func toStrings() -> [SKQueueNotificationString] {
          var s = [SKQueueNotificationString]()
          if contains(.Rename) { s.append(.Rename) }
          if contains(.Write) { s.append(.Write) }
          if contains(.Delete) { s.append(.Delete) }
      Severity: Minor
      Found in WireGuardStatusbarHelper/SKQueue.swift - About 35 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Function addPathToQueue has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

        private func addPathToQueue(_ path: String, notifyingAbout notification: SKQueueNotification) -> SKQueuePath? {
          var pathEntry = watchedPaths[path]
      
          if pathEntry != nil {
            if pathEntry!.notification.contains(notification) {
      Severity: Minor
      Found in WireGuardStatusbarHelper/SKQueue.swift - About 35 mins to fix

      Cognitive Complexity

      Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

      A method's cognitive complexity is based on a few simple rules:

      • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
      • Code is considered more complex for each "break in the linear flow of the code"
      • Code is considered more complex when "flow breaking structures are nested"

      Further reading

      Enum case names should be lowerCamelCase
      Open

        case AttributeChange

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      If statement closing brace should be isolated on a separate line
      Open

          if contains(.Rename) { s.append(.Rename) }

      brace-style

      Definitions of - class - struct - function - Control flow constructs (if, else if, else, switch, for, while, repeat-while) - init - protocol - enum - closure - Getters and Setters (set, get) - extension

      should follow the One True Brace Style (1TBS): each construct has its opening brace one the same line along with the same indentation level as its header, the statements within the braces are indented, and the closing brace at the end is on the same indentation level as the header of the function at a line of its own. Braces are not omitted for a control statement with only a single statement in its scope. Every opening brace must also have one space preceding it.

      Classes

      Preferred

      class SomeClass {
      }
      
      class SomeClass: SomeSuperClass {
      }

      Not Preferred

      class SomeClass
      {
      }
      
      class SomeClass: SomeSuperClass{
      }

      Structs

      Preferred

      struct SomeStruct {
      }
      
      struct SomeStruct : SomeParentStruct {
      }

      Not Preferred

      struct SomeStruct
      {
      }
      
      struct SomeStruct : SomeParentStruct  {
      }

      Functions

      Preferred

      func someMethod() {
      }
      
      func someOtherFunction () -> () {
      }

      Not Preferred

      func someMethod()
      {
      }
      
      func someOtherFunction () -> ()
      {
      }

      Control flow constructs

      • if, else if, and else statement

      Preferred

      if SomeCondition {
      
      } else if someOtherCondition {
      } else {
      }

      Not Preferred

      if SomeCondition
      {
      
      }
      else if someOtherCondition
      {
      }
      else
      {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch SomeData
      {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for var i = 0; i < 10; i+=1
      {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while SomeCondition
      {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat
      {
      
      } while SomeCondition

      Initializers

      Preferred

      init(someParameter:Double, someOtherParameter:Double) {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Not Preferred

      init(someParameter:Double, someOtherParameter:Double)
      {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Protocols

      Preferred

      protocol SomeProtocol {
      
      }
      
      protocol SomeOtherProtocol : X {
      
      }

      Not Preferred

      protocol SomeProtocol
      {
      
      }
      
      protocol SomeOtherProtocol : X
      {
      }

      Enums

      Preferred

      enum SomeEnum {
          case A, B, C, D
      }
      
      enum SomeEnum {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int {
          case A, B, C = 5, D
      }

      Not Preferred

      enum SomeEnum
      {
          case A, B, C, D
      }
      
      enum SomeEnum
      {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int
      {
          case A, B, C = 5, D
      }

      Closures

      Preferred

      func someFunction () -> () {
      // closure
      }

      Not Preferred

      func someFunction () -> ()
      {
      // closure
      }

      Setters and Getters

      • set

      Preferred

      set {
          oldValue = newValue / 2
      }

      Not Preferred

      set
      {
          oldValue = newValue / 2
      }
      • get

      Preferred

      get {
          return value * 2
      }

      Not Preferred

      get
      {
          return value * 2
      }

      Extensions

      Preferred

      extension someExtension {
      }

      Not Preferred

      extension someExtension
      {
      }

      If statement closing brace should be isolated on a separate line
      Open

          if contains(.SizeIncrease) { s.append(.SizeIncrease) }

      brace-style

      Definitions of - class - struct - function - Control flow constructs (if, else if, else, switch, for, while, repeat-while) - init - protocol - enum - closure - Getters and Setters (set, get) - extension

      should follow the One True Brace Style (1TBS): each construct has its opening brace one the same line along with the same indentation level as its header, the statements within the braces are indented, and the closing brace at the end is on the same indentation level as the header of the function at a line of its own. Braces are not omitted for a control statement with only a single statement in its scope. Every opening brace must also have one space preceding it.

      Classes

      Preferred

      class SomeClass {
      }
      
      class SomeClass: SomeSuperClass {
      }

      Not Preferred

      class SomeClass
      {
      }
      
      class SomeClass: SomeSuperClass{
      }

      Structs

      Preferred

      struct SomeStruct {
      }
      
      struct SomeStruct : SomeParentStruct {
      }

      Not Preferred

      struct SomeStruct
      {
      }
      
      struct SomeStruct : SomeParentStruct  {
      }

      Functions

      Preferred

      func someMethod() {
      }
      
      func someOtherFunction () -> () {
      }

      Not Preferred

      func someMethod()
      {
      }
      
      func someOtherFunction () -> ()
      {
      }

      Control flow constructs

      • if, else if, and else statement

      Preferred

      if SomeCondition {
      
      } else if someOtherCondition {
      } else {
      }

      Not Preferred

      if SomeCondition
      {
      
      }
      else if someOtherCondition
      {
      }
      else
      {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch SomeData
      {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for var i = 0; i < 10; i+=1
      {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while SomeCondition
      {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat
      {
      
      } while SomeCondition

      Initializers

      Preferred

      init(someParameter:Double, someOtherParameter:Double) {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Not Preferred

      init(someParameter:Double, someOtherParameter:Double)
      {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Protocols

      Preferred

      protocol SomeProtocol {
      
      }
      
      protocol SomeOtherProtocol : X {
      
      }

      Not Preferred

      protocol SomeProtocol
      {
      
      }
      
      protocol SomeOtherProtocol : X
      {
      }

      Enums

      Preferred

      enum SomeEnum {
          case A, B, C, D
      }
      
      enum SomeEnum {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int {
          case A, B, C = 5, D
      }

      Not Preferred

      enum SomeEnum
      {
          case A, B, C, D
      }
      
      enum SomeEnum
      {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int
      {
          case A, B, C = 5, D
      }

      Closures

      Preferred

      func someFunction () -> () {
      // closure
      }

      Not Preferred

      func someFunction () -> ()
      {
      // closure
      }

      Setters and Getters

      • set

      Preferred

      set {
          oldValue = newValue / 2
      }

      Not Preferred

      set
      {
          oldValue = newValue / 2
      }
      • get

      Preferred

      get {
          return value * 2
      }

      Not Preferred

      get
      {
          return value * 2
      }

      Extensions

      Preferred

      extension someExtension {
      }

      Not Preferred

      extension someExtension
      {
      }

      Function names should be lowerCamelCase
      Open

      func ev_create(ident: UInt, filter: Int16, flags: UInt16, fflags: UInt32, data: Int, udata: UnsafeMutableRawPointer) -> kevent {

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      Enum case names should be lowerCamelCase
      Open

        case Delete

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      If statement closing brace should be isolated on a separate line
      Open

          if contains(.LinkCountChange) { s.append(.LinkCountChange) }

      brace-style

      Definitions of - class - struct - function - Control flow constructs (if, else if, else, switch, for, while, repeat-while) - init - protocol - enum - closure - Getters and Setters (set, get) - extension

      should follow the One True Brace Style (1TBS): each construct has its opening brace one the same line along with the same indentation level as its header, the statements within the braces are indented, and the closing brace at the end is on the same indentation level as the header of the function at a line of its own. Braces are not omitted for a control statement with only a single statement in its scope. Every opening brace must also have one space preceding it.

      Classes

      Preferred

      class SomeClass {
      }
      
      class SomeClass: SomeSuperClass {
      }

      Not Preferred

      class SomeClass
      {
      }
      
      class SomeClass: SomeSuperClass{
      }

      Structs

      Preferred

      struct SomeStruct {
      }
      
      struct SomeStruct : SomeParentStruct {
      }

      Not Preferred

      struct SomeStruct
      {
      }
      
      struct SomeStruct : SomeParentStruct  {
      }

      Functions

      Preferred

      func someMethod() {
      }
      
      func someOtherFunction () -> () {
      }

      Not Preferred

      func someMethod()
      {
      }
      
      func someOtherFunction () -> ()
      {
      }

      Control flow constructs

      • if, else if, and else statement

      Preferred

      if SomeCondition {
      
      } else if someOtherCondition {
      } else {
      }

      Not Preferred

      if SomeCondition
      {
      
      }
      else if someOtherCondition
      {
      }
      else
      {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch SomeData
      {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for var i = 0; i < 10; i+=1
      {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while SomeCondition
      {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat
      {
      
      } while SomeCondition

      Initializers

      Preferred

      init(someParameter:Double, someOtherParameter:Double) {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Not Preferred

      init(someParameter:Double, someOtherParameter:Double)
      {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Protocols

      Preferred

      protocol SomeProtocol {
      
      }
      
      protocol SomeOtherProtocol : X {
      
      }

      Not Preferred

      protocol SomeProtocol
      {
      
      }
      
      protocol SomeOtherProtocol : X
      {
      }

      Enums

      Preferred

      enum SomeEnum {
          case A, B, C, D
      }
      
      enum SomeEnum {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int {
          case A, B, C = 5, D
      }

      Not Preferred

      enum SomeEnum
      {
          case A, B, C, D
      }
      
      enum SomeEnum
      {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int
      {
          case A, B, C = 5, D
      }

      Closures

      Preferred

      func someFunction () -> () {
      // closure
      }

      Not Preferred

      func someFunction () -> ()
      {
      // closure
      }

      Setters and Getters

      • set

      Preferred

      set {
          oldValue = newValue / 2
      }

      Not Preferred

      set
      {
          oldValue = newValue / 2
      }
      • get

      Preferred

      get {
          return value * 2
      }

      Not Preferred

      get
      {
          return value * 2
      }

      Extensions

      Preferred

      extension someExtension {
      }

      Not Preferred

      extension someExtension
      {
      }

      Condition should not be enclosed within parentheses
      Open

          if (kqueueId == -1) {

      redundant-parentheses

      Control flow constructs (if, else if, switch, for, while, repeat-while, and guard statements), Exception handling constructs (throw, and do/catch statements), and Initializers (array, dictionary, initializer patterns) should not be enclosed in parentheses.

      Additionally, method calls with no parameters and a trailing closure should not have empty parentheses following the method name.

      Control flow constructs

      • if, else if statement

      Preferred

      if SomeCondition {
      
      } else if SomeOtherCondition {
      }

      Not Preferred

      if (SomeCondition) {
      
      } else if (SomeOtherCondition) {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch (SomeData) {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for (var i = 0; i < 10; i+=1) {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while (SomeCondition) {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat {
      
      } while (SomeCondition)
      • guard clause

      Preferred

      guard true else {   }

      Not Preferred

      guard (true) else {   }

      Exception handling constructs

      • do/catch statement

      Preferred

      do  {
      
      } catch SomeException {
      
      }

      Not Preferred

      do  {
      
      } catch (SomeException) {
      
      }
      • throw statement

      Preferred

      throw SomeException

      Not Preferred

      throw (SomeException)

      Initializers

      • array items

      Preferred

      var shoppingList: [String] = ["Eggs", "Milk"]

      Not Preferred

      var shoppingList: [String] = [("Eggs"), ("Milk")]
      • dictionary items

      Preferred

      var airports: [String: String] = ["YYZ": "Toronto Pearson", "DUB": "Dublin"]

      Not Preferred

      var airports: [String: String] = [("YYZ"): ("Toronto Pearson"), ("DUB"): ("Dublin")]
      • initializer patterns

      Preferred

      var x: Int = 2
      var y: String = "Sleekbyte"
      var x = 2

      Not Preferred

      var x: Int = (2)
      var y: String = ("Sleekbyte")
      var x = (2)

      Method calls

      Preferred

      items.map {
        item in item.transform()
      }

      Not Preferred

      items.map() {
        item in item.transform()
      }

      Enum case names should be lowerCamelCase
      Open

        case Write

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      Enum case names should be lowerCamelCase
      Open

        case Rename

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      Enum case names should be lowerCamelCase
      Open

        case SizeIncrease

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      Enum case names should be lowerCamelCase
      Open

        case LinkCountChange

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      If statement closing brace should be isolated on a separate line
      Open

          if contains(.Write) { s.append(.Write) }

      brace-style

      Definitions of - class - struct - function - Control flow constructs (if, else if, else, switch, for, while, repeat-while) - init - protocol - enum - closure - Getters and Setters (set, get) - extension

      should follow the One True Brace Style (1TBS): each construct has its opening brace one the same line along with the same indentation level as its header, the statements within the braces are indented, and the closing brace at the end is on the same indentation level as the header of the function at a line of its own. Braces are not omitted for a control statement with only a single statement in its scope. Every opening brace must also have one space preceding it.

      Classes

      Preferred

      class SomeClass {
      }
      
      class SomeClass: SomeSuperClass {
      }

      Not Preferred

      class SomeClass
      {
      }
      
      class SomeClass: SomeSuperClass{
      }

      Structs

      Preferred

      struct SomeStruct {
      }
      
      struct SomeStruct : SomeParentStruct {
      }

      Not Preferred

      struct SomeStruct
      {
      }
      
      struct SomeStruct : SomeParentStruct  {
      }

      Functions

      Preferred

      func someMethod() {
      }
      
      func someOtherFunction () -> () {
      }

      Not Preferred

      func someMethod()
      {
      }
      
      func someOtherFunction () -> ()
      {
      }

      Control flow constructs

      • if, else if, and else statement

      Preferred

      if SomeCondition {
      
      } else if someOtherCondition {
      } else {
      }

      Not Preferred

      if SomeCondition
      {
      
      }
      else if someOtherCondition
      {
      }
      else
      {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch SomeData
      {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for var i = 0; i < 10; i+=1
      {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while SomeCondition
      {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat
      {
      
      } while SomeCondition

      Initializers

      Preferred

      init(someParameter:Double, someOtherParameter:Double) {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Not Preferred

      init(someParameter:Double, someOtherParameter:Double)
      {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Protocols

      Preferred

      protocol SomeProtocol {
      
      }
      
      protocol SomeOtherProtocol : X {
      
      }

      Not Preferred

      protocol SomeProtocol
      {
      
      }
      
      protocol SomeOtherProtocol : X
      {
      }

      Enums

      Preferred

      enum SomeEnum {
          case A, B, C, D
      }
      
      enum SomeEnum {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int {
          case A, B, C = 5, D
      }

      Not Preferred

      enum SomeEnum
      {
          case A, B, C, D
      }
      
      enum SomeEnum
      {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int
      {
          case A, B, C = 5, D
      }

      Closures

      Preferred

      func someFunction () -> () {
      // closure
      }

      Not Preferred

      func someFunction () -> ()
      {
      // closure
      }

      Setters and Getters

      • set

      Preferred

      set {
          oldValue = newValue / 2
      }

      Not Preferred

      set
      {
          oldValue = newValue / 2
      }
      • get

      Preferred

      get {
          return value * 2
      }

      Not Preferred

      get
      {
          return value * 2
      }

      Extensions

      Preferred

      extension someExtension {
      }

      Not Preferred

      extension someExtension
      {
      }

      Enum case names should be lowerCamelCase
      Open

        case AccessRevocation

      lower-camel-case

      method and var names should follow lowerCamelCase naming convention: first letter of the entire word is lowercase, but subsequent first letters are uppercase.

      Method and selector names

      Preferred

      func someMethod() {
          // method definition goes here
      }

      Not Preferred

      func some-method() {
          // method definition goes here
      }

      Variable names

      Preferred

      var someVariable = someValue

      Not Preferred

      var Some_Var1able = someValue

      Condition should not be enclosed within parentheses
      Open

          while (keepWatcherThreadRunning) {

      redundant-parentheses

      Control flow constructs (if, else if, switch, for, while, repeat-while, and guard statements), Exception handling constructs (throw, and do/catch statements), and Initializers (array, dictionary, initializer patterns) should not be enclosed in parentheses.

      Additionally, method calls with no parameters and a trailing closure should not have empty parentheses following the method name.

      Control flow constructs

      • if, else if statement

      Preferred

      if SomeCondition {
      
      } else if SomeOtherCondition {
      }

      Not Preferred

      if (SomeCondition) {
      
      } else if (SomeOtherCondition) {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch (SomeData) {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for (var i = 0; i < 10; i+=1) {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while (SomeCondition) {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat {
      
      } while (SomeCondition)
      • guard clause

      Preferred

      guard true else {   }

      Not Preferred

      guard (true) else {   }

      Exception handling constructs

      • do/catch statement

      Preferred

      do  {
      
      } catch SomeException {
      
      }

      Not Preferred

      do  {
      
      } catch (SomeException) {
      
      }
      • throw statement

      Preferred

      throw SomeException

      Not Preferred

      throw (SomeException)

      Initializers

      • array items

      Preferred

      var shoppingList: [String] = ["Eggs", "Milk"]

      Not Preferred

      var shoppingList: [String] = [("Eggs"), ("Milk")]
      • dictionary items

      Preferred

      var airports: [String: String] = ["YYZ": "Toronto Pearson", "DUB": "Dublin"]

      Not Preferred

      var airports: [String: String] = [("YYZ"): ("Toronto Pearson"), ("DUB"): ("Dublin")]
      • initializer patterns

      Preferred

      var x: Int = 2
      var y: String = "Sleekbyte"
      var x = 2

      Not Preferred

      var x: Int = (2)
      var y: String = ("Sleekbyte")
      var x = (2)

      Method calls

      Preferred

      items.map {
        item in item.transform()
      }

      Not Preferred

      items.map() {
        item in item.transform()
      }

      If statement closing brace should be isolated on a separate line
      Open

          if contains(.Delete) { s.append(.Delete) }

      brace-style

      Definitions of - class - struct - function - Control flow constructs (if, else if, else, switch, for, while, repeat-while) - init - protocol - enum - closure - Getters and Setters (set, get) - extension

      should follow the One True Brace Style (1TBS): each construct has its opening brace one the same line along with the same indentation level as its header, the statements within the braces are indented, and the closing brace at the end is on the same indentation level as the header of the function at a line of its own. Braces are not omitted for a control statement with only a single statement in its scope. Every opening brace must also have one space preceding it.

      Classes

      Preferred

      class SomeClass {
      }
      
      class SomeClass: SomeSuperClass {
      }

      Not Preferred

      class SomeClass
      {
      }
      
      class SomeClass: SomeSuperClass{
      }

      Structs

      Preferred

      struct SomeStruct {
      }
      
      struct SomeStruct : SomeParentStruct {
      }

      Not Preferred

      struct SomeStruct
      {
      }
      
      struct SomeStruct : SomeParentStruct  {
      }

      Functions

      Preferred

      func someMethod() {
      }
      
      func someOtherFunction () -> () {
      }

      Not Preferred

      func someMethod()
      {
      }
      
      func someOtherFunction () -> ()
      {
      }

      Control flow constructs

      • if, else if, and else statement

      Preferred

      if SomeCondition {
      
      } else if someOtherCondition {
      } else {
      }

      Not Preferred

      if SomeCondition
      {
      
      }
      else if someOtherCondition
      {
      }
      else
      {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch SomeData
      {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for var i = 0; i < 10; i+=1
      {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while SomeCondition
      {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat
      {
      
      } while SomeCondition

      Initializers

      Preferred

      init(someParameter:Double, someOtherParameter:Double) {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Not Preferred

      init(someParameter:Double, someOtherParameter:Double)
      {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Protocols

      Preferred

      protocol SomeProtocol {
      
      }
      
      protocol SomeOtherProtocol : X {
      
      }

      Not Preferred

      protocol SomeProtocol
      {
      
      }
      
      protocol SomeOtherProtocol : X
      {
      }

      Enums

      Preferred

      enum SomeEnum {
          case A, B, C, D
      }
      
      enum SomeEnum {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int {
          case A, B, C = 5, D
      }

      Not Preferred

      enum SomeEnum
      {
          case A, B, C, D
      }
      
      enum SomeEnum
      {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int
      {
          case A, B, C = 5, D
      }

      Closures

      Preferred

      func someFunction () -> () {
      // closure
      }

      Not Preferred

      func someFunction () -> ()
      {
      // closure
      }

      Setters and Getters

      • set

      Preferred

      set {
          oldValue = newValue / 2
      }

      Not Preferred

      set
      {
          oldValue = newValue / 2
      }
      • get

      Preferred

      get {
          return value * 2
      }

      Not Preferred

      get
      {
          return value * 2
      }

      Extensions

      Preferred

      extension someExtension {
      }

      Not Preferred

      extension someExtension
      {
      }

      If statement closing brace should be isolated on a separate line
      Open

          if contains(.AttributeChange) { s.append(.AttributeChange) }

      brace-style

      Definitions of - class - struct - function - Control flow constructs (if, else if, else, switch, for, while, repeat-while) - init - protocol - enum - closure - Getters and Setters (set, get) - extension

      should follow the One True Brace Style (1TBS): each construct has its opening brace one the same line along with the same indentation level as its header, the statements within the braces are indented, and the closing brace at the end is on the same indentation level as the header of the function at a line of its own. Braces are not omitted for a control statement with only a single statement in its scope. Every opening brace must also have one space preceding it.

      Classes

      Preferred

      class SomeClass {
      }
      
      class SomeClass: SomeSuperClass {
      }

      Not Preferred

      class SomeClass
      {
      }
      
      class SomeClass: SomeSuperClass{
      }

      Structs

      Preferred

      struct SomeStruct {
      }
      
      struct SomeStruct : SomeParentStruct {
      }

      Not Preferred

      struct SomeStruct
      {
      }
      
      struct SomeStruct : SomeParentStruct  {
      }

      Functions

      Preferred

      func someMethod() {
      }
      
      func someOtherFunction () -> () {
      }

      Not Preferred

      func someMethod()
      {
      }
      
      func someOtherFunction () -> ()
      {
      }

      Control flow constructs

      • if, else if, and else statement

      Preferred

      if SomeCondition {
      
      } else if someOtherCondition {
      } else {
      }

      Not Preferred

      if SomeCondition
      {
      
      }
      else if someOtherCondition
      {
      }
      else
      {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch SomeData
      {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for var i = 0; i < 10; i+=1
      {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while SomeCondition
      {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat
      {
      
      } while SomeCondition

      Initializers

      Preferred

      init(someParameter:Double, someOtherParameter:Double) {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Not Preferred

      init(someParameter:Double, someOtherParameter:Double)
      {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Protocols

      Preferred

      protocol SomeProtocol {
      
      }
      
      protocol SomeOtherProtocol : X {
      
      }

      Not Preferred

      protocol SomeProtocol
      {
      
      }
      
      protocol SomeOtherProtocol : X
      {
      }

      Enums

      Preferred

      enum SomeEnum {
          case A, B, C, D
      }
      
      enum SomeEnum {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int {
          case A, B, C = 5, D
      }

      Not Preferred

      enum SomeEnum
      {
          case A, B, C, D
      }
      
      enum SomeEnum
      {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int
      {
          case A, B, C = 5, D
      }

      Closures

      Preferred

      func someFunction () -> () {
      // closure
      }

      Not Preferred

      func someFunction () -> ()
      {
      // closure
      }

      Setters and Getters

      • set

      Preferred

      set {
          oldValue = newValue / 2
      }

      Not Preferred

      set
      {
          oldValue = newValue / 2
      }
      • get

      Preferred

      get {
          return value * 2
      }

      Not Preferred

      get
      {
          return value * 2
      }

      Extensions

      Preferred

      extension someExtension {
      }

      Not Preferred

      extension someExtension
      {
      }

      If statement closing brace should be isolated on a separate line
      Open

          if contains(.AccessRevocation) { s.append(.AccessRevocation) }

      brace-style

      Definitions of - class - struct - function - Control flow constructs (if, else if, else, switch, for, while, repeat-while) - init - protocol - enum - closure - Getters and Setters (set, get) - extension

      should follow the One True Brace Style (1TBS): each construct has its opening brace one the same line along with the same indentation level as its header, the statements within the braces are indented, and the closing brace at the end is on the same indentation level as the header of the function at a line of its own. Braces are not omitted for a control statement with only a single statement in its scope. Every opening brace must also have one space preceding it.

      Classes

      Preferred

      class SomeClass {
      }
      
      class SomeClass: SomeSuperClass {
      }

      Not Preferred

      class SomeClass
      {
      }
      
      class SomeClass: SomeSuperClass{
      }

      Structs

      Preferred

      struct SomeStruct {
      }
      
      struct SomeStruct : SomeParentStruct {
      }

      Not Preferred

      struct SomeStruct
      {
      }
      
      struct SomeStruct : SomeParentStruct  {
      }

      Functions

      Preferred

      func someMethod() {
      }
      
      func someOtherFunction () -> () {
      }

      Not Preferred

      func someMethod()
      {
      }
      
      func someOtherFunction () -> ()
      {
      }

      Control flow constructs

      • if, else if, and else statement

      Preferred

      if SomeCondition {
      
      } else if someOtherCondition {
      } else {
      }

      Not Preferred

      if SomeCondition
      {
      
      }
      else if someOtherCondition
      {
      }
      else
      {
      }
      • switch statement

      Preferred

      switch SomeData {
          default:
              break
      }

      Not Preferred

      switch SomeData
      {
          default:
              break
      }
      • for loop

      Preferred

      for var i = 0; i < 10; i+=1 {
      
      }

      Not Preferred

      for var i = 0; i < 10; i+=1
      {
      
      }
      • while loop

      Preferred

      while SomeCondition {
      
      }

      Not Preferred

      while SomeCondition
      {
      
      }
      • repeat-while loop

      Preferred

      repeat {
      
      } while SomeCondition

      Not Preferred

      repeat
      {
      
      } while SomeCondition

      Initializers

      Preferred

      init(someParameter:Double, someOtherParameter:Double) {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Not Preferred

      init(someParameter:Double, someOtherParameter:Double)
      {
         self.someMember = someParameter
         self.someOtherMember = someOtherParameter
      }

      Protocols

      Preferred

      protocol SomeProtocol {
      
      }
      
      protocol SomeOtherProtocol : X {
      
      }

      Not Preferred

      protocol SomeProtocol
      {
      
      }
      
      protocol SomeOtherProtocol : X
      {
      }

      Enums

      Preferred

      enum SomeEnum {
          case A, B, C, D
      }
      
      enum SomeEnum {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int {
          case A, B, C = 5, D
      }

      Not Preferred

      enum SomeEnum
      {
          case A, B, C, D
      }
      
      enum SomeEnum
      {
          case A
          case B
          case C
          case D
      }
      
      enum SomeEnum: Int
      {
          case A, B, C = 5, D
      }

      Closures

      Preferred

      func someFunction () -> () {
      // closure
      }

      Not Preferred

      func someFunction () -> ()
      {
      // closure
      }

      Setters and Getters

      • set

      Preferred

      set {
          oldValue = newValue / 2
      }

      Not Preferred

      set
      {
          oldValue = newValue / 2
      }
      • get

      Preferred

      get {
          return value * 2
      }

      Not Preferred

      get
      {
          return value * 2
      }

      Extensions

      Preferred

      extension someExtension {
      }

      Not Preferred

      extension someExtension
      {
      }

      There are no issues that match your filters.

      Category
      Status