shortcake 0.1.0__py3-none-any.whl

shortcake/__init__.py

@@ -0,0 +1,3 @@
+"""Shortcake CLI package."""
+
+__version__ = "0.1.0"

shortcake/cli.py

@@ -0,0 +1,266 @@
+"""CLI module for shortcake."""
+
+import re
+import subprocess
+import time
+
+import typer
+
+from shortcake import config
+
+app = typer.Typer(help="Shortcake CLI - A CLI built with typer and uv")
+
+
+@app.command()
+def version():
+    """Show the version."""
+    from shortcake import __version__
+
+    typer.echo(f"Shortcake version {__version__}")
+
+
+def _generate_branch_name(commit_message: str, keep_emoji: bool = False) -> str:
+    """Generate a branch name from a commit message.
+
+    Converts the commit message to lowercase, replaces spaces with hyphens,
+    and removes special characters. Optionally keeps emojis.
+
+    Args:
+        commit_message: The commit message to convert
+        keep_emoji: If True, keeps emojis in the branch name. Default is False.
+
+    Note: Future enhancement - support for gitmoji conventions
+    """
+    # Convert to lowercase and replace spaces with hyphens
+    branch_name = commit_message.lower().strip()
+    # Replace multiple spaces with single hyphen
+    branch_name = re.sub(r"\s+", "-", branch_name)
+
+    if keep_emoji:
+        # Keep emojis, alphanumeric (including unicode), and hyphens
+        # Comprehensive Unicode ranges for emojis:
+        # - \U0001F300-\U0001F9FF: Miscellaneous Symbols and Pictographs, Emoticons, etc.
+        # - \U0001F600-\U0001F64F: Emoticons
+        # - \U0001F680-\U0001F6FF: Transport and Map Symbols
+        # - \U00002600-\U000027BF: Miscellaneous Symbols
+        # - \U00002B00-\U00002BFF: Miscellaneous Symbols and Arrows (includes ⭐)
+        # - \U0001F1E0-\U0001F1FF: Regional Indicator Symbols (flags)
+        branch_name = re.sub(
+            r"[^\w\-\U0001F300-\U0001F9FF\U0001F600-\U0001F64F\U0001F680-\U0001F6FF\U00002600-\U000027BF\U00002B00-\U00002BFF\U0001F1E0-\U0001F1FF]",
+            "",
+            branch_name,
+        )
+    else:
+        # Remove special characters including emojis, keep hyphens and word chars (including unicode)
+        branch_name = re.sub(r"[^\w-]", "", branch_name)
+
+    # Collapse consecutive hyphens into a single hyphen
+    branch_name = re.sub(r"-+", "-", branch_name)
+
+    # Remove leading/trailing hyphens
+    branch_name = branch_name.strip("-")
+    # Limit length to 50 characters
+    branch_name = branch_name[:50].rstrip("-")
+
+    return branch_name
+
+
+@app.command()
+def create():
+    """Create a stack with a new branch and commit.
+
+    Stage your changes first with 'git add', then run this command.
+    Opens your configured editor to compose the commit message.
+    The branch name is automatically generated from the commit message.
+
+    Emoji handling in branch names is controlled by the keep_emoji configuration setting
+    (use 'shortcake config set keep_emoji true/false').
+
+    Note: Future enhancement will include gitmoji integration.
+    """
+    # Get keep_emoji setting from config
+    keep_emoji = config.get_keep_emoji()
+
+    # Get the original branch to restore on error
+    original_branch_result = subprocess.run(
+        ["git", "rev-parse", "--abbrev-ref", "HEAD"],
+        capture_output=True,
+        text=True,
+    )
+    original_branch = (
+        original_branch_result.stdout.strip() if original_branch_result.returncode == 0 else None
+    )
+
+    temp_branch_name = None
+
+    try:
+        # Create a temporary branch name using timestamp
+        temp_branch_name = f"temp-shortcake-{int(time.time() * 1000)}"
+
+        # Create and switch to temporary branch
+        subprocess.run(
+            ["git", "checkout", "-b", temp_branch_name],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+
+        # Create commit using git's normal flow (opens editor)
+        subprocess.run(["git", "commit"], check=True)
+
+        # Get the commit message that was just created
+        result = subprocess.run(
+            ["git", "log", "-1", "--pretty=%s"], capture_output=True, text=True, check=True
+        )
+        commit_message = result.stdout.strip()
+
+        if not commit_message:
+            typer.echo("Error: Commit message cannot be empty", err=True)
+            raise typer.Exit(1)
+
+        # Generate branch name from commit message
+        branch_name = _generate_branch_name(commit_message, keep_emoji=keep_emoji)
+
+        if not branch_name:
+            typer.echo(
+                "Error: Could not generate a valid branch name from the commit message", err=True
+            )
+            raise typer.Exit(1)
+
+        # Rename the temporary branch to the final name
+        subprocess.run(
+            ["git", "branch", "-m", temp_branch_name, branch_name],
+            capture_output=True,
+            text=True,
+            check=True,
+        )
+
+        typer.echo(f"Created and switched to branch: {branch_name}")
+        typer.echo(f"Created commit: {commit_message}")
+
+    except subprocess.CalledProcessError as e:
+        # Clean up: switch back to original branch and delete temp branch if it was created
+        if temp_branch_name and original_branch:
+            subprocess.run(
+                ["git", "checkout", original_branch],
+                capture_output=True,
+                text=True,
+            )
+            subprocess.run(
+                ["git", "branch", "-D", temp_branch_name],
+                capture_output=True,
+                text=True,
+            )
+
+        typer.echo(f"Error: {e.stderr.strip() if e.stderr else 'Command failed'}", err=True)
+        raise typer.Exit(1) from None
+
+
+@app.command()
+def edit():
+    """Edit the current stack by amending the commit.
+
+    Stage your changes first with 'git add', then run this command.
+    Amends the previous commit without opening an editor.
+    """
+    try:
+        # Check if there are staged changes
+        diff_result = subprocess.run(
+            ["git", "diff", "--cached", "--quiet"],
+            capture_output=True,
+            text=True,
+        )
+
+        # git diff --quiet returns 0 if no changes, 1 if there are changes
+        if diff_result.returncode == 0:
+            typer.echo("Error: No staged changes to amend. Use 'git add' first.", err=True)
+            raise typer.Exit(1)
+
+        # Amend the commit without opening editor (reuse previous message)
+        subprocess.run(
+            ["git", "commit", "--amend", "--no-edit"], capture_output=True, text=True, check=True
+        )
+        typer.echo("Successfully amended the commit")
+
+    except subprocess.CalledProcessError as e:
+        # Only catch errors from the actual commit command, not from diff check above
+        if "git commit" in str(e.cmd):
+            typer.echo("Error: Failed to amend commit", err=True)
+            raise typer.Exit(1) from None
+        raise
+
+
+# Create alias for edit command
+@app.command(name="modify")
+def modify():
+    """Alias for edit - Edit the current stack by amending the commit.
+
+    Stage your changes first with 'git add', then run this command.
+    Amends the previous commit without opening an editor.
+    """
+    edit()
+
+
+@app.command(name="config")
+def config_cmd(
+    action: str = typer.Argument(..., help="Action to perform: 'get', 'set', or 'list'"),
+    key: str = typer.Argument(None, help="Configuration key (e.g., 'keep_emoji')"),
+    value: str = typer.Argument(None, help="Configuration value (for 'set' action)"),
+):
+    """Manage shortcake configuration.
+
+    Examples:
+        shortcake config list - List all configuration settings
+        shortcake config get keep_emoji - Get a specific setting
+        shortcake config set keep_emoji true - Set a configuration value
+    """
+    if action == "list":
+        # List all configuration settings
+        cfg = config.load_config()
+        typer.echo("Current configuration:")
+        for field_name, field_value in cfg.model_dump().items():
+            typer.echo(f"  {field_name} = {field_value}")
+        typer.echo(f"\nConfiguration file: {config.get_config_path()}")
+
+    elif action == "get":
+        if not key:
+            typer.echo("Error: Key is required for 'get' action", err=True)
+            raise typer.Exit(1)
+
+        cfg = config.load_config()
+        cfg_dict = cfg.model_dump()
+        if key in cfg_dict:
+            typer.echo(f"{key} = {cfg_dict[key]}")
+        else:
+            typer.echo(f"Configuration key '{key}' not found")
+            typer.echo(f"Available keys: {', '.join(cfg_dict.keys())}")
+
+    elif action == "set":
+        if not key or value is None:
+            typer.echo("Error: Both key and value are required for 'set' action", err=True)
+            raise typer.Exit(1)
+
+        # Handle boolean values
+        if key == "keep_emoji":
+            if value.lower() in ("true", "1", "yes"):
+                config.set_keep_emoji(True)
+                typer.echo(f"Set {key} = true")
+            elif value.lower() in ("false", "0", "no"):
+                config.set_keep_emoji(False)
+                typer.echo(f"Set {key} = false")
+            else:
+                typer.echo(f"Error: Invalid value for {key}. Use 'true' or 'false'", err=True)
+                raise typer.Exit(1)
+        else:
+            typer.echo(f"Error: Unknown configuration key '{key}'", err=True)
+            cfg = config.load_config()
+            typer.echo(f"Available keys: {', '.join(cfg.model_dump().keys())}")
+            raise typer.Exit(1)
+
+    else:
+        typer.echo(f"Error: Unknown action '{action}'. Use 'list', 'get', or 'set'", err=True)
+        raise typer.Exit(1)
+
+
+if __name__ == "__main__":
+    app()

shortcake/config.py

@@ -0,0 +1,75 @@
+"""Configuration management for shortcake."""
+
+import os
+from pathlib import Path
+
+import rtoml
+from pydantic import BaseModel, Field
+
+
+class ShortcakeConfig(BaseModel):
+    """Configuration model for shortcake."""
+
+    keep_emoji: bool = Field(default=False, description="Whether to keep emojis in branch names")
+
+
+def get_config_path() -> Path:
+    """Get the path to the configuration file following XDG Base Directory spec."""
+    xdg_config_home = os.environ.get("XDG_CONFIG_HOME")
+
+    if xdg_config_home:
+        config_dir = Path(xdg_config_home) / "shortcake"
+    else:
+        config_dir = Path.home() / ".config" / "shortcake"
+
+    config_dir.mkdir(parents=True, exist_ok=True)
+    return config_dir / "config.toml"
+
+
+def load_config() -> ShortcakeConfig:
+    """Load configuration from the user's config file.
+
+    Returns:
+        ShortcakeConfig instance with configuration values.
+        Returns default config if file doesn't exist.
+    """
+    config_path = get_config_path()
+    if not config_path.exists():
+        return ShortcakeConfig()
+
+    try:
+        config_data = rtoml.load(config_path)
+        return ShortcakeConfig.model_validate(config_data)
+    except Exception:
+        return ShortcakeConfig()
+
+
+def save_config(config: ShortcakeConfig) -> None:
+    """Save configuration to the user's config file.
+
+    Args:
+        config: ShortcakeConfig instance containing configuration values to save.
+    """
+    config_path = get_config_path()
+    rtoml.dump(config.model_dump(), config_path, pretty=True)
+
+
+def get_keep_emoji() -> bool:
+    """Get the keep_emoji configuration value.
+
+    Returns:
+        True if emojis should be kept in branch names, False otherwise.
+    """
+    config = load_config()
+    return config.keep_emoji
+
+
+def set_keep_emoji(value: bool) -> None:
+    """Set the keep_emoji configuration value.
+
+    Args:
+        value: True to keep emojis in branch names, False to remove them.
+    """
+    config = load_config()
+    config.keep_emoji = value
+    save_config(config)

shortcake-0.1.0.dist-info/METADATA

@@ -0,0 +1,157 @@
+Metadata-Version: 2.4
+Name: shortcake
+Version: 0.1.0
+Summary: A CLI built with typer and uv
+License-File: LICENSE
+Requires-Python: >=3.14
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rtoml>=0.11.0
+Requires-Dist: typer>=0.9.0
+Description-Content-Type: text/markdown
+
+# shortcake
+
+A CLI application built with [typer](https://typer.tiangolo.com/) and [uv](https://docs.astral.sh/uv/), supporting only Python 3.14.
+
+## Requirements
+
+- Python 3.14+
+- uv package manager
+
+## Installation
+
+Install dependencies using uv:
+
+```bash
+uv sync
+```
+
+## Usage
+
+Run the CLI using uv:
+
+```bash
+# Show help
+uv run shortcake --help
+
+# Say hello with default greeting
+uv run shortcake hello
+
+# Say hello with custom name
+uv run shortcake hello --name "Patrick"
+
+# Show version
+uv run shortcake version
+```
+
+## Commands
+
+### `hello`
+Say hello to someone.
+
+Options:
+- `--name TEXT`: Name to greet (default: "World")
+
+### `version`
+Show the current version of shortcake.
+
+### `create`
+Create a stack with a new branch and commit.
+
+This command helps you create stacked PRs by:
+1. Creating a temporary branch
+2. Opening your configured editor ($EDITOR) to compose the commit message (emojis are fully supported! 🎉)
+3. Creating the commit
+4. Generating a branch name from the commit message (lowercase, hyphenated, alphanumeric only)
+5. Renaming the temporary branch to the final branch name
+
+**Important:** Stage your changes with `git add` before running this command. Only staged changes will be committed.
+
+**Emoji Support:**
+- Commit messages fully support emojis
+- Emoji handling in branch names is controlled by the `keep_emoji` configuration setting
+- Use `shortcake config set keep_emoji true` to preserve emojis in branch names
+- Use `shortcake config set keep_emoji false` to remove emojis from branch names (default)
+
+**Note:** Future enhancement will include gitmoji integration for conventional emoji commits.
+
+Example:
+```bash
+# Stage your changes first
+git add .
+
+# Basic usage (emojis removed from branch name by default)
+uv run shortcake create
+# Opens your editor to compose commit message
+# Type: 🚀 Add rocket feature
+# Save and close
+# Creates commit: 🚀 Add rocket feature
+# Creates branch: add-rocket-feature
+
+# Configure to keep emojis in branch names
+uv run shortcake config set keep_emoji true
+
+# Stage changes and create
+git add .
+uv run shortcake create
+# Opens your editor to compose commit message
+# Type: 🔥 Add fire feature
+# Save and close
+# Creates commit: 🔥 Add fire feature
+# Creates branch: 🔥-add-fire-feature
+```
+
+### `edit` / `modify`
+Edit the current stack by amending the commit.
+
+This command helps you modify the current stack by amending the previous commit without opening an editor.
+
+**Important:** Stage your changes with `git add` before running this command. Only staged changes will be amended.
+
+Example:
+```bash
+# Make some changes to your files
+echo "more content" >> file.txt
+
+# Stage your changes first
+git add .
+
+# Amend the previous commit
+uv run shortcake edit
+# Successfully amended the commit (reuses previous commit message)
+
+# Or use the modify alias
+uv run shortcake modify
+```
+
+### `config`
+Manage shortcake configuration settings.
+
+Configuration is stored in `~/.shortcake/config.json` in your home directory.
+
+Available settings:
+- `keep_emoji`: Whether to keep emojis in branch names (true/false, default: false)
+
+**Actions:**
+- `list` - List all configuration settings
+- `get <key>` - Get a specific configuration value
+- `set <key> <value>` - Set a configuration value
+
+Example:
+```bash
+# List all configuration
+uv run shortcake config list
+
+# Get a specific setting
+uv run shortcake config get keep_emoji
+
+# Set keep_emoji to true
+uv run shortcake config set keep_emoji true
+
+# Set keep_emoji to false
+uv run shortcake config set keep_emoji false
+```
+
+## Development
+
+This project uses uv for dependency management and requires Python 3.14 or higher.

shortcake-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+shortcake/__init__.py,sha256=wMhdtPPRECMOYHAZ24AQzxtFHHiJstljsPkwETWc-Kg,52
+shortcake/cli.py,sha256=aLd4TjBxEAB4vxjddyZJLClHLEmyDquh2AyCFUoepfQ,9424
+shortcake/config.py,sha256=xLM4XIYZBnOBM4lKswol7YV_wL09JKKw7EBl-WHjrPg,2027
+shortcake-0.1.0.dist-info/METADATA,sha256=G_tlZsqqybdRC6EsXmrdhuqt0VgopjlIXwfF25bmGNI,3913
+shortcake-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+shortcake-0.1.0.dist-info/entry_points.txt,sha256=t8Wxen9tlumoUnxmSYdyU-YTN7eSOf5czD7KyTvfzLQ,48
+shortcake-0.1.0.dist-info/licenses/LICENSE,sha256=oYA1Ia1s3TIvpFLy7uhdMlanjFx4Mn-MErxK0rQk5lY,1072
+shortcake-0.1.0.dist-info/RECORD,,

shortcake-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

shortcake-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+shortcake = shortcake.cli:app

shortcake-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Patrick Arminio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.