feat: extract formatter templates to files and rename Context to ContextV1

Author: NicolasIRAGNE

src/gitingest/entrypoint.py

@@ -28,7 +28,7 @@
     from types import TracebackType
 
     from gitingest.schemas import IngestionQuery
-    from gitingest.schemas import Context
+    from gitingest.schemas import ContextV1
 
 # Initialize logger for this module
 logger = get_logger(__name__)
@@ -52,7 +52,7 @@ async def ingest_async(
     This function analyzes a source (URL or local path), clones the corresponding repository (if applicable),
     and processes its files according to the specified query parameters. It returns a single digest string.
 
-    The output is generated lazily using a Context object and the generate_digest() function.
+    The output is generated lazily using a ContextV1 object and the generate_digest() function.
 
     Parameters
     ----------
@@ -167,7 +167,7 @@ def ingest(
     This function analyzes a source (URL or local path), clones the corresponding repository (if applicable),
     and processes its files according to the specified query parameters. It returns a single digest string.
 
-    The output is generated lazily using a Context object and the generate_digest() function.
+    The output is generated lazily using a ContextV1 object and the generate_digest() function.
 
     Parameters
     ----------

src/gitingest/format/DebugFormatter/Source.j2

@@ -0,0 +1,4 @@
+{{ SEPARATOR }}
+DEBUG: {{ class_name }}
+Fields: {{ fields_str }}
+{{ SEPARATOR }}

src/gitingest/format/DefaultFormatter/ContextV1.j2

@@ -0,0 +1,11 @@
+# Generated using https://gitingest.com/{{ context.query.user_name }}/{{ context.query.repo_name }}
+
+Sources used:
+{%- for source in context.sources %}
+- {{ source.name }}: {{ source.__class__.__name__ }}
+{% endfor %}
+
+{%- for source in context.sources %}
+{{ formatter.format(source, context.query) }}
+{%- endfor %}
+# End of generated content

src/gitingest/format/DefaultFormatter/FileSystemDirectory.j2

@@ -0,0 +1,7 @@
+{%- if node.depth == 0 %}{{ node.name }}:
+{{ node.tree }}
+
+{% endif -%}
+{%- for child in node.children -%}
+{{ formatter.format(child, query) }}
+{%- endfor -%}

src/gitingest/format/DefaultFormatter/FileSystemFile.j2

@@ -0,0 +1,4 @@
+{{ SEPARATOR }}
+{{ node.name }}
+{{ SEPARATOR }}
+{{ node.content }}

src/gitingest/format/DefaultFormatter/FileSystemSymlink.j2

@@ -0,0 +1,3 @@
+{{ SEPARATOR }}
+{{ node.name }}{% if node.target %} -> {{ node.target }}{% endif %}
+{{ SEPARATOR }}

src/gitingest/format/DefaultFormatter/GitRepository.j2

@@ -0,0 +1,7 @@
+{%- if node.depth == 0 %}🔗 Git Repository: {{ node.name }}
+{{ node.tree }}
+
+{% endif -%}
+{%- for child in node.children -%}
+{{ formatter.format(child, query) }}
+{%- endfor -%}

src/gitingest/format/SummaryFormatter/ContextV1.j2

@@ -0,0 +1,3 @@
+Repository: {{ context.query.user_name }}/{{ context.query.repo_name }}
+Commit: {{ context.query.commit }}
+Files analyzed: {{ context.sources[0].file_count }}

src/gitingest/format/SummaryFormatter/FileSystemDirectory.j2

@@ -0,0 +1,2 @@
+Directory structure:
+{{ node.tree }}

src/gitingest/ingestion.py

@@ -6,7 +6,7 @@
 from typing import TYPE_CHECKING
 
 from gitingest.config import MAX_DIRECTORY_DEPTH, MAX_FILES, MAX_TOTAL_SIZE_BYTES
-from gitingest.schemas import Context, FileSystemNode, FileSystemStats
+from gitingest.schemas import ContextV1, FileSystemNode, FileSystemStats
 from gitingest.schemas.filesystem import FileSystemDirectory, FileSystemFile, FileSystemSymlink, GitRepository
 from gitingest.utils.ingestion_utils import _should_exclude, _should_include
 from gitingest.utils.logging_config import get_logger
@@ -23,11 +23,11 @@ def _is_git_repository(path: Path) -> bool:
     return (path / ".git").exists()
 
 
-def ingest_query(query: IngestionQuery) -> Context:
+def ingest_query(query: IngestionQuery) -> ContextV1:
     """Run the ingestion process for a parsed query.
 
     This is the main entry point for analyzing a codebase directory or single file. It processes the query
-    parameters, reads the file or directory content, and returns a Context object that can generate the final output digest on demand.
+    parameters, reads the file or directory content, and returns a ContextV1 object that can generate the final output digest on demand.
 
     Parameters
     ----------
@@ -36,8 +36,8 @@ def ingest_query(query: IngestionQuery) -> Context:
 
     Returns
     -------
-    Context
-        A Context object representing the ingested file system nodes. Use generate_digest(context) to get the summary, directory structure, and file contents.
+    ContextV1
+        A ContextV1 object representing the ingested file system nodes. Use generate_digest(context) to get the summary, directory structure, and file contents.
 
     Raises
     ------
@@ -92,7 +92,7 @@ def ingest_query(query: IngestionQuery) -> Context:
                 "file_size": file_node.size,
             },
         )
-        return Context([file_node], query)
+        return ContextV1([file_node], query)
 
     # Check if this is a git repository and create appropriate node type
     if _is_git_repository(path):
@@ -123,7 +123,7 @@ def ingest_query(query: IngestionQuery) -> Context:
         },
     )
 
-    return Context([root_node], query)
+    return ContextV1([root_node], query)
 
 
 def _process_node(node: FileSystemNode, query: IngestionQuery, stats: FileSystemStats) -> None: