Source code for dartwork_mpl.install

"""Installation utilities for IDE integration and LLM assistants.

This module provides functions for automatically installing or removing
the dartwork-mpl usage guide in various IDE environments (e.g., Cursor)
and AI coding assistants (e.g., Claude Code).
"""

from pathlib import Path

__all__ = ["install_llm_txt", "uninstall_llm_txt"]




def install_llm_txt(project_dir: str | Path | None = None) -> None:
    """Install the dartwork-mpl usage guide into project IDE integration folders.

    Copies the usage guide to the following paths so that various AI coding
    assistants can discover library context:
    - ``.claude/commands/`` (for Claude Code)
    - ``.cursor/`` (for Cursor IDE)

    Parameters
    ----------
    project_dir : str | Path | None, optional
        Target project directory. If None, the current working directory
        is used. Default is None.

    Raises
    ------
    FileNotFoundError
        If the USAGE_GUIDE.md file cannot be found in the package assets.
    """
    # Get the usage guide path from the asset folder
    usage_guide_path: Path = Path(__file__).parent / "asset" / "USAGE_GUIDE.md"

    if not usage_guide_path.exists():
        raise FileNotFoundError(f"Usage guide not found at: {usage_guide_path}")

    # Get project directory (current working directory if not specified)
    if project_dir is None:
        project_dir_obj: Path = Path.cwd()
    else:
        project_dir_obj = Path(project_dir)

    # Install for Claude Code
    claude_dir: Path = project_dir_obj / ".claude" / "commands"
    claude_dir.mkdir(parents=True, exist_ok=True)
    claude_file: Path = claude_dir / "dartwork-mpl-usage.md"

    # Install for Cursor IDE
    cursor_dir: Path = project_dir_obj / ".cursor"
    cursor_dir.mkdir(parents=True, exist_ok=True)
    cursor_file: Path = cursor_dir / "dartwork-mpl-usage.md"

    # Read the original usage guide
    with open(usage_guide_path, encoding="utf-8") as f:
        content: str = f.read()

    # Create Claude Code version with command prefix
    claude_content: str = f"""# dartwork-mpl Library Usage Command

This command provides comprehensive usage guide for the dartwork-mpl library.

## Usage
Type `/dartwork-mpl` to get help with dartwork-mpl library usage.

---

{content}
"""

    # Create Cursor IDE version with instruction format
    cursor_content: str = f"""// Cursor IDE Instructions for dartwork-mpl library
// This file provides context about dartwork-mpl library usage

{content}
"""

    # Write files
    with open(claude_file, "w", encoding="utf-8") as f:
        f.write(claude_content)

    with open(cursor_file, "w", encoding="utf-8") as f:
        f.write(cursor_content)

    print("✅ dartwork-mpl usage guide installed successfully!")
    print(f"📁 Project: {project_dir_obj}")
    print(f"📁 Claude Code: {claude_file}")
    print(f"📁 Cursor IDE: {cursor_file}")
    print()
    print("🔧 Usage:")
    print("- In Claude Code: Type '/dartwork-mpl' for help")
    print(
        "- In Cursor IDE: The AI will automatically"
        " have access to dartwork-mpl context"
    )





def uninstall_llm_txt(project_dir: str | Path | None = None) -> None:
    """Remove the dartwork-mpl usage guide from project IDE integration folders.

    Parameters
    ----------
    project_dir : str | Path | None, optional
        Target project directory. If None, the current working directory
        is used. Default is None.
    """
    # Get project directory (current working directory if not specified)
    if project_dir is None:
        project_dir_obj: Path = Path.cwd()
    else:
        project_dir_obj = Path(project_dir)

    # Files to remove
    files_to_remove: list[Path] = [
        project_dir_obj / ".claude" / "commands" / "dartwork-mpl-usage.md",
        project_dir_obj / ".cursor" / "dartwork-mpl-usage.md",
    ]

    removed_files: list[Path] = []
    for file_path in files_to_remove:
        if file_path.exists():
            file_path.unlink()
            removed_files.append(file_path)

    if removed_files:
        print("✅ dartwork-mpl usage guide uninstalled successfully!")
        for file_path in removed_files:
            print(f"🗑️  Removed: {file_path}")
    else:
        print("ℹ️  No dartwork-mpl usage guides found to remove.")



if __name__ == "__main__":
    install_llm_txt()