Minor tweaks

Author: sindresorhus

.swiftlint.yml

@@ -81,7 +81,6 @@ whitelist_rules:
   - operator_whitespace
   - orphaned_doc_comment
   - overridden_super_call
-  - pattern_matching_keywords
   - prefer_self_type_over_type_of_self
   - private_action
   - private_outlet

KeyboardShortcutsExample/AppDelegate.swift

@@ -4,7 +4,7 @@ import KeyboardShortcuts
 
 @NSApplicationMain
 final class AppDelegate: NSObject, NSApplicationDelegate {
-	var window: NSWindow!
+	private var window: NSWindow!
 
 	func applicationDidFinishLaunching(_ notification: Notification) {
 		let contentView = ContentView()

KeyboardShortcutsExample/ContentView.swift

@@ -10,7 +10,7 @@ struct ContentView: View {
 	@State private var isPressed1 = false
 	@State private var isPressed2 = false
 
-    var body: some View {
+	var body: some View {
 		VStack {
 			HStack {
 				KeyboardShortcuts.Recorder(for: .testShortcut1)
@@ -44,11 +44,11 @@ struct ContentView: View {
 					self.isPressed2 = false
 				}
 			}
-    }
+	}
 }
 
 struct ContentView_Previews: PreviewProvider {
-    static var previews: some View {
-        ContentView()
-    }
+	static var previews: some View {
+		ContentView()
+	}
 }

Sources/KeyboardShortcuts/Key.swift

@@ -229,7 +229,7 @@ extension KeyboardShortcuts {
 			case kVK_RightShift:
 				self = .rightShift
 			case kVK_Return:
-				self = .`return`
+				self = .return
 			case kVK_ANSI_Backslash:
 				self = .backslash
 			case kVK_ANSI_Grave:
@@ -464,7 +464,7 @@ extension KeyboardShortcuts {
 				return kVK_RightControl
 			case .rightShift:
 				return kVK_RightShift
-			case .`return`:
+			case .return:
 				return kVK_Return
 			case .backslash:
 				return kVK_ANSI_Backslash

Sources/KeyboardShortcuts/Recorder.swift

@@ -33,16 +33,13 @@ extension KeyboardShortcuts {
 		private let onChange: ((_ shortcut: Shortcut?) -> Void)?
 
 		/**
-		  Creates a new Recorder view
-		  - Parameter name: strongly typed `KeyboardShortcuts.Name`
-		  - Parameter onChange: optional callback which will be called when the shortcut is successfully changed/removed. This could be useful if you would like to store the keyboard shortcut somewhere yourself instead of rely on the build-in `UserDefaults` storage.
-		  ```
-		  KeyboardShortcuts.Recorder(for: .toggleUnicornMode, onChange: { (shortcut: KeyboardShortcuts.Shortcut?) in
-		    print("Changed shortcut to:", shortcut)
-		  })
-		  ```
-		**/
-		public init(for name: Name, onChange: ((_ shortcut: Shortcut?) -> Void)? = nil) {
+		- Parameter name: Strongly-typed keyboard shortcut name.
+		- Parameter onChange: Callback which will be called when the keyboard shortcut is changed/removed by the user. This can be useful when you need more control. For example, when migrating from a different keyboard shortcut solution and you need to store the keyboard shortcut somewhere yourself instead of relying on the built-in storage. However, it's strongly recommended to just rely on the built-in storage when possible.
+		*/
+		public init(
+			for name: Name,
+			onChange: ((_ shortcut: Shortcut?) -> Void)? = nil
+		) {
 			self.name = name
 			self.onChange = onChange
 		}
@@ -57,7 +54,7 @@ extension KeyboardShortcuts {
 
 @available(macOS 10.15, *)
 struct SwiftUI_Previews: PreviewProvider {
-    static var previews: some View {
+	static var previews: some View {
 		KeyboardShortcuts.Recorder(for: .Name("xcodePreview"))
-    }
+	}
 }

Sources/KeyboardShortcuts/RecorderCocoa.swift

@@ -51,16 +51,13 @@ extension KeyboardShortcuts {
 		}
 
 		/**
-		  Creates a new RecorderCocoa view
-		  - Parameter name: strongly typed `KeyboardShortcuts.Name`
-		  - Parameter onChange: optional callback which will be called when the shortcut is successfully changed/removed. This could be useful if you would like to store the keyboard shortcut somewhere yourself instead of rely on the build-in `UserDefaults` storage.
-		  ```
-		  KeyboardShortcuts.RecorderCocoa(for: .toggleUnicornMode, onChange: { (shortcut: KeyboardShortcuts.Shortcut?) in
-		    print("Changed shortcut to:", shortcut)
-		  })
-		  ```
-		**/
-		public required init(for name: Name, onChange: ((_ shortcut: Shortcut?) -> Void)? = nil) {
+		- Parameter name: Strongly-typed keyboard shortcut name.
+		- Parameter onChange: Callback which will be called when the keyboard shortcut is changed/removed by the user. This can be useful when you need more control. For example, when migrating from a different keyboard shortcut solution and you need to store the keyboard shortcut somewhere yourself instead of relying on the built-in storage. However, it's strongly recommended to just rely on the built-in storage when possible.
+		*/
+		public required init(
+			for name: Name,
+			onChange: ((_ shortcut: Shortcut?) -> Void)? = nil
+		) {
 			self.shortcutName = name
 			self.onChange = onChange
 
@@ -133,7 +130,7 @@ extension KeyboardShortcuts {
 				let clickMargin: CGFloat = 3
 
 				if
-					(event.type == .leftMouseUp || event.type == .rightMouseUp),
+					event.type == .leftMouseUp || event.type == .rightMouseUp,
 					!self.frame.insetBy(dx: -clickMargin, dy: -clickMargin).contains(clickPoint)
 				{
 					self.blur()
@@ -163,22 +160,18 @@ extension KeyboardShortcuts {
 				}
 
 				if
-					event.modifiers.isEmpty &&
-					(
-						event.specialKey == .delete ||
-						event.specialKey == .deleteForward ||
-						event.specialKey == .backspace
-					)
+					event.modifiers.isEmpty,
+					event.specialKey == .delete
+						|| event.specialKey == .deleteForward
+						|| event.specialKey == .backspace
 				{
 					self.clear()
 					return nil
 				}
 
 				guard
-					(
-						!event.modifiers.isEmpty ||
-						event.specialKey?.isFunctionKey == true
-					),
+					!event.modifiers.isEmpty
+						|| event.specialKey?.isFunctionKey == true,
 					let shortcut = Shortcut(event: event)
 				else {
 					NSSound.beep()

Sources/KeyboardShortcuts/Shortcut.swift

@@ -188,8 +188,8 @@ extension KeyboardShortcuts.Shortcut {
 			return nil
 		}
 
-		let dataRef = unsafeBitCast(layoutDataPointer, to: CFData.self)
-		let keyLayout = unsafeBitCast(CFDataGetBytePtr(dataRef), to: UnsafePointer<CoreServices.UCKeyboardLayout>.self)
+		let layoutData = unsafeBitCast(layoutDataPointer, to: CFData.self)
+		let keyLayout = unsafeBitCast(CFDataGetBytePtr(layoutData), to: UnsafePointer<CoreServices.UCKeyboardLayout>.self)
 		var deadKeyState: UInt32 = 0
 		let maxLength = 4
 		var length = 0
@@ -199,7 +199,7 @@ extension KeyboardShortcuts.Shortcut {
 			keyLayout,
 			UInt16(carbonKeyCode),
 			UInt16(CoreServices.kUCKeyActionDisplay),
-			UInt32(carbonModifiers),
+			0, // No modifiers
 			UInt32(LMGetKbdType()),
 			OptionBits(CoreServices.kUCKeyTranslateNoDeadKeysBit),
 			&deadKeyState,