Add modifier keys to option dictionary (#62)

johnste · Jun 15, 2019 · af2ee09 · af2ee09
1 parent d024992
commit af2ee09
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 2 deletions.
diff --git a/Finicky/Finicky/Config.swift b/Finicky/Finicky/Config.swift
@@ -1,5 +1,6 @@
 import Foundation
 import JavaScriptCore
+import AppKit
 
 var FNConfigPath: String = "~/.finicky.js"
 
@@ -272,12 +273,24 @@ open class FinickyConfig {
         let optionsDict = [
             "sourceBundleIdentifier": sourceBundleIdentifier as Any,
             "urlString": url.absoluteString,
+            "keys": getModifierKeyFlags(),
             "url": FinickyAPI.getUrlParts(url.absoluteString),
         ] as [AnyHashable: Any]
         let result = ctx.evaluateScript(processUrlJS)?.call(withArguments: [optionsDict])
         return result
     }
 
+    func getModifierKeyFlags() -> [String: Bool] {
+        return [
+            "shift": NSEvent.modifierFlags.contains(.shift),
+            "option": NSEvent.modifierFlags.contains(.option),
+            "command": NSEvent.modifierFlags.contains(.command),
+            "control": NSEvent.modifierFlags.contains(.control),
+            "capsLock": NSEvent.modifierFlags.contains(.capsLock),
+            "function": NSEvent.modifierFlags.contains(.function),
+        ]
+    }
+
     open func setupAPI() {
         ctx = createJSContext()
 

diff --git a/Finicky/Finicky/Info.plist b/Finicky/Finicky/Info.plist
@@ -67,7 +67,7 @@
 		</dict>
 	</array>
 	<key>CFBundleVersion</key>
-	<string>134</string>
+	<string>136</string>
 	<key>LSApplicationCategoryType</key>
 	<string>public.app-category.utilities</string>
 	<key>LSMinimumSystemVersion</key>

diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ Finicky is an macOS application that allows you to set up rules that decide whic
   - [Basic configuration](#basic-configuration)
   - [Rewrite urls](#rewrite-urls)
   - [Advanced usage, settings](#advanced-usage-settings)
+  - [Keyboard modifiers](#keyboard-modifiers)
   - [Configuration ideas](#configuration-ideas)
 - [API Reference](#api-reference)
 - [Issues](#issues)
@@ -48,7 +49,7 @@ Finicky is an macOS application that allows you to set up rules that decide whic
 1. Install Finicky:
 
 - Download [the latest release](https://github.com/johnste/finicky/releases), unzip and put `Finicky.app` in your application folder.
-<!-- - Alternatively, you can install with [homebrew-cask](https://github.com/caskroom/homebrew-cask): `brew cask install finicky`. -->
+  <!-- - Alternatively, you can install with [homebrew-cask](https://github.com/caskroom/homebrew-cask): `brew cask install finicky`. -->
 
 2. Create a file called `.finicky.js` with configuration
    ([examples](#example-configuration)) in your home directory.
@@ -128,6 +129,23 @@ module.exports = {
 };
 ```
 
+### Keyboard modifiers
+
+```js
+module.exports = {
+  defaultBrowser: "Google Chrome",
+  handlers: [
+    {
+      // Open links in Safari when the option key is pressed
+      // Valid keys are: shift, option, command, control, capsLock, and function.
+      // Please not that control usually opens a tooltip menu instead of visiting a link
+      match: ({ keys }) => keys.option,
+      browser: "Safari"
+    }
+  ]
+};
+```
+
 ### Configuration ideas
 
 See the wiki page for other [configuration ideas](https://github.com/johnste/finicky/wiki/Configuration-ideas)