empathy-framework 5.2.1__py3-none-any.whl → 5.4.0__py3-none-any.whl

empathy_os/workflows/keyboard_shortcuts/prompts.py

@@ -1,295 +0,0 @@
-"""XML-Enhanced Prompts for Keyboard Shortcut Generation.
-
-These prompts follow the Keyboard Conductor design principles:
-- Musical scale pattern (Scale 1: Daily, Scale 2: Frequent, Scale 3: Advanced)
-- Ergonomic optimization (left-hand home row preference)
-- Mnemonic quality (letter matches, memorable phrases)
-"""
-
-# Stage 1: Feature Analysis Prompt
-ANALYZE_FEATURES_PROMPT = """
-<prompt name="analyze_features" tier="capable">
-  <system>
-    You are a UX expert specializing in keyboard ergonomics and mnemonic design.
-    Your goal is to analyze project features and recommend optimal keyboard shortcuts
-    following the "Keyboard Conductor" musical scale pattern.
-
-    Design Principles:
-    - Scale 1 (Daily): 4 most-used features on home row
-    - Scale 2 (Frequent): Next 4 features on adjacent keys
-    - Scale 3 (Advanced): Remaining features logically placed
-    - Left-hand priority for primary actions
-    - Memorable mnemonics (letter matches like M=Morning, S=Ship)
-  </system>
-
-  <context>
-    <project_name>{project_name}</project_name>
-    <project_type>{project_type}</project_type>
-    <total_features>{feature_count}</total_features>
-    <target_layouts>qwerty, dvorak, colemak</target_layouts>
-  </context>
-
-  <input>
-    <features format="yaml">
-{features_yaml}
-    </features>
-  </input>
-
-  <task>
-    Analyze these features and provide:
-
-    1. **Frequency Classification**: Categorize each feature as:
-       - daily: Used multiple times per day (4 features max)
-       - frequent: Used regularly but not constantly (4 features)
-       - advanced: Used occasionally or for power users (remaining)
-
-    2. **Groupings**: Identify natural feature groups (4-6 max):
-       - Quick Actions (morning routines, ship checks)
-       - Workflows (code review, testing)
-       - Views (dashboard, costs)
-       - Analysis (security, bugs, health)
-
-    3. **Mnemonic Suggestions**: For each feature, suggest:
-       - Primary letter (first letter match if available)
-       - Alternative letter (if conflict)
-       - Mnemonic phrase (e.g., "M = Morning briefing")
-
-    4. **Conflict Detection**: Flag features that:
-       - Have same first letter
-       - Should share modifier patterns
-       - Might conflict with OS/IDE shortcuts
-  </task>
-
-  <output format="yaml">
-    Return a YAML document with this structure:
-
-    analyzed_features:
-      - id: "morning"
-        frequency: "daily"
-        primary_letter: "m"
-        alt_letter: null
-        mnemonic: "M = Morning briefing"
-        group: "Quick Actions"
-
-    suggested_groups:
-      - name: "Quick Actions"
-        icon: "$(zap)"
-        features: ["morning", "ship", "fix", "dashboard"]
-
-    conflict_warnings:
-      - type: "letter_conflict"
-        features: ["review", "refactor"]
-        message: "Both start with 'r' - suggest using 'r' for review, 'f' for refactor"
-
-    phrase_mnemonic: "My Ship Floats Daily"
-  </output>
-</prompt>
-"""
-
-# Stage 2: Shortcut Generation Prompt
-GENERATE_SHORTCUTS_PROMPT = """
-<prompt name="generate_shortcuts" tier="capable">
-  <system>
-    You are a keyboard layout specialist. Generate ergonomic keyboard shortcuts
-    following the "Keyboard Conductor" musical scale pattern.
-
-    The goal is to create shortcuts that:
-    1. Are physically comfortable (minimize finger travel)
-    2. Are memorable (use meaningful letter associations)
-    3. Progress naturally (learn 4 keys, then 4 more, then rest)
-    4. Work across keyboard layouts (QWERTY, Dvorak, Colemak)
-  </system>
-
-  <constraints>
-    <physical_layout>
-      - Prioritize left-hand home row for Scale 1 (daily) actions
-      - Use adjacent keys for related actions
-      - Avoid awkward stretches or pinky overuse
-      - Reserve right hand for less frequent actions
-    </physical_layout>
-
-    <mnemonic_quality>
-      - Prefer direct letter matches (M=Morning, S=Ship, F=Fix)
-      - Use sound-alikes when letters conflict (B=Bugs, not P=Predict)
-      - Create memorable phrases for groups ("My Ship Floats Daily")
-      - Consider keyboard position for alternatives (adjacent keys)
-    </mnemonic_quality>
-
-    <layout_adaptation>
-      QWERTY home row: A-S-D-F (left), J-K-L-; (right)
-      Dvorak home row: A-O-E-U (left), H-T-N-S (right)
-      Colemak home row: A-R-S-T (left), N-E-I-O (right)
-
-      For Dvorak/Colemak, adapt mnemonics:
-      - Dvorak: "AOEU - vowels for daily actions"
-      - Colemak: "ARST - your daily rhythm"
-    </layout_adaptation>
-  </constraints>
-
-  <input>
-    <analyzed_features>{analyzed_yaml}</analyzed_features>
-    <existing_shortcuts>{existing_shortcuts}</existing_shortcuts>
-    <reserved_keys>{reserved_keys}</reserved_keys>
-  </input>
-
-  <output format="json">
-    Generate shortcuts for each layout. Return JSON with this structure:
-
-    {{
-      "qwerty": {{
-        "shortcuts": [
-          {{
-            "feature_id": "morning",
-            "key": "m",
-            "mnemonic": "M = Morning",
-            "hand": "left",
-            "finger": "index",
-            "row": "home"
-          }}
-        ],
-        "scale_assignments": {{
-          "daily": ["m", "s", "f", "d"],
-          "frequent": ["w", "r", "t", "c"],
-          "advanced": ["h", "b", "a", "g", "l", "v", "p", "z"]
-        }},
-        "phrase_mnemonic": "My Ship Floats Daily, With Really Tested Code"
-      }},
-      "dvorak": {{
-        "shortcuts": [...],
-        "scale_assignments": {{
-          "daily": ["a", "o", "e", "u"],
-          "frequent": ["i", "h", "t", "n"],
-          "advanced": [...]
-        }},
-        "phrase_mnemonic": "AOEU - vowels for daily actions"
-      }},
-      "colemak": {{
-        "shortcuts": [...],
-        "scale_assignments": {{
-          "daily": ["a", "r", "s", "t"],
-          "frequent": ["g", "n", "e", "i"],
-          "advanced": [...]
-        }},
-        "phrase_mnemonic": "ARST - your daily rhythm"
-      }}
-    }}
-  </output>
-</prompt>
-"""
-
-# Stage 3: Conflict Validation Prompt
-VALIDATE_SHORTCUTS_PROMPT = """
-<prompt name="validate_shortcuts" tier="cheap">
-  <system>
-    Validate generated keyboard shortcuts for conflicts and ergonomic issues.
-    Your role is to ensure the shortcuts are safe, comfortable, and memorable.
-  </system>
-
-  <input>
-    <generated_shortcuts>{shortcuts_json}</generated_shortcuts>
-
-    <platform_reserved>
-      macOS: Cmd+Q (quit), Cmd+W (close), Cmd+H (hide), Cmd+M (minimize)
-      Windows: Ctrl+W (close), Ctrl+Q (quit in some apps)
-      Linux: Similar to Windows
-
-      IDE (VSCode): Ctrl+S (save), Ctrl+Z (undo), Ctrl+N (new), Ctrl+O (open)
-    </platform_reserved>
-  </input>
-
-  <checks>
-    Verify each of these conditions:
-
-    1. **No Duplicates**: Each key is used only once per layout
-
-    2. **No OS Conflicts**: Shortcuts don't override critical OS shortcuts
-       (after the Ctrl+Shift+E prefix, check the final key)
-
-    3. **No IDE Conflicts**: Don't conflict with common VSCode shortcuts
-
-    4. **Balanced Fingers**: No single finger used more than 4 times
-       (distribute across fingers evenly)
-
-    5. **No Awkward Combos**: Avoid:
-       - Keys requiring hand crossing
-       - Pinky + ring finger stretches
-       - Consecutive same-finger keys
-
-    6. **Mnemonic Quality**: Each shortcut has a clear, memorable association
-
-    7. **Progressive Learning**: Scale 1 keys are easier to reach than Scale 3
-  </checks>
-
-  <output format="json">
-    Return validation results:
-
-    {{
-      "valid": true,
-      "conflicts": [
-        {{
-          "type": "duplicate",
-          "key": "r",
-          "features": ["review", "refactor"],
-          "severity": "error"
-        }}
-      ],
-      "warnings": [
-        {{
-          "type": "ergonomic",
-          "key": "q",
-          "message": "Pinky stretch - consider moving to Scale 3",
-          "severity": "warning"
-        }}
-      ],
-      "suggestions": [
-        {{
-          "feature": "refactor",
-          "current_key": "r",
-          "suggested_key": "x",
-          "reason": "Conflicts with 'review', 'x' is available and adjacent"
-        }}
-      ],
-      "finger_distribution": {{
-        "pinky": 2,
-        "ring": 3,
-        "middle": 4,
-        "index": 5
-      }},
-      "mnemonic_quality_score": 0.85
-    }}
-  </output>
-</prompt>
-"""
-
-
-def format_analyze_prompt(
-    project_name: str,
-    project_type: str,
-    feature_count: int,
-    features_yaml: str,
-) -> str:
-    """Format the feature analysis prompt with provided data."""
-    return ANALYZE_FEATURES_PROMPT.format(
-        project_name=project_name,
-        project_type=project_type,
-        feature_count=feature_count,
-        features_yaml=features_yaml,
-    )
-
-
-def format_generate_prompt(
-    analyzed_yaml: str,
-    existing_shortcuts: str = "[]",
-    reserved_keys: str = "[]",
-) -> str:
-    """Format the shortcut generation prompt with provided data."""
-    return GENERATE_SHORTCUTS_PROMPT.format(
-        analyzed_yaml=analyzed_yaml,
-        existing_shortcuts=existing_shortcuts,
-        reserved_keys=reserved_keys,
-    )
-
-
-def format_validate_prompt(shortcuts_json: str) -> str:
-    """Format the validation prompt with provided data."""
-    return VALIDATE_SHORTCUTS_PROMPT.format(shortcuts_json=shortcuts_json)

empathy_os/workflows/keyboard_shortcuts/schema.py

@@ -1,193 +0,0 @@
-"""Schema definitions for keyboard shortcut generation.
-
-Uses Pydantic models for validation and serialization.
-"""
-
-from dataclasses import dataclass, field
-from enum import Enum
-from typing import Literal
-
-
-class FrequencyTier(str, Enum):
-    """Usage frequency tiers for feature prioritization."""
-
-    DAILY = "daily"  # Scale 1: 4 most-used features
-    FREQUENT = "frequent"  # Scale 2: Next 4 features
-    ADVANCED = "advanced"  # Scale 3: Remaining features
-
-
-class KeyboardLayout(str, Enum):
-    """Supported keyboard layouts."""
-
-    QWERTY = "qwerty"
-    DVORAK = "dvorak"
-    COLEMAK = "colemak"
-
-
-class HandPosition(str, Enum):
-    """Which hand operates the key."""
-
-    LEFT = "left"
-    RIGHT = "right"
-
-
-class FingerPosition(str, Enum):
-    """Which finger operates the key."""
-
-    PINKY = "pinky"
-    RING = "ring"
-    MIDDLE = "middle"
-    INDEX = "index"
-    THUMB = "thumb"
-
-
-class RowPosition(str, Enum):
-    """Keyboard row position."""
-
-    TOP = "top"  # QWERTY row
-    HOME = "home"  # ASDF row
-    BOTTOM = "bottom"  # ZXCV row
-
-
-@dataclass
-class Feature:
-    """A single feature that needs a keyboard shortcut."""
-
-    id: str  # Unique identifier (e.g., "morning", "ship")
-    name: str  # Human-readable name (e.g., "Morning Briefing")
-    description: str = ""
-    command: str = ""  # VSCode command or CLI command
-    cli_alias: str = ""  # CLI equivalent (e.g., "empathy morning")
-    frequency: FrequencyTier = FrequencyTier.FREQUENT
-    context: Literal["global", "editor", "explorer"] = "global"
-    icon: str = "$(symbol-misc)"
-
-
-@dataclass
-class Category:
-    """A group of related features."""
-
-    name: str
-    icon: str = "$(folder)"
-    tier: FrequencyTier = FrequencyTier.FREQUENT
-    features: list[Feature] = field(default_factory=list)
-
-
-@dataclass
-class LayoutConfig:
-    """Configuration for a specific keyboard layout."""
-
-    layout: KeyboardLayout
-    home_row: list[str] = field(default_factory=list)
-    mnemonic_base: str = ""
-
-    def __post_init__(self):
-        if not self.home_row:
-            if self.layout == KeyboardLayout.QWERTY:
-                self.home_row = ["a", "s", "d", "f"]
-                self.mnemonic_base = "natural English letters"
-            elif self.layout == KeyboardLayout.DVORAK:
-                self.home_row = ["a", "o", "e", "u"]
-                self.mnemonic_base = "vowel-centric patterns"
-            elif self.layout == KeyboardLayout.COLEMAK:
-                self.home_row = ["a", "r", "s", "t"]
-                self.mnemonic_base = "ARST patterns"
-
-
-@dataclass
-class ShortcutAssignment:
-    """A keyboard shortcut assignment for a feature."""
-
-    feature_id: str
-    key: str  # Single letter key (e.g., "m", "s")
-    mnemonic: str  # Memory aid (e.g., "M = Morning")
-    hand: HandPosition = HandPosition.LEFT
-    finger: FingerPosition = FingerPosition.INDEX
-    row: RowPosition = RowPosition.HOME
-    layout: KeyboardLayout = KeyboardLayout.QWERTY
-
-
-@dataclass
-class ScaleAssignments:
-    """Shortcut assignments organized by scale (learning progression)."""
-
-    daily: list[str] = field(default_factory=list)  # Scale 1: 4 keys
-    frequent: list[str] = field(default_factory=list)  # Scale 2: 4 keys
-    advanced: list[str] = field(default_factory=list)  # Scale 3: remaining
-
-
-@dataclass
-class LayoutShortcuts:
-    """Complete shortcut set for a specific layout."""
-
-    layout: KeyboardLayout
-    shortcuts: list[ShortcutAssignment] = field(default_factory=list)
-    scale_assignments: ScaleAssignments = field(default_factory=ScaleAssignments)
-    phrase_mnemonic: str = ""  # e.g., "My Ship Floats Daily"
-
-
-@dataclass
-class FeatureManifest:
-    """Complete manifest for keyboard shortcut generation."""
-
-    project_name: str
-    project_type: Literal["vscode-extension", "python-cli", "custom"] = "custom"
-    prefix: str = "ctrl+shift+e"  # Base chord
-    categories: list[Category] = field(default_factory=list)
-    layouts: list[LayoutConfig] = field(default_factory=list)
-
-    def __post_init__(self):
-        if not self.layouts:
-            self.layouts = [
-                LayoutConfig(layout=KeyboardLayout.QWERTY),
-                LayoutConfig(layout=KeyboardLayout.DVORAK),
-                LayoutConfig(layout=KeyboardLayout.COLEMAK),
-            ]
-
-    def all_features(self) -> list[Feature]:
-        """Get all features across all categories."""
-        features = []
-        for category in self.categories:
-            features.extend(category.features)
-        return features
-
-    def features_by_tier(self, tier: FrequencyTier) -> list[Feature]:
-        """Get features filtered by frequency tier."""
-        return [f for f in self.all_features() if f.frequency == tier]
-
-
-@dataclass
-class GeneratedShortcuts:
-    """Complete output from keyboard shortcut generation."""
-
-    manifest: FeatureManifest
-    layouts: dict[KeyboardLayout, LayoutShortcuts] = field(default_factory=dict)
-    validation_passed: bool = True
-    conflicts: list[str] = field(default_factory=list)
-    warnings: list[str] = field(default_factory=list)
-
-
-# Keyboard layout reference data
-KEYBOARD_LAYOUTS = {
-    KeyboardLayout.QWERTY: {
-        "top_row": list("qwertyuiop"),
-        "home_row": list("asdfghjkl"),
-        "bottom_row": list("zxcvbnm"),
-    },
-    KeyboardLayout.DVORAK: {
-        "top_row": list("',.pyfgcrl"),
-        "home_row": list("aoeuidhtns"),
-        "bottom_row": list(";qjkxbmwvz"),
-    },
-    KeyboardLayout.COLEMAK: {
-        "top_row": list("qwfpgjluy;"),
-        "home_row": list("arstdhneio"),
-        "bottom_row": list("zxcvbkm,."),
-    },
-}
-
-# Reserved keys that should not be used (conflicts with OS/IDE)
-RESERVED_KEYS = {
-    "global": ["q", "w", "e", "x"],  # Commonly used by OS
-    "ide": ["n", "o", "s", "z"],  # Commonly used by IDE (new, open, save, undo)
-}