sddflow 2.7.0__py3-none-any.whl

sdd/commands/cr.py

@@ -0,0 +1,257 @@
+from __future__ import annotations
+import re
+from pathlib import Path
+import click
+from rich.console import Console
+
+from sdd.utils.atlassian_auth import load_profile, build_session
+from sdd.utils.integrations import load_integrations
+from sdd.utils.jira_client import JiraClient
+from sdd.utils.confluence_client import ConfluenceClient
+from sdd.utils.md_to_cf import md_to_storage
+from sdd.utils.manifest import read_manifest
+
+console = Console()
+
+
+def _cr_path(feature: str, cr_id: str) -> Path:
+    return Path(".specify") / "features" / feature / "changesets" / f"{cr_id}.md"
+
+
+def _extract_cr_summary(text: str) -> str:
+    """Pull the one-line description from the CR record (§1 Change Description)."""
+    for line in text.splitlines():
+        line = line.strip()
+        if line and not line.startswith("#") and not line.startswith("|") and len(line) > 10:
+            return line[:120]
+    return "Change Request"
+
+
+@click.group()
+def cr_command():
+    """Change Request lifecycle — submit, check, status."""
+
+
+@cr_command.command("submit")
+@click.option("--cr",      required=True,
+              help="CR identifier, e.g. CR-001")
+@click.option("--profile", default=None)
+@click.option("--feature", default=None,
+              help="Feature name (default: from manifest.yml)")
+@click.option("--reviewer", default=None,
+              help="Jira accountId of the reviewer (overrides integrations.yml cr_reviewer)")
+@click.option("--dry-run", is_flag=True)
+def cr_submit(cr, profile, feature, reviewer, dry_run):
+    """Push a CR record to Confluence and create a Jira review task.
+
+    Run this automatically after /change saves the changeset record.
+    Stakeholders review and comment in Confluence; the Jira task tracks
+    formal approval exactly like sdd review submit does for spec docs.
+    """
+    cr_id = cr.upper()
+    console.print()
+    console.print("[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]")
+    label = f"  [bold cyan]CR Submit[/bold cyan] — {cr_id}"
+    if dry_run:
+        label += "  [yellow](dry run)[/yellow]"
+    console.print(label)
+    console.print("[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]")
+    console.print()
+
+    try:
+        cfg = load_integrations()
+    except FileNotFoundError as e:
+        console.print(f"  [red]✗  {e}[/red]")
+        raise SystemExit(1)
+
+    manifest     = read_manifest() or {}
+    proj         = manifest.get("project") or {}
+    project_name = proj.get("name", "Project")
+    feature_name = feature or proj.get("feature", "")
+
+    cr_file = _cr_path(feature_name, cr_id)
+    if not cr_file.exists():
+        console.print(f"  [red]✗  CR file not found: {cr_file}[/red]")
+        console.print("  Run /change first to generate the changeset record.")
+        raise SystemExit(1)
+
+    cr_text    = cr_file.read_text()
+    cr_summary = _extract_cr_summary(cr_text)
+    page_title = f"{project_name} — {cr_id}: {cr_summary}"[:200]
+
+    console.print(f"  CR file  : [cyan]{cr_file}[/cyan]")
+    console.print(f"  Title    : [cyan]{page_title}[/cyan]")
+
+    if dry_run:
+        console.print()
+        console.print("  [dim]would push to Confluence + create Jira review task[/dim]")
+        console.print()
+        return
+
+    try:
+        prof    = load_profile(profile or cfg.profile)
+        session = build_session(prof)
+    except Exception as e:
+        console.print(f"  [red]✗  Auth error: {e}[/red]")
+        raise SystemExit(1)
+
+    page_url = ""
+
+    # ── Push CR record to Confluence ─────────────────────────────────────────
+    if cfg.confluence:
+        cf_client = ConfluenceClient(session, prof.base_url)
+        body_html = md_to_storage(cr_text)
+        try:
+            page, created = cf_client.upsert_page(
+                cfg.confluence.space_key,
+                page_title,
+                body_html,
+                cfg.confluence.parent_page_id,
+            )
+            action   = "[green]created[/green]" if created else "[dim]updated[/dim]"
+            web_ui   = page.get("_links", {}).get("webui", "")
+            page_url = f"{prof.base_url}/wiki{web_ui}" if web_ui else ""
+            console.print(f"  {action}  Confluence: [cyan]{page_title}[/cyan]")
+            if page_url:
+                console.print(f"          [underline cyan]{page_url}[/underline cyan]")
+        except Exception as e:
+            console.print(f"  [yellow]⚠  Confluence error: {e} — continuing to Jira[/yellow]")
+    else:
+        console.print("  [dim]·[/dim]  Confluence not configured — skipping page push")
+
+    # ── Create / update Jira review task ─────────────────────────────────────
+    if cfg.jira:
+        jira_client      = JiraClient(session, prof.base_url)
+        idempotency_label = f"sdd-cr:{cr_id.lower()}"
+        existing          = jira_client.find_by_label(cfg.jira.project_key, idempotency_label)
+
+        reviewer_id = (
+            reviewer
+            or getattr(cfg, "cr_reviewer", None)
+        )
+
+        desc_text = (
+            f"Please review Change Request {cr_id}.\n\n"
+            f"Summary: {cr_summary}\n\n"
+            + (f"Confluence: {page_url}\n\n" if page_url else "")
+            + f"To APPROVE: set task to Done and comment 'Approved'.\n"
+            f"To REQUEST CHANGES: add comments and leave the task open."
+        )
+        fields: dict = {
+            "project":   {"key": cfg.jira.project_key},
+            "issuetype": {"name": cfg.jira.issue_hierarchy.get("task", "Task")},
+            "summary":   f"Review: {project_name} — {cr_id}",
+            "labels":    ["sdd-cr", idempotency_label],
+            "description": {
+                "type": "doc", "version": 1,
+                "content": [{"type": "paragraph", "content": [
+                    {"type": "text", "text": desc_text}
+                ]}],
+            },
+        }
+        if reviewer_id:
+            fields["assignee"] = {"accountId": reviewer_id}
+
+        try:
+            if existing:
+                jira_client.update_issue(existing["key"], fields)
+                task_key = existing["key"]
+                console.print(f"  [dim]·[/dim]   Jira task updated: [cyan]{task_key}[/cyan]")
+            else:
+                result   = jira_client.create_issue(fields)
+                task_key = result["key"]
+                console.print(f"  [green]✓[/green]  Jira task created: [cyan]{task_key}[/cyan]")
+        except Exception as e:
+            console.print(f"  [yellow]⚠  Jira error: {e}[/yellow]")
+    else:
+        console.print("  [dim]·[/dim]  Jira not configured — skipping review task")
+
+    console.print()
+    console.print("[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]")
+    console.print(f"  [bold green]{cr_id} submitted![/bold green]")
+    console.print("  Stakeholders can review and comment in Confluence.")
+    console.print("  Reviewer approves in Jira when ready.")
+    console.print(f"  Check status: [cyan]sdd cr check --cr {cr_id}[/cyan]")
+    console.print("[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]")
+    console.print()
+
+
+@cr_command.command("check")
+@click.option("--cr",      required=True)
+@click.option("--profile", default=None)
+def cr_check(cr, profile):
+    """Check approval status of a CR in Jira.
+    Exit codes: 0=approved 1=needs-revision 2=pending 3=not-submitted.
+    """
+    cr_id = cr.upper()
+    console.print()
+
+    try:
+        cfg     = load_integrations()
+        prof    = load_profile(profile or cfg.profile)
+        session = build_session(prof)
+    except Exception as e:
+        console.print(f"  [red]✗  {e}[/red]")
+        raise SystemExit(1)
+
+    if not cfg.jira:
+        console.print("  [red]✗  No jira: section in integrations.yml[/red]")
+        raise SystemExit(1)
+
+    client = JiraClient(session, prof.base_url)
+    issue  = client.find_by_label(cfg.jira.project_key, f"sdd-cr:{cr_id.lower()}")
+
+    if not issue:
+        console.print(f"  [dim]·  {cr_id} — NOT SUBMITTED[/dim]")
+        console.print(f"     Run [cyan]sdd cr submit --cr {cr_id}[/cyan] first.")
+        console.print()
+        raise SystemExit(3)
+
+    jira_status = issue.get("fields", {}).get("status", {}).get("name", "")
+    comments    = client.get_comments(issue["key"])
+
+    approved_statuses  = cfg.approved_statuses
+    approved_keywords  = cfg.approved_keywords
+
+    if jira_status in approved_statuses:
+        console.print(f"  [green]✓  {cr_id} — APPROVED[/green]  [dim](Jira status: {jira_status})[/dim]")
+        console.print()
+        raise SystemExit(0)
+
+    for c in comments:
+        body = c.get("body", "")
+        text = body if isinstance(body, str) else " ".join(
+            n.get("text", "") for n in _walk_adf(body)
+        )
+        if any(kw in text.lower() for kw in approved_keywords):
+            console.print(f"  [green]✓  {cr_id} — APPROVED[/green]  [dim](via comment keyword)[/dim]")
+            console.print()
+            raise SystemExit(0)
+
+    if comments:
+        console.print(f"  [yellow]✗  {cr_id} — NEEDS REVISION[/yellow]")
+        console.print()
+        console.print("  [bold]Review comments:[/bold]")
+        for c in comments:
+            author = (c.get("author") or {}).get("displayName", "?")
+            body   = c.get("body", "")
+            text   = body if isinstance(body, str) else " ".join(
+                n.get("text", "") for n in _walk_adf(body)
+            )
+            console.print(f"  [cyan]{author}[/cyan]: {text.strip()[:300]}")
+        console.print()
+        raise SystemExit(1)
+
+    console.print(f"  [dim]⏳  {cr_id} — PENDING[/dim]  Waiting for reviewer.")
+    console.print()
+    raise SystemExit(2)
+
+
+def _walk_adf(node: dict) -> list[dict]:
+    """Flatten ADF doc into text nodes."""
+    out: list[dict] = []
+    if node.get("type") == "text":
+        out.append(node)
+    for child in node.get("content", []):
+        out.extend(_walk_adf(child))
+    return out

sdd/commands/init.py

@@ -0,0 +1,279 @@
+from pathlib import Path
+import click
+import questionary
+from rich.console import Console
+
+from sdd.utils.detect import detect_project_type, PROJECT_TYPES
+from sdd.utils.validate import validate_name, assert_valid_name
+from sdd.utils.manifest import patch_manifest, MANIFEST_PATH, SDD_VERSION
+from sdd.utils.scaffold import (
+    recommended_pack, scaffold_pack,
+    PACK_DESCRIPTIONS, ALL_PACKS, TYPE_TO_PACK,
+)
+
+AI_TOOLS = [
+    questionary.Choice("Claude Code    — type /specify",                                value="claude-code"),
+    questionary.Choice("GitHub Copilot — type /specify",                                value="copilot"),
+    questionary.Choice("Cursor         — chat: Read and follow the prompt file",        value="cursor"),
+    questionary.Choice("Windsurf       — chat: Run specify",                            value="windsurf"),
+    questionary.Choice("Other / not sure",                                              value="other"),
+]
+
+_AI_TOOL_NEXT_STEP: dict[str, str] = {
+    "claude-code": "Open this folder in Claude Code and type:  [bold]/specify[/bold]",
+    "copilot":     "Open in VS Code with Copilot Chat and type:  [bold]/specify[/bold]",
+    "cursor":      "In Cursor chat, type:\n     [bold]Read and follow .github/prompts/specify.prompt.md exactly[/bold]",
+    "windsurf":    "In Windsurf chat, type:  [bold]Run specify[/bold]",
+    "other":       "Copy [cyan].github/prompts/specify.prompt.md[/cyan] and paste into your AI tool",
+}
+
+console = Console()
+
+_BANNER = f"""
+[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]
+  [bold cyan]SDD Framework[/bold cyan] [dim]v{SDD_VERSION}[/dim]
+[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]"""
+
+
+@click.command()
+@click.option("-p", "--project", "project_name", default=None, help="Project name")
+@click.option("-f", "--feature", "feature_name", default=None, help="First feature name")
+@click.option("-s", "--scope",   default=None,   help="pilot | mvp | full")
+@click.option("-t", "--type",    "project_type", default=None,
+              help="Project type (auto-detected if omitted)")
+@click.option("--pack",          default=None,
+              help=f"Pack to scaffold: {', '.join(ALL_PACKS)}")
+def init_command(project_name, feature_name, scope, project_type, pack):
+    """Initialize an SDD pack in the current project directory."""
+    console.print(_BANNER)
+
+    # ── Scaffold mode: no pack present yet ───────────────────────────────────
+    if not Path(MANIFEST_PATH).exists():
+        _scaffold_mode(project_type, pack)
+
+    # ── Fill mode: manifest.yml already exists ────────────────────────────────
+    # (also reached after scaffold_mode copies the pack)
+
+    # ── Project type (needed for manifest even in fill mode) ─────────────────
+    if not project_type:
+        console.print("[dim]  Detecting project type...[/dim] ", end="")
+        detected = detect_project_type(".")
+        if detected:
+            console.print(f"[green]{detected}[/green]")
+            confirmed = questionary.confirm(
+                f"  Use detected type '{detected}'?", default=True
+            ).ask()
+            project_type = detected if confirmed else None
+
+        if not project_type:
+            project_type = questionary.select(
+                "  Project type:",
+                choices=PROJECT_TYPES,
+            ).ask()
+
+    # ── Interactive prompts ───────────────────────────────────────────────────
+    if not project_name:
+        project_name = questionary.text(
+            "Project name:",
+            validate=lambda v: validate_name(v, "Project name") or True,
+        ).ask()
+
+    if not feature_name:
+        feature_name = questionary.text(
+            "First feature name:",
+            validate=lambda v: validate_name(v, "Feature name") or True,
+        ).ask()
+
+    if not scope:
+        scope = questionary.select(
+            "Scope:",
+            choices=[
+                questionary.Choice("pilot  — quick prototype, minimal docs", value="pilot"),
+                questionary.Choice("mvp    — production-ready (+ api-spec, data-model, LLD, ADR)", value="mvp"),
+                questionary.Choice("full   — enterprise (+ resilience, investigation, security-design)", value="full"),
+            ],
+        ).ask()
+
+    ai_tool = questionary.select(
+        "Which AI tool will you use?",
+        choices=AI_TOOLS,
+    ).ask()
+
+    # Validate CLI-supplied values (questionary validates interactive ones)
+    assert_valid_name(project_name, "Project name")
+    assert_valid_name(feature_name, "Feature name")
+
+    console.print()
+    console.print("  Setting up:")
+    console.print(f"  Project : [cyan]{project_name}[/cyan]")
+    console.print(f"  Type    : [cyan]{project_type}[/cyan]")
+    console.print(f"  Feature : [cyan]{feature_name}[/cyan]")
+    console.print(f"  Scope   : [cyan]{scope}[/cyan]")
+    console.print(f"  AI tool : [cyan]{ai_tool}[/cyan]")
+    console.print()
+
+    # ── Update manifest.yml via PyYAML (no string injection possible) ─────────
+    patch_manifest({
+        "project": {
+            "name":         project_name,
+            "scope":        scope,
+            "feature":      feature_name,
+            "context_file": f"{feature_name}.md",
+        },
+        "project_type": project_type,
+        "sdd_version":  SDD_VERSION,
+        "ai_tool":      ai_tool,
+    })
+    console.print(f"  [green]✓[/green]  {MANIFEST_PATH} filled")
+
+    # ── Create context file ───────────────────────────────────────────────────
+    context_path = Path(".specify") / "contexts" / f"{feature_name}.md"
+    context_path.parent.mkdir(parents=True, exist_ok=True)
+
+    if not context_path.exists():
+        context_path.write_text(_context_template(feature_name, project_name))
+        console.print(f"  [green]✓[/green]  {context_path} created")
+    else:
+        console.print(f"  [dim]·[/dim]  {context_path} already exists — skipped")
+
+    # ── Create feature output directory ──────────────────────────────────────
+    feature_dir = Path(".specify") / "features" / feature_name
+    feature_dir.mkdir(parents=True, exist_ok=True)
+    console.print(f"  [green]✓[/green]  {feature_dir}/ ready")
+
+    # ── Done ──────────────────────────────────────────────────────────────────
+    next_step = _AI_TOOL_NEXT_STEP.get(ai_tool, _AI_TOOL_NEXT_STEP["other"])
+    console.print()
+    console.print("[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]")
+    console.print(f"  [bold green]Setup complete![/bold green]  Next steps:")
+    console.print("[bold]━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━[/bold]")
+    console.print()
+    console.print(f"  1. Edit [cyan]{context_path}[/cyan]")
+    console.print("     Fill in: What it does, actors, key flows, tech stack, NFRs")
+    console.print("     (or run /create-context to build it interactively)")
+    console.print()
+    console.print(f"  2. {next_step}")
+    console.print()
+    console.print("  See QUICKSTART.md for the full walkthrough.")
+    console.print()
+
+
+def _scaffold_mode(project_type: str | None, pack_override: str | None) -> None:
+    """
+    No SDD pack found — detect project type, recommend a pack, copy it here.
+    Exits (raises SystemExit) only on error; on success the manifest will now
+    exist and init_command continues normally.
+    """
+    console.print("  [yellow]No SDD pack found in this directory.[/yellow]")
+    console.print()
+
+    # ── Detect or accept supplied project type ────────────────────────────────
+    if not project_type:
+        console.print("[dim]  Detecting project type...[/dim] ", end="")
+        project_type = detect_project_type(".")
+        if project_type:
+            console.print(f"[green]{project_type}[/green]")
+        else:
+            console.print("[yellow]not detected[/yellow]")
+
+    # ── Determine recommended pack ────────────────────────────────────────────
+    rec = pack_override or recommended_pack(project_type)
+
+    # ── Ask user which pack to scaffold ──────────────────────────────────────
+    console.print()
+
+    if pack_override:
+        chosen_pack = pack_override
+        console.print(f"  Pack: [cyan]{chosen_pack}[/cyan]  (from --pack flag)")
+    else:
+        choices = _build_pack_choices(project_type, rec)
+        chosen_pack = questionary.select(
+            "Which pack would you like to scaffold?",
+            choices=choices,
+        ).ask()
+
+        if chosen_pack == "__all__":
+            chosen_pack = questionary.select(
+                "Select pack:",
+                choices=[
+                    questionary.Choice(
+                        f"{p}  —  {PACK_DESCRIPTIONS[p]}",
+                        value=p,
+                    )
+                    for p in ALL_PACKS
+                ],
+            ).ask()
+
+    if not chosen_pack:
+        console.print("[red]Cancelled.[/red]")
+        raise SystemExit(1)
+
+    # ── Copy pack files ───────────────────────────────────────────────────────
+    console.print()
+    console.print(f"  Scaffolding [cyan]{chosen_pack}[/cyan]...")
+    try:
+        n = scaffold_pack(chosen_pack, dest=".")
+    except RuntimeError as e:
+        console.print(f"[red]✗  {e}[/red]")
+        raise SystemExit(1)
+
+    console.print(f"  [green]✓[/green]  {chosen_pack} scaffolded ({n} files copied)")
+    console.print()
+
+
+def _build_pack_choices(project_type: str | None, rec: str) -> list:
+    """Build the questionary choices list for pack selection."""
+    choices = []
+
+    if rec != "sdd-universal":
+        choices.append(questionary.Choice(
+            f"{rec}  ({PACK_DESCRIPTIONS[rec]})  ← recommended for {project_type}",
+            value=rec,
+        ))
+        choices.append(questionary.Choice(
+            f"sdd-universal  ({PACK_DESCRIPTIONS['sdd-universal']})",
+            value="sdd-universal",
+        ))
+    else:
+        label = f"for {project_type}" if project_type else "when type is unclear"
+        choices.append(questionary.Choice(
+            f"sdd-universal  ({PACK_DESCRIPTIONS['sdd-universal']})  ← recommended {label}",
+            value="sdd-universal",
+        ))
+
+    choices.append(questionary.Choice("Choose from all packs…", value="__all__"))
+    return choices
+
+
+def _context_template(feature_name: str, project_name: str) -> str:
+    return f"""# Context: {feature_name}
+# Project: {project_name}
+# Fill this file, then run /specify (or /create-context to build it interactively).
+
+## What This Does
+{{describe the feature in 2-3 sentences}}
+
+## Actors
+{{who triggers or benefits from this feature?}}
+
+## Key Flows
+{{describe 2-3 main user journeys}}
+
+## Integrations
+{{list any external systems, APIs, or databases}}
+
+## Business Rules
+{{any constraints, validation rules, or compliance requirements}}
+
+## Tech Stack
+{{language, framework, database, cache, CI/CD — fill what you know}}
+
+## Non-Functional Requirements
+{{performance targets, availability, security level}}
+
+## Out of Scope
+{{explicitly list what this feature does NOT cover}}
+
+## Open Questions
+{{anything unclear that needs a decision}}
+"""