shotgun-sh 0.4.0.dev1__py3-none-any.whl → 0.6.2__py3-none-any.whl

shotgun/tui/screens/onboarding.py

@@ -1,584 +0,0 @@
-"""Onboarding popup modal for first-time users."""
-
-import webbrowser
-
-from textual import on
-from textual.app import ComposeResult
-from textual.containers import Container, Horizontal, VerticalScroll
-from textual.events import Resize
-from textual.screen import ModalScreen
-from textual.widgets import Button, Markdown, Static
-
-from shotgun.tui.layout import COMPACT_HEIGHT_THRESHOLD, TINY_HEIGHT_THRESHOLD
-
-
-class OnboardingModal(ModalScreen[None]):
-    """Multi-page onboarding modal for new users.
-
-    This modal presents helpful resources and tips for using Shotgun across
-    multiple pages. Users can navigate between pages using Next/Back buttons.
-    """
-
-    CSS = """
-        OnboardingModal {
-            align: center middle;
-        }
-
-        #onboarding-container {
-            width: 95;
-            max-width: 100;
-            height: auto;
-            max-height: 90%;
-            border: thick $primary;
-            background: $surface;
-            padding: 2;
-        }
-
-        #progress-sidebar {
-            width: 26;
-            dock: left;
-            border-right: solid $primary;
-            padding: 1;
-            height: 100%;
-        }
-
-        #main-content {
-            width: 1fr;
-            height: auto;
-        }
-
-        #progress-header {
-            text-style: bold;
-            padding-bottom: 1;
-            color: $text-accent;
-        }
-
-        .progress-item {
-            padding: 1 0;
-        }
-
-        .progress-item-current {
-            color: $accent;
-            text-style: bold;
-        }
-
-        .progress-item-visited {
-            color: $success;
-        }
-
-        .progress-item-unvisited {
-            color: $text-muted;
-        }
-
-        #onboarding-header {
-            text-style: bold;
-            color: $text-accent;
-            padding-bottom: 1;
-            text-align: center;
-        }
-
-        #onboarding-content {
-            height: 1fr;
-            padding: 1 0;
-        }
-
-        #page-indicator {
-            text-align: center;
-            color: $text-muted;
-            padding: 1 0;
-        }
-
-        #buttons-container {
-            height: auto;
-            padding: 1 0 0 0;
-        }
-
-        #navigation-buttons {
-            width: 100%;
-            height: auto;
-            align: center middle;
-        }
-
-        .nav-button {
-            margin: 0 1;
-            min-width: 12;
-        }
-
-        #resource-sections {
-            padding: 1 0;
-            height: auto;
-        }
-
-        #resource-sections Button {
-            width: 100%;
-            margin: 0 0 2 0;
-        }
-
-        #video-section {
-            padding: 0;
-            margin: 0 0 1 0;
-        }
-
-        #docs-section {
-            padding: 0;
-            margin: 2 0 1 0;
-        }
-
-        /* Tiny screen fallback */
-        #tiny-screen-container {
-            display: none;
-            width: auto;
-            height: auto;
-            padding: 1 2;
-            background: $surface;
-            text-align: center;
-        }
-
-        #tiny-screen-message {
-            padding: 1 0;
-        }
-
-        #tiny-screen-link {
-            padding: 1 0;
-            color: $accent;
-        }
-
-        /* Compact styles for short terminals */
-        #onboarding-container.compact {
-            padding: 1;
-            max-height: 98%;
-        }
-
-        #progress-sidebar.compact {
-            padding: 0;
-        }
-
-        .progress-item.compact {
-            padding: 0;
-        }
-
-        #onboarding-header.compact {
-            padding-bottom: 0;
-        }
-
-        #onboarding-content.compact {
-            padding: 0;
-        }
-
-        #page-indicator.compact {
-            padding: 0;
-        }
-
-        #buttons-container.compact {
-            padding: 0;
-        }
-
-        #resource-sections.compact {
-            padding: 0;
-        }
-
-        #resource-sections.compact Button {
-            margin: 0 0 1 0;
-        }
-
-        #video-section.compact {
-            margin: 0;
-        }
-
-        #docs-section.compact {
-            margin: 1 0 0 0;
-        }
-
-        /* Tiny mode - hide full onboarding, show minimal message */
-        OnboardingModal.tiny #onboarding-container {
-            display: none;
-        }
-
-        OnboardingModal.tiny #tiny-screen-container {
-            display: block;
-        }
-    """
-
-    BINDINGS = [
-        ("escape", "dismiss", "Close"),
-        ("ctrl+c", "app.quit", "Quit"),
-    ]
-
-    def __init__(self) -> None:
-        """Initialize the onboarding modal."""
-        super().__init__()
-        self.current_page = 0
-        self.total_pages = 4
-        self.page_titles = [
-            "Getting Started",
-            "Discovering the 5 Modes",
-            "Prompting Better",
-            "Context Management!",
-        ]
-        # Track which pages have been visited (in memory only)
-        self.visited_pages: set[int] = {0}  # Start on page 0, so it's visited
-
-    def compose(self) -> ComposeResult:
-        """Compose the onboarding modal."""
-        # Tiny screen fallback - shown when terminal is too small
-        with Container(id="tiny-screen-container"):
-            yield Static(
-                "Your screen is too small for the onboarding wizard.",
-                id="tiny-screen-message",
-            )
-            yield Static(
-                "[@click=screen.open_usage_guide]View usage instructions[/]",
-                id="tiny-screen-link",
-                markup=True,
-            )
-            yield Button("Start Shotgunning", id="tiny-close-button")
-
-        # Full onboarding container
-        with Container(id="onboarding-container"):
-            # Left sidebar for progress tracking
-            with Container(id="progress-sidebar"):
-                yield Static("Progress", id="progress-header")
-                for i in range(self.total_pages):
-                    yield Static(
-                        f"{i + 1}. {self.page_titles[i]}",
-                        id=f"progress-item-{i}",
-                        classes="progress-item",
-                    )
-
-            # Main content area
-            with Container(id="main-content"):
-                yield Static("Welcome to Shotgun!", id="onboarding-header")
-                with VerticalScroll(id="onboarding-content"):
-                    yield Markdown(id="page-content")
-                    # Resource sections (only shown on page 1)
-                    with Container(id="resource-sections"):
-                        yield Markdown(
-                            "### 🎥 Video Demo\nWatch our demo video to see Shotgun in action",
-                            id="video-section",
-                        )
-                        yield Button(
-                            "▶️  Watch Demo Video",
-                            id="youtube-button",
-                            variant="success",
-                        )
-                        yield Markdown(
-                            "### 📖 Documentation\nRead the comprehensive usage guide for detailed instructions",
-                            id="docs-section",
-                        )
-                        yield Button(
-                            "📚 Read Usage Guide", id="usage-button", variant="primary"
-                        )
-                yield Static(id="page-indicator")
-                with Container(id="buttons-container"):
-                    with Horizontal(id="navigation-buttons"):
-                        yield Button("Back", id="back-button", classes="nav-button")
-                        yield Button(
-                            "Next",
-                            id="next-button",
-                            classes="nav-button",
-                            variant="primary",
-                        )
-                        yield Button("Close", id="close-button", classes="nav-button")
-
-    def on_mount(self) -> None:
-        """Set up the modal after mounting."""
-        self.update_page()
-        # Apply layout based on terminal height
-        self._apply_layout_for_height(self.app.size.height)
-
-    @on(Resize)
-    def handle_resize(self, event: Resize) -> None:
-        """Adjust layout based on terminal height."""
-        self._apply_layout_for_height(event.size.height)
-
-    def _apply_layout_for_height(self, height: int) -> None:
-        """Apply appropriate layout based on terminal height."""
-        if height < TINY_HEIGHT_THRESHOLD:
-            self.add_class("tiny")
-            self.remove_class("compact")
-        elif height < COMPACT_HEIGHT_THRESHOLD:
-            self.remove_class("tiny")
-            self._apply_compact_classes(True)
-        else:
-            self.remove_class("tiny")
-            self._apply_compact_classes(False)
-
-    def _apply_compact_classes(self, compact: bool) -> None:
-        """Apply or remove compact layout classes."""
-        container = self.query_one("#onboarding-container")
-        sidebar = self.query_one("#progress-sidebar")
-        header = self.query_one("#onboarding-header")
-        content = self.query_one("#onboarding-content")
-        page_indicator = self.query_one("#page-indicator")
-        buttons_container = self.query_one("#buttons-container")
-        resource_sections = self.query_one("#resource-sections")
-        progress_items = self.query(".progress-item")
-
-        if compact:
-            container.add_class("compact")
-            sidebar.add_class("compact")
-            header.add_class("compact")
-            content.add_class("compact")
-            page_indicator.add_class("compact")
-            buttons_container.add_class("compact")
-            resource_sections.add_class("compact")
-            for item in progress_items:
-                item.add_class("compact")
-        else:
-            container.remove_class("compact")
-            sidebar.remove_class("compact")
-            header.remove_class("compact")
-            content.remove_class("compact")
-            page_indicator.remove_class("compact")
-            buttons_container.remove_class("compact")
-            resource_sections.remove_class("compact")
-            for item in progress_items:
-                item.remove_class("compact")
-
-    def action_open_usage_guide(self) -> None:
-        """Open the usage guide in browser."""
-        webbrowser.open(
-            "https://github.com/shotgun-sh/shotgun?tab=readme-ov-file#-usage"
-        )
-
-    def update_page(self) -> None:
-        """Update the displayed page content and navigation buttons."""
-        # Mark current page as visited
-        self.visited_pages.add(self.current_page)
-
-        # Update page content
-        content_widget = self.query_one("#page-content", Markdown)
-        content_widget.update(self.get_page_content())
-
-        # Update page indicator
-        page_indicator = self.query_one("#page-indicator", Static)
-        page_indicator.update(f"Page {self.current_page + 1} of {self.total_pages}")
-
-        # Update progress sidebar
-        for i in range(self.total_pages):
-            progress_item = self.query_one(f"#progress-item-{i}", Static)
-            # Remove all progress classes first
-            progress_item.remove_class(
-                "progress-item-current",
-                "progress-item-visited",
-                "progress-item-unvisited",
-            )
-            # Add appropriate class
-            if i == self.current_page:
-                progress_item.add_class("progress-item-current")
-                progress_item.update(f"▶ {i + 1}. {self.page_titles[i]}")
-            elif i in self.visited_pages:
-                progress_item.add_class("progress-item-visited")
-                progress_item.update(f"✓ {i + 1}. {self.page_titles[i]}")
-            else:
-                progress_item.add_class("progress-item-unvisited")
-                progress_item.update(f"  {i + 1}. {self.page_titles[i]}")
-
-        # Show/hide resource sections (only on page 1)
-        resource_sections = self.query_one("#resource-sections", Container)
-        resource_sections.display = self.current_page == 0
-
-        # Update button visibility and states
-        back_button = self.query_one("#back-button", Button)
-        next_button = self.query_one("#next-button", Button)
-
-        # Update back button label and state
-        if self.current_page == 0:
-            back_button.disabled = True
-            back_button.label = "Back"
-        else:
-            back_button.disabled = False
-            prev_title = self.page_titles[self.current_page - 1]
-            back_button.label = f"← {prev_title}"
-
-        # Update next button label
-        if self.current_page == self.total_pages - 1:
-            next_button.label = "Finish"
-        else:
-            next_title = self.page_titles[self.current_page + 1]
-            next_button.label = f"{next_title} (Next →)"
-
-        # Focus the appropriate button
-        if self.current_page == 0:
-            next_button.focus()
-        else:
-            next_button.focus()
-
-        # Scroll content to top
-        self.query_one("#onboarding-content", VerticalScroll).scroll_home(animate=False)
-
-    def get_page_content(self) -> str:
-        """Get the content for the current page."""
-        if self.current_page == 0:
-            return self._page_1_resources()
-        elif self.current_page == 1:
-            return self._page_2_modes()
-        elif self.current_page == 2:
-            return self._page_3_prompts()
-        else:
-            return self._page_4_context_management()
-
-    def _page_1_resources(self) -> str:
-        """Page 1: Helpful resources."""
-        return """
-## Getting Started Resources
-
-Here are some helpful resources to get you up to speed with Shotgun:
-"""
-
-    def _page_2_modes(self) -> str:
-        """Page 2: Explanation of the Router and its modes."""
-        return """
-## Understanding Shotgun's Router
-
-Shotgun uses an intelligent **Router** that orchestrates your workflow automatically. Just describe what you need, and the Router will coordinate research, specifications, planning, and tasks for you.
-
-### Two Operating Modes
-
-The Router operates in two modes, which you can toggle with `Shift+Tab`:
-
-### 📋 Planning Mode (Default)
-- **Incremental execution**: Does one step at a time
-- **Asks clarifying questions** before complex tasks
-- **Shows plan for approval** before executing multi-step work
-- **Confirms before cascading** changes to dependent files
-
-Best for: Complex tasks, learning the workflow, staying in control
-
-### ✍️ Drafting Mode
-- **Auto-executes** plans without stopping for approval
-- **Makes reasonable assumptions** instead of asking questions
-- **Updates all dependent files** automatically
-
-Best for: Routine tasks, experienced users, speed-focused work
-
----
-
-### Files Created
-
-The Router manages these files in `.shotgun/`:
-- `research.md` - Research findings
-- `specification.md` - Detailed specifications
-- `plan.md` - Implementation plans
-- `tasks.md` - Actionable task lists
-- `exports/` - Documentation exports
-
----
-
-**Tip:** Press `Shift+Tab` to toggle between Planning and Drafting modes!
-"""
-
-    def _page_3_prompts(self) -> str:
-        """Page 3: Tips for better prompts."""
-        return """
-## Writing Better Prompts
-
-Here are some tips to get the best results from Shotgun:
-
-### 1. Ask for Research First
-Before jumping into a task, ask Shotgun to research the codebase or topic:
-
-> "Can you research how authentication works in this codebase?"
-
-### 2. Request Clarifying Questions
-Let Shotgun ask you questions to better understand your needs:
-
-> "I want to add user profiles. Please ask me clarifying questions before starting."
-
-### 3. Be Specific About Context
-Provide relevant context about what you're trying to accomplish:
-
-> "I'm working on the payment flow. I need to add support for refunds."
-
-### 4. Let the Router Guide You
-The Router will automatically coordinate the right workflow:
-- Describe what you want to accomplish
-- In Planning mode, it will ask clarifying questions first
-- In Drafting mode, it will execute immediately
-
----
-
-**Remember:** Shotgun works best when you give it context and let it ask questions!
-"""
-
-    def _page_4_context_management(self) -> str:
-        """Page 4: Context management and conversation controls."""
-        return """
-## Managing Conversation Context
-
-As conversations grow, you may need to manage the context sent to the AI model.
-
-### Clear Conversation
-Completely start over with a fresh conversation.
-
-**How to use:**
-- Open Command Palette: `Ctrl+P`
-- Type: "Clear Conversation"
-- Confirm the action
-
-**When to use:**
-- Starting a completely new task or project
-- When you want a clean slate
-- Context has become too cluttered
-
----
-
-### Compact Conversation
-Intelligently compress the conversation history while preserving important context.
-
-**How to use:**
-- Open Command Palette: `Ctrl+P`
-- Type: "Compact Conversation"
-- Shotgun will compress older messages automatically
-
-**When to use:**
-- Conversation is getting long but you want to keep context
-- Running into token limits
-- Want to reduce costs while maintaining continuity
-
-**What it does:**
-- Summarizes older messages
-- Keeps recent messages intact
-- Preserves key information and decisions
-
----
-
-**Tip:** Use `Ctrl+U` to view your current usage and see how much context you're using!
-"""
-
-    @on(Button.Pressed, "#back-button")
-    def handle_back(self) -> None:
-        """Handle back button press."""
-        if self.current_page > 0:
-            self.current_page -= 1
-            self.update_page()
-
-    @on(Button.Pressed, "#next-button")
-    def handle_next(self) -> None:
-        """Handle next/finish button press."""
-        if self.current_page < self.total_pages - 1:
-            self.current_page += 1
-            self.update_page()
-        else:
-            # On last page, finish closes the modal
-            self.dismiss()
-
-    @on(Button.Pressed, "#close-button")
-    @on(Button.Pressed, "#tiny-close-button")
-    def handle_close(self) -> None:
-        """Handle close button press."""
-        self.dismiss()
-
-    @on(Button.Pressed, "#youtube-button")
-    def handle_youtube(self) -> None:
-        """Open demo section in README."""
-        webbrowser.open(
-            "https://github.com/shotgun-sh/shotgun?tab=readme-ov-file#-demo"
-        )
-
-    @on(Button.Pressed, "#usage-button")
-    def handle_usage_guide(self) -> None:
-        """Open usage guide in browser."""
-        webbrowser.open(
-            "https://github.com/shotgun-sh/shotgun?tab=readme-ov-file#-usage"
-        )