Function format_user_prompt

codewiki/src/be/prompt_template.py:251–327

Format the user prompt with module name and organized core component codes. Args: module_name: Name of the module to document core_component_ids: List of component IDs to include components: Dictionary mapping component IDs to CodeComponent objects Retu

(module_name: str, core_component_ids: list[str], components: Dict[str, Any], module_tree: dict[str, any])

""".strip()

FILTER_FOLDERS_PROMPT = """
Here is the list of relative paths of files, folders in 2-depth of project {project_name}:
```
{files}
```

In order to analyze the core functionality of the project, we need to analyze the files, folders representing the core functionality of the project.

Please shortlist the files, folders representing the core functionality and ignore the files, folders that are not essential to the core functionality of the project (e.g. test files, documentation files, etc.) from the list above.

Reasoning at first, then return the list of relative paths in JSON format.
"""

import logging
from collections import defaultdict
from typing import Any

from codewiki.src.utils import file_manager

logger = logging.getLogger(__name__)

# codex rejects any turn whose total input exceeds 1,048,576 characters
# (input_too_large, code -32602 — server-side, not configurable).  Cap the
# user prompt below that, leaving headroom for the system prompt, tool
# schemas and protocol overhead.
MAX_USER_PROMPT_CHARS = 900_000

MODULE_TREE_TRIMMED_NOTE = (
    "NOTE: per-module component listings were omitted because the full module "
    "tree exceeds the model input limit. Module names and hierarchy are "
    "complete; read the referenced modules' documentation files or use your "
    "code-reading tools when you need component-level detail."
)

CODE_TRUNCATED_NOTE = (
    "\n... [file contents truncated to fit the model input limit — use your "
    "file-reading tools to read the full files]"
)

# Appended to the user prompt (after USER_PROMPT) when the dependency graph
# contains artifact nodes. Kept out of USER_PROMPT itself so callers that
# format the template directly (MCP prompt server) keep working.
ARTIFACT_USAGE_NOTE = (
    "* NOTE: when this module's behaviour depends on how the system is built, "
    "configured, packaged, deployed or tested, read the relevant artifact file "
    'with `str_replace_editor` (`command="view"`, `working_dir="repo"`, path as '
    "listed above) and cite the file path in the documentation."
)

REPO_OVERVIEW_ARTIFACT_ADDENDUM = """
The repository also contains the following build, CI, container, packaging, manifest and configuration artifacts:
{artifact_index}

Include a short section titled "How it is built and run" that summarises how the project is built, tested, packaged and deployed, and links to the module documentation that covers these artifacts (for example a `Build, Deployment and Configuration` module) instead of repeating its content.
""".strip()

EXTENSION_TO_LANGUAGE = {
    ".py": "python",