chore: add ty

Author: Harshal6927

src/docs/ARCHITECTURE.md CONTRIBUTING.mdsrc/docs/ARCHITECTURE.md renamed to CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Litestar Start - Architecture Documentation
+# Litestar Start
 
 This document explains the architecture and design of `litestar-start`, a CLI tool for scaffolding Litestar projects.
 

Makefile

@@ -4,6 +4,7 @@ lint:
 	@echo "Running linters... 🔄"
 	pre-commit install
 	pre-commit run -a
+	ty check
 	@echo "Linters completed. ✅"
 
 release:

pyproject.toml

@@ -6,9 +6,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Topic :: Software Development :: Code Generators",
 ]
@@ -18,7 +15,7 @@ keywords = ["litestar", "scaffolding", "cli", "fullstack", "template", "generato
 license = "MIT"
 name = "litestar-start"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.13"
 version = "0.1.0a6"
 
 [project.scripts]
@@ -49,4 +46,4 @@ lint.ignore = [
 ]
 
 [dependency-groups]
-dev = ["pre-commit>=4.5.1", "ruff>=0.14.11"]
+dev = ["pre-commit>=4.5.1", "ruff>=0.14.11", "ty>=0.0.11"]

src/cli.py

@@ -1,6 +1,5 @@
 """Command-line interface for litestar-start."""
 
-import sys
 from pathlib import Path
 
 import questionary
@@ -28,6 +27,9 @@ def ask_project_name() -> str:
     Returns:
         The validated project name.
 
+    Raises:
+        SystemExit: If the user cancels the operation.
+
     """
     while True:
         name = questionary.text(
@@ -37,7 +39,7 @@ def ask_project_name() -> str:
 
         if name is None:  # User pressed Ctrl+C
             console.print("\n[yellow]Cancelled.[/yellow]")
-            sys.exit(0)
+            raise SystemExit(0)
 
         error = validate_project_name(name)
         if error:
@@ -53,6 +55,9 @@ def ask_framework() -> Framework:
     Returns:
         The selected framework.
 
+    Raises:
+        SystemExit: If the user cancels the operation.
+
     """
     choices = [
         questionary.Choice(title="Litestar", value=Framework.LITESTAR),
@@ -65,7 +70,7 @@ def ask_framework() -> Framework:
 
     if result is None:
         console.print("\n[yellow]Cancelled.[/yellow]")
-        sys.exit(0)
+        raise SystemExit(0)
 
     return result
 
@@ -76,6 +81,9 @@ def ask_database() -> Database:
     Returns:
         The selected database.
 
+    Raises:
+        SystemExit: If the user cancels the operation.
+
     """
     choices = [
         questionary.Choice(title="PostgreSQL", value=Database.POSTGRESQL),
@@ -91,7 +99,7 @@ def ask_database() -> Database:
 
     if result is None:
         console.print("\n[yellow]Cancelled.[/yellow]")
-        sys.exit(0)
+        raise SystemExit(0)
 
     return result
 
@@ -105,6 +113,9 @@ def ask_plugins(database: Database) -> list[Plugin]:
     Returns:
         A list of selected plugins.
 
+    Raises:
+        SystemExit: If the user cancels the operation.
+
     """
     choices = []
 
@@ -127,7 +138,7 @@ def ask_plugins(database: Database) -> list[Plugin]:
 
     if result is None:
         console.print("\n[yellow]Cancelled.[/yellow]")
-        sys.exit(0)
+        raise SystemExit(0)
 
     # Filter out None values
     return [p for p in result if p is not None]
@@ -139,6 +150,9 @@ def ask_docker() -> tuple[bool, bool]:
     Returns:
         A tuple of (generate_dockerfile, generate_docker_infra).
 
+    Raises:
+        SystemExit: If the user cancels the operation (e.g., presses Ctrl+C).
+
     """
     docker = questionary.confirm(
         "Generate Dockerfile for the application?",
@@ -147,7 +161,7 @@ def ask_docker() -> tuple[bool, bool]:
 
     if docker is None:
         console.print("\n[yellow]Cancelled.[/yellow]")
-        sys.exit(0)
+        raise SystemExit(0)
 
     docker_infra = questionary.confirm(
         "Generate docker-compose.infra.yml for local development (database, etc.)?",
@@ -156,13 +170,18 @@ def ask_docker() -> tuple[bool, bool]:
 
     if docker_infra is None:
         console.print("\n[yellow]Cancelled.[/yellow]")
-        sys.exit(0)
+        raise SystemExit(0)
 
     return docker, docker_infra
 
 
 def main() -> None:
-    """Run the main CLI interface."""
+    """Run the main CLI interface.
+
+    Raises:
+        SystemExit: If the user cancels the operation (e.g., presses Ctrl+C).
+
+    """
     print_banner()
 
     try:
@@ -202,7 +221,7 @@ def main() -> None:
         proceed = questionary.confirm("Generate project?", default=True).ask()
         if not proceed:
             console.print("[yellow]Cancelled.[/yellow]")
-            sys.exit(0)
+            raise SystemExit(0)
 
         # Generate project
         output_dir = Path.cwd() / config.slug
@@ -224,7 +243,7 @@ def main() -> None:
 
     except KeyboardInterrupt:
         console.print("\n[yellow]Cancelled.[/yellow]")
-        sys.exit(0)
+        return
 
 
 if __name__ == "__main__":

src/models.py

@@ -1,5 +1,7 @@
 """Data models for project configuration."""
 
+from __future__ import annotations
+
 from enum import StrEnum
 
 import msgspec
@@ -67,7 +69,7 @@ class DatabaseConfig(msgspec.Struct):
     docker_image: str | None = None
 
     @classmethod
-    def for_database(cls, db: Database) -> "DatabaseConfig | None":
+    def for_database(cls, db: Database) -> DatabaseConfig | None:
         """Get configuration for a specific database.
 
         Args:

tools/prepare_release.py

@@ -2,7 +2,6 @@
 """Prepare a new release by bumping version numbers."""
 
 import re
-import sys
 from enum import StrEnum
 from pathlib import Path
 
@@ -28,12 +27,16 @@ def get_current_version(pyproject_path: Path) -> str:
     Returns:
         Current version string.
 
+    Raises:
+        SystemExit: If version cannot be found in pyproject.toml.
+
     """
     content = pyproject_path.read_text(encoding="utf-8")
     match = re.search(r'version = "(\d+\.\d+\.\d+(?:[ab]\d+)?)"', content)
     if not match:
         console.print("[red]Could not find version in pyproject.toml[/red]")
-        sys.exit(1)
+        raise SystemExit(1)
+
     return match.group(1)
 
 
@@ -43,12 +46,15 @@ def bump_version(current_version: str, bump_type: BumpType) -> str:
     Returns:
         New version string.
 
+    Raises:
+        SystemExit: If the version format is invalid.
+
     """
     # Parse version with optional alpha/beta suffix
     base_match = re.match(r"(\d+)\.(\d+)\.(\d+)(?:([ab])(\d+))?", current_version)
     if not base_match:
         console.print(f"[red]Invalid version format: {current_version}[/red]")
-        sys.exit(1)
+        raise SystemExit(1)
 
     major = int(base_match.group(1))
     minor = int(base_match.group(2))
@@ -95,13 +101,18 @@ def update_file(path: Path, pattern: str, replacement: str) -> None:
 
 
 def main() -> None:
-    """Execute the release preparation process."""
+    """Execute the release preparation process.
+
+    Raises:
+        SystemExit: If pyproject.toml is not found or version cannot be determined.
+
+    """
     root_dir = Path(__file__).parent.parent
     pyproject_path = root_dir / "pyproject.toml"
 
     if not pyproject_path.exists():
         console.print("[red]Could not find pyproject.toml.[/red]")
-        sys.exit(1)
+        raise SystemExit(1)
 
     current_version = get_current_version(pyproject_path)
     console.print(f"Current version: [bold cyan]{current_version}[/bold cyan]")