Probably a fix for macOS keybinds

src/ZenKeyboardShortcuts.mjs

@@ -1,43 +1,106 @@
-
 const kZKSActions = {
   // Note: If they start with "command:", it means that "command=" will be added to the key element,
   // otherwise "oncommand=" will be added.
 
   // Split view actions
-  zenSplitViewGrid: ["gZenViewSplitter.toggleShortcut('grid')", "zen-split-view-grid", "split-view-action"],
+  zenSplitViewGrid: [
-  zenSplitViewVertical: ["gZenViewSplitter.toggleShortcut('vsep')", "zen-split-view-vertical", "split-view-action"],
+    "gZenViewSplitter.toggleShortcut('grid')",
-  zenSplitViewHorizontal: ["gZenViewSplitter.toggleShortcut('hsep')", "zen-split-view-horizontal", "split-view-action"],
+    "zen-split-view-grid",
-  zenSplitViewClose: ["gZenViewSplitter.toggleShortcut('unsplit')", "zen-split-view-close", "split-view-action"],
+    "split-view-action",
+  ],
+  zenSplitViewVertical: [
+    "gZenViewSplitter.toggleShortcut('vsep')",
+    "zen-split-view-vertical",
+    "split-view-action",
+  ],
+  zenSplitViewHorizontal: [
+    "gZenViewSplitter.toggleShortcut('hsep')",
+    "zen-split-view-horizontal",
+    "split-view-action",
+  ],
+  zenSplitViewClose: [
+    "gZenViewSplitter.toggleShortcut('unsplit')",
+    "zen-split-view-close",
+    "split-view-action",
+  ],
 
   // Workspace actions
-  zenChangeWorkspace: ["ZenWorkspaces.changeWorkspaceShortcut()", "zen-change-workspace", "workspace-action"],
+  zenChangeWorkspace: [
+    "ZenWorkspaces.changeWorkspaceShortcut()",
+    "zen-change-workspace",
+    "workspace-action",
+  ],
 
   // manage actions
-  openNewTab: ["command:cmd_newNavigatorTabNoEvent","open-new-tab", "tab-action"],
+  openNewTab: [
-  duplicateTab: ["duplicateTabIn(gBrowser.selectedTab, 'tab')", "duplicate-tab", "tab-action"],
+    "command:cmd_newNavigatorTabNoEvent",
+    "open-new-tab",
+    "tab-action",
+  ],
+  duplicateTab: [
+    "duplicateTabIn(gBrowser.selectedTab, 'tab')",
+    "duplicate-tab",
+    "tab-action",
+  ],
   closeTab: ["command:cmd_close", "close-tab", "tab-action"],
   openNewWindow: ["command:cmd_newNavigator", "open-new-window", "tab-action"],
-  openNewPrivateWindow: ["command:Tools:PrivateBrowsing", "open-new-private-window", "tab-action"],
+  openNewPrivateWindow: [
+    "command:Tools:PrivateBrowsing",
+    "open-new-private-window",
+    "tab-action",
+  ],
   closeWindow: ["command:cmd_closeWindow", "close-window", "tab-action"],
   restoreLastTab: ["undoCloseTab()", "restore-last-session", "tab-action"],
-  restoreLastWindow: ["command:History:UndoCloseWindow", "restore-last-window", "tab-action"],
+  restoreLastWindow: [
-  showNextTab: ["gBrowser.tabContainer.advanceSelectedTab(1, true)", "show-next-tab", "tab-action"],
+    "command:History:UndoCloseWindow",
-  showPreviousTab: ["gBrowser.tabContainer.advanceSelectedTab(-1, true)", "show-previous-tab", "tab-action"],
+    "restore-last-window",
-  showAllTabsPanel: ["gTabsPanel.showAllTabsPanel()", "show-all-tabs-panel", "tab-action"],
+    "tab-action",
+  ],
+  showNextTab: [
+    "gBrowser.tabContainer.advanceSelectedTab(1, true)",
+    "show-next-tab",
+    "tab-action",
+  ],
+  showPreviousTab: [
+    "gBrowser.tabContainer.advanceSelectedTab(-1, true)",
+    "show-previous-tab",
+    "tab-action",
+  ],
+  showAllTabsPanel: [
+    "gTabsPanel.showAllTabsPanel()",
+    "show-all-tabs-panel",
+    "tab-action",
+  ],
 
   // Compact mode actions
-  zenToggleCompactMode: ["gZenCompactModeManager.toggle()", "zen-toggle-compact-mode", "compact-mode-action"],
+  zenToggleCompactMode: [
-  zenToggleCompactModeSidebar: ["gZenCompactModeManager.toggleSidebar()", "zen-toggle-compact-mode-sidebar", "compact-mode-action"],
+    "gZenCompactModeManager.toggle()",
-  zenToggleCompactModeToolbar: ["gZenCompactModeManager.toggleToolbar()", "zen-toggle-compact-mode-toolbar", "compact-mode-action"],
+    "zen-toggle-compact-mode",
+    "compact-mode-action",
+  ],
+  zenToggleCompactModeSidebar: [
+    "gZenCompactModeManager.toggleSidebar()",
+    "zen-toggle-compact-mode-sidebar",
+    "compact-mode-action",
+  ],
+  zenToggleCompactModeToolbar: [
+    "gZenCompactModeManager.toggleToolbar()",
+    "zen-toggle-compact-mode-toolbar",
+    "compact-mode-action",
+  ],
 
   // Page actions
   sendWithMail: ["command:Browser:SendLink", "send-with-mail", "page-action"],
   savePage: ["command:Browser:SavePage", "save-page", "page-action"],
   printPage: ["command:cmd_print", "print-page", "page-action"],
   muteCurrentTab: ["command:cmd_toggleMute", "mute-current-tab", "page-action"],
-  showSourceOfPage: ["command:View:PageSource", "show-source-of-page", "page-action"],
+  showSourceOfPage: [
+    "command:View:PageSource",
+    "show-source-of-page",
+    "page-action",
+  ],
   showPageInfo: ["command:View:PageInfo", "show-page-info", "page-action"],
-  
+
   // Visible actions
   zoomIn: ["command:cmd_fullZoomEnlarge", "zoom-in", "visible-action"],
   zoomOut: ["command:cmd_fullZoomReduce", "zoom-out", "visible-action"],
@@ -48,57 +111,189 @@ const kZKSActions = {
   forward: ["command:Browser:Forward", "forward", "history-action"],
   stop: ["command:Browser:Stop", "stop", "history-action"],
   reload: ["command:Browser:Reload", "reload", "history-action"],
-  forceReload: ["command:Browser:ReloadSkipCache", "force-reload", "history-action"],
+  forceReload: [
+    "command:Browser:ReloadSkipCache",
+    "force-reload",
+    "history-action",
+  ],
 
   // search actions
-  searchInThisPage: ["gLazyFindCommand('onFindCommand')", "search-in-this-page", "search-action"],
+  searchInThisPage: [
-  showNextSearchResult: ["gLazyFindCommand('onFindAgainCommand', false)", "show-next-search-result", "search-action"],
+    "gLazyFindCommand('onFindCommand')",
-  showPreviousSearchResult: ["gLazyFindCommand('onFindAgainCommand', true)", "show-previous-search-result", "search-action"],
+    "search-in-this-page",
+    "search-action",
+  ],
+  showNextSearchResult: [
+    "gLazyFindCommand('onFindAgainCommand', false)",
+    "show-next-search-result",
+    "search-action",
+  ],
+  showPreviousSearchResult: [
+    "gLazyFindCommand('onFindAgainCommand', true)",
+    "show-previous-search-result",
+    "search-action",
+  ],
   searchTheWeb: ["command:Tools:Search", "search-the-web", "search-action"],
 
   // Tools actions
-  openMigrationWizard: ["command:cmd_file_importFromAnotherBrowser", "open-migration-wizard", "tools-action"],
+  openMigrationWizard: [
-  quitFromApplication: ["command:goQuitApplication", "quit-from-application", "tools-action"],
+    "command:cmd_file_importFromAnotherBrowser",
-  enterIntoCustomizeMode: ["gCustomizeMode.enter()", "enter-into-customize-mode", "tools-action"],
+    "open-migration-wizard",
-  enterIntoOfflineMode: ["command:cmd_toggleOfflineStatus", "enter-into-offline-mode", "tools-action"],
+    "tools-action",
-  openScreenCapture: ["command:Browser:Screenshot", "open-screen-capture", "tools-action"],
+  ],
+  quitFromApplication: [
+    "command:goQuitApplication",
+    "quit-from-application",
+    "tools-action",
+  ],
+  enterIntoCustomizeMode: [
+    "gCustomizeMode.enter()",
+    "enter-into-customize-mode",
+    "tools-action",
+  ],
+  enterIntoOfflineMode: [
+    "command:cmd_toggleOfflineStatus",
+    "enter-into-offline-mode",
+    "tools-action",
+  ],
+  openScreenCapture: [
+    "command:Browser:Screenshot",
+    "open-screen-capture",
+    "tools-action",
+  ],
 
   // Bookmark actions
-  bookmarkThisPage: ["BrowserPageActions.doCommandForAction(PageActions.actionForID('bookmark'), event, this);", "bookmark-this-page", "bookmark-action"],
+  bookmarkThisPage: [
-  openBookmarkAddTool: ["PlacesUIUtils.showBookmarkPagesDialog(PlacesCommandHook.uniqueCurrentPages)", "open-bookmark-add-tool", "bookmark-action"],
+    "BrowserPageActions.doCommandForAction(PageActions.actionForID('bookmark'), event, this);",
-  openBookmarksManager: ["SidebarController.toggle('viewBookmarksSidebar');", "open-bookmarks-manager", "bookmark-action"],
+    "bookmark-this-page",
-  toggleBookmarkToolbar: ["BookmarkingUI.toggleBookmarksToolbar('bookmark-tools')", "toggle-bookmark-toolbar", "bookmark-action"],
+    "bookmark-action",
+  ],
+  openBookmarkAddTool: [
+    "PlacesUIUtils.showBookmarkPagesDialog(PlacesCommandHook.uniqueCurrentPages)",
+    "open-bookmark-add-tool",
+    "bookmark-action",
+  ],
+  openBookmarksManager: [
+    "SidebarController.toggle('viewBookmarksSidebar');",
+    "open-bookmarks-manager",
+    "bookmark-action",
+  ],
+  toggleBookmarkToolbar: [
+    "BookmarkingUI.toggleBookmarksToolbar('bookmark-tools')",
+    "toggle-bookmark-toolbar",
+    "bookmark-action",
+  ],
 
   // Open Page actions
-  openGeneralPreferences: ["openPreferences()", "open-general-preferences", "open-page-action"],
+  openGeneralPreferences: [
-  openPrivacyPreferences: ["openPreferences('panePrivacy')", "open-privacy-preferences", "open-page-action"],
+    "openPreferences()",
-  openWorkspacesPreferences: ["openPreferences('paneWorkspaces')", "open-workspaces-preferences", "open-page-action"],
+    "open-general-preferences",
-  openContainersPreferences: ["openPreferences('paneContainers')", "open-containers-preferences", "open-page-action"],
+    "open-page-action",
-  openSearchPreferences: ["openPreferences('paneSearch')", "open-search-preferences", "open-page-action"],
+  ],
-  openSyncPreferences: ["openPreferences('paneSync')", "open-sync-preferences", "open-page-action"],
+  openPrivacyPreferences: [
-  openTaskManager: ["command:View:AboutProcesses", "open-task-manager", "open-page-action"],
+    "openPreferences('panePrivacy')",
-  openAddonsManager: ["command:Tools:Addons", "open-addons-manager", "open-page-action"],
+    "open-privacy-preferences",
+    "open-page-action",
+  ],
+  openWorkspacesPreferences: [
+    "openPreferences('paneWorkspaces')",
+    "open-workspaces-preferences",
+    "open-page-action",
+  ],
+  openContainersPreferences: [
+    "openPreferences('paneContainers')",
+    "open-containers-preferences",
+    "open-page-action",
+  ],
+  openSearchPreferences: [
+    "openPreferences('paneSearch')",
+    "open-search-preferences",
+    "open-page-action",
+  ],
+  openSyncPreferences: [
+    "openPreferences('paneSync')",
+    "open-sync-preferences",
+    "open-page-action",
+  ],
+  openTaskManager: [
+    "command:View:AboutProcesses",
+    "open-task-manager",
+    "open-page-action",
+  ],
+  openAddonsManager: [
+    "command:Tools:Addons",
+    "open-addons-manager",
+    "open-page-action",
+  ],
   openHomePage: ["BrowserHome()", "open-home-page", "open-page-action"],
 
   // History actions
   forgetHistory: ["command:Tools:Sanitize", "forget-history", "history-action"],
-  quickForgetHistory: ["PlacesUtils.history.clear(true)", "quick-forget-history", "history-action"],
+  quickForgetHistory: [
-  clearRecentHistory: ["command:cmd_closeWindow", "clear-recent-history", "history-action"],
+    "PlacesUtils.history.clear(true)",
-  restoreLastSession: ["command:Browser:RestoreLastSession", "restore-last-session", "history-action"],
+    "quick-forget-history",
-  searchHistory: ["command:History:SearchHistory", "search-history", "history-action"],
+    "history-action",
-  manageHistory: ["PlacesCommandHook.showPlacesOrganizer('History')", "manage-history", "history-action"],
+  ],
+  clearRecentHistory: [
+    "command:cmd_closeWindow",
+    "clear-recent-history",
+    "history-action",
+  ],
+  restoreLastSession: [
+    "command:Browser:RestoreLastSession",
+    "restore-last-session",
+    "history-action",
+  ],
+  searchHistory: [
+    "command:History:SearchHistory",
+    "search-history",
+    "history-action",
+  ],
+  manageHistory: [
+    "PlacesCommandHook.showPlacesOrganizer('History')",
+    "manage-history",
+    "history-action",
+  ],
 
   // Downloads actions
-  openDownloads: ["DownloadsPanel.showDownloadsHistory()", "open-downloads", "downloads-action"],
+  openDownloads: [
+    "DownloadsPanel.showDownloadsHistory()",
+    "open-downloads",
+    "downloads-action",
+  ],
 
   // Sidebar actions
-  showBookmarkSidebar: ["SidebarController.show('viewBookmarksSidebar')", "show-bookmark-sidebar", "sidebar-action"],
+  showBookmarkSidebar: [
-  showHistorySidebar: ["SidebarController.show('viewHistorySidebar')", "show-history-sidebar", "sidebar-action"],
+    "SidebarController.show('viewBookmarksSidebar')",
-  showSyncedTabsSidebar: ["SidebarController.show('viewTabsSidebar')", "show-synced-tabs-sidebar", "sidebar-action"],
+    "show-bookmark-sidebar",
-  reverseSidebarPosition: ["SidebarController.reversePosition()", "reverse-sidebar", "sidebar-action"],
+    "sidebar-action",
+  ],
+  showHistorySidebar: [
+    "SidebarController.show('viewHistorySidebar')",
+    "show-history-sidebar",
+    "sidebar-action",
+  ],
+  showSyncedTabsSidebar: [
+    "SidebarController.show('viewTabsSidebar')",
+    "show-synced-tabs-sidebar",
+    "sidebar-action",
+  ],
+  reverseSidebarPosition: [
+    "SidebarController.reversePosition()",
+    "reverse-sidebar",
+    "sidebar-action",
+  ],
   hideSidebar: ["SidebarController.hide()", "hide-sidebar", "sidebar-action"],
-  toggleSidebar: ["SidebarController.toggle()", "toggle-sidebar", "sidebar-action"],
+  toggleSidebar: [
-  zenToggleWebPanels: ["gZenBrowserManagerSidebar.toggle()", "zen-toggle-web-panels", "sidebar-action"],
+    "SidebarController.toggle()",
+    "toggle-sidebar",
+    "sidebar-action",
+  ],
+  zenToggleWebPanels: [
+    "gZenBrowserManagerSidebar.toggle()",
+    "zen-toggle-web-panels",
+    "sidebar-action",
+  ],
 };
 
 const kZenDefaultShortcuts = {
@@ -117,7 +312,7 @@ const kZenDefaultShortcuts = {
   zenToggleCompactModeToolbar: "Ctrl+Alt+T",
 
   // manage actions
-  zenToggleWebPanels: "Alt+P", 
+  zenToggleWebPanels: "Alt+P",
 };
 
 // Section: ZenKeyboardShortcuts
@@ -180,7 +375,10 @@ var gZenKeyboardShortcuts = {
   },
 
   _saveShortcuts() {
-    Services.prefs.setStringPref(kZKSStorageKey, JSON.stringify(this._savedShortcuts));
+    Services.prefs.setStringPref(
+      kZKSStorageKey,
+      JSON.stringify(this._savedShortcuts),
+    );
   },
 
   _parseDefaultShortcut(shortcut) {
@@ -189,19 +387,37 @@ var gZenKeyboardShortcuts = {
     let shift = shortcut.includes("Shift+");
     let meta = shortcut.includes("Meta+");
     let key = shortcut.replace(/Ctrl\+|Alt\+|Shift\+|Meta\+/g, "");
-    if (["Tab", "Enter", "Escape", "Space", "ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown"].includes(key)) {
+    if (
+      [
+        "Tab",
+        "Enter",
+        "Escape",
+        "Space",
+        "ArrowLeft",
+        "ArrowRight",
+        "ArrowUp",
+        "ArrowDown",
+      ].includes(key)
+    ) {
       return { ctrl, alt, shift, meta, key: undefined, keycode: key };
     }
     let isKeyCode = key.length > 1;
-    return { ctrl, alt, shift, meta, 
+    return {
-        key: isKeyCode ? undefined : key, 
+      ctrl,
-        keycode: isKeyCode ? key : undefined };
+      alt,
+      shift,
+      meta,
+      key: isKeyCode ? undefined : key,
+      keycode: isKeyCode ? key : undefined,
+    };
   },
 
   _addDefaultShortcuts() {
     for (let action in kZenDefaultShortcuts) {
       if (!this._savedShortcuts[action]) {
-        this._savedShortcuts[action] = this._parseDefaultShortcut(kZenDefaultShortcuts[action]);
+        this._savedShortcuts[action] = this._parseDefaultShortcut(
+          kZenDefaultShortcuts[action],
+        );
       }
     }
   },
@@ -214,19 +430,27 @@ var gZenKeyboardShortcuts = {
     }
     this._saveShortcuts();
   },
-    
+
   _initShortcuts() {
     if (window.location.href == "chrome://browser/content/browser.xhtml") {
       console.info("Zen CKS: Initializing shortcuts");
-      Services.prefs.addObserver(kZKSStorageKey, this._onShortcutChange.bind(this));
+      Services.prefs.addObserver(
-      Services.prefs.addObserver("zen.keyboard.shortcuts.disable-firefox", this._disableFirefoxShortcuts.bind(this));
+        kZKSStorageKey,
+        this._onShortcutChange.bind(this),
+      );
+      Services.prefs.addObserver(
+        "zen.keyboard.shortcuts.disable-firefox",
+        this._disableFirefoxShortcuts.bind(this),
+      );
       this._initSavedShortcuts();
       this._disableFirefoxShortcuts();
     }
   },
 
   _disableFirefoxShortcuts() {
-    let disable = Services.prefs.getBoolPref("zen.keyboard.shortcuts.disable-firefox");
+    let disable = Services.prefs.getBoolPref(
+      "zen.keyboard.shortcuts.disable-firefox",
+    );
     if (!disable) {
       return;
     }
@@ -270,10 +494,12 @@ var gZenKeyboardShortcuts = {
       accel: shortcut.ctrl,
       alt: shortcut.alt,
       shift: shortcut.shift,
-      meta: shortcut.meta
+      meta: shortcut.meta,
     };
 
-    modifiers = Object.keys(modifiers).filter(mod => modifiers[mod]).join(",");
+    modifiers = Object.keys(modifiers)
+      .filter((mod) => modifiers[mod])
+      .join(",");
 
     if (keycode) {
       const key = kZKSKeyCodeMap[keycode] || keycode;
@@ -302,7 +528,7 @@ var gZenKeyboardShortcuts = {
     if (!keySet) {
       throw new Error("Zen CKS: No main keyset found");
     }
-    
+
     for (let action in kZKSActions) {
       let id = `zen-key_${action}`;
       let existing = document.getElementById(id);
@@ -340,7 +566,7 @@ var gZenKeyboardShortcuts = {
   shortCutToString(shortcut) {
     let str = "";
     if (shortcut.ctrl) {
-      str += AppConstants.platform == "macosx" ? "Cmd+" : "Ctrl+";
+      str += "Ctrl+";
     }
     if (shortcut.alt) {
       str += "Alt+";
@@ -349,11 +575,12 @@ var gZenKeyboardShortcuts = {
       str += "Shift+";
     }
     if (shortcut.meta) {
-      str += "Meta+";
+      str += AppConstants.platform == "macosx" ? "Cmd+" : "Meta+";
     }
     if (shortcut.keycode) {
       str += shortcut.keycode;
-    } else if (shortcut.key) { // It can be undefined if edited from the settings
+    } else if (shortcut.key) {
+      // It can be undefined if edited from the settings
       str += shortcut.key;
     }
     return str;