Add ability to set default shortcut (#13)

Co-authored-by: Sindre Sorhus <[email protected]>

Author: gpoitch

Sources/KeyboardShortcuts/KeyboardShortcuts.swift

@@ -211,10 +211,14 @@ public enum KeyboardShortcuts {
 			return
 		}
 
-		UserDefaults.standard.removeObject(forKey: userDefaultsKey(for: name))
+		UserDefaults.standard.set(false, forKey: userDefaultsKey(for: name))
 		unregister(shortcut)
 		userDefaultsDidChange(name: name)
 	}
+
+	static func userDefaultsContains(name: Name) -> Bool {
+		UserDefaults.standard.object(forKey: userDefaultsKey(for: name)) != nil
+	}
 }
 
 extension Notification.Name {

Sources/KeyboardShortcuts/Name.swift

@@ -13,14 +13,28 @@ extension KeyboardShortcuts {
 	```
 	*/
 	public struct Name: Hashable {
-		// This is to allow `extension KeyboardShortcuts.Name { static let x = Name("x") }`.
+		// These make it possible to use the types without the namespace.
+		// `extension KeyboardShortcuts.Name { static let x = Name("x") }`.
 		/// :nodoc:
 		public typealias Name = KeyboardShortcuts.Name
+		/// :nodoc:
+		public typealias Shortcut = KeyboardShortcuts.Shortcut
 
 		public let rawValue: String
 
-		public init(_ name: String) {
+		/**
+		- Parameter name: Name of the shortcut.
+		- Parameter default: Optional default key combination for the shortcut. Do not set this unless it's essential. Users find it annoying when random apps steal their existing keyboard shortcuts. It's generally better to show a welcome screen on the first app launch that lets the user set the shortcut.
+		*/
+		public init(_ name: String, default defaultShortcut: Shortcut? = nil) {
 			self.rawValue = name
+
+			if
+				let defaultShortcut = defaultShortcut,
+				!userDefaultsContains(name: self)
+			{
+				userDefaultsSet(name: self, shortcut: defaultShortcut)
+			}
 		}
 	}
 }