Merge branch 'main' into VsCode-Extension

Author: filipchristiansen

docs/frontpage.png

@@ -60,22 +60,48 @@ def _is_valid_pattern(pattern: str) -> bool:
 
 def _validate_host(host: str) -> None:
     """
-    Validate the given host against the known Git hosts.
+    Validate a hostname.
+
+    The host is accepted if it is either present in the hard-coded `KNOWN_GIT_HOSTS` list or if it satisfies the
+    simple heuristics in `_looks_like_git_host`, which try to recognise common self-hosted Git services (e.g. GitLab
+    instances on sub-domains such as `gitlab.example.com` or `git.example.com`).
 
     Parameters
     ----------
     host : str
-        The host to validate.
+        Hostname (case-insensitive).
 
     Raises
     ------
     ValueError
-        If the host is not a known Git host.
+        If the host cannot be recognised as a probable Git hosting domain.
     """
-    if host not in KNOWN_GIT_HOSTS:
+    host = host.lower()
+    if host not in KNOWN_GIT_HOSTS and not _looks_like_git_host(host):
         raise ValueError(f"Unknown domain '{host}' in URL")
 
 
+def _looks_like_git_host(host: str) -> bool:
+    """
+    Check if the given host looks like a Git host.
+
+    The current heuristic returns `True` when the host starts with `git.` (e.g. `git.example.com`) or starts with
+    `gitlab.` (e.g. `gitlab.company.com`).
+
+    Parameters
+    ----------
+    host : str
+        Hostname (case-insensitive).
+
+    Returns
+    -------
+    bool
+        True if the host looks like a Git host, otherwise False.
+    """
+    host = host.lower()
+    return host.startswith(("git.", "gitlab."))
+
+
 def _validate_url_scheme(scheme: str) -> None:
     """
     Validate the given scheme against the known schemes.
@@ -90,6 +116,7 @@ def _validate_url_scheme(scheme: str) -> None:
     ValueError
         If the scheme is not 'http' or 'https'.
     """
+    scheme = scheme.lower()
     if scheme not in ("https", "http"):
         raise ValueError(f"Invalid URL scheme '{scheme}' in URL")
 

src/gitingest/utils/query_parser_utils.py

@@ -104,6 +104,19 @@ async def robots() -> FileResponse:
     return FileResponse("static/robots.txt")
 
 
+@app.get("/llm.txt")
+async def llm_txt() -> FileResponse:
+    """
+    Serve the `llm.txt` file to provide information about the site to LLMs.
+
+    Returns
+    -------
+    FileResponse
+        The `llm.txt` file located in the static directory.
+    """
+    return FileResponse("static/llm.txt")
+
+
 # Include routers for modular endpoints
 app.include_router(index)
 app.include_router(download)

src/server/main.py

@@ -91,6 +91,9 @@ async def process_query(
         if not query.url:
             raise ValueError("The 'url' parameter is required.")
 
+        # Sets the "<user>/<repo>" for the page title
+        context["short_repo_url"] = f"{query.user_name}/{query.repo_name}"
+
         clone_config = query.extract_clone_config()
         await clone_repo(clone_config, token=token)
         summary, tree, content = ingest_query(query)

src/server/query_processor.py

@@ -33,7 +33,13 @@
         <meta property="og:url" content="{{ request.url }}">
         <meta property="og:image" content="/static/og-image.png">
         <title>
-            {% block title %}Gitingest{% endblock %}
+            {% block title %}
+                {% if short_repo_url %}
+                    Gitingest - {{ short_repo_url }}
+                {% else %}
+                    Gitingest
+                {% endif %}
+            {% endblock %}
         </title>
         <script src="https://cdn.tailwindcss.com"></script>
         <script src="/static/js/utils.js"></script>

src/server/templates/base.jinja

@@ -0,0 +1 @@
+<span class="inline-block transform -rotate-6 -translate-y-1 mx-1 px-1 bg-[#FE4A60] border border-gray-900 text-white text-[10px] font-bold shadow-[2px_2px_0_0_rgba(0,0,0,1)]">NEW</span>

src/server/templates/components/badge_new.jinja

@@ -1,37 +1,26 @@
 <footer class="w-full border-t-[3px] border-gray-900 mt-auto">
     <div class="max-w-4xl mx-auto px-4 py-4">
-        <div class="grid grid-cols-3 items-center text-gray-900 text-sm">
-            <!-- Left column - GitHub links -->
+        <div class="grid grid-cols-2 items-center text-gray-900 text-sm">
+            <!-- Left column - Extension and PyPI links -->
             <div class="flex items-center space-x-4">
-                <a href="https://github.com/cyclotruc/gitingest"
+                <a href="https://chromewebstore.google.com/detail/git-ingest-turn-any-git-r/adfjahbijlkjfoicpjkhjicpjpjfaood"
                    target="_blank"
                    rel="noopener noreferrer"
                    class="hover:underline flex items-center">
-                    <svg class="w-4 h-4 mr-1"
-                         xmlns="http://www.w3.org/2000/svg"
-                         viewBox="0 0 496 512">
-                        <path fill="currentColor" d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" />
-                    </svg>
-                    Suggest a feature
+                    <img src="https://img.icons8.com/ios/50/chrome--v1.png"
+                         alt="chrome"
+                         class="w-4 h-4 mr-1">
+                    Extension
+                </a>
+                <a href="https://pypi.org/project/gitingest/"
+                   target="_blank"
+                   rel="noopener noreferrer"
+                   class="hover:underline flex items-center">
+                    <img src="https://img.icons8.com/windows/32/python.png"
+                         alt="python"
+                         class="w-4 h-4 mr-1">
+                    Python package
                 </a>
-            </div>
-            <!-- Middle column - Made with love -->
-            <div class="flex flex-col justify-center items-center">
-                <div class="flex items-center">
-                    made with ❤️ by
-                    <a href="https://x.com/romdot2"
-                       target="_blank"
-                       rel="noopener noreferrer"
-                       class="ml-1 hover:underline">@rom2</a>
-                </div>
-                <div class="flex items-center mt-1">
-                    Check out my
-                    <a href="https://pad.ws"
-                       target="_blank"
-                       rel="noopener noreferrer"
-                       referrerpolicy="origin"
-                       class="ml-1 hover:underline">latest project</a>
-                </div>
             </div>
             <!-- Right column - Discord -->
             <div class="flex justify-end">

src/server/templates/components/footer.jinja

@@ -24,7 +24,7 @@
         const row = document.getElementById('controlsRow');
         const show = checkbox.checked;
         container.classList.toggle('hidden', !show);
-        row.classList.toggle('mb-8', show);
+        row.classList.toggle('mb-12', show);
     }
 </script>
 <div class="relative">
@@ -129,6 +129,7 @@
                                onchange="toggleAccessSettings()"
                                {% if token %}checked{% endif %}>
                         <label for="showAccessSettings" class="text-gray-900">Private Repository</label>
+                        {% include "components/badge_new.jinja" %}
                     </div>
                     <!-- PAT field -->
                     <div id="accessSettingsContainer"

src/server/templates/components/git_form.jinja

@@ -34,24 +34,10 @@
             </div>
             <!-- Navigation with updated styling -->
             <nav class="flex items-center space-x-6">
-                <!-- Simplified Chrome extension button -->
-                <a href="https://chromewebstore.google.com/detail/git-ingest-turn-any-git-r/adfjahbijlkjfoicpjkhjicpjpjfaood"
-                   target="_blank"
-                   rel="noopener noreferrer"
-                   class="text-gray-900 hover:-translate-y-0.5 transition-transform flex items-center gap-1.5">
-                    <div class="flex items-center">
-                        <svg xmlns="http://www.w3.org/2000/svg"
-                             width="24"
-                             height="24"
-                             viewBox="0 0 50 50"
-                             fill="none"
-                             stroke="currentColor"
-                             stroke-width="3"
-                             class="w-4 h-4 mx-1">
-                            <path d="M 25 2 C 12.309295 2 2 12.309295 2 25 C 2 37.690705 12.309295 48 25 48 C 37.690705 48 48 37.690705 48 25 C 48 12.309295 37.690705 2 25 2 z M 25 4 C 32.987976 4 39.925645 8.44503 43.476562 15 L 25 15 A 1.0001 1.0001 0 0 0 24.886719 15.005859 C 19.738868 15.064094 15.511666 19.035373 15.046875 24.078125 L 8.0351562 12.650391 C 11.851593 7.4136918 18.014806 4 25 4 z M 6.8242188 14.501953 L 16.476562 30.230469 A 1.0001 1.0001 0 0 0 16.591797 30.388672 A 1.0001 1.0001 0 0 0 16.59375 30.392578 C 18.3752 33.158533 21.474925 35 25 35 C 26.413063 35 27.756327 34.701734 28.976562 34.169922 L 22.320312 45.824219 C 11.979967 44.509804 4 35.701108 4 25 C 4 21.169738 5.0375742 17.591533 6.8242188 14.501953 z M 25 17 C 29.430123 17 33 20.569877 33 25 C 33 26.42117 32.629678 27.751591 31.984375 28.90625 A 1.0001 1.0001 0 0 0 31.982422 28.908203 A 1.0001 1.0001 0 0 0 31.947266 28.966797 C 30.57172 31.37734 27.983486 33 25 33 C 20.569877 33 17 29.430123 17 25 C 17 20.569877 20.569877 17 25 17 z M 30.972656 17 L 44.421875 17 C 45.43679 19.465341 46 22.165771 46 25 C 46 36.609824 36.609824 46 25 46 C 24.842174 46 24.686285 45.991734 24.529297 45.988281 L 33.683594 29.958984 A 1.0001 1.0001 0 0 0 33.742188 29.841797 C 34.541266 28.405674 35 26.755664 35 25 C 35 21.728612 33.411062 18.825934 30.972656 17 z" />
-                        </svg>
-                        Extension
-                    </div>
+                <a href="/llm.txt"
+                   class="text-gray-900 hover:-translate-y-0.5 transition-transform flex items-center">
+                    {% include "components/badge_new.jinja" %}
+                    /llm.txt
                 </a>
                 <!-- Simplified VS Code extension button -->
                 <a href="https://marketplace.visualstudio.com/items?itemName=iamshreydxv.gitingest"

src/server/templates/components/navbar.jinja

@@ -1,22 +1,48 @@
 <script>
-    function getFileName(line) {
-        // Skips "|", "└", "├" found in file tree
-        const index = line.search(/[a-zA-Z0-9]/);
-        return line.substring(index).trim();
+    function getFileName(element) {
+        const indentSize = 4;
+        let path = "";
+        let prevIndentLevel = null;
+
+        while (element) {
+            const line = element.textContent;
+            const index = line.search(/[a-zA-Z0-9_.-]/);
+            const indentLevel = index / indentSize;
+
+            // Stop when we reach or go above the top-level directory
+            if (indentLevel <= 1) {
+                break;
+            }
+
+            // Only include directories that are one level above the previous
+            if (prevIndentLevel === null || indentLevel === prevIndentLevel - 1) {
+                const fileName = line.substring(index).trim();
+                path = fileName + path;
+                prevIndentLevel = indentLevel;
+            }
+
+            element = element.previousElementSibling;
+        }
+
+        return path;
     }
 
     function toggleFile(element) {
         const patternInput = document.getElementById("pattern");
         const patternFiles = patternInput.value ? patternInput.value.split(",").map(item => item.trim()) : [];
 
-        if (element.textContent.includes("Directory structure:")) {
+        const directoryContainer = document.getElementById("directory-structure-container");
+        const treeLineElements = Array.from(directoryContainer.children).filter(child => child.tagName === "PRE");
+
+        // Skip the first two tree lines (header and repository name)
+        if (treeLineElements[0] === element || treeLineElements[1] === element) {
             return;
         }
 
         element.classList.toggle('line-through');
         element.classList.toggle('text-gray-500');
 
-        const fileName = getFileName(element.textContent);
+        const fileName = getFileName(element);
         const fileIndex = patternFiles.indexOf(fileName);
 
         if (fileIndex !== -1) {