pre-commit-html 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

pre_commit_html/__init__.py

@@ -1,11 +1,21 @@
 """Module for formatting pre-commit results into an HTML file."""
 
-from pathlib import Path
+import os
 import subprocess
-from jinja2 import Template, Environment, FileSystemLoader  # noqa: F401
+from pathlib import Path
+
+from jinja2 import Environment, FileSystemLoader, Template  # noqa: F401
 
-env = Environment(
-    loader=FileSystemLoader(Path(__file__).parent.resolve().joinpath("site/templates"))
+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
@@ -13,17 +23,23 @@ render_template = env.get_template
 path_result_content = Path("result_pre_commit.html")
 
 
-class PreCommitParser:
+class PreCommitToHTML:
     """Class to parse and format pre-commit results."""
 
-    @classmethod
-    def run_pre_commit(cls) -> str:
+    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(
@@ -35,14 +51,13 @@ class PreCommitParser:
         except subprocess.CalledProcessError as e:
             return f"Erro ao executar pre-commit: {e.stderr}"
 
-    @classmethod
-    def pre_commit_html(cls) -> None:
+    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 = cls.run_pre_commit()
+        content = self.run_pre_commit()
 
         content_splitlines = content.splitlines()
 
@@ -58,19 +73,37 @@ class PreCommitParser:
 
                 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_code_file}:{line_code}:',
-                                f'{column_code}">{path_code_file}:{line_code}:{column_code}</a></h3>',
-                            )
-                        )
+                        "".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>'
@@ -79,14 +112,10 @@ class PreCommitParser:
             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_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
-                )
+                to_html = render_template("code_error.jinja").render(code_error=code_error)
 
                 html_content.append(to_html)
 
@@ -101,12 +130,10 @@ class PreCommitParser:
                 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>',
-                        )
-                    )
+                    "".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>'
@@ -117,16 +144,11 @@ class PreCommitParser:
                 code_part.append(line)
 
         if path_result_content.exists():
-            path_result_content.unlink()
+            os.remove(str(path_result_content))
 
         path_result_content.touch()
 
-        html_content = render_template("html_content.jinja").render(
-            content=html_content
-        )
+        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/__main__.py

@@ -1,15 +1,6 @@
-"""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()
+"""Module containing the main function to run the pre-commit formatter."""
 
+from pre_commit_html.main import main
 
 if __name__ == "__main__":
     SystemExit(main())

pre_commit_html/main.py

@@ -0,0 +1,18 @@
+"""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/utils.py

@@ -0,0 +1,52 @@
+"""Utility functions for generating file editor links.
+
+This module provides functionality for constructing URLs that open files in various
+editors. It supports multiple editor URL schemes.
+"""
+
+import pathlib
+from urllib.parse import quote
+
+
+def generate_editor_links(path: str, line: int = None, column: int = None) -> dict[str, str]:
+    """Generate multiple editor links for opening files.
+
+    Args:
+        path (str): The file path.
+        line (int, optional): The line number in the file.
+        column (int, optional): The column number in the file.
+
+    Returns:
+        dict[str, str]: A dictionary containing editor-specific URL schemes.
+
+    """
+    file_path = pathlib.Path(path).resolve()
+    file_uri = file_path.as_uri()  # file:// format
+    escaped_path = quote(str(file_path))  # For editors like VS Code, JetBrains, Sublime, Atom, etc.
+
+    # Formatted line and column strings
+    line_str = f":{line}" if line else ""
+    column_str = f":{column}" if column else ""
+
+    # Editor-specific URL formats
+    links = {
+        "file://": f"{file_uri}{f'#L{line}' if line else ''}{f'C{column}' if column else ''}",
+        "VS Code": f"vscode://file/{escaped_path}{line_str}{column_str}",
+        "Nova (macOS)": (
+            f"nova://open?path={escaped_path}{f'&line={line}' if line else ''}{f'&column={column}' if column else ''}"
+        ),
+        "Sublime Text": (
+            f"subl://open?url=file://{escaped_path}"
+            f"{f'&line={line}' if line else ''}"
+            f"{f'&column={column}' if column else ''}"
+        ),
+        "Atom": (
+            f"atom://core/open/file?filename={escaped_path}"
+            f"{f'&line={line}' if line else ''}"
+            f"{f'&column={column}' if column else ''}"
+        ),
+        "BBEdit (macOS)": f"bbedit://open?path={escaped_path}{f'&line={line}' if line else ''}",
+        "Vim/Nvim": f"vim://open?url=file://{escaped_path}{f'&line={line}' if line else ''}",
+    }
+
+    return links

{pre_commit_html-0.1.2.dist-info → pre_commit_html-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pre_commit_html
-Version: 0.1.2
+Version: 0.1.4
 Summary: Format results from pre-commit cmd to HTML file
 License: MIT
 Author: Robotz213
@@ -33,7 +33,7 @@ This project is designed to run pre-commit hooks and format the results into an
 
 ## How It Works
 
-1. **Run Pre-Commit Hooks**: The `PreCommitParser` class runs the pre-commit hooks using the `pre-commit run --all-files` command.
+1. **Run Pre-Commit Hooks**: The `PreCommitToHTML` 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.
 
@@ -58,7 +58,7 @@ This will generate an HTML file named `result_pre_commit.html` in the project di
 ## 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.
+- `pre_commit_html/__init__.py`: Contains the `PreCommitToHTML` 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

pre_commit_html-0.1.4.dist-info/RECORD

@@ -0,0 +1,13 @@
+pre_commit_html/__init__.py,sha256=Jqu0BfEfeVI69waWiCRmN-fM4nubQFXJbVEnvngTdcI,5233
+pre_commit_html/__main__.py,sha256=3xoQ6wvPiHkruP_D36-H3BHkkVq4601cMGP89eLWV5c,165
+pre_commit_html/main.py,sha256=G9ShTj1bNFGzPt7v5y2MuB5lxXDa4IyWa4Zx23yFBS0,538
+pre_commit_html/site/nothing,sha256=FgEEp-DgpF7jCB5mTtiWk_6yQcNz6q68-hqvGHulRbA,15
+pre_commit_html/site/templates/code_error.jinja,sha256=Nca684pgieEMbgrHFEl7acf26-e5LpGQIYFMDfyHoZ0,52
+pre_commit_html/site/templates/code_part.jinja,sha256=ZmTKj9Ev1_yDoUQJlZ1RQZb1-VYDOSkN2sNvwbnfng0,111
+pre_commit_html/site/templates/html_content.jinja,sha256=9dmoVLZ-BmYEf27j_52F6md23WS_5JshkTqO9VpRvX0,1695
+pre_commit_html/utils.py,sha256=4L0RHabgXxTFARKJR8EArB7SW00m8zCgcyHwIhEvt-8,1968
+pre_commit_html-0.1.4.dist-info/LICENSE,sha256=3V9deIJXT--GYubOVNXj1madYOvijNEIn03Yh6ChvPI,1066
+pre_commit_html-0.1.4.dist-info/METADATA,sha256=MjOucQucaGvrr14v09vVZEZM40nD_UcXMH9L2PVSK8k,2926
+pre_commit_html-0.1.4.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
+pre_commit_html-0.1.4.dist-info/entry_points.txt,sha256=QDAlUvwqJE8dDBmurDHauYiMar21Pu_0_-Ew9EjK75w,65
+pre_commit_html-0.1.4.dist-info/RECORD,,

pre_commit_html-0.1.4.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+pre-commit-html=pre_commit_html.__main__:main
+

pre_commit_html-0.1.2.dist-info/RECORD

@@ -1,11 +0,0 @@
-pre_commit_html/__init__.py,sha256=W30OYPhTtrsoGH_xbIFRGO8IpDKcL5OEdobZLqYXYrM,4364
-pre_commit_html/__main__.py,sha256=ME8XDYKL00PsCgA96rYrGqzujMCu5FiUPVZo5VyiZ6w,367
-pre_commit_html/site/nothing,sha256=FgEEp-DgpF7jCB5mTtiWk_6yQcNz6q68-hqvGHulRbA,15
-pre_commit_html/site/templates/code_error.jinja,sha256=Nca684pgieEMbgrHFEl7acf26-e5LpGQIYFMDfyHoZ0,52
-pre_commit_html/site/templates/code_part.jinja,sha256=ZmTKj9Ev1_yDoUQJlZ1RQZb1-VYDOSkN2sNvwbnfng0,111
-pre_commit_html/site/templates/html_content.jinja,sha256=9dmoVLZ-BmYEf27j_52F6md23WS_5JshkTqO9VpRvX0,1695
-pre_commit_html-0.1.2.dist-info/LICENSE,sha256=3V9deIJXT--GYubOVNXj1madYOvijNEIn03Yh6ChvPI,1066
-pre_commit_html-0.1.2.dist-info/METADATA,sha256=SRNwXpJjTDfIWzwLcFsu_AcjfQW4YXIVZuTaGtnAVcw,2926
-pre_commit_html-0.1.2.dist-info/WHEEL,sha256=XbeZDeTWKc1w7CSIyre5aMDU_-PohRwTQceYnisIYYY,88
-pre_commit_html-0.1.2.dist-info/entry_points.txt,sha256=qosHLsMCjOyjqzpzxw7GKkNQ5RzBxXAh6sFjINUHpMM,60
-pre_commit_html-0.1.2.dist-info/RECORD,,

pre_commit_html-0.1.2.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-pre_commit_html=pre_commit_html:__main__
-