Autogenerated project.yaml now uses the template and includes the comments

.serena/project.yml

@@ -1,4 +1,66 @@
-# language of the project (csharp, python, rust, java, typescript, javascript, go, or ruby)
-language: python
-# list of directories to ignore: either names (e.g. "temp") or relative paths (e.g. "build/foo")
-ignore_all_files_in_gitignore: True
+# language of the project (csharp, python, rust, java, typescript, javascript, go, cpp, or ruby)
+# Special requirements:
+#  * csharp: Requires the presence of a .sln file in the project folder.
+language: typescript
+
+# whether to use the project's gitignore file to ignore files
+# Added on 2025-04-07
+ignore_all_files_in_gitignore: true
+# list of additional paths to ignore
+# same syntax as gitignore, so you can use * and **
+# Was previously called `ignored_dirs`, please update your config if you are using that.
+# Added (renamed)on 2025-04-07
+ignored_paths: []
+
+# whether the project is in read-only mode
+# If set to true, all editing tools will be disabled and attempts to use them will result in an error
+# Added on 2025-04-18
+read_only: false
+
+
+# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
+# Below is the complete list of tools for convenience.
+# To make sure you have the latest list of tools, and to view their descriptions, 
+# execute `uv run scripts/print_tool_overview.py`.
+#
+#  * `activate_project`: Activates a project by name.
+#  * `check_onboarding_performed`: Checks whether project onboarding was already performed.
+#  * `create_text_file`: Creates/overwrites a file in the project directory.
+#  * `delete_lines`: Deletes a range of lines within a file.
+#  * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
+#  * `execute_shell_command`: Executes a shell command.
+#  * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
+#  * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
+#  * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
+#  * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
+#  * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file or directory.
+#  * `initial_instructions`: Gets the initial instructions for the current project.
+#     Should only be used in settings where the system prompt cannot be set,
+#     e.g. in clients you have no control over, like Claude Desktop.
+#  * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
+#  * `insert_at_line`: Inserts content at a given line in a file.
+#  * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
+#  * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
+#  * `list_memories`: Lists memories in Serena's project-specific memory store.
+#  * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
+#  * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
+#  * `read_file`: Reads a file within the project directory.
+#  * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
+#  * `remove_project`: Removes a project from the Serena configuration.
+#  * `replace_lines`: Replaces a range of lines within a file with new content.
+#  * `replace_symbol_body`: Replaces the full definition of a symbol.
+#  * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
+#  * `search_for_pattern`: Performs a search for a pattern in the project.
+#  * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
+#  * `switch_modes`: Activates modes by providing a list of their names
+#  * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
+#  * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
+#  * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
+#  * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
+excluded_tools: []
+
+# initial prompt for the project. It will always be given to the LLM upon activating the project
+# (contrary to the memories, which are loaded on demand).
+initial_prompt: ""
+
+project_name: "serena"

project.template.yml

@@ -1,7 +1,3 @@
-# absolute path to the project you want Serena to work on (where all the source code, etc. is located)
-# This is optional if this file is placed in the project directory under `.serena/project.yml`.
-project_root: /path/to/project
-
 # language of the project (csharp, python, rust, java, typescript, javascript, go, cpp, or ruby)
 # Special requirements:
 #  * csharp: Requires the presence of a .sln file in the project folder.
@@ -36,8 +32,7 @@ read_only: false
 #  * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
 #  * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
 #  * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
-#  * `get_active_project`: Gets the name of the currently active project (if any) and lists existing projects
-#  * `get_current_config`: Prints the current configuration of the agent, including the active modes, tools, and context.
+#  * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
 #  * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file or directory.
 #  * `initial_instructions`: Gets the initial instructions for the current project.
 #     Should only be used in settings where the system prompt cannot be set,
@@ -51,6 +46,7 @@ read_only: false
 #  * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
 #  * `read_file`: Reads a file within the project directory.
 #  * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
+#  * `remove_project`: Removes a project from the Serena configuration.
 #  * `replace_lines`: Replaces a range of lines within a file with new content.
 #  * `replace_symbol_body`: Replaces the full definition of a symbol.
 #  * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
@@ -62,3 +58,9 @@ read_only: false
 #  * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
 #  * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
 excluded_tools: []
+
+# initial prompt for the project. It will always be given to the LLM upon activating the project
+# (contrary to the memories, which are loaded on demand).
+initial_prompt: ""
+
+project_name: "project_name"

scripts/demo_run_tools.py

@@ -1,19 +1,16 @@
 """
 This script demonstrates how to use Serena's tools locally, useful
-for testing or development. Here the config is pointing to the serena repo itself,
-it assumes that you already have a serena_config.yml file setup.
+for testing or development. Here the tools will be operation the serena repo itself.
 """
 
 import json
-from pathlib import Path
 from pprint import pprint
 
 from serena.agent import *
-
-project_root = Path(__file__).parent.parent
+from serena.constants import REPO_ROOT
 
 if __name__ == "__main__":
-    agent = SerenaAgent(project_config=str(project_root / ".serena" / "project.yml"))
+    agent = SerenaAgent(project=REPO_ROOT)
     overview_tool = agent.get_tool(GetSymbolsOverviewTool)
     find_symbol_tool = agent.get_tool(FindSymbolTool)
 

src/serena/agent.py

@@ -14,7 +14,7 @@ from abc import ABC, abstractmethod
 from collections import defaultdict
 from collections.abc import Callable, Generator, Iterable, Sequence
 from copy import copy, deepcopy
-from dataclasses import asdict, dataclass, field
+from dataclasses import dataclass, field
 from functools import cached_property
 from logging import Logger
 from pathlib import Path
@@ -33,7 +33,7 @@ from multilspy.multilspy_logger import MultilspyLogger
 from multilspy.multilspy_types import SymbolKind
 from serena import serena_root_path, serena_version
 from serena.config import SerenaAgentContext, SerenaAgentMode
-from serena.constants import SERENA_MANAGED_DIR_NAME
+from serena.constants import PROJECT_TEMPLATE_FILE, SERENA_MANAGED_DIR_NAME
 from serena.dashboard import MemoryLogHandler, SerenaDashboardAPI
 from serena.prompt_factory import PromptFactory, SerenaPromptFactory
 from serena.symbol import SymbolLocation, SymbolManager
@@ -117,25 +117,12 @@ class ProjectConfig(ToStringMixin):
             )
         # find the language with the highest percentage
         dominant_language = max(language_composition.keys(), key=lambda lang: language_composition[lang])
-        result = cls(
-            project_name=project_name,
-            language=Language(dominant_language),
-        )
+        config_with_comments = load_yaml(PROJECT_TEMPLATE_FILE, preserve_comments=True)
+        config_with_comments["project_name"] = project_name
+        config_with_comments["language"] = dominant_language
         if save_to_disk:
-            result.save(project_root)
-        return result
-
-    def save(self, project_root: str | Path) -> None:
-        """
-        Save the project configuration to the project root.
-        """
-        project_root = Path(project_root).resolve()
-        config_path = project_root / self.rel_path_to_project_yml()
-        config_path.parent.mkdir(parents=True, exist_ok=True)
-        serializable_self = asdict(self)
-        serializable_self["language"] = self.language.value
-        serializable_self["excluded_tools"] = list(self.excluded_tools)
-        save_yaml(str(config_path), serializable_self)
+            save_yaml(str(project_root / cls.rel_path_to_project_yml()), config_with_comments, preserve_comments=True)
+        return cls._from_yml_data(config_with_comments)
 
     @classmethod
     def rel_path_to_project_yml(cls) -> str:

src/serena/constants.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-_repo_root_path = Path(__file__).parent.parent.parent
+_repo_root_path = Path(__file__).parent.parent.parent.resolve()
 
 REPO_ROOT = str(_repo_root_path)
 PROMPT_TEMPLATES_DIR = str(_repo_root_path / "config" / "prompt_templates")
@@ -11,3 +11,5 @@ SERENA_MANAGED_DIR_NAME = ".serena"
 
 DEFAULT_CONTEXT = "desktop-app"
 DEFAULT_MODES = ("interactive", "editing")
+
+PROJECT_TEMPLATE_FILE = str(_repo_root_path / "project.template.yml")