fix: add minimal pyproject metadata during init

Author: mohamedashrraf222

codeflash/cli_cmds/init_config.py

@@ -14,6 +14,7 @@
 
 from codeflash.cli_cmds.console import apologize_and_exit, console
 from codeflash.code_utils.compat import LF
+from codeflash.code_utils.pyproject_utils import ensure_minimal_project_metadata
 from codeflash.code_utils.config_parser import parse_config_file
 from codeflash.code_utils.env_utils import check_formatter_installed
 from codeflash.lsp.helpers import is_LSP_enabled
@@ -202,6 +203,7 @@ def configure_pyproject_toml(
             f"Please create a new empty pyproject.toml file here, OR if you use poetry then run `poetry init`, OR run `codeflash init` again from a directory with an existing pyproject.toml file."
         )
         return False
+    ensure_minimal_project_metadata(pyproject_data, toml_path.parent)
 
     codeflash_section = tomlkit.table()
     codeflash_section.add(tomlkit.comment("All paths are relative to this pyproject.toml's directory."))
@@ -252,6 +254,7 @@ def create_empty_pyproject_toml(pyproject_toml_path: Path) -> None:
     lsp_mode = is_LSP_enabled()
     # Define a minimal pyproject.toml content
     new_pyproject_toml = tomlkit.document()
+    ensure_minimal_project_metadata(new_pyproject_toml, pyproject_toml_path.parent)
     new_pyproject_toml["tool"] = {"codeflash": {}}
     try:
         pyproject_toml_path.write_text(tomlkit.dumps(new_pyproject_toml), encoding="utf8")

codeflash/code_utils/pyproject_utils.py

@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+import re
+from pathlib import Path
+from typing import Any
+
+import tomlkit
+
+DEFAULT_MINIMAL_PROJECT_VERSION = "0.0.0"
+
+
+def infer_minimal_project_name(project_root: Path) -> str:
+    """Generate a PEP 621-friendly project name from the directory name."""
+    candidate = project_root.resolve().name.strip().lower()
+    if not candidate:
+        return "codeflash-project"
+
+    normalized = re.sub(r"[^a-z0-9._-]+", "-", candidate)
+    normalized = re.sub(r"[-_.]{2,}", "-", normalized).strip("-_.")
+    return normalized or "codeflash-project"
+
+
+def ensure_minimal_project_metadata(pyproject_data: Any, project_root: Path) -> bool:
+    """Add minimal [project] metadata when the file has no standard project section.
+
+    Codeflash can create a pyproject.toml solely for tool configuration. Some tooling,
+    including uv in certain flows, expects PEP 621 metadata once a pyproject.toml exists.
+    We only inject minimal metadata when neither [project] nor [tool.poetry] exists.
+    """
+
+    if "project" in pyproject_data:
+        return False
+
+    tool_section = pyproject_data.get("tool", {})
+    if isinstance(tool_section, dict) and "poetry" in tool_section:
+        return False
+
+    project_section = tomlkit.table()
+    project_section["name"] = infer_minimal_project_name(project_root)
+    project_section["version"] = DEFAULT_MINIMAL_PROJECT_VERSION
+    pyproject_data["project"] = project_section
+    return True

codeflash/setup/config_writer.py

@@ -11,6 +11,7 @@
 from typing import TYPE_CHECKING
 
 import tomlkit
+from codeflash.code_utils.pyproject_utils import ensure_minimal_project_metadata
 
 if TYPE_CHECKING:
     from pathlib import Path
@@ -66,6 +67,8 @@ def _write_pyproject_toml(project_root: Path, config: CodeflashConfig) -> tuple[
         else:
             doc = tomlkit.document()
 
+        ensure_minimal_project_metadata(doc, project_root)
+
         # Ensure [tool] section exists
         if "tool" not in doc:
             doc["tool"] = tomlkit.table()

tests/test_cmd_init.py

@@ -3,15 +3,18 @@
 from pathlib import Path
 
 import pytest
+import tomlkit
 
 from codeflash.cli_cmds.init_config import (
     CLISetupInfo,
     VsCodeSetupInfo,
     configure_pyproject_toml,
+    create_empty_pyproject_toml,
     get_formatter_cmds,
     get_valid_subdirs,
     is_valid_pyproject_toml,
 )
+from codeflash.code_utils.pyproject_utils import infer_minimal_project_name
 
 
 @pytest.fixture
@@ -103,17 +106,14 @@ def test_configure_pyproject_toml_for_cli(temp_dir: Path) -> None:
         assert success
 
         config_content = pyproject_path.read_text()
-        assert (
-            config_content
-            == """[tool.codeflash]
-# All paths are relative to this pyproject.toml's directory.
-module-root = "."
-tests-root = "tests"
-ignore-paths = []
-disable-telemetry = true
-formatter-cmds = ["black $file"]
-"""
-        )
+        data = tomlkit.parse(config_content)
+        assert data["project"]["name"] == infer_minimal_project_name(temp_dir)
+        assert data["project"]["version"] == "0.0.0"
+        assert data["tool"]["codeflash"]["module-root"] == "."
+        assert data["tool"]["codeflash"]["tests-root"] == "tests"
+        assert data["tool"]["codeflash"]["ignore-paths"] == []
+        assert data["tool"]["codeflash"]["disable-telemetry"] is True
+        assert data["tool"]["codeflash"]["formatter-cmds"] == ["black $file"]
         valid, _, _ = is_valid_pyproject_toml(pyproject_path)
         assert valid
 
@@ -131,14 +131,12 @@ def test_configure_pyproject_toml_for_vscode_with_empty_config(temp_dir: Path) -
         assert success
 
         config_content = pyproject_path.read_text()
-        assert (
-            config_content
-            == """[tool.codeflash]
-module-root = "."
-tests-root = "tests"
-formatter-cmds = ["black $file"]
-"""
-        )
+        data = tomlkit.parse(config_content)
+        assert data["project"]["name"] == infer_minimal_project_name(temp_dir)
+        assert data["project"]["version"] == "0.0.0"
+        assert data["tool"]["codeflash"]["module-root"] == "."
+        assert data["tool"]["codeflash"]["tests-root"] == "tests"
+        assert data["tool"]["codeflash"]["formatter-cmds"] == ["black $file"]
         valid, _, _ = is_valid_pyproject_toml(pyproject_path)
         assert valid
 
@@ -162,15 +160,13 @@ def test_configure_pyproject_toml_for_vscode_with_existing_config(temp_dir: Path
 
         config_content = pyproject_path.read_text()
         # the benchmarks-root shouldn't get overwritten
-        assert (
-            config_content
-            == """[tool.codeflash]
-module-root = "."
-tests-root = "tests"
-benchmarks-root = "tests/benchmarks"
-formatter-cmds = ["disabled"]
-"""
-        )
+        data = tomlkit.parse(config_content)
+        assert data["project"]["name"] == infer_minimal_project_name(temp_dir)
+        assert data["project"]["version"] == "0.0.0"
+        assert data["tool"]["codeflash"]["module-root"] == "."
+        assert data["tool"]["codeflash"]["tests-root"] == "tests"
+        assert data["tool"]["codeflash"]["benchmarks-root"] == "tests/benchmarks"
+        assert data["tool"]["codeflash"]["formatter-cmds"] == ["disabled"]
         valid, _, _ = is_valid_pyproject_toml(pyproject_path)
         assert valid
 
@@ -186,3 +182,18 @@ def test_get_valid_subdirs(temp_dir: Path) -> None:
     assert "tests" in dirs
     assert "dir1" in dirs
     assert "dir2" in dirs
+
+
+def test_create_empty_pyproject_toml_adds_minimal_project_metadata(
+    temp_dir: Path, monkeypatch: pytest.MonkeyPatch
+) -> None:
+    pyproject_path = temp_dir / "pyproject.toml"
+    monkeypatch.setattr("codeflash.cli_cmds.init_config.is_LSP_enabled", lambda: True)
+    monkeypatch.setattr("codeflash.cli_cmds.init_config.ph", lambda *args, **kwargs: None)
+
+    create_empty_pyproject_toml(pyproject_path)
+
+    data = tomlkit.parse(pyproject_path.read_text())
+    assert data["project"]["name"] == infer_minimal_project_name(temp_dir)
+    assert data["project"]["version"] == "0.0.0"
+    assert data["tool"]["codeflash"] == {}

tests/test_setup/test_config.py

@@ -4,6 +4,7 @@
 
 import tomlkit
 
+from codeflash.code_utils.pyproject_utils import infer_minimal_project_name
 from codeflash.setup.config_schema import CodeflashConfig
 from codeflash.setup.config_writer import (
     _write_package_json,
@@ -170,10 +171,29 @@ def test_creates_new_pyproject(self, tmp_path):
         # Verify content
         content = (tmp_path / "pyproject.toml").read_text()
         data = tomlkit.parse(content)
+        assert data["project"]["name"] == infer_minimal_project_name(tmp_path)
+        assert data["project"]["version"] == "0.0.0"
         assert "tool" in data
         assert "codeflash" in data["tool"]
         assert data["tool"]["codeflash"]["module-root"] == "src"
 
+    def test_adds_minimal_project_metadata_when_missing(self, tmp_path):
+        """Should add [project] metadata when pyproject.toml only has tool config."""
+        (tmp_path / "pyproject.toml").write_text("[tool.ruff]\nline-length = 120")
+
+        config = CodeflashConfig(language="python", module_root="src")
+
+        success, message = _write_pyproject_toml(tmp_path, config)
+
+        assert success is True
+
+        content = (tmp_path / "pyproject.toml").read_text()
+        data = tomlkit.parse(content)
+        assert data["project"]["name"] == infer_minimal_project_name(tmp_path)
+        assert data["project"]["version"] == "0.0.0"
+        assert data["tool"]["ruff"]["line-length"] == 120
+        assert data["tool"]["codeflash"]["module-root"] == "src"
+
     def test_preserves_existing_content(self, tmp_path):
         """Should preserve existing pyproject.toml content."""
         (tmp_path / "pyproject.toml").write_text(
@@ -208,6 +228,22 @@ def test_updates_existing_codeflash_section(self, tmp_path):
         assert data["tool"]["codeflash"]["module-root"] == "new"
         assert data["tool"]["codeflash"]["tests-root"] == "new_tests"
 
+    def test_preserves_poetry_metadata_without_adding_project(self, tmp_path):
+        """Should not inject [project] into poetry-managed pyproject.toml files."""
+        (tmp_path / "pyproject.toml").write_text('[tool.poetry]\nname = "myapp"\nversion = "1.0.0"')
+
+        config = CodeflashConfig(language="python", module_root="src")
+
+        success, message = _write_pyproject_toml(tmp_path, config)
+
+        assert success is True
+
+        content = (tmp_path / "pyproject.toml").read_text()
+        data = tomlkit.parse(content)
+        assert "project" not in data
+        assert data["tool"]["poetry"]["name"] == "myapp"
+        assert data["tool"]["codeflash"]["module-root"] == "src"
+
     def test_preserves_crlf_newlines_for_existing_pyproject(self, tmp_path):
         """Should not introduce doubled carriage returns when preserving CRLF files."""
         pyproject_path = tmp_path / "pyproject.toml"