feat: Added VS Code debug launch configurations (#1)

vanolucas · web-flow · commit 46d83147c46c · 2025-02-19T23:23:49.000+01:00
* fix(api): unnecessary default type arguments (Ruff UP043)

* feat: added VS Code launch configurations for FastAPI and pytest

* feat: added VS Code debug launch configuration for Typer CLI
diff --git a/.gitignore b/.gitignore
@@ -63,7 +63,7 @@ dist/
 .terraform/
 
 # VS Code
-.vscode/
+.vscode/*
 
 # Default template
 my-project/
diff --git a/template/.gitignore b/template/.gitignore
@@ -62,5 +62,6 @@ dist/
 # Terraform
 .terraform/
 
-# VS Code
-.vscode/
+# VS Code (but still include launch configurations)
+.vscode/*
+!/.vscode/launch.json*
diff --git a/template/.vscode/launch.json.jinja b/template/.vscode/launch.json.jinja
@@ -0,0 +1,41 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {%- if with_fastapi_api %}
+        {
+            "name": "API [debug]",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uvicorn",
+            "args": [
+                "{{ project_name_snake_case }}.api:app",
+                "--reload"
+            ],
+            "jinja": true,
+            "justMyCode": true,
+            "console": "integratedTerminal"
+        },
+        {%- endif %}
+        {%- if with_typer_cli %}
+        {
+            "name": "CLI [debug]",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}//src//{{ project_name_snake_case }}//cli.py",
+            "args": [
+                "--name",
+                "Someone"
+            ],
+            "justMyCode": true,
+            "console": "integratedTerminal"
+        },
+        {%- endif %}
+        {
+            "name": "Python file [debug]",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        }
+    ]
+}
diff --git a/template/src/{{ project_name_snake_case }}/{% if with_fastapi_api %}api.py{% endif %}.jinja b/template/src/{{ project_name_snake_case }}/{% if with_fastapi_api %}api.py{% endif %}.jinja
@@ -9,7 +9,7 @@ from fastapi import FastAPI
 
 
 @asynccontextmanager
-async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
+async def lifespan(app: FastAPI) -> AsyncGenerator[None]:
     """Handle FastAPI startup and shutdown events."""
     # Startup events.
     for handler in logging.root.handlers:
diff --git a/template/src/{{ project_name_snake_case }}/{% if with_typer_cli %}cli.py{% endif %}.jinja b/template/src/{{ project_name_snake_case }}/{% if with_typer_cli %}cli.py{% endif %}.jinja
@@ -10,3 +10,7 @@ app = typer.Typer()
 def fire(name: str = "Chell") -> None:
     """Fire portal gun."""
     rprint(f"[bold red]Alert![/bold red] {name} fired [green]portal gun[/green] :boom:")
+
+
+if __name__ == "__main__":
+    app()
diff --git a/{{ cookiecutter.__project_name_kebab_case }}/.gitignore b/{{ cookiecutter.__project_name_kebab_case }}/.gitignore
@@ -64,5 +64,6 @@ __pycache__/
 # Terraform
 .terraform/
 
-# VS Code
-.vscode/
+# VS Code (but still include launch configurations)
+.vscode/*
+!/.vscode/launch.json*
diff --git a/{{ cookiecutter.__project_name_kebab_case }}/.vscode/launch.json b/{{ cookiecutter.__project_name_kebab_case }}/.vscode/launch.json
@@ -0,0 +1,41 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {%- if with_fastapi_api %}
+        {
+            "name": "API [debug]",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uvicorn",
+            "args": [
+                "{{ project_name_snake_case }}.api:app",
+                "--reload"
+            ],
+            "jinja": true,
+            "justMyCode": true,
+            "console": "integratedTerminal"
+        },
+        {%- endif %}
+        {%- if with_typer_cli %}
+        {
+            "name": "CLI [debug]",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}//src//{{ project_name_snake_case }}//cli.py",
+            "args": [
+                "--name",
+                "Someone"
+            ],
+            "justMyCode": true,
+            "console": "integratedTerminal"
+        },
+        {%- endif %}
+        {
+            "name": "Python file [debug]",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal"
+        }
+    ]
+}
diff --git a/{{ cookiecutter.__project_name_kebab_case }}/src/{{ cookiecutter.__project_name_snake_case }}/api.py b/{{ cookiecutter.__project_name_kebab_case }}/src/{{ cookiecutter.__project_name_snake_case }}/api.py
@@ -9,7 +9,7 @@
 
 
 @asynccontextmanager
-async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
+async def lifespan(app: FastAPI) -> AsyncGenerator[None]:
     """Handle FastAPI startup and shutdown events."""
     # Startup events.
     for handler in logging.root.handlers:
diff --git a/{{ cookiecutter.__project_name_kebab_case }}/src/{{ cookiecutter.__project_name_snake_case }}/cli.py b/{{ cookiecutter.__project_name_kebab_case }}/src/{{ cookiecutter.__project_name_snake_case }}/cli.py
@@ -10,3 +10,7 @@
 def fire(name: str = "Chell") -> None:
     """Fire portal gun."""
     print(f"[bold red]Alert![/bold red] {name} fired [green]portal gun[/green] :boom:")
+
+
+if __name__ == "__main__":
+    app()
