pre-commit-html 0.1.1__tar.gz

pre_commit_html-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Robotz213
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pre_commit_html-0.1.1/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.3
+Name: pre_commit_html
+Version: 0.1.1
+Summary: Format results from pre-commit cmd to HTML file
+License: MIT
+Author: Robotz213
+Author-email: nicholas@robotz.dev
+Requires-Python: >=3.13
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+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 Formatter
+
+> Portuguese version [here](docs/README-pt.md)(Link only works on the project page).
+
+This project is designed to run pre-commit hooks and format the results into an HTML file for easy viewing.
+
+## Summary
+
+- [How It Works](#how-it-works)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Project Structure](#project-structure)
+- [Templates](#templates)
+- [Example](#example)
+- [License](#license)
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+
+## How It Works
+
+1. **Run Pre-Commit Hooks**: The `PreCommitParser` class runs the pre-commit hooks using the `pre-commit run --all-files` command.
+2. **Parse Output**: The output from the pre-commit hooks is parsed to extract relevant information such as file paths, line numbers, column numbers, and error messages.
+3. **Generate HTML**: The parsed information is then formatted into an HTML file using Jinja2 templates. The HTML file includes links to the relevant lines in the source code and references to the documentation for the errors.
+
+## Installation
+
+To use this project, you need to have Python and `pre-commit` installed. You can install the required dependencies using pip:
+
+```sh
+poetry install
+```
+
+## Usage
+
+To run the pre-commit formatter, execute the following command:
+
+```sh
+python -m pre_commit_html
+```
+
+This will generate an HTML file named `result_pre_commit.html` in the project directory.
+
+## Project Structure
+
+- `pre_commit_html/__main__.py`: Contains the main function to run the pre-commit formatter.
+- `pre_commit_html/__init__.py`: Contains the `PreCommitParser` class which handles running the pre-commit hooks and formatting the output.
+- `site/templates/`: Contains the Jinja2 templates used to generate the HTML file.
+
+## Templates
+
+The project uses Jinja2 templates to format the HTML output. The templates are located in the `site/templates/` directory and include:
+
+- `code_part.jinja`: Template for formatting code parts.
+- `code_error.jinja`: Template for formatting code errors.
+- `html_content.jinja`: Template for the overall HTML content.
+
+## Example
+
+Here is an example of how the HTML output might look:
+
+```html
+<h3>File: <a href="./path/to/file.py:10:5">path/to/file.py:10:5</a></h3>
+<p>
+  Error: <a href="https://docs.astral.sh/ruff/rules/#E123">E123</a> Some error
+  message
+</p>
+<pre>
+    | Some code part |
+</pre>
+```
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE).
+

pre_commit_html-0.1.1/README.md

@@ -0,0 +1,74 @@
+# Pre-Commit Formatter
+
+> Portuguese version [here](docs/README-pt.md)(Link only works on the project page).
+
+This project is designed to run pre-commit hooks and format the results into an HTML file for easy viewing.
+
+## Summary
+
+- [How It Works](#how-it-works)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Project Structure](#project-structure)
+- [Templates](#templates)
+- [Example](#example)
+- [License](#license)
+- [Contributing](CONTRIBUTING.md)
+- [Code of Conduct](CODE_OF_CONDUCT.md)
+
+## How It Works
+
+1. **Run Pre-Commit Hooks**: The `PreCommitParser` class runs the pre-commit hooks using the `pre-commit run --all-files` command.
+2. **Parse Output**: The output from the pre-commit hooks is parsed to extract relevant information such as file paths, line numbers, column numbers, and error messages.
+3. **Generate HTML**: The parsed information is then formatted into an HTML file using Jinja2 templates. The HTML file includes links to the relevant lines in the source code and references to the documentation for the errors.
+
+## Installation
+
+To use this project, you need to have Python and `pre-commit` installed. You can install the required dependencies using pip:
+
+```sh
+poetry install
+```
+
+## Usage
+
+To run the pre-commit formatter, execute the following command:
+
+```sh
+python -m pre_commit_html
+```
+
+This will generate an HTML file named `result_pre_commit.html` in the project directory.
+
+## Project Structure
+
+- `pre_commit_html/__main__.py`: Contains the main function to run the pre-commit formatter.
+- `pre_commit_html/__init__.py`: Contains the `PreCommitParser` class which handles running the pre-commit hooks and formatting the output.
+- `site/templates/`: Contains the Jinja2 templates used to generate the HTML file.
+
+## Templates
+
+The project uses Jinja2 templates to format the HTML output. The templates are located in the `site/templates/` directory and include:
+
+- `code_part.jinja`: Template for formatting code parts.
+- `code_error.jinja`: Template for formatting code errors.
+- `html_content.jinja`: Template for the overall HTML content.
+
+## Example
+
+Here is an example of how the HTML output might look:
+
+```html
+<h3>File: <a href="./path/to/file.py:10:5">path/to/file.py:10:5</a></h3>
+<p>
+  Error: <a href="https://docs.astral.sh/ruff/rules/#E123">E123</a> Some error
+  message
+</p>
+<pre>
+    | Some code part |
+</pre>
+```
+
+## License
+
+This project is licensed under the [MIT License](./LICENSE).

pre_commit_html-0.1.1/pre_commit_html/__init__.py

@@ -0,0 +1,131 @@
+"""Module for formatting pre-commit results into an HTML file."""
+
+from pathlib import Path
+import subprocess
+from jinja2 import Template, Environment, FileSystemLoader  # noqa: F401
+
+env = Environment(
+    loader=FileSystemLoader(Path(__file__).parent.resolve().joinpath("site/templates"))
+)
+
+render_template = env.get_template
+
+path_result_content = Path("result_pre_commit.html")
+
+
+class PreCommitParser:
+    """Class to parse and format pre-commit results."""
+
+    @classmethod
+    def run_pre_commit(cls) -> 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}"
+
+    @classmethod
+    def pre_commit_html(cls) -> 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 = cls.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("\\", "/")
+
+                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>'
+                )
+
+            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():
+            path_result_content.unlink()
+
+        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)
+
+
+PreCommitParser.pre_commit_html()

pre_commit_html-0.1.1/pre_commit_html/__main__.py

@@ -0,0 +1,11 @@
+"""This module contains the main function to run the pre-commit formatter."""
+
+from . import PreCommitParser
+
+
+def main() -> None:
+    """Main function to run the pre-commit formatter.
+
+    This function calls the pre_commit_html method from the PreCommitParser class.
+    """
+    PreCommitParser.pre_commit_html()

pre_commit_html-0.1.1/pre_commit_html/site/nothing

@@ -0,0 +1 @@
+just inchident

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

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

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

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

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

@@ -0,0 +1,38 @@
+<!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>

pre_commit_html-0.1.1/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "pre_commit_html"
+version = "0.1.1"
+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)"]
+
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.9.5"