Resolve merge conflicts

Author: Ekarerina-Ulyanova

osa_tool/config/prompts/docstring_generation.toml

@@ -355,3 +355,60 @@ Format you answer in a way you're writing README file for the module. Use such t
 ## Overview
 ## Purpose
 Do not mention or describe any submodule or files! Rename snake_case names on meaningful names.Keep in mind that your audience is document readers, so use a deterministic tone to generate precise content and don't let them know you're provided with any information. AVOID ANY SPECULATION and inaccurate descriptions! Now, provide the summarized idea of the module based on it's components'''
+
+class_generation_jsdoc = '''Generate a JSDoc comment for the following JavaScript/TypeScript class {class_name}. Include:
+- Respond strictly in English.
+- A short summary of what the class does.
+- Keep it concise; do NOT list methods or attributes as separate sections.
+- Do NOT use Python conventions: no self, __init__, Args:, Returns:, or Attributes: sections.
+
+Return only the comment text, without quotation marks.'''
+
+class_update_jsdoc = '''Update the provided description for the following JavaScript/TypeScript class {class_name} using the project's main idea as context.
+Do not mention the project idea explicitly.
+
+The main idea: {main_idea}
+Old docstring description part: {old_description}
+
+Return only the changed description, without code, other documentation parts, or quotation marks.'''
+
+method_generation_jsdoc = '''Generate a JSDoc comment for the following JavaScript/TypeScript function.
+- Respond strictly in English.
+- Include a short summary.
+- Include an @param {{type}} name line for every parameter; infer types from code and use * if unknown.
+- Include an @returns {{type}} line when the function returns a value.
+- Do NOT use Python conventions such as self, __init__, Args:, or Returns:.
+- Do NOT document inner functions separately.
+
+Method name: {method_name}
+Source code:
+```
+{source_code}
+```
+Arguments: {arguments}
+Decorators: {decorators}
+Related context (for understanding only; do not document it):
+{context}
+
+Return only the JSDoc comment text.'''
+
+method_update_jsdoc = '''Update the provided JSDoc comment for the following JavaScript/TypeScript function.
+Preserve correct information and add missing details based on the source code.
+- Use @param {{type}} name for each parameter and @returns {{type}} for a returned value.
+- Do NOT use Python conventions such as self, __init__, Args:, or Returns:.
+- Do NOT invent parameters or behaviour.
+
+Original JSDoc:
+{docstring}
+
+Method name: {method_name}{class_location}
+Decorators: {decorators}
+Source code:
+```
+{source_code}
+```
+Related context (for understanding only; do not document it):
+{context}
+Project main idea (context only): {main_idea}
+
+Return only the updated JSDoc comment text.'''

osa_tool/operations/codebase/docstring_generation/docgen.py

@@ -76,6 +76,9 @@ def __init__(self, config_manager: ConfigManager):
         self.config_manager = config_manager
         self.model_settings = self.config_manager.get_model_settings("docstring")
         self.model_handler: ProtollmHandler = ModelHandlerFactory.build(self.model_settings)
+        self.readme_model_handler: ProtollmHandler = ModelHandlerFactory.build(
+            self.config_manager.get_model_settings("readme")
+        )
         self.main_idea = None
         self._function_index_cache = None
         self.is_small_model = self._is_small_model_name(self.model_settings.model)
@@ -325,14 +328,7 @@ async def generate_class_documentation(
         attributes = class_details.attributes
         methods = class_details.methods
         if language in ("javascript", "typescript"):
-            prompt = (
-                f"""Generate a JSDoc comment for the following JavaScript/TypeScript class {class_name}. Include:\n"""
-                "- Respond strictly in English.\n"
-                "- A short summary of what the class does.\n"
-                "- Keep it concise; do NOT list methods/attributes as separate sections.\n"
-                "- Do NOT use Python conventions: no `self`, no `__init__`, no `Args:`/`Returns:`/`Attributes:` sections.\n\n"
-                "Return only the comment text without any quotation."
-            )
+            prompt = self._render_prompt("class_generation_jsdoc", class_name=class_name)
         else:
             prompt = (
                 self._get_class_generation_prompt_small(class_name, attributes, methods)
@@ -342,6 +338,8 @@ async def generate_class_documentation(
 
         async with semaphore:
             docstring = await self.model_handler.async_request(prompt)
+            if language in ("javascript", "typescript"):
+                return docstring.strip()
             return self.extract_pure_docstring(docstring)
 
     def _get_class_generation_prompt_large(self, class_name: str, attributes: list, methods: list) -> str:
@@ -411,12 +409,11 @@ async def update_class_documentation(
                 old_description=old_desc,
             )
         else:
-            prompt = (
-                f"""Update the provided description for the following JavaScript/TypeScript class {class_details.name} using provided main idea of the project.\n"""
-                """Do not pay too much attention to the provided main idea - try not to mention it explicitly.\n"""
-                f"""The main idea: {self.main_idea}\n"""
-                f"""Old docstring description part: {old_desc}\n\n"""
-                """Return only pure changed description - without any code, other parts of docs, any quotations)"""
+            prompt = self._render_prompt(
+                "class_update_jsdoc",
+                class_name=class_details.name,
+                main_idea=self.main_idea,
+                old_description=old_desc,
             )
 
         async with semaphore:
@@ -452,6 +449,8 @@ async def generate_method_documentation(
 
         async with semaphore:
             docstring = await self.model_handler.async_request(prompt)
+            if language in ("javascript", "typescript"):
+                return docstring.strip()
             extracted = self.extract_pure_docstring(docstring)
             return self.clean_docstring(extracted)
 
@@ -460,13 +459,13 @@ def _get_method_generation_prompt_large(
     ) -> str:
         arguments = [a for a in method_details["arguments"] if a not in ("self", "cls")]
         if language in ("javascript", "typescript"):
-            intro = (
-                "Generate a JSDoc comment for the following JavaScript/TypeScript function. Use JSDoc tags and include:\n"
-                "- Respond strictly in English.\n"
-                "- A short summary of what the function does.\n"
-                "- A `@param {type} name` line for each parameter (infer the type from the code; use `*` if unknown).\n"
-                "- A `@returns {type}` line describing the return value (omit it if the function returns nothing).\n"
-                "- Do NOT use Python conventions: no `self`, no `__init__`, no `Args:`/`Returns:` sections.\n\n"
+            return self._render_prompt(
+                "method_generation_jsdoc",
+                method_name=method_details["method_name"],
+                source_code=method_details["source_code"],
+                arguments=arguments,
+                decorators=method_details["decorators"],
+                context=context_code or "",
             )
         else:
             intro = (
@@ -493,9 +492,6 @@ def _get_method_generation_prompt_large(
             "Method Details:\n"
             f"- Method decorators: {method_details['decorators']}\n\n"
         )
-
-        if language in ("javascript", "typescript"):
-            return prompt
         return self._render_prompt(
             "method_generation_standard",
             method_name=method_details["method_name"],
@@ -557,6 +553,8 @@ async def update_method_documentation(
 
         async with semaphore:
             response = await self.model_handler.async_request(prompt)
+            if language in ("javascript", "typescript"):
+                return response.strip()
             return self.clean_docstring(self.extract_pure_docstring(response))
 
     def _get_method_update_prompt_large(
@@ -568,14 +566,15 @@ def _get_method_update_prompt_large(
         language: str = "python",
     ) -> str:
         if language in ("javascript", "typescript"):
-            guidelines = (
-                "Update the provided JSDoc comment for the following JavaScript/TypeScript function.\n"
-                "Preserve correct existing information and add missing details based on the source code.\n\n"
-                "Guidelines:\n"
-                "- Improve clarity and completeness without rewriting everything from scratch.\n"
-                "- Use JSDoc tags: `@param {type} name` for each parameter, `@returns {type}` for the return value (omit if nothing is returned).\n"
-                "- Do NOT use Python conventions: no `self`, no `__init__`, no `Args:`/`Returns:` sections.\n"
-                "- Do NOT invent parameters or behavior.\n\n"
+            return self._render_prompt(
+                "method_update_jsdoc",
+                docstring=docstring,
+                method_name=method_details["method_name"],
+                class_location=f" (located inside {class_name} class)" if class_name else "",
+                decorators=method_details["decorators"],
+                source_code=method_details["source_code"],
+                context=context_code or "",
+                main_idea=self.main_idea,
             )
         else:
             guidelines = (
@@ -600,9 +599,6 @@ def _get_method_update_prompt_large(
             f"{method_details['source_code']}\n"
             "```\n\n"
         )
-
-        if language in ("javascript", "typescript"):
-            return prompt
         return self._render_prompt(
             "method_update_standard",
             docstring=docstring,
@@ -1473,7 +1469,7 @@ async def generate_the_main_idea(self, parsed_structure: dict, top_n: int = 5) -
 
         components = "\n\n".join(prompt_structure)
 
-        self.main_idea = await self.model_handler.async_request(
+        self.main_idea = await self.readme_model_handler.async_request(
             self._render_prompt("main_idea_generation", components=components)
         )
 
@@ -1523,7 +1519,7 @@ async def summarize_directory(name: str, file_summaries: List[str], submodule_su
             logger.info(f"Generating summary for the module {name}")
 
             async with semaphore:
-                return await self.model_handler.async_request(
+                return await self.readme_model_handler.async_request(
                     self._render_prompt("submodule_summary", components=components, main_idea=self.main_idea)
                 )
 

tests/unit/operations/codebase/docstring_generation/test_docgen.py

@@ -327,6 +327,24 @@ async def test_generate_class_documentation_uses_small_model_prompt(mock_config_
     assert "must start at column 0" not in prompt
 
 
+@pytest.mark.asyncio
+async def test_generate_class_documentation_keeps_jsdoc_response_raw(mock_config_manager):
+    docgen = DocGen(mock_config_manager)
+    docgen.is_small_model = True
+    docgen.model_handler.async_request = AsyncMock(return_value="/**\n * Documents a class.\n */")
+
+    result = await docgen.generate_class_documentation(
+        ClassDocumentationDetails(name="Widget"),
+        asyncio.Semaphore(1),
+        language="typescript",
+    )
+
+    prompt = docgen.model_handler.async_request.await_args.args[0]
+    assert result == "/**\n * Documents a class.\n */"
+    assert "JSDoc" in prompt
+    assert "Google-style" not in prompt
+
+
 @pytest.mark.asyncio
 async def test_update_class_documentation(mock_config_manager):
     # Arrange
@@ -395,6 +413,30 @@ async def test_update_method_documentation(mock_config_manager):
     docgen.model_handler.async_request.assert_called_once()
 
 
+@pytest.mark.asyncio
+async def test_generate_method_documentation_uses_jsdoc_for_small_models(mock_config_manager):
+    docgen = DocGen(mock_config_manager)
+    docgen.is_small_model = True
+    docgen.model_handler.async_request = AsyncMock(return_value="Describes the function.")
+
+    result = await docgen.generate_method_documentation(
+        {
+            "method_name": "run",
+            "source_code": "return value;",
+            "arguments": ["value"],
+            "decorators": [],
+            "docstring": "",
+        },
+        asyncio.Semaphore(1),
+        language="javascript",
+    )
+
+    prompt = docgen.model_handler.async_request.await_args.args[0]
+    assert result == "Describes the function."
+    assert "JSDoc" in prompt
+    assert "Google-style" not in prompt
+
+
 def test_valid_triple_quotes(mock_config_manager):
     # Arrange
     docgen = DocGen(mock_config_manager)
@@ -722,7 +764,7 @@ async def test_generate_the_main_idea_filters_and_sorts(mock_config_manager, moc
     # Arrange
     docgen = DocGen(mock_config_manager)
     mock_request = mocker.AsyncMock(return_value="# Project\n## Overview\n## Purpose")
-    docgen.model_handler.async_request = mock_request
+    docgen.readme_model_handler.async_request = mock_request
 
     parsed_structure = {
         "src/core.py": {
@@ -772,7 +814,11 @@ async def test_summarize_submodules_creates_summaries(mock_config_manager, mocke
     (sub_dir / "__init__.py").write_text("")
     (sub_dir / "helper.py").write_text("def helper(): pass")
 
-    mocker.patch.object(docgen.model_handler, "async_request", new=mocker.AsyncMock(return_value="Summary of module"))
+    mocker.patch.object(
+        docgen.readme_model_handler,
+        "async_request",
+        new=mocker.AsyncMock(return_value="Summary of module"),
+    )
 
     project_structure = {
         str(pkg_dir / "core.py"): {