@peaske7/readit 0.2.0 → 0.3.0-rc.0

package/src/lib/shortcut-registry.ts

@@ -0,0 +1,244 @@
+import type { KeybindingOverride, ShortcutBinding } from "../schema";
+import type { TranslationKey } from "./i18n/types";
+
+const IS_MAC =
+  typeof navigator !== "undefined" && navigator.platform.includes("Mac");
+
+export const ShortcutActions = {
+  COPY_ALL: "copyAll",
+  COPY_ALL_RAW: "copyAllRaw",
+  NAVIGATE_NEXT: "navigateNext",
+  NAVIGATE_PREVIOUS: "navigatePrevious",
+  COPY_SELECTION_RAW: "copySelectionRaw",
+  COPY_SELECTION_LLM: "copySelectionLLM",
+  CLEAR_SELECTION: "clearSelection",
+} as const;
+
+export type ShortcutAction =
+  (typeof ShortcutActions)[keyof typeof ShortcutActions];
+
+export interface ShortcutDefinition {
+  id: ShortcutAction;
+  label: TranslationKey;
+  description: TranslationKey;
+  defaultBinding: ShortcutBinding;
+  binding: ShortcutBinding;
+  enabled: boolean;
+}
+
+export const DEFAULT_SHORTCUTS: ShortcutDefinition[] = [
+  {
+    id: ShortcutActions.COPY_ALL,
+    label: "shortcut.copyAll.label",
+    description: "shortcut.copyAll.description",
+    defaultBinding: { key: "c", alt: true },
+    binding: { key: "c", alt: true },
+    enabled: true,
+  },
+  {
+    id: ShortcutActions.COPY_ALL_RAW,
+    label: "shortcut.copyAllRaw.label",
+    description: "shortcut.copyAllRaw.description",
+    defaultBinding: { key: "c", alt: true, shift: true },
+    binding: { key: "c", alt: true, shift: true },
+    enabled: true,
+  },
+  {
+    id: ShortcutActions.NAVIGATE_NEXT,
+    label: "shortcut.navigateNext.label",
+    description: "shortcut.navigateNext.description",
+    defaultBinding: { key: "ArrowDown", alt: true },
+    binding: { key: "ArrowDown", alt: true },
+    enabled: true,
+  },
+  {
+    id: ShortcutActions.NAVIGATE_PREVIOUS,
+    label: "shortcut.navigatePrevious.label",
+    description: "shortcut.navigatePrevious.description",
+    defaultBinding: { key: "ArrowUp", alt: true },
+    binding: { key: "ArrowUp", alt: true },
+    enabled: true,
+  },
+  {
+    id: ShortcutActions.COPY_SELECTION_RAW,
+    label: "shortcut.copySelectionRaw.label",
+    description: "shortcut.copySelectionRaw.description",
+    defaultBinding: IS_MAC
+      ? { key: "c", meta: true, shift: true }
+      : { key: "c", ctrl: true, shift: true },
+    binding: IS_MAC
+      ? { key: "c", meta: true, shift: true }
+      : { key: "c", ctrl: true, shift: true },
+    enabled: true,
+  },
+  {
+    id: ShortcutActions.COPY_SELECTION_LLM,
+    label: "shortcut.copySelectionLLM.label",
+    description: "shortcut.copySelectionLLM.description",
+    defaultBinding: IS_MAC
+      ? { key: "c", meta: true, alt: true }
+      : { key: "c", ctrl: true, alt: true },
+    binding: IS_MAC
+      ? { key: "c", meta: true, alt: true }
+      : { key: "c", ctrl: true, alt: true },
+    enabled: true,
+  },
+  {
+    id: ShortcutActions.CLEAR_SELECTION,
+    label: "shortcut.clearSelection.label",
+    description: "shortcut.clearSelection.description",
+    defaultBinding: { key: "Escape" },
+    binding: { key: "Escape" },
+    enabled: true,
+  },
+];
+
+export function matchesBinding(
+  event: KeyboardEvent,
+  binding: ShortcutBinding,
+): boolean {
+  if (event.key.toLowerCase() !== binding.key.toLowerCase()) return false;
+  if (!!binding.alt !== event.altKey) return false;
+  if (!!binding.ctrl !== event.ctrlKey) return false;
+  if (!!binding.meta !== event.metaKey) return false;
+  if (!!binding.shift !== event.shiftKey) return false;
+  return true;
+}
+
+export function formatBinding(
+  binding: ShortcutBinding,
+  isMac: boolean,
+): string {
+  const parts: string[] = [];
+
+  if (binding.ctrl) {
+    parts.push(isMac ? "\u2303" : "Ctrl");
+  }
+  if (binding.meta) {
+    parts.push(isMac ? "\u2318" : "Meta");
+  }
+  if (binding.alt) {
+    parts.push(isMac ? "\u2325" : "Alt");
+  }
+  if (binding.shift) {
+    parts.push(isMac ? "\u21E7" : "Shift");
+  }
+
+  const keyDisplay = KEY_DISPLAY_MAP[binding.key] ?? binding.key.toUpperCase();
+  parts.push(keyDisplay);
+
+  return parts.join(isMac ? "" : "+");
+}
+
+const KEY_DISPLAY_MAP: Record<string, string> = {
+  ArrowUp: "\u2191",
+  ArrowDown: "\u2193",
+  ArrowLeft: "\u2190",
+  ArrowRight: "\u2192",
+  Escape: "Esc",
+  Enter: "\u21B5",
+  Backspace: "\u232B",
+  Delete: "\u2326",
+  Tab: "\u21E5",
+  " ": "Space",
+};
+
+export function resolveShortcuts(
+  overrides: KeybindingOverride[],
+): ShortcutDefinition[] {
+  return DEFAULT_SHORTCUTS.map((def) => {
+    const override = overrides.find((o) => o.id === def.id);
+    if (!override) return { ...def };
+    return {
+      ...def,
+      binding: override.binding ?? def.defaultBinding,
+      enabled: override.enabled,
+    };
+  });
+}
+
+// Mac-specific reserved bindings (Cmd+key)
+export const RESERVED_BINDINGS_MAC: ShortcutBinding[] = [
+  { key: "r", meta: true },
+  { key: "w", meta: true },
+  { key: "t", meta: true },
+  { key: "n", meta: true },
+  { key: "q", meta: true },
+  { key: "l", meta: true },
+  { key: "a", meta: true },
+  { key: "f", meta: true },
+  { key: "p", meta: true },
+];
+
+// Windows/Linux reserved bindings (Ctrl+key consumed by browser)
+export const RESERVED_BINDINGS_OTHER: ShortcutBinding[] = [
+  { key: "r", ctrl: true },
+  { key: "w", ctrl: true },
+  { key: "t", ctrl: true },
+  { key: "n", ctrl: true },
+  { key: "l", ctrl: true },
+  { key: "a", ctrl: true },
+  { key: "f", ctrl: true },
+  { key: "p", ctrl: true },
+];
+
+export function isReservedBinding(
+  binding: ShortcutBinding,
+  isMac: boolean,
+): boolean {
+  const reserved = isMac ? RESERVED_BINDINGS_MAC : RESERVED_BINDINGS_OTHER;
+  // Ignore shift when checking reserved bindings because browsers also
+  // consume the shifted variants (e.g. Cmd+Shift+R, Ctrl+Shift+T).
+  return reserved.some(
+    (r) =>
+      r.key.toLowerCase() === binding.key.toLowerCase() &&
+      !!r.alt === !!binding.alt &&
+      !!r.ctrl === !!binding.ctrl &&
+      !!r.meta === !!binding.meta,
+  );
+}
+
+export function eventToBinding(event: KeyboardEvent): ShortcutBinding {
+  return {
+    key: event.key,
+    ...(event.altKey && { alt: true }),
+    ...(event.ctrlKey && { ctrl: true }),
+    ...(event.metaKey && { meta: true }),
+    ...(event.shiftKey && { shift: true }),
+  };
+}
+
+export function bindingsEqual(a: ShortcutBinding, b: ShortcutBinding): boolean {
+  return (
+    a.key.toLowerCase() === b.key.toLowerCase() &&
+    !!a.alt === !!b.alt &&
+    !!a.ctrl === !!b.ctrl &&
+    !!a.meta === !!b.meta &&
+    !!a.shift === !!b.shift
+  );
+}
+
+export interface ShortcutGroup {
+  label: TranslationKey;
+  ids: ShortcutAction[];
+}
+
+export const SHORTCUT_GROUPS: ShortcutGroup[] = [
+  {
+    label: "shortcutGroup.copy",
+    ids: [
+      ShortcutActions.COPY_ALL,
+      ShortcutActions.COPY_ALL_RAW,
+      ShortcutActions.COPY_SELECTION_RAW,
+      ShortcutActions.COPY_SELECTION_LLM,
+    ],
+  },
+  {
+    label: "shortcutGroup.navigate",
+    ids: [ShortcutActions.NAVIGATE_NEXT, ShortcutActions.NAVIGATE_PREVIOUS],
+  },
+  {
+    label: "shortcutGroup.other",
+    ids: [ShortcutActions.CLEAR_SELECTION],
+  },
+];

package/src/lib/utils.ts

@@ -1,5 +1,4 @@
 import { type ClassValue, clsx } from "clsx";
-import type { ReactNode } from "react";
 import { twMerge } from "tailwind-merge";
 
 export function isMarkdownFile(filePath: string): boolean {
@@ -14,31 +13,3 @@ export function truncate(text: string, maxLength = 30): string {
   if (text.length <= maxLength) return text;
   return `${text.slice(0, maxLength)}…`;
 }
-
-export function getTextContent(children: ReactNode): string {
-  if (typeof children === "string" || typeof children === "number") {
-    return String(children);
-  }
-  if (Array.isArray(children)) {
-    return children.map(getTextContent).join("");
-  }
-  if (
-    typeof children === "object" &&
-    children !== null &&
-    "props" in children
-  ) {
-    return getTextContent(
-      (children as { props: { children?: ReactNode } }).props.children,
-    );
-  }
-  return "";
-}
-
-export function slugify(text: string): string {
-  return text
-    .toLowerCase()
-    .trim()
-    .replace(/[^\w\s-]/g, "")
-    .replace(/\s+/g, "-")
-    .replace(/-+/g, "-");
-}

package/src/main.ts

@@ -0,0 +1,16 @@
+import { mount } from "svelte";
+import "./index.css";
+import App from "./App.svelte";
+import { hydrateFromInlineData } from "./stores/app.svelte";
+import { initSettings } from "./stores/settings.svelte";
+import { initShortcuts } from "./stores/shortcuts.svelte";
+
+const dataEl = document.getElementById("__readit");
+if (dataEl) {
+  const data = JSON.parse(dataEl.textContent ?? "{}");
+  hydrateFromInlineData(data);
+  initSettings(data.settings);
+  initShortcuts(data.settings?.keybindings ?? []);
+}
+
+mount(App, { target: document.getElementById("app")! });

package/src/schema.ts

@@ -17,19 +17,16 @@ export interface Comment {
   id: string;
   selectedText: string;
   comment: string;
-  createdAt: string;
+  createdAt?: string;
   startOffset: number;
   endOffset: number;
-  /** e.g. "L42" or "L42-L55" */
   lineHint?: string;
   anchorConfidence?: AnchorConfidence;
-  /** First N chars of original text for anchor matching when selectedText is truncated */
   anchorPrefix?: string;
 }
 
 export interface CommentFile {
   source: string;
-  /** SHA-256 prefix (16 chars) */
   hash: string;
   version: number;
   comments: Comment[];
@@ -53,7 +50,7 @@ export interface Selection extends SelectionRange {
 }
 
 export interface Document {
-  content: string;
+  html: string;
   filePath: string;
   fileName: string;
   clean: boolean;
@@ -79,3 +76,17 @@ export interface DocumentSettings {
   fontFamily: FontFamily;
   onboarded?: boolean;
 }
+
+export interface ShortcutBinding {
+  key: string;
+  alt?: boolean;
+  ctrl?: boolean;
+  meta?: boolean;
+  shift?: boolean;
+}
+
+export interface KeybindingOverride {
+  id: string;
+  binding?: ShortcutBinding;
+  enabled: boolean;
+}