Files
search-with-chatgpt-powered…/options/shortcut.js
golem ff61aff5b9 feat: rewrite the options page for first-time users (#23)
Rewrites the options page for first-time users without removing any setting. Customization in a lightweight package is what sets this extension apart. Design: `docs/superpowers/specs/2026-10-18-options-page-for-first-time-users-design.md`.

**User-visible changes**
- **Layout:** the description stays as the first line, followed by a **Usage instructions** section and the **Settings** section. Each section has a heading and a divider.
- **Usage instructions:** one labelled line per way to open ChatGPT, each with a small drawing:
  - **Address bar:** `<Ctrl>+L`, then `gpt`, a space and the question. The drawing shows a ChatGPT label because the address-bar code shipped in Firefox 157.0.1 enters search mode when an engine keyword is followed by a space. I checked that in its `omni.ja`, but it still needs confirming on screen; see the checks below.
  - **Right-click:** a drawing of the menu with Ask ChatGPT highlighted.
  - **Keyboard:** key caps for the user's actual shortcut, held down. The line is hidden when no shortcut is set.
  - **Toolbar:** the hovered button with the pointer, its tooltip, the puzzle-piece Extensions button, and a selected heading.
- **Drawings:** they are HTML/CSS and inline SVG, not screenshots, so they follow light and dark themes, stay sharp, and never go stale. They are centred. The package grows from 52.8 KB to 56.5 KB.
- **Settings:**
  - **Right-click menu** (was "Context menu") and **Open ChatGPT in** stay visible.
  - Choosing **Advanced** reveals a drawing of the Ask ChatGPT submenu (Ask normally, Explain, Summarize, Debug code). It lives in the block that only shows for Advanced, so it needs no script.
  - Prompt template, temporary chat and web search move under **More options**, whose heading names them. It opens by itself on load, or when a sync changes one of them, if one of them isn't at its default.
  - **Restore defaults** is right-aligned and red.
- **Bottom of the page:**
  - The keyword/default-engine and keyboard-shortcut notes become collapsed sections with numbered steps.
  - The project links are centred, and stack on narrow panels.
- **Hotkeys:** written as `<Ctrl>+L` and `<Alt>+<Shift>+G`, including the user's actual shortcut. Mac users see `<Cmd>`, `<Option>` and `<Return>`, detected with `runtime.getPlatformInfo`, which needs no permission.
- **Docs:**
  - Keyword wording is corrected in the options page and README: Firefox adds a custom keyword alongside `gpt` instead of replacing it.
  - README and AGENTS.md use the new setting names.
  - AGENTS.md records the keep-every-setting rule, the hotkey format and the "filled in, never sent" copy rule.

These still match the original options design spec: the temporary-chat and web-search wording, and the rule that copy never says the question is sent.

No permission, search URL, privacy or packaging changes.

**Checks**
- `npm test`: lint 0 errors / 0 warnings, 61/61 unit tests, build OK.
- New tests:
  - the key formatter, including the Mac names Firefox stores (Command, MacCtrl, Alt)
  - the page's written hotkeys match the formatter
  - the keyboard drawing's key caps follow the live shortcut
- Rendered in headless Firefox 157 with the extension APIs stubbed:
  - light and dark themes
  - 680 px and 360 px wide
  - Mac key names
  - More options opening for a customised prompt template
  - both bottom sections expanded

**Manual Firefox checks (`npm run dev` → about:addons → Preferences)**
- [x] Typing `gpt` and a space shows a ChatGPT label in the address bar, as drawn. If it doesn't, the drawing drops the label and shows plain `gpt how do magnets work?`
- [x] Light and dark themes, and a narrow about:addons width
- [x] Expanding More options and the two bottom sections grows the inline panel without clipping or scrolling
- [x] The Keyboard line and its key caps disappear when the shortcut is removed, and come back showing the new keys when one is set
- [x] More options opens by itself after changing the prompt template and reopening the page
- [x] Choosing Advanced shows the submenu drawing; Simple and Off hide it
- [x] Settings still save, and Restore defaults still works

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Reviewed-on: https://git.zavage.net/Zavage-Software/search-with-chatgpt-powered-by-openai-extension/pulls/23
Co-authored-by: golem <golem@zavage.net>
2026-10-18 22:53:27 -06:00

83 lines
3.1 KiB
JavaScript

// Firefox stores Mac shortcuts with Command, MacCtrl, and Alt, and reads a
// manifest's Ctrl as Command there (ShortcutUtils' chromeModifierKeyMap).
const MAC_KEY_NAMES = { Ctrl: "Cmd", Command: "Cmd", MacCtrl: "Ctrl", Alt: "Option", Enter: "Return" };
const OTHER_KEY_NAMES = { Command: "Ctrl", MacCtrl: "Ctrl" };
// The keys of a Firefox shortcut such as "Alt+Shift+G", named for the platform.
export function shortcutKeys(shortcut, os) {
const names = os === "mac" ? MAC_KEY_NAMES : OTHER_KEY_NAMES;
return shortcut.split("+").map((key) => names[key] ?? key);
}
// Writes a shortcut the way the page does: named keys in angle brackets and
// single characters plain, "<Alt>+<Shift>+G".
export function formatShortcut(shortcut, os) {
return shortcutKeys(shortcut, os)
.map((name) => (name.length > 1 ? `<${name}>` : name))
.join("+");
}
// The page's static hotkeys are written for Windows and Linux.
export function renderStaticShortcuts(document, os) {
for (const element of document.querySelectorAll("[data-shortcut]")) {
element.textContent = formatShortcut(element.dataset.shortcut, os);
}
}
// Firefox owns shortcut preferences; never copy them into extension storage.
export async function initializeShortcut({ commands, document, window, os }) {
const field = (id) => document.getElementById(id);
let refreshId = 0;
// One key cap per key for the drawing, joined by plain "+" text.
function keycaps(shortcut) {
return shortcutKeys(shortcut, os).flatMap((name, index) => {
const key = document.createElement("kbd");
key.className = "drawing-key";
key.textContent = name;
return index ? ["+", key] : [key];
});
}
function render(shortcut) {
const keys = shortcut ? formatShortcut(shortcut, os) : "";
field("shortcut-intro").hidden = !keys;
field("shortcut-intro-key").textContent = keys;
field("shortcut-keycaps").replaceChildren(...(keys ? keycaps(shortcut) : []));
field("shortcut-current").textContent = shortcut === null
? "Could not read the keyboard shortcut. Check Manage Extension Shortcuts in Add-ons."
: keys ? `Current shortcut: ${keys}` : "No keyboard shortcut assigned.";
}
async function refresh() {
const requestId = ++refreshId;
try {
const all = await commands.getAll();
const command = all.find(({ name }) => name === "ask-chatgpt");
if (requestId === refreshId) render(command?.shortcut ?? "");
} catch {
if (requestId === refreshId) render(null);
}
}
const button = field("change-shortcut");
button.hidden = typeof commands?.openShortcutSettings !== "function";
button.addEventListener("click", async () => {
try {
await commands.openShortcutSettings();
} catch {
field("shortcut-current").textContent =
"Open Add-ons, then the gear menu → Manage Extension Shortcuts to change your shortcut.";
}
});
commands?.onChanged?.addListener(({ name }) => {
if (name === "ask-chatgpt") void refresh();
});
window.addEventListener("focus", refresh);
document.addEventListener("visibilitychange", () => {
if (document.visibilityState === "visible") void refresh();
});
await refresh();
}