pre-commit-html 0.1.4__tar.gz → 0.1.4.post1__tar.gz

{pre_commit_html-0.1.4 → pre_commit_html-0.1.4.post1}/PKG-INFO

@@ -1,14 +1,15 @@
 Metadata-Version: 2.3
 Name: pre_commit_html
-Version: 0.1.4
+Version: 0.1.4.post1
 Summary: Format results from pre-commit cmd to HTML file
 License: MIT
 Author: Robotz213
 Author-email: nicholas@robotz.dev
-Requires-Python: >=3.13
+Requires-Python: >=3.13,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: html2text (>=2024.2.26,<2025.0.0)
 Requires-Dist: jinja2 (>=3.1.5,<4.0.0)
 Requires-Dist: pre-commit (>=4.1.0,<5.0.0)
 Description-Content-Type: text/markdown

pre_commit_html-0.1.4.post1/pre_commit_html/__init__.py

@@ -0,0 +1,210 @@
+"""Module for formatting pre-commit results into an HTML file."""
+
+import os
+import subprocess
+from pathlib import Path
+
+import html2text
+import yaml  # noqa: F401
+from jinja2 import Environment, FileSystemLoader
+
+from pre_commit_html.utils import generate_editor_links
+
+env = Environment(  # noqa:S701
+    loader=FileSystemLoader(
+        Path(
+            __file__,
+        )
+        .parent.resolve()
+        .joinpath("site/templates")
+    ),
+)
+
+render_template = env.get_template
+
+result_html = Path("result_pre_commit.html")
+result_md = Path("result_pre_commit.md")
+
+
+class PreCommitToHTML:
+    """Class to parse and format pre-commit results.
+
+    Attributes:
+        code_error (list[str]): Represents the section where the linter
+            error is occurring with:
+            - File path
+            - Line number
+            - Column number
+            - Error message
+
+        code_part (list[str]): Represents the code part where the linter
+        html_content (list[str]): Represents the HTML content to be written to the file.
+
+    """
+
+    theme = "dark"
+    ide = "VS Code"
+    to_markdown = False
+    code_error: list[str | list[str]] = []
+    code_part: list[str] = []
+    html_content: list[list[str | list[str]]] = []
+
+    uri_html = ""
+
+    def __init__(self, ide: str = "VS Code", to_markdown: bool = False, theme: str = "dark") -> None:
+        """Initialize the PreCommitToHTML class."""
+        self.ide = ide
+        self.to_markdown = to_markdown
+        self.theme = theme
+        self.pre_commit_html()
+
+    def render_template(self) -> None:
+        """Render the template and write the result to an HTML file."""
+        html_content = render_template("html_content.jinja").render(content=self.html_content, theme=self.theme)
+        if result_html.exists():
+            os.remove(str(result_html))
+
+        with result_html.open("w", encoding="utf-8") as f:
+            f.write(html_content)
+
+        if self.to_markdown:
+            try:
+                converter = html2text.HTML2Text()
+                converter.body_width = 0
+                converter.code = True
+
+                with result_md.open("w", encoding="utf-8") as f:
+                    result = converter.handle(html_content)
+                    f.write(result)
+
+            except ImportError:
+                print(  # noqa:T201
+                    """
+                    ====================================
+                    Docling package is required to convert HTML to Markdown.
+                    Please install it using the following command:
+                    `pip install docling` or poetry add docling
+                    ====================================
+                    """
+                )
+
+    def run_pre_commit(self) -> str:
+        """Run the pre-commit command and capture its output.
+
+        Returns:
+            str: The output of the pre-commit command.
+
+        Raises:
+            subprocess.CalledProcessError: If the pre-commit command fails.
+
+        """
+        try:
+            results = ""
+            yaml_config = yaml.safe_load(Path(".pre-commit-config.yaml").read_text())
+            repos = yaml_config.get("repos")
+            for repo in repos:
+                hooks = repo.get("hooks")
+                for hook in hooks:
+                    id_hook = hook.get("id")
+                    if id_hook:
+                        result = subprocess.run(
+                            ["pre-commit", "run", id_hook, "--all-files"],
+                            capture_output=True,
+                            text=True,
+                        )
+
+                        if "passed" not in result.stdout.lower():
+                            if results != "":
+                                results += f"{result.stdout}\n"
+                                continue
+
+                            results = result.stdout
+            return results
+        except subprocess.CalledProcessError as e:
+            return f"Erro ao executar pre-commit: {e.stderr}"
+
+    def format_result(self, h3_file: str) -> None:
+        """Format the error head message."""
+        ruff_ref = ""
+        path_code_file = h3_file.split(":")[0]
+        line_code = h3_file.split(":")[1]
+        column_code = h3_file.split(":")[2]
+        message = h3_file.split(":")[3]
+        path_file_link = str(path_code_file)
+
+        try:
+            workdir = Path.cwd().resolve()
+            path_code_file = h3_file.split(":")[0]
+
+            path_file_link = generate_editor_links(
+                workdir.joinpath(str(path_code_file)), int(line_code), int(column_code)
+            )[self.ide]
+        except Exception as e:
+            print(  # noqa:T201
+                f"""
+                ====================================
+                Error to generate link to file editor
+                File: {path_code_file}
+                Exception: {e}
+                ====================================
+                """
+            )
+        self.code_error.append(message)
+        self.code_error.append(f"{path_code_file}:{line_code}:{column_code}")
+        self.code_error.append(path_file_link)
+        if len(message.split(" ")) > 1:
+            ruff_ref = message.split(" ")[1]
+            self.code_error.append(f"https://docs.astral.sh/ruff/rules/#{ruff_ref}")
+
+        else:
+            self.code_error.append("")
+
+    def pre_commit_html(self) -> None:
+        """Format the pre-commit output into an HTML file.
+
+        This method runs the pre-commit command, processes its output, and writes the formatted
+        results into an HTML file.
+        """
+        content = self.run_pre_commit()
+
+        content_splitlines = content.splitlines()
+
+        for line in content_splitlines:
+            if "\\" in line and ":" in line:
+                # if a file is found, add it to the code_part list if it is empty
+                h3_file = line.replace("\\", "/")
+
+                if len(self.code_part) > 0:
+                    self.code_error.append(self.code_part)
+                    to_append = self.code_error
+                    self.html_content.append(to_append)
+
+                    self.code_error = []
+                    self.code_part = []
+
+                if len(h3_file.split(":")) > 3:
+                    self.format_result(h3_file=h3_file)
+
+            elif "|" in line:
+                code_content = line
+                if code_content.strip() == "|":
+                    continue
+                self.code_part.append(code_content)
+
+        if all(
+            [  # noqa:W503
+                len(self.html_content) == 0,
+                len(self.code_part) > 0,
+                len(self.code_error) > 0,
+            ],
+        ):
+            self.code_error.append(self.code_part)
+            self.html_content.append(self.code_error)
+
+            h3_file = line.replace("\\", "/")
+            if len(h3_file.split(":")) == 4:
+                self.format_result(h3_file=h3_file)
+
+        self.render_template()
+        self.uri_html = result_html.resolve().as_uri()
+        print(f"HTML file generated: {self.uri_html}")  # noqa:T201

pre_commit_html-0.1.4.post1/pre_commit_html/main.py

@@ -0,0 +1,39 @@
+"""Main module for the pre-commit-html package."""
+
+import argparse
+import sys
+import webbrowser
+from typing import Sequence
+
+from pre_commit_html import PreCommitToHTML
+
+
+def main(argv: Sequence[str] | None = None) -> None:
+    """Run the pre-commit formatter."""
+    argv = argv if argv is not None else sys.argv[1:]
+    parser = argparse.ArgumentParser(prog="pre-commit-html")
+
+    parser.add_argument(
+        "-i",
+        "--IDE",
+        type=str,
+        help="""IDE for config link files. Supported IDEs: VS Code, Sublime Text, Atom, PyCharm, IntelliJ IDEA, and
+                     WebStorm""",
+        default="VS Code",
+    )
+    parser.add_argument("-m", "--to-markdown", "--md", help="Convert the HTML file to Markdown.", action="store_true")
+    parser.add_argument(
+        "-t",
+        "--theme",
+        type=str,
+        help="Theme for the HTML file. Supported themes: dark, light",
+        default="dark",
+    )
+    args = parser.parse_args(argv)
+    instance_ = PreCommitToHTML(
+        ide=args.IDE,
+        to_markdown=args.to_markdown,
+        theme=args.theme,
+    )
+
+    webbrowser.open(str(instance_.uri_html))

pre_commit_html-0.1.4.post1/pre_commit_html/site/templates/html_content.jinja

@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html lang="en" data-bs-theme="{{ theme }}">
+
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Pre-Commit Result</title>
+
+
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js"
+      integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g=="
+      crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/2.11.8/umd/popper.min.js"
+      integrity="sha512-TPh2Oxlg1zp+kz3nFA0C5vVC6leG/6mm1z9+mA81MI5eaUVqasPLO8Cuk4gMF4gUfP5etR73rgU/8PNMsSesoQ=="
+      crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.3.3/js/bootstrap.min.js"
+      integrity="sha512-ykZ1QQr0Jy/4ZkvKuqWn4iF3lqPZyij9iRv6sGqLRdTPkY69YX6+7wvVGmsdBbiIfN/8OdsI7HABjvEok6ZopQ=="
+      crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bootstrap/5.3.3/css/bootstrap.min.css"
+      integrity="sha512-jnSuA4Ss2PkkikSOLtYs8BlYIeeIK1h99ty4YfvRPAlzr377vr3CXDb7sb7eEEBYjDtcYj+AjBH3FLv5uSJuXg=="
+      crossorigin="anonymous" referrerpolicy="no-referrer" />
+    <link rel="stylesheet"
+      href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/atom-one-dark.min.css"
+      integrity="sha512-Jk4AqjWsdSzSWCSuQTfYRIF84Rq/eV0G2+tu07byYwHcbTGfdmLrHjUSwvzp5HvbiqK4ibmNwdcG49Y5RGYPTg=="
+      crossorigin="anonymous" referrerpolicy="no-referrer" />
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"
+      integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ=="
+      crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/python.min.js"
+      integrity="sha512-wW8K3TEH5ZViD4aMPzwPdhXKs/Kb5MAm7qLRd3QliYlHy0u9utSKZsZzqlZAgJ9xxXp81acwnrZVZ8oTfoLG1g=="
+      crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+  </head>
+
+  <body class="bg-{{ theme }}">
+
+    <div class="container">
+      <div class="card mt-4">
+        <div class="card-header" style="background-color: rgb(36, 51, 1);">
+          <h1>Pre-Commit Result</h1>
+          <!-- <p>Pre-Commit Result:
+            <span id="result">
+
+            </span>
+          </p> -->
+        </div>
+        <div class="card-body">
+          <div class="list-group">
+            {% for item in content %}
+            <a href="{{ item[2] }}" class="list-group-item list-group-item-action d-flex gap-3 py-3"
+              aria-current="true">
+              <div class="d-block w-100 gap-2 justify-content-between">
+                <div>
+                  <h6 class="mb-0">{{ item[1] }}</h6>
+                  <p class="mb-0 opacity-75">{{ item[0] }}</p>
+                  {% set code = item[4] %}
+                  <pre
+                    class="theme-atom-one-dark shadow-3xl text-sm relative overflow-hidden max-w-full tab-size h-full ">
+                    <code class="language-python">
+                      {% for linecode in code %}
+{{ linecode }}
+                      {% endfor %}
+                    </code>
+
+                  </pre>
+                </div>
+              </div>
+            </a>
+            {% endfor %}
+          </div>
+          </ul>
+        </div>
+      </div>
+    </div>
+    <script>hljs.highlightAll();</script>
+
+  </body>
+
+</html>

{pre_commit_html-0.1.4 → pre_commit_html-0.1.4.post1}/pyproject.toml

@@ -1,12 +1,16 @@
 [project]
 name = "pre_commit_html"
-version = "v0.1.4"
+version = "v0.1.4.post1"
 description = "Format results from pre-commit cmd to HTML file"
 authors = [{ name = "Robotz213", email = "nicholas@robotz.dev" }]
 readme = "README.md"
 license = "MIT"
-requires-python = ">=3.13"
-dependencies = ["pre-commit (>=4.1.0,<5.0.0)", "jinja2 (>=3.1.5,<4.0.0)"]
+requires-python = ">=3.13,<4.0"
+dependencies = [
+    "pre-commit (>=4.1.0,<5.0.0)",
+    "jinja2 (>=3.1.5,<4.0.0)",
+    "html2text (>=2024.2.26,<2025.0.0)",
+]
 
 [tool.poetry.scripts]
 pre-commit-html = "pre_commit_html.__main__:main"

pre_commit_html-0.1.4/pre_commit_html/__init__.py

@@ -1,154 +0,0 @@
-"""Module for formatting pre-commit results into an HTML file."""
-
-import os
-import subprocess
-from pathlib import Path
-
-from jinja2 import Environment, FileSystemLoader, Template  # noqa: F401
-
-from pre_commit_html.utils import generate_editor_links
-
-env = Environment(  # noqa:S701
-    loader=FileSystemLoader(
-        Path(
-            __file__,
-        )
-        .parent.resolve()
-        .joinpath("site/templates")
-    ),
-)
-
-render_template = env.get_template
-
-path_result_content = Path("result_pre_commit.html")
-
-
-class PreCommitToHTML:
-    """Class to parse and format pre-commit results."""
-
-    def __init__(self, ide: str = "VS Code") -> None:
-        """Initialize the PreCommitToHTML class."""
-        self.ide = ide
-        self.pre_commit_html()
-
-    def run_pre_commit(self) -> str:
-        """Run the pre-commit command and capture its output.
-
-        Returns:
-            str: The output of the pre-commit command.
-
-        Raises:
-            subprocess.CalledProcessError: If the pre-commit command fails.
-
-        """
-        try:
-            result = subprocess.run(
-                ["pre-commit", "run", "--all-files"],
-                capture_output=True,
-                text=True,
-            )
-            return result.stdout
-        except subprocess.CalledProcessError as e:
-            return f"Erro ao executar pre-commit: {e.stderr}"
-
-    def pre_commit_html(self) -> None:
-        """Format the pre-commit output into an HTML file.
-
-        This method runs the pre-commit command, processes its output, and writes the formatted
-        results into an HTML file.
-        """
-        content = self.run_pre_commit()
-
-        content_splitlines = content.splitlines()
-
-        html_content: list[str] = []
-
-        code_part: list[str] = []
-
-        code_error: list[str] = []
-
-        for line in content_splitlines:
-            if "\\" in line and ":" in line and len(code_part) == 0:
-                h3_file = line.replace("\\", "/")
-
-                if len(h3_file.split(":")) == 4:
-                    path_code_file = h3_file.split(":")[0]
-                    path_file_link = path_code_file
-
-                    line_code = h3_file.split(":")[1]
-                    column_code = h3_file.split(":")[2]
-                    message = h3_file.split(":")[3]
-
-                    try:
-                        workdir = Path.cwd().resolve()
-                        path_code_file = h3_file.split(":")[0]
-
-                        path_file_link = generate_editor_links(
-                            workdir.joinpath(str(path_code_file)), int(line_code), int(column_code)
-                        )[self.ide]
-                    except Exception as e:
-                        print(  # noqa:T201
-                            f"""
-                            ====================================
-                            Error to generate link to file editor
-                            File: {path_code_file}
-                            Exception: {e}
-                            ====================================
-                            """
-                        )
-
-                    ruff_ref = message.split(" ")[1]
-
-                    code_error.append(
-                        "".join((
-                            f'<h3>File: <a href="{path_file_link}',
-                            f'{column_code}">{path_code_file}:{line_code}:{column_code}</a></h3>',
-                        ))
-                    )
-                    code_error.append(
-                        f'<p>Error: <a href="https://docs.astral.sh/ruff/rules/#{ruff_ref}">{ruff_ref}</a>{message}</p>'
-                    )
-
-            elif "\\" in line and ":" in line and len(code_part) > 0:
-                h3_file = line.replace("\\", "/")
-
-                code_part_html = render_template("code_part.jinja").render(code_part=code_part)
-
-                code_error.append(code_part_html)
-                to_html = render_template("code_error.jinja").render(code_error=code_error)
-
-                html_content.append(to_html)
-
-                code_part.clear()
-                code_error.clear()
-
-                path_code_file = h3_file.split(":")[0]
-                line_code = h3_file.split(":")[1]
-                column_code = h3_file.split(":")[2]
-                message = h3_file.split(":")[3]
-
-                ruff_ref = message.split(" ")[1]
-
-                code_error.append(
-                    "".join((
-                        f'<h3>File: <a href="./{path_code_file}:{line_code}:',
-                        f'{column_code}">{path_code_file}:{line_code}:{column_code}</a></h3>',
-                    ))
-                )
-                code_error.append(
-                    f'<p>Error: <a href="https://docs.astral.sh/ruff/rules/#{ruff_ref}">{ruff_ref}</a>{message}</p>'
-                )
-                continue
-
-            if "|" in line:
-                code_part.append(line)
-
-        if path_result_content.exists():
-            os.remove(str(path_result_content))
-
-        path_result_content.touch()
-
-        html_content = render_template("html_content.jinja").render(content=html_content)
-
-        with open(path_result_content, "w", encoding="utf-8") as f:
-            f.write(html_content)

pre_commit_html-0.1.4/pre_commit_html/main.py

@@ -1,18 +0,0 @@
-"""Main module for the pre-commit-html package."""
-
-import argparse
-import sys
-from typing import Sequence
-
-from pre_commit_html import PreCommitToHTML
-
-
-def main(argv: Sequence[str] | None = None) -> None:
-    """Run the pre-commit formatter."""
-    argv = argv if argv is not None else sys.argv[1:]
-    parser = argparse.ArgumentParser(prog="pre-commit-html")
-
-    parser.add_argument("-i", "--IDE", type=str, help="The IDE to open the file in.", default="VS Code")
-
-    args = parser.parse_args(argv)
-    PreCommitToHTML(ide=args.IDE)

pre_commit_html-0.1.4/pre_commit_html/site/templates/code_error.jinja

@@ -1,3 +0,0 @@
-{% for item in code_error %}
-{{ item }}
-{% endfor %}

pre_commit_html-0.1.4/pre_commit_html/site/templates/code_part.jinja

@@ -1,7 +0,0 @@
-<pre>
-  <code class="python">
-    {% for item in code_part %}
-    {{ item }}
-    {% endfor %}
-  </code>
-</pre>

pre_commit_html-0.1.4/pre_commit_html/site/templates/html_content.jinja

@@ -1,38 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-  <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Pre-Commit Result</title>
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/styles/a11y-dark.min.css"
-      integrity="sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg=="
-      crossorigin="anonymous" referrerpolicy="no-referrer" />
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/highlight.min.js"
-      integrity="sha512-EBLzUL8XLl+va/zAsmXwS7Z2B1F9HUHkZwyS/VKwh3S7T/U0nF4BaU29EP/ZSf6zgiIxYAnKLu6bJ8dqpmX5uw=="
-      crossorigin="anonymous" referrerpolicy="no-referrer"></script>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.1/languages/python.min.js"
-      integrity="sha512-/uCTceIDOniHf+VUKbCnP/x6GQSRrm4GwUtQYMgKa9yIZPGzlR04flSsD+2or7bPn44VY9inIHI4cwNCcZmJDw=="
-      crossorigin="anonymous" referrerpolicy="no-referrer"></script>
-  </head>
-
-  <body>
-    <h1>Pre-Commit Result</h1>
-    <p>Pre-Commit Result: <span id="result"></span></p>
-
-    <ul>
-      {% for item in content %}
-      {{ item }}
-      {% endfor %}
-    </ul>
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
-
-    <!-- and it's easy to individually load additional languages -->
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/go.min.js"></script>
-
-    <script>hljs.highlightAll();</script>
-
-  </body>
-
-</html>